netapp_eseries.santricity.na_santricity_facts – NetApp E-Series retrieve facts about NetApp E-Series storage arrays
Note
This plugin is part of the netapp_eseries.santricity collection (version 1.2.13).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install netapp_eseries.santricity.
To use it in a playbook, specify: netapp_eseries.santricity.na_santricity_facts.
Synopsis
- The na_santricity_facts module returns a collection of facts regarding NetApp E-Series storage arrays.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| api_password
string / required
|
The password to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API.
|
|
| api_url
string / required
|
The url to the SANtricity Web Services Proxy or Embedded Web Services API.
Example https://prod-1.wahoo.acme.com:8443/devmgr/v2
|
|
| api_username
string / required
|
The username to authenticate with the SANtricity Web Services Proxy or Embedded Web Services API.
|
|
| ssid
string
|
Default:
1
|
The ID of the array to manage. This value must be unique for each array.
|
| validate_certs
boolean
|
|
Should https certificates be validated?
|
Notes
Note
- The E-Series Ansible modules require either an instance of the Web Services Proxy (WSP), to be available to manage the storage-system, or an E-Series storage-system that supports the Embedded Web Services API.
- Embedded Web Services is currently available on the E2800, E5700, EF570, and newer hardware models.
- M(netapp_e_storage_system) may be utilized for configuring the systems managed by a WSP instance.
Examples
---
- name: Get array facts
na_santricity_facts:
ssid: "1"
api_url: "https://192.168.1.100:8443/devmgr/v2"
api_username: "admin"
api_password: "adminpass"
validate_certs: true
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | |
|---|---|---|---|
| msg
string
|
on success |
Success message
Sample:
['Gathered facts for storage array. Array ID [1].', 'Gathered facts for web services proxy.']
|
|
| proxy_facts
complex
|
on successful inquiry from from web services proxy's rest api |
proxy storage system list
|
|
| array_status
string
|
success |
storage system status
Sample:
optimal
|
|
| asup_enabled
boolean
|
success |
storage system auto-support status
Sample:
True
|
|
| certificate_status
string
|
success |
storage system ssl certificate status
Sample:
untrusted
|
|
| chassis_serial
string
|
success |
storage system chassis serial number
Sample:
SX0810032
|
|
| controller
complex
|
success |
controller list that contains identification, ip addresses, and certificate information for each controller
Sample:
[{'certificateStatus': 'selfSigned', 'controllerId': '070000000000000000000001', 'ipAddresses': ['172.17.0.5', '3.3.3.3']}]
|
|
| drive_types
list / elements=string
|
success |
all available storage system drive types
Sample:
['sas', 'fibre']
|
|
| firmware_version
string
|
success |
storage system install firmware version
Sample:
08.50.42.99
|
|
| model
string
|
success |
NetApp E-Series model number
Sample:
5700
|
|
| name
string
|
success |
storage system name
Sample:
EF570-NVMe
|
|
| password_status
string
|
success |
storage system password status
Sample:
invalid
|
|
| ssid
string
|
success |
storage system id
Sample:
ec8ed9d2-eba3-4cac-88fb-0954f327f1d4
|
|
| unconfigured_space
string
|
success |
unconfigured storage system space in bytes
Sample:
982259020595200
|
|
| wwn
string
|
success |
storage system unique identifier
Sample:
AC1100051E1E1E1E1E1E1E1E1E1E1E1E
|
|
| storage_array_facts
complex
|
on successful inquiry from from embedded web services rest api |
provides details about the array, controllers, management interfaces, hostside interfaces, driveside interfaces, disks, storage pools, volumes, snapshots, and features.
|
|
| netapp_controllers
complex
|
success |
storage array controller list that contains basic controller identification and status
Sample:
[[{'name': 'A', 'serial': '021632007299', 'status': 'optimal'}, {'name': 'B', 'serial': '021632007300', 'status': 'failed'}]]
|
|
| netapp_disks
complex
|
success |
drive list that contains identification, type, and status information for each drive
Sample:
[[{'available': False, 'firmware_version': 'MS02', 'id': '01000000500003960C8B67880000000000000000', 'media_type': 'ssd', 'product_id': 'PX02SMU080 ', 'serial_number': '15R0A08LT2BA', 'status': 'optimal', 'tray_ref': '0E00000000000000000000000000000000000000', 'usable_bytes': '799629205504'}]]
|
|
| netapp_driveside_interfaces
complex
|
success |
drive side interface list that contains identification, type, and speed for each interface
Sample:
[[{'controller': 'A', 'interface_speed': '12g', 'interface_type': 'sas'}], [{'controller': 'B', 'interface_speed': '10g', 'interface_type': 'iscsi'}]]
|
|
| netapp_enabled_features
complex
|
on success |
specifies the enabled features on the storage array.
Sample:
[['flashReadCache', 'performanceTier', 'protectionInformation', 'secureVolume']]
|
|
| netapp_host_groups
complex
|
on success |
specifies the host groups on the storage arrays.
Sample:
[[{'id': '85000000600A098000A4B28D003610705C40B964', 'name': 'group1'}]]
|
|
| netapp_host_types
complex
|
on success |
lists the available host types on the storage array.
Sample:
[[{'index': 0, 'type': 'FactoryDefault'}, {'index': 1, 'type': 'W2KNETNCL'}, {'index': 2, 'type': 'SOL'}, {'index': 5, 'type': 'AVT_4M'}, {'index': 6, 'type': 'LNX'}, {'index': 7, 'type': 'LnxALUA'}, {'index': 8, 'type': 'W2KNETCL'}, {'index': 9, 'type': 'AIX MPIO'}, {'index': 10, 'type': 'VmwTPGSALUA'}, {'index': 15, 'type': 'HPXTPGS'}, {'index': 17, 'type': 'SolTPGSALUA'}, {'index': 18, 'type': 'SVC'}, {'index': 22, 'type': 'MacTPGSALUA'}, {'index': 23, 'type': 'WinTPGSALUA'}, {'index': 24, 'type': 'LnxTPGSALUA'}, {'index': 25, 'type': 'LnxTPGSALUA_PM'}, {'index': 26, 'type': 'ONTAP_ALUA'}, {'index': 27, 'type': 'LnxTPGSALUA_SF'}, {'index': 28, 'type': 'LnxDHALUA'}, {'index': 29, 'type': 'ATTOClusterAllOS'}]]
|
|
| netapp_hosts
complex
|
on success |
specifies the hosts on the storage arrays.
Sample:
[[{'group_id': '85000000600A098000A4B28D003610705C40B964', 'host_type_index': 28, 'id': '8203800000000000000000000000000000000000', 'name': 'host1', 'ports': [{'address': '1000FF7CFFFFFF01', 'label': 'FC_1', 'type': 'fc'}, {'address': '1000FF7CFFFFFF00', 'label': 'FC_2', 'type': 'fc'}]}]]
|
|
| netapp_hostside_interfaces
complex
|
success |
host side interface list that contains identification, configuration, type, speed, and status information for each interface
Sample:
[[{'iscsi': [{'controller': 'A', 'current_interface_speed': '10g', 'ipv4_address': '10.10.10.1', 'ipv4_enabled': True, 'ipv4_gateway': '10.10.10.1', 'ipv4_subnet_mask': '255.255.255.0', 'ipv6_enabled': False, 'iqn': 'iqn.1996-03.com.netapp:2806.600a098000a81b6d0000000059d60c76', 'link_status': 'up', 'mtu': 9000, 'supported_interface_speeds': ['10g']}]}]]
|
|
| netapp_management_interfaces
complex
|
success |
management interface list that contains identification, configuration, and status for each interface
Sample:
[[{'alias': 'ict-2800-A', 'channel': 1, 'controller': 'A', 'dns_config_method': 'dhcp', 'dns_servers': [], 'ipv4_address': '10.1.1.1', 'ipv4_address_config_method': 'static', 'ipv4_enabled': True, 'ipv4_gateway': '10.113.1.1', 'ipv4_subnet_mask': '255.255.255.0', 'ipv6_enabled': False, 'link_status': 'up', 'mac_address': '00A098A81B5D', 'name': 'wan0', 'ntp_config_method': 'disabled', 'ntp_servers': [], 'remote_ssh_access': False}]]
|
|
| netapp_storage_array
dictionary
|
success |
provides storage array identification, firmware version, and available capabilities
Sample:
[{'cacheBlockSizes': [4096, 8192, 16384, 32768], 'chassis_serial': '021540006043', 'firmware': '08.40.00.01', 'name': 'ict-2800-11_40', 'supportedSegSizes': [8192, 16384, 32768, 65536, 131072, 262144, 524288], 'wwn': '600A098000A81B5D0000000059D60C76'}]
|
|
| netapp_storage_pools
complex
|
success |
storage pool list that contains identification and capacity information for each pool
Sample:
[[{'available_capacity': '3490353782784', 'id': '04000000600A098000A81B5D000002B45A953A61', 'name': 'Raid6', 'total_capacity': '5399466745856', 'used_capacity': '1909112963072'}]]
|
|
| netapp_volumes
complex
|
success |
storage volume list that contains identification and capacity information for each volume
Sample:
[[{'capacity': '5368709120', 'id': '02000000600A098000AAC0C3000002C45A952BAA', 'is_thin_provisioned': False, 'name': '5G', 'parent_storage_pool_id': '04000000600A098000A81B5D000002B45A953A61'}]]
|
|
| netapp_volumes_by_initiators
complex
|
success |
list of available volumes keyed by the mapped initiators.
Sample:
[{'beegfs_host': [{'eui': '0000139A3885FA4500A0980000EAA272V', 'host_types': ['nvmeof'], 'id': '02000000600A098000A4B9D1000015FD5C8F7F9E', 'meta_data': {'filetype': 'ext4', 'public': True}, 'name': 'some_volume', 'volume_metadata': '{"format_type": "ext4", "format_options": "-i 2048 -I 512 -J size=400 -Odir_index,filetype", "mount_options": "noatime,nodiratime,nobarrier,_netdev", "mount_directory": "/data/beegfs/"}', 'workload_metadata': {'filetype': 'ext4', 'public': True}, 'workload_name': 'beegfs_metadata', 'wwn': '600A098000A4B9D1000015FD5C8F7F9E'}]}]
|
|
| netapp_workload_tags
complex
|
success |
workload tag list
Sample:
[[{'id': '87e19568-43fb-4d8d-99ea-2811daaa2b38', 'name': 'ftp_server', 'workloadAttributes': [{'key': 'use', 'value': 'general'}]}]]
|
|
| snapshot_images
complex
|
success |
snapshot image list that contains identification, capacity, and status information for each snapshot image
Sample:
[[{'active_cow': True, 'creation_method': 'user', 'id': '34000000600A098000A81B5D00630A965B0535AC', 'pit_capacity': '5368709120', 'reposity_cap_utilization': '0', 'rollback_source': False, 'status': 'optimal'}]]
|
|
Authors
- Kevin Hulquest (@hulquest)
- Nathan Swartz (@ndswartz)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netapp_eseries/santricity/na_santricity_facts_module.html