netapp.elementsw.na_elementsw_info – NetApp Element Software Info¶
Note
This plugin is part of the netapp.elementsw collection (version 20.11.0).
To install it use: ansible-galaxy collection install netapp.elementsw
.
To use it in a playbook, specify: netapp.elementsw.na_elementsw_info
.
New in version 20.10.0: of netapp.elementsw
Synopsis¶
Collect cluster and node information.
Use a MVIP as hostname for cluster and node scope.
Use a MIP as hostname for node scope.
When using MIPs, cluster APIs are expected to fail with ‘xUnknownAPIMethod method=ListAccounts’
Requirements¶
The below requirements are needed on the host that executes this module.
The modules were developed with SolidFire 10.1
solidfire-sdk-python (1.1.0.92) or greater. Install using ‘pip install solidfire-sdk-python’
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
fail_on_error
boolean
|
|
by default, errors are not fatal when collecting a subset. The subset will show on error in the info output.
if set to True, the module fails on the first error.
|
fail_on_key_not_found
boolean
|
|
force an error when filter is used and a key is not present in records.
|
fail_on_record_not_found
boolean
|
|
force an error when filter is used and no record is matched.
|
filter
dictionary
|
When a list of records is returned, this can be used to limit the records to be returned.
If more than one key is used, all keys must match.
|
|
gather_subsets
list
/ elements=string
|
Default: ["all"]
|
list of subsets to gather from target cluster or node
supported values
node_config, cluster_accounts
additional values
all - for all subsets,
all_clusters - all subsets at cluster scope,
all_nodes - all subsets at node scope
aliases: gather_subset |
hostname
string
/ required
|
The hostname or IP address of the SolidFire cluster.
For na_elementsw_cluster, the Management IP (MIP) or hostname of the node to initiate the cluster creation from.
|
|
password
string
/ required
|
Password for the specified user.
aliases: pass |
|
username
string
/ required
|
Please ensure that the user has the adequate permissions. For more information, please read the official documentation https://mysupport.netapp.com/documentation/docweb/index.html?productID=62636&language=en-US.
aliases: user |
Notes¶
Note
The modules prefixed with na\_elementsw are built to support the SolidFire storage platform.
Examples¶
- name: get all available subsets
na_elementsw_info:
hostname: "{{ elementsw_mvip }}"
username: "{{ elementsw_username }}"
password: "{{ elementsw_password }}"
gather_subsets: all
register: result
- name: collect data for elementsw accounts using a filter
na_elementsw_info:
hostname: "{{ elementsw_mvip }}"
username: "{{ elementsw_username }}"
password: "{{ elementsw_password }}"
gather_subsets: 'cluster_accounts'
filter:
username: "{{ username_to_find }}"
register: result
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
NetApp Ansible Team (@carchi8py) <ng-ansibleteam@netapp.com>