| 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/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? |
Note
---
- name: Get array facts
netapp_e_facts:
ssid: "{{ netapp_array_id }}"
api_url: "https://{{ netapp_e_api_host }}:8443/devmgr/v2"
api_username: "{{ netapp_api_username }}"
api_password: "{{ netapp_api_password }}"
validate_certs: "{{ netapp_api_validate_certs }}"
- name: Get array facts
netapp_e_facts:
ssid: 1
api_url: https://192.168.1.100:8443/devmgr/v2
api_username: myApiUser
api_password: myApiPass
validate_certs: true
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.'] | |
| 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 | 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 | 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 | 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: [[{'id': '8203800000000000000000000000000000000000', 'name': 'host1', 'group_id': '85000000600A098000A4B28D003610705C40B964', 'host_type_index': 28, 'ports': [{'type': 'fc', 'address': '1000FF7CFFFFFF01', 'label': 'FC_1'}, {'type': 'fc', 'address': '1000FF7CFFFFFF00', 'label': 'FC_2'}]}]] | |
| netapp_hostside_interfaces complex | 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 | 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 | provides storage array identification, firmware version, and available capabilities Sample: [{'chassis_serial': '021540006043', 'firmware': '08.40.00.01', 'name': 'ict-2800-11_40', 'wwn': '600A098000A81B5D0000000059D60C76', 'cacheBlockSizes': [4096, 8192, 16384, 32768], 'supportedSegSizes': [8192, 16384, 32768, 65536, 131072, 262144, 524288]}] | ||
| netapp_storage_pools complex | 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 | 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 | list of available volumes keyed by the mapped initiators. Sample: [{'192_168_1_1': [{'id': '02000000600A098000A4B9D1000015FD5C8F7F9E', 'meta_data': {'filetype': 'xfs', 'public': True}, 'name': 'some_volume', 'workload_name': 'test2_volumes', 'wwn': '600A098000A4B9D1000015FD5C8F7F9E'}]}] | ||
| netapp_workload_tags complex | workload tag list Sample: [[{'id': '87e19568-43fb-4d8d-99ea-2811daaa2b38', 'name': 'ftp_server', 'workloadAttributes': [{'key': 'use', 'value': 'general'}]}]] | ||
| snapshot_images complex | 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'}]] | ||
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/netapp_e_facts_module.html