hpe_nimble_group – Manage the HPE Nimble Storage group.

Synopsis

Manage an HPE Nimble Storage group on an Nimble Storage array.

Requirements

The below requirements are needed on the host that executes this module.

  • Ansible 2.9 or later
  • NimbleOS 5.0 or later
  • HPE Nimble Storage SDK for Python 1.0.0 or later (nimble-sdk Python module)

Parameters

alarms (False, bool, None)
Whether alarm feature is enabled.
alert_to_email_addrs (False, str, None)
Comma-separated list of email addresss to receive emails. Comma separated email list.
alert_from_email_addrs (False, str, None)
From email address to use while sending emails. Case insensitive email address.
alert_min_level (False, str, None)
Minimum level of alert to be notified.
allow_analytics_gui (False, bool, None)
Specify whether to allow HPE Nimble Storage to use Google Analytics in the GUI. HPE Nimble Storage uses Google Analytics to gather data related to GUI usage. The data gathered is used to evaluate and improve the product.
allow_support_tunnel (False, bool, None)
Whether to allow support tunnel.
auto_switchover (False, bool, None)
Whether automatic switchover of Group management services feature is enabled.
autoclean_unmanaged_snapshots (False, bool, None)
Whether autoclean unmanaged snapshots feature is enabled.
autoclean_unmanaged_snapshots_ttl_unit (False, int, None)
Unit for unmanaged snapshot time to live.
autosupport (False, bool, None)
Whether to send autosupport.
cc_mode (False, bool, None)
Enable or disable Common Criteria mode.
change_name (False, str, None)
Change name of the existing group.
check_migrate (False, bool, None)
Check if the group Management Service can be migrated to the group Management Service backup array.
date (False, int, None)
Unix epoch time local to the group. Seconds since last epoch. Example- 3400.
default_iscsi_target_scope (False, str, None)
Newly created volumes are exported under iSCSI Group Target or iSCSI Volume Target.
default_volume_limit (False, int, None)
Default limit for a volume space usage as a percentage of volume size. Volume will be taken offline/made non-writable on exceeding its limit. Percentage as integer from 0 to 100.
domain_name (False, str, None)
Domain name for this group. String of alphanumeric characters, valid range is from 2 to 255; Each label must be between 1 and 63 characters long; - and . are allowed after the first and before the last character.
dns_servers (False, list, None)
IP addresses for this group’s dns servers.
fc_enabled (False, bool, None)
Whether FC is enabled on this group.
force (False, bool, False)
Can be used with halt or merge flag. Halt remaining arrays when one or more is unreachable. Ignore warnings and forcibly merge specified group with this group.
group_snapshot_ttl (False, int, None)
Snapshot Time-to-live(TTL) configured at group level for automatic deletion of unmanaged snapshots. Value 0 indicates unlimited TTL.
group_target_enabled (False, bool, None)
Is group_target enabled on this group.
group_target_name (False, str, None)
Iscsi target name for this group. String of up to 255 alphanumeric, hyphenated, colon, or period-separated characters; but cannot begin with hyphen, colon or period. This type is used for the group target name.
halt (False, bool, None)
Halt all arrays in the group.
iscsi_enabled (False, bool, None)
Whether iSCSI is enabled on this group.
isns_enabled (False, bool, None)
Whether iSNS is enabled.
isns_port (False, int, None)
Port number for iSNS Server. Positive integer value up to 65535 representing TCP/IP port.
isns_server (False, str, None)
Hostname or IP Address of iSNS Server.
level (False, str, None)
Level of the test alert.
login_banner_after_auth (False, bool, None)
Should the banner be displayed before the user credentials are prompted or after prompting the user credentials.
login_banner_message (False, str, None)
The message for the login banner that is displayed during user login activity. String upto 2048 characters.
login_banner_reset (False, str, None)
This will reset the banner to the version of the installed NOS. When login_banner_after_auth is specified, login_banner_reset can not be set to true.
merge (False, bool, None)
Perform group merge with the specified group.
migrate (False, bool, None)
Migrate the group Management Service to the current group Management Service backup array.
name (True, str, None)
Name of the group.
ntp_server (False, str, None)
Either IP address or hostname of the NTP server for this group. Plain string.
proxy_port (False, int, None)
Proxy Port of HTTP Proxy Server. Integer value between 0-65535 representing TCP/IP port.
proxy_server (False, str, None)
Hostname or IP Address of HTTP Proxy Server. Setting this attribute to an empty string will unset all proxy settings.
proxy_username (False, str, None)
Username to authenticate with HTTP Proxy Server. HTTP proxy server username, string up to 255 characters, special characters are not allowed.
proxy_password (False, str, None)
Password to authenticate with HTTP Proxy Server.
reboot (False, bool, None)
Reboot all arrays in the group.
repl_throttle_list (False, list, None)
All the replication bandwidth limits on the system. All the throttles for the partner.
send_alert_to_support (False, bool, None)
Whether to send alert to Support.
skip_secondary_mgmt_ip (False, bool, None)
Skip check for secondary management IP address.
smtp_auth_enabled (False, bool, None)
Whether SMTP Server requires authentication.
smtp_auth_password (False, str, None)
Password to authenticate with SMTP Server.
smtp_auth_username (False, str, None)
Username to authenticate with SMTP Server.
smtp_port (False, int, None)
Port number of SMTP Server.
smtp_encrypt_type (False, str, None)
Level of encryption for SMTP.
snmp_community (False, str, None)
Community string to be used with SNMP.
snmp_get_enabled (False, bool, None)
Whether to accept SNMP get commands.
snmp_get_port (False, int, None)
Port number to which SNMP get requests should be sent.
snmp_trap_enabled (False, bool, None)
Whether to enable SNMP traps.
snmp_trap_host (False, str, None)
Hostname or IP Address to send SNMP traps.
snmp_trap_port (False, int, None)
Port number of SNMP trap host.
snmp_sys_contact (False, str, None)
Name of the SNMP administrator. Plain string.
snmp_sys_location (False, str, None)
Location of the group. Plain string.
src_group_ip (False, str, None)
IP address of the source group.
src_group_name (False, str, None)
Name of the source group.
src_username (False, str, None)
Username of the source group.
src_passphrase (False, str, None)
Source group encryption passphrase. Encryption passphrase. String with size from 8 to 64 printable characters.
src_password (False, str, None)
Password of the source group.
state (True, str, None)
The group operation.
syslogd_enabled (False, bool, None)
Is syslogd enabled on this system.
syslogd_port (False, int, None)
Port number for syslogd server.
syslogd_server (False, str, None)
Hostname of the syslogd server.
tdz_enabled (False, bool, None)
Is Target Driven Zoning (TDZ) enabled on this group.
tdz_prefix (False, str, None)
arget Driven Zoning (TDZ) prefix for peer zones created by TDZ.
test_alert (False, bool, None)
Generate a test alert.
timezone (False, str, None)
Timezone in which this group is located. Plain string.
tlsv1_enabled (False, bool, None)
Enable or disable TLSv1.0 and TLSv1.1.
user_inactivity_timeout (False, int, None)
The amount of time in seconds that the user session is inactive before timing out. User inactivity timeout in second, valid range is from 1 to 43200.
validate_merge (False, bool, None)
Perform group merge validation.
vss_validation_timeout (False, int, None)
The amount of time in seconds to validate Microsoft VSS application synchronization before timing out. VSS validation timeout in second, valid range is from 1 to 3600.
vvol_enabled (False, bool, None)
Are vVol enabled on this group.
host (True, str, None)
HPE Nimble Storage IP address.
password (True, str, None)
HPE Nimble Storage password.
username (True, str, None)
HPE Nimble Storage user name.

Notes

Note

  • check_mode is not supported.

Examples

- name: Update group
  hpe_nimble_group:
    host: "{{ host }}"
    username: "{{ username }}"
    password: "{{ password }}"
    name: "{{ name }}"
    send_alert_to_support: "{{ send_alert_to_support }}"
    alert_to_email_addrs: "{{ alert_to_email_addrs }}"
    state: "present"

- name: Reboot group
  hpe_nimble_group:
    host: "{{ host }}"
    username: "{{ username }}"
    password: "{{ password }}"
    name: "{{ name }}"
    state: "present"
    reboot: true

- name: Halt group
  hpe_nimble_group:
    host: "{{ host }}"
    username: "{{ username }}"
    password: "{{ password }}"
    name: "{{ name }}"
    state: "present"
    halt: true

- name: Validate merge group
  hpe_nimble_group:
    host: "{{ host }}"
    username: "{{ username }}"
    password: "{{ password }}"
    name: "{{ name }}"
    src_group_ip: "{{ src_group_ip }}"
    src_password: "{{ src_password }}"
    skip_secondary_mgmt_ip: "{{ skip_secondary_mgmt_ip }}"
    src_passphrase: "{{ src_passphrase }}"
    state: "present"
    validate_merge: true

- name: Merge group
  hpe_nimble_group:
    host: "{{ host }}"
    username: "{{ username }}"
    password: "{{ password }}"
    name: "{{ name }}"
    src_group_ip: "{{ src_group_ip }}"
    src_password: "{{ src_password }}"
    skip_secondary_mgmt_ip: "{{ skip_secondary_mgmt_ip }}"
    src_passphrase: "{{ src_passphrase }}"
    state: "present"
    merge: true

- name: Test alert group
  hpe_nimble_group:
    host: "{{ host }}"
    username: "{{ username }}"
    password: "{{ password }}"
    name: "{{ name }}"
    level: "{{ level }}"
    state: "present"
    test_alert: true

- name: Migrate group
  hpe_nimble_group:
    host: "{{ host }}"
    username: "{{ username }}"
    password: "{{ password }}"
    name: "{{ name }}"
    state: "present"
    migrate: true

- name: Check migrate group
  hpe_nimble_group:
    host: "{{ host }}"
    username: "{{ username }}"
    password: "{{ password }}"
    name: "{{ name }}"
    state: "present"
    check_migrate: true

Status

  • This module is not guaranteed to have a backwards compatible interface. [preview]
  • This module is maintained by community.

Authors