info.rst

info -- Gathers information about PowerStore Storage entities

• Synopsis
• Requirements
• Parameters
• Notes
• Examples
• Return Values
• Status

Synopsis

Gathers the list of specified PowerStore Storage System entities, includes block/file provisioning modules, replication modules, configuration modules, and virtualization modules.

Block provisioning module includes volumes, volume groups, hosts, host groups, snapshot rules, and protection policies.

File provisioning module includes NAS servers, NFS exports, SMB shares, tree quotas, user quotas, file systems, file interface, SMB server, NFS server, file DNS, and file NIS.

Replication module includes replication rules, replication sessions, replication groups, and remote system.

Virtualization module includes vCenters and virtual volumes.

Configuration module includes cluster nodes, networks, roles, local users, appliances, discovered appliances, security configs, certificates.

Configureation modules also includes AD/LDAP servers, LDAP accounts, LDAP domain, and service configs.

It also includes DNS/NTP servers, smtp configs, email destinations, remote support, and remote support contacts.

Requirements

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

• A Dell PowerStore storage system version 3.0.0.0 or later.
• PyPowerStore 3.3.0.

Parameters

gather_subset (True, list, None)

A list of string variables which specify the PowerStore system entities requiring information.

Volumes - vol.

All the nodes - node.

Volume groups - vg.

Protection policies - protection_policy.

Hosts - host.

Host groups - hg.

Snapshot rules - snapshot_rule.

NAS servers - nas_server.

NFS exports - nfs_export.

SMB shares - smb_share.

Tree quotas - tree_quota.

User quotas - user_quota.

File systems - file_system.

Replication rules - replication_rule.

Replication sessions - replication_session.

Remote systems - remote_system.

Various networks - network.

Roles - role.

Local users - user.

Appliances - appliance.

Security configurations - security_config.

Certificates - certificate.

Active directories - ad.

LDAPs - ldap.

DNS servers - dns.

NTP servers - ntp.

Email notification destinations - email_notification.

SMTP configurations - smtp_config.

Remote Support - remote_support.

Remote support contacts - remote_support_contact.

LDAP accounts - ldap_account.

LDAP domain - ldap_domain.

All vCenters - vcenter.

Virtual volumes - virtual_volume.

Storage containers - storage_container.

Replication groups - replication_group.

Discovered appliances - discovered_appliance.

File interfaces - file_interface.

SMB servers - smb_server.

NFS servers - nfs_server.

File DNS - file_dns.

File NIS - file_nis.

Service configs - service_configs.

filters (optional, list, None)

A list of filters to support filtered output for storage entities.

Each filter is a list of filter_key, filter_operator, filter_value.

Supports passing of multiple filters.

filter_key (True, str, None)

Name identifier of the filter.

filter_operator (True, str, None)

Operation to be performed on the filter key.

filter_value (True, str, None)

Value of the filter key.

all_pages (optional, bool, False)

Indicates whether to return all available entities on the storage system.

If set to true, the Info module will implement pagination and return all entities. Otherwise, a maximum of the first 100 entities of any type will be returned.

array_ip (True, str, None)

IP or FQDN of the PowerStore management system.

validate_certs (optional, bool, True)

Boolean variable to specify whether to validate SSL certificate or not.

true - indicates that the SSL certificate should be verified. Set the environment variable REQUESTS_CA_BUNDLE to the path of the SSL certificate.

false - indicates that the SSL certificate should not be verified.

user (True, str, None)

The username of the PowerStore host.

password (True, str, None)

The password of the PowerStore host.

timeout (optional, int, 120)

Time after which the connection will get terminated.

It is to be mentioned in seconds.

port (optional, int, None)

Port number for the PowerStore array.

If not passed, it will take 443 as default.

Notes

Note

• Pagination is not supported for role, local user, security configs, LDAP accounts, discovered appliances and LDAP domain. If all_pages is passed, it will be ignored.
• The check_mode is supported.
• The modules present in this collection named as 'dellemc.powerstore' are built to support the Dell PowerStore storage platform.

Examples

- name: Get list of volumes, volume groups, hosts, host groups and node
  dellemc.powerstore.info:
    array_ip: "{{array_ip}}"
    validate_certs: "{{validate_certs}}"
    user: "{{user}}"
    password: "{{password}}"
    gather_subset:
      - vol
      - vg
      - host
      - hg
      - node

- name: Get list of replication related entities
  dellemc.powerstore.info:
    array_ip: "{{array_ip}}"
    validate_certs: "{{validate_certs}}"
    user: "{{user}}"
    password: "{{password}}"
    gather_subset:
      - replication_rule
      - replication_session
      - remote_system

- name: Get list of volumes whose state notequal to ready
  dellemc.powerstore.info:
    array_ip: "{{array_ip}}"
    validate_certs: "{{validate_certs}}"
    user: "{{user}}"
    password: "{{password}}"
    gather_subset:
      - vol
    filters:
      - filter_key: "state"
        filter_operator: "notequal"
        filter_value: "ready"

- name: Get list of protection policies and snapshot rules
  dellemc.powerstore.info:
    array_ip: "{{array_ip}}"
    validate_certs: "{{validate_certs}}"
    user: "{{user}}"
    password: "{{password}}"
    gather_subset:
      - protection_policy
      - snapshot_rule

- name: Get list of snapshot rules whose desired_retention between 101-499
  dellemc.powerstore.info:
    array_ip: "{{array_ip}}"
    validate_certs: "{{validate_certs}}"
    user: "{{user}}"
    password: "{{password}}"
    gather_subset:
      - snapshot_rule
    filters:
      - filter_key: "desired_retention"
        filter_operator: "greater"
        filter_value: "100"
      - filter_key: "desired_retention"
        filter_operator: "lesser"
        filter_value: "500"

- name: Get list of nas server, nfs_export and smb share
  dellemc.powerstore.info:
    array_ip: "{{array_ip}}"
    validate_certs: "{{validate_certs}}"
    user: "{{user}}"
    password: "{{password}}"
    gather_subset:
      - nas_server
      - nfs_export
      - smb_share

- name: Get list of tree quota, user quota and file system
  dellemc.powerstore.info:
    array_ip: "{{array_ip}}"
    validate_certs: "{{validate_certs}}"
    user: "{{user}}"
    password: "{{password}}"
    gather_subset:
      - tree_quota
      - user_quota
      - file_system

- name: Get list of nas server whose name equal to 'nas_server'
  dellemc.powerstore.info:
    array_ip: "{{array_ip}}"
    validate_certs: "{{validate_certs}}"
    user: "{{user}}"
    password: "{{password}}"
    gather_subset:
      - nas_server
    filters:
      - filter_key: "name"
        filter_operator: "equal"
        filter_value: "nas_server"

- name: Get list of smb share whose name contains 'share'
  dellemc.powerstore.info:
    array_ip: "{{array_ip}}"
    validate_certs: "{{validate_certs}}"
    user: "{{user}}"
    password: "{{password}}"
    gather_subset:
      - nas_server
    filters:
      - filter_key: "name"
        filter_operator: "like"
        filter_value: "*share*"

- name: Get list of user, role, network and appliances
  dellemc.powerstore.info:
    array_ip: "{{array_ip}}"
    validate_certs: "{{validate_certs}}"
    user: "{{user}}"
    password: "{{password}}"
    gather_subset:
      - user
      - role
      - network
      - appliance

- name: Get list of ad, certificate, security config and ldaps
  dellemc.powerstore.info:
    array_ip: "{{array_ip}}"
    validate_certs: "{{validate_certs}}"
    user: "{{user}}"
    password: "{{password}}"
    gather_subset:
      - ad
      - ldap
      - certificate
      - security_config

- name: Get list of networks whose name contains 'Management'
  dellemc.powerstore.info:
    array_ip: "{{array_ip}}"
    validate_certs: "{{validate_certs}}"
    user: "{{user}}"
    password: "{{password}}"
    gather_subset:
      - network
    filters:
      - filter_key: "name"
        filter_operator: "like"
        filter_value: "*Management*"

- name: Get list of dns, email notification, ntp, remote support, remote support contact and smtp config
  dellemc.powerstore.info:
    array_ip: "{{array_ip}}"
    validate_certs: "{{validate_certs}}"
    user: "{{user}}"
    password: "{{password}}"
    gather_subset:
      - dns
      - email_notification
      - ntp
      - remote_support
      - remote_support_contact
      - smtp_config

- name: Get list of emails which receives minor notifications
  dellemc.powerstore.info:
    array_ip: "{{array_ip}}"
    validate_certs: "{{validate_certs}}"
    user: "{{user}}"
    password: "{{password}}"
    gather_subset:
      - email_notification
    filters:
      - filter_key: 'notify_minor'
        filter_operator: 'equal'
        filter_value: 'false'

- name: Get list of LDAP accounts
  dellemc.powerstore.info:
    array_ip: "{{array_ip}}"
    validate_certs: "{{validate_certs}}"
    user: "{{user}}"
    password: "{{password}}"
    gather_subset:
      - ldap_account

- name: Get list of LDAP accounts with type as "User"
  dellemc.powerstore.info:
    array_ip: "{{array_ip}}"
    validate_certs: "{{validate_certs}}"
    user: "{{user}}"
    password: "{{password}}"
    gather_subset:
      - ldap_account
    filters:
      - filter_key: 'type'
        filter_operator: 'equal'
        filter_value: 'User'

- name: Get list of LDAP domain
  dellemc.powerstore.info:
    array_ip: "{{array_ip}}"
    validate_certs: "{{validate_certs}}"
    user: "{{user}}"
    password: "{{password}}"
    gather_subset:
      - ldap_domain

- name: Get list of LDAP domain with protocol as "LDAPS"
  dellemc.powerstore.info:
    array_ip: "{{array_ip}}"
    validate_certs: "{{validate_certs}}"
    user: "{{user}}"
    password: "{{password}}"
    gather_subset:
      - ldap_domain
    filters:
      - filter_key: 'protocol'
        filter_operator: 'equal'
        filter_value: 'LDAPS'

- name: Get list of vCenters
  dellemc.powerstore.info:
    array_ip: "{{array_ip}}"
    validate_certs: "{{validate_certs}}"
    user: "{{user}}"
    password: "{{password}}"
    gather_subset:
      - vcenter

- name: Get list of virtual volumes
  dellemc.powerstore.info:
    array_ip: "{{array_ip}}"
    validate_certs: "{{validate_certs}}"
    user: "{{user}}"
    password: "{{password}}"
    gather_subset:
      - virtual_volume
      - replication_group

- name: Get list of storage containers and discovered appliances
  dellemc.powerstore.info:
    array_ip: "{{array_ip}}"
    validate_certs: "{{validate_certs}}"
    user: "{{user}}"
    password: "{{password}}"
    gather_subset:
      - storage_container
      - discovered_appliance

- name: Get list of file interfaces, SMB servers, NFS servers, file DNS and file NIS
  dellemc.powerstore.info:
    array_ip: "{{array_ip}}"
    validate_certs: "{{validate_certs}}"
    user: "{{user}}"
    password: "{{password}}"
    gather_subset:
      - file_interface
      - smb_server
      - nfs_server
      - file_dns
      - file_nis

- name: Get list of service configs
  dellemc.powerstore.info:
    array_ip: "{{array_ip}}"
    validate_certs: "{{validate_certs}}"
    user: "{{user}}"
    password: "{{password}}"
    gather_subset:
      - service_config

Return Values

changed (always, bool, false)

Shows whether or not the resource has changed.

Array_Software_Version (always, str, 3.0.0.0)

API version of PowerStore array.

ActiveDirectory (When C(ad) is in a given I(gather_subset), list, [{'id': '60866158-5d00-3d7a-971b-5adabf42d82c'}])

Provides details of all active directories.

id (, str, )

ID of the active directory.

Appliance (When C(appliance) is in a given I(gather_subset), list, [{'id': 'A1', 'name': 'Appliance-WND8977', 'service_tag': 'A1', 'express_service_code': 'A1', 'model': 'PowerStore 1000T', 'node_count': 1, 'drive_failure_tolerance_level': 'None', 'is_hyper_converged': False, 'nodes': [], 'ip_pool_addresses': [], 'veth_ports': [], 'virtual_volumes': [], 'maintenance_windows': [], 'fc_ports': [], 'sas_ports': [], 'eth_ports': [], 'eth_be_ports': [], 'software_installed': [], 'hardware': [], 'volumes': []}])

Provides details of all appliances.

id (, str, )

ID of the appliance.

name (, str, )

Name of the appliance.

service_tag (, str, )

Dell service tag of the appliance.

express_service_code (, str, )

Express service code.

model (, str, )

Model type of the PowerStore.

node_count (, int, )

Number of nodes deployed on an appliance. It was added in version 3.0.0.0.

drive_failure_tolerance_level (, str, )

Drive failure tolerance level.

is_hyper_converged (, bool, )

Whether the appliance is a hyper-converged appliance. It was added in version 3.2.0.0.

nodes (, list, )

Provides details of all nodes.

ip_pool_addresses (, list, )

Provides details of all IP pool addresses.

veth_ports (, list, )

Provides details of all veth ports.

virtual_volumes (, list, )

Provides details of all virtual volumes.

maintenance_windows (, list, )

Provides details of all maintenance windows.

fc_ports (, list, )

Provides details of all FC ports.

sas_ports (, list, )

Provides details of all SAS ports.

eth_ports (, list, )

Provides details of all Ethernet ports.

eth_be_ports (, list, )

Provides details of all eth_be_ports. It was added in version 3.0.0.0.

software_installed (, list, )

Provides details of all software installed.

hardware (, list, )

Provides details of all hardware.

volumes (, list, )

Provides details of all volumes.

Certificate (When C(certificates) is in a given I(gather_subset), list, [{'id': 'e940144f-393f-4e9c-8f54-9a4d57b38c48'}])

Provides details of all certificates.

id (, str, )

ID of the certificate.

Cluster (always, list, [{'id': '0', 'name': 'RT-D1006'}])

Provides details of all clusters.

id (always, str, )

ID of the cluster.

name (always, str, )

Name of the cluster.

DiscoveredAppliances (When C(discovered_appliance) is in a given I(gather_subset), list, [{'id': 'A1', 'link_local_address': '1.0.2.x', 'service_name': 'Appliance-WND8977', 'service_tag': 'A8977', 'state': 'Unconfigured', 'mode': 'Unified', 'model': 'PowerStore 1000T', 'express_service_code': 'A8977', 'is_local': True, 'management_service_ready': True, 'software_version_compatibility': '3.0.0.0', 'build_version': '3.0.0.0', 'build_id': '3202', 'power_score': 0, 'node_count': 2, 'is_unified_capable': True, 'is_hyper_converged': False}])

Provides details of all discovered appliances.

id (, str, )

ID of a discovered appliance. The local discovered appliance has the id "0".

link_local_address (, str, )

Link local IPv4 address of the discovered appliance.

service_name (, str, )

Service name of the discovered appliance.

service_tag (, str, )

The Dell service tag.

state (, str, )

Possible unmanaged appliance states.

mode (, str, )

Storage access mode supported by the appliance.

model (, str, )

The model of the appliance.

express_service_code (, str, )

Express service code for the appliance.

is_local (, bool, )

Indicates whether appliance is local or not.

management_service_ready (, bool, )

Indicates whether the management services are ready.

software_version_compatibility (, str, )

Compatibility of the software version on an appliance compared to the software version on the appliance running the request.

build_version (, str, )

Build version of the installed software package release.

build_id (, str, )

Build ID.

power_score (, int, )

Power rating of the appliance.

node_count (, int, )

Number of nodes deployed on an appliance.

is_unified_capable (, bool, )

Indicates whether the appliance is capable of unified configuration.

drive_failure_tolerance_level_and_availability (, list, )

Drive failure tolerance level and availability.

is_hyper_converged (, bool, )

Indicates whether the appliance is a hyper converged or not. It was added in version 3.2.0.0.

DNS (When C(dns) is in a given I(gather_subset), list, [{'id': 'DNS1'}])

Provides details of all DNS servers.

id (always, str, )

ID of the DNS server.

EmailNotification (When C(email_notification) is in a given I(gather_subset), list, [{'email_address': 'abc', 'id': '9c3e5cba-17d5-4d64-b97c-350f91e2b714'}])

Provides details of all emails to which notifications will be sent.

id (always, str, )

ID of the email.

email_address (always, str, )

Email address.

FileDNS (When C(file_dns) is in a given I(gather_subset), list, [{'domain': 'NAS_domain', 'id': '65ab7e44-7009-e3e5-907a-62b767ad9845', 'ip_addresses': ['10.10.10.11'], 'is_destination_override_enabled': False, 'nas_server_id': '6581683c-61a3-76ab-f107-62b767ad9845', 'transport': 'UDP'}])

Provides details of all file DNS.

domain (, str, )

Name of the DNS domain.

id (, str, )

The unique identifier of the file DNS.

ip_addresses (, list, )

The addresses may be IPv4 or IPv6.

is_destination_override_enabled (, bool, )

Used in replication context when the user wants to override the settings on the destination.

nas_server_id (, str, )

Unique identifier of the NAS server.

transport (, str, )

Transport used when connecting to the DNS Server.

FileInterfaces (When C(file_interface) is in a given I(gather_subset), list, [{'gateway': '10.10.10.1', 'id': '65a50e0d-25f9-bd0a-8ca7-62b767ad9845', 'ip_address': '10.10.10.10', 'ip_port_id': 'IP_PORT2', 'is_destination_override_enabled': False, 'is_disabled': False, 'is_dr_test': False, 'name': 'PROD022_19c8adfb1d41_1d', 'nas_server_id': '6581683c-61a3-76ab-f107-62b767ad9845', 'prefix_length': 21, 'role': 'Production', 'source_parameters': 'None', 'vlan_id': 0}])

Provides details of all file interfaces.

gateway (, str, )

Gateway address for the network interface.

id (, str, )

The unique identifier of the file interface.

ip_address (, str, )

IP address of the network interface.

ip_port_id (, str, )

Unique Identifier of the IP Port that is associated with the file interface.

is_destination_override_enabled (, bool, )

Used in replication context when the user wants to override the settings on the destination.

is_disabled (, bool, )

Indicates whether the network interface is disabled.

name (, str, )

Name of the network interface. This property supports case-insensitive filtering.

nas_server_id (, str, )

Unique identifier of the NAS server.

prefix_length (, int, )

Prefix length for the interface.

role (, str, )

Role of the interface

vlan_id (, int, )

Virtual Local Area Network (VLAN) identifier for the interface.

FileNIS (When C(file_nis) is in a given I(gather_subset), list, [{'domain': 'NAS_domain', 'id': '65ab7e44-7009-e3e5-907a-62b767ad9845', 'ip_addresses': ['10.10.10.11'], 'is_destination_override_enabled': False, 'nas_server_id': '6581683c-61a3-76ab-f107-62b767ad9845'}])

Provides details of all file NIS.

domain (, str, )

Name of the NIS domain.

id (, str, )

The unique identifier of the file NIS.

ip_addresses (, list, )

The addresses may be IPv4 or IPv6.

is_destination_override_enabled (, bool, )

Used in replication context when the user wants to override the settings on the destination.

nas_server_id (, str, )

Unique identifier of the NAS server.

FileSystems (When C(file_system) is in a given I(gather_subset), list, [{'id': '61ef399b-f4c4-ccb6-1761-16c6ac7490fc', 'name': 'test_fs'}])

Provides details of all filesystems.

id (, str, )

ID of the filesystem.

name (, str, )

Name of the filesystem.

HostGroups (When C(hg) is in a given I(gather_subset), list, [{'id': 'f62b97b4-f262-417c-8dc9-39bec9024665', 'name': 'test_hg'}])

Provides details of all host groups.

id (, str, )

ID of the host group.

name (, str, )

Name of the host group.

Hosts (When C(host) is in a given I(gather_subset), list, [{'id': '42a0d739-20e6-49ec-afa6-65d2b3c006c8', 'name': 'test_host'}])

Provides details of all hosts.

id (, str, )

ID of the host.

name (, str, )

Name of the host.

LDAP (When C(ldap) is in a given I(gather_subset), list, [{'id': '60ba0edd-551a-64f1-ce49-8a83a5bce479'}])

Provides details of all LDAPs.

id (, str, )

ID of the LDAP.

LDAPAccounts (When C(ldap_account) is in a given I(gather_subset), list, [{'id': '5', 'role_id': '1', 'domain_id': '2', 'name': 'sample_ldap_user', 'type': 'User', 'type_l10n': 'User', 'dn': 'cn=sample_ldap_user,dc=ldap,dc=com'}])

Provides details of all LDAP accounts.

id (, str, )

ID of the LDAP account.

role_id (, int, )

Unique identifier of the role to which the LDAP account is mapped.

domain_id (, int, )

Unique identifier of the LDAP domain to which LDAP user or group belongs.

name (, str, )

Name of the LDAP account.

type (, str, )

Type of LDAP account.

dn (, str, )

Types of directory service protocol.

LDAPDomain (When C(ldap_domain) configuration is in a given I(gather_subset), list, [{'id': '9', 'domain_name': 'domain.com', 'port': 636, 'protocol': 'LDAPS', 'protocol_l10n': 'LDAPS', 'bind_user': 'cn=ldapadmin,dc=domain,dc=com', 'ldap_timeout': 300000, 'ldap_server_type': 'OpenLDAP', 'ldap_server_type_l10n': 'OpenLDAP', 'is_global_catalog': False, 'user_id_attribute': 'uid', 'user_object_class': 'inetOrgPerson', 'user_search_path': 'dc=domain,dc=com', 'group_name_attribute': 'cn', 'group_member_attribute': 'member', 'group_object_class': 'groupOfNames', 'group_search_path': 'dc=domain,dc=com', 'group_search_level': 0, 'ldap_servers': ['10.xxx.xx.xxx']}])

Provides details of the LDAP domain configurations.

id (, str, )

Unique identifier of the new LDAP server configuration.

domain_name (, str, )

Name of the LDAP authority to construct the LDAP server configuration.

ldap_servers (, list, )

List of IP addresses of the LDAP servers for the domain. IP addresses are in IPv4 format.

port (, int, )

Port number used to connect to the LDAP server(s).

ldap_server_type (, str, )

Types of LDAP server.

protocol (, str, )

Types of directory service protocol.

bind_user (, str, )

Distinguished Name (DN) of the user to be used when binding.

ldap_timeout (, int, )

Timeout for establishing a connection to an LDAP server. Default value is 30000 (30 seconds).

is_global_catalog (, bool, )

Whether or not the catalog is global. Default value is false.

user_id_attribute (, str, )

Name of the LDAP attribute whose value indicates the unique identifier of the user.

user_object_class (, str, )

LDAP object class for users.

user_search_path (, str, )

Path used to search for users on the directory server.

group_name_attribute (, str, )

Name of the LDAP attribute whose value indicates the group name.

group_member_attribute (, str, )

Name of the LDAP attribute whose value contains the names of group members within a group.

group_object_class (, str, )

LDAP object class for groups.

group_search_path (, str, )

Path used to search for groups on the directory server.

group_search_level (, int, )

Nested search level for performing group search.

ldap_server_type_l10n (, str, )

Localized message string corresponding to ldap_server_type.

protocol_l10n (, str, )

Localized message string corresponding to protocol.

LocalUsers (When C(user) is in a given I(gather_subset), list, [{'id': '1', 'name': 'admin'}])

Provides details of all local users.

id (, str, )

ID of the user.

name (, str, )

Name of the user.

NASServers (When C(nas_server) is in a given I(gather_subset), list, [{'id': '61e1c9bb-b791-550e-a785-16c6ac7490fc', 'name': 'test_nas'}])

Provides details of all nas servers.

id (, str, )

ID of the nas server.

name (, str, )

Name of the nas server.

Networks (When C(network) is in a given I(gather_subset), list, [{'id': 'NW1', 'name': 'Default Management Network'}])

Provides details of all networks.

id (, str, )

ID of the network.

name (, str, )

Name of the network.

NFSExports (When C(nfs_export) is in a given I(gather_subset), list, [{'id': '61ef39a0-09b3-5339-c8bb-16c6ac7490fc', 'name': 'test_nfs'}])

Provides details of all nfs exports.

id (, str, )

ID of the nfs export.

name (, str, )

Name of the nfs export.

NFSServers (When C(nfs_server) is in a given I(gather_subset), list, [{'credentials_cache_TTL': 120, 'host_name': 'sample_host_name', 'id': '65ad14fe-5f6e-beb3-424f-62b767ad9845', 'is_extended_credentials_enabled': True, 'is_joined': False, 'is_nfsv3_enabled': True, 'is_nfsv4_enabled': False, 'is_secure_enabled': False, 'is_use_smb_config_enabled': None, 'nas_server_id': '6581683c-61a3-76ab-f107-62b767ad9845', 'service_principal_name': None}])

Provides details of all nfs servers.

credentials_cache_TTL (, int, )

Sets the Time-To-Live (in minutes) expiration timestamp for a Windows entry in the credentials cache.

id (, str, )

The unique identifier of the NFS server.

host_name (, str, )

The name that will be used by NFS clients to connect to this NFS server.

is_extended_credentials_enabled (, bool, )

Indicates whether the NFS server supports more than 16 Unix groups in a Unix credential.

is_joined (, bool, )

Indicates whether the NFS server is joined to Active Directory.

is_nfsv3_enabled (, bool, )

Indicates whether NFSv3 is enabled on the NAS server.

is_nfsv4_enabled (, bool, )

Indicates whether NFSv4 is enabled on the NAS server.

nas_server_id (, str, )

Unique identifier of the NAS server.

is_secure_enabled (, bool, )

Indicates whether secure NFS is enabled on the NFS server.

is_use_smb_config_enabled (, bool, )

Indicates whether SMB authentication is used to authenticate to the KDC.

service_principal_name (, str, )

The Service Principal Name (SPN) for the NFS server.

Nodes (When a C(node) is in a given I(gather_subset), list, [{'id': 'N1', 'name': 'Appliance-RT-D1006-node-A'}])

Provides details of all nodes.

id (, str, )

ID of the node.

name (, str, )

Name of the node.

NTP (When C(ntp) is in a given I(gather_subset), list, [{'id': 'NTP1'}])

Provides details of all NTP servers.

id (always, str, )

ID of the NTP server.

ProtectionPolicies (When C(protection_policy) is in a given I(gather_subset), list, [{'id': '4eff379c-090c-48e0-9949-b2cd0ce2cf88', 'name': 'test_protection_policy'}])

Provides details of all protection policies.

id (, str, )

ID of the protection policy.

name (, str, )

Name of the protection policy.

RemoteSupport (When C(remote_support) is in a given I(gather_subset), list, [{'id': '0'}])

Provides details of all remote support config.

id (, str, )

ID of the remote support.

RemoteSupportContact (When C(remote_support_contact) is in a given I(gather_subset), list, [{'id': '0'}, {'id': '1'}])

Provides details of all remote support contacts.

id (, str, )

ID of the remote support contact.

ReplicationGroups (when C(replication_group) is in a given I(gather_subset)., list, [{'id': 'c4ba4ad3-2200-47d4-8f61-ddf51d83aac2', 'storage_container_id': '0b460d65-b8b6-40bf-8578-aa2e2fd3d02a', 'name': 'Ansible_RTD8337_VM', 'description': 'Ansible_RTD8337_VM', 'creator_type': 'User', 'creation_timestamp': '2024-05-16T13:58:09.348368+00:00', 'is_replication_destination': False, 'creator_type_l10n': 'User'}])

Provide details of all replication group.

id (, str, )

ID of the replication group.

name (, str, )

Name of the replication group.

storage_container_id (, str, )

ID of the storage container.

description (, str, )

Description of the replication group.

creator_type (, str, )

Creator type of the storage resource.

creation_timestamp (, str, )

Timestamp when given replication group was created.

is_replication_destination (, bool, )

Indicates whether replication group is replication destination or not.

creator_type_l10n (, str, )

Localized message string corresponding to creator_type.

ReplicationRules (When C(replication_rule) is in a given I(gather_subset), list, [{'id': '55d14477-de22-4d39-b24d-07cf08ba329f', 'name': 'ansible_rep_rule'}])

Provides details of all replication rules.

id (, str, )

ID of the replication rule.

name (, str, )

Name of the replication rule.

ReplicationSession (when C(replication_session) given in I(gather_subset), list, [{'id': '0b0a7ae9-c0c4-4dce-8c49-570f4ea80bb0'}])

Details of all replication sessions.

id (, str, )

ID of the replication session.

RemoteSystems (When C(remote_system) is in a given I(gather_subset), list, [{'id': 'f07be373-dafd-4a46-8b21-f7cf790c287f', 'name': 'WN-D8978'}])

Provides details of all remote systems.

id (, str, )

ID of the remote system.

name (, str, )

Name of the remote system.

Roles (When C(role is in a given I(gather_subset, list, [{'id': '1', 'name': 'Administrator'}, {'id': '2', 'name': 'Storage Administrator'}, {'id': '3', 'name': 'Operator'}, {'id': '4', 'name': 'VM Administrator'}, {'id': '5', 'name': 'Security Administrator'}, {'id': '6', 'name': 'Storage Operator'}])

Provides details of all roles.

id (, str, )

ID of the role.

name (, str, )

Name of the role.

SecurityConfig (When C(security_config) is in a given I(gather_subset), list, [{'id': '1'}])

Provides details of all security configs.

id (, str, )

ID of the security config.

ServiceConfigs (When C(service_config) is in a given I(gather_subset), list, [{'id': 'A1', 'appliance_id': 'A1', 'is_ssh_enabled': True}])

Provides details of all service configurations.

id (, str, )

ID of the service config.

appliance_id (, str, )

ID of the appliance.

is_ssh_enabled (, bool, )

Indicates whether ssh is enabled or not on the appliance.

SMBServers (When C(smb_server) is in a given I(gather_subset), list, [{'computer_name': None, 'description': 'string2', 'domain': None, 'id': '65ad211b-374b-5f77-2946-62b767ad9845', 'is_joined': False, 'is_standalone': True, 'nas_server_id': '6581683c-61a3-76ab-f107-62b767ad9845', 'netbios_name': 'STRING2', 'workgroup': 'STRING2'}])

Provides details of all SMB servers.

computer_name (, str, )

DNS name of the associated computer account when the SMB server is joined to an Active Directory domain.

id (, str, )

The unique identifier of the SMB server.

description (, str, )

Description of the SMB server.

domain (, str, )

Domain name where SMB server is registered in Active Directory, if applicable.

is_joined (, bool, )

Indicates whether the SMB server is joined to the Active Directory.

is_standalone (, bool, )

Indicates whether the SMB server is standalone.

netbios_name (, str, )

NetBIOS name is the network name of the standalone SMB server.

nas_server_id (, str, )

Unique identifier of the NAS server.

workgroup (, str, )

Windows network workgroup for the SMB server.

SMBShares (When C(smb_share) is in a given I(gather_subset), list, [{'id': '72ef39a0-09b3-5339-c8bb-16c6ac7490fc', 'name': 'test_smb'}])

Provides details of all smb shares.

id (, str, )

ID of the smb share.

name (, str, )

name of the smb share.

SMTPConfig (When C(smtp_config) is in a given I(gather_subset), list, [{'id': '0'}])

Provides details of all smtp config.

id (, str, )

ID of the smtp config.

SnapshotRules (When C(snapshot_rule) is in a given I(gather_subset), list, [{'id': 'e1b1bc3e-f8a1-4c81-a143-9ffd6af55837', 'name': 'Snapshot Rule Test'}])

Provides details of all snapshot rules.

id (, str, )

ID of the snapshot rule.

name (, str, )

Name of the snapshot rule.

StorageContainers (When C(storage_container) is in a given I(gather_subset), list, [{'datastores': [], 'destinations': [], 'id': 'e0ccd953-5650-41d8-9bce-f36d876d6a2a', 'name': 'Ansible_storage_container_1', 'quota': 21474836480, 'replication_groups': [], 'storage_protocol': 'NVMe', 'storage_protocol_l10n': 'NVMe', 'virtual_volumes': []}])

Provide details of all storage containers.

id (, str, )

ID of the storage container.

name (, str, )

Name of the storage container.

storage_protocol (, str, )

The type of storage container.

quota (, int, )

The total number of bytes that can be provisioned/reserved against this storage container.

replication_groups (, list, )

Properties of a Replication Group.

id (, str, )

Unique identifier of the Replication Group instance.

name (, str, )

Name of the Replication Group.

virtual_volumes (, list, )

The virtual volumes associated to the storage container.

id (, str, )

The unique identifier of the virtual volume.

name (, str, )

The name of the virtual volume.

destinations (, list, )

A storage container destination defines replication destination for a local storage container on a remote system.

id (, str, )

The unique id of the storage container destination.

remote_system_id (, str, )

The unique id of the remote system.

remote_system_name (, str, )

The name of the remote system.

remote_storage_container_id (, str, )

The unique id of the destination storage container on the remote system.

datastores (, list, )

List of associated datastores.

id (, str, )

Unique identifier of the datastore instance.

name (, str, )

User-assigned name of the datastore in vCenter.

VolumeGroups (When C(vg) is in a given I(gather_subset), list, [{'id': 'faaa8370-c62e-4fa2-b8ca-7f54419a5b40', 'name': 'Volume Group Test'}])

Provides details of all volume groups.

id (, str, )

ID of the volume group.

name (, str, )

Name of the volume group.

Volumes (When C(vol) is in a given I(gather_subset), list, [{'id': '01854336-94ef-4df9-b1e7-0a729ca7c944', 'name': 'test_vol'}])

Provides details of all volumes.

id (, str, )

ID of the volume.

name (, str, )

Name of the volume.

TreeQuotas (When C(tree_quota) is in a given I(gather_subset), list, [{'id': '00000003-0fe0-0001-0000-0000e8030000'}])

Provides details of all tree quotas.

id (, str, )

ID of the tree quota.

path (, str, )

Path of the tree quota.

UserQuotas (When C(user_quota) is in a given I(gather_subset), list, [{'id': '00000003-0708-0000-0000-000004000080'}])

Provides details of all user quotas.

id (, str, )

ID of the user quota.

vCenter (When C(vCenter) is in a given I(gather_subset), list, [{'id': '0d330d6c-3fe6-41c6-8023-5bd3fa7c61cd', 'instance_uuid': '0d330d6c-3fe6-41c6-8023-5bd3fa7c61cd', 'address': '10.x.x.x', 'username': 'administrator', 'version': '7.0.3', 'vendor_provider_status': 'Online', 'vendor_provider_status_l10n': 'Online', 'virtual_machines': [], 'datastores': [], 'vsphere_hosts': []}])

Provide details of all vCenters.

id (, str, )

Unique identifier of vCenter.

instance_uuid (, str, )

UUID instance of vCenter.

address (, str, )

IP address of vCenter host, in IPv4, IPv6 or hostname format.

username (, str, )

Username to login to vCenter.

version (, str, )

Version of vCenter including its build number. Was added in PowerStore version 3.0.0.0.

vendor_provider_status (, str, )

General status of the VASA vendor provider in vCenter.

vendor_provider_status_l10n (, str, )

Localized message string corresponding to vendor_provider_status.

virtual_machines (, list, )

Virtual Machine associated with vCenter.

datastores (, list, )

Datastores that exists on a specific vCenter. Was added in PowerStore version 3.0.0.0.

vsphere_hosts (, list, )

All vSphere hosts that exists on a specific vCenter. Was added in PowerStore version 3.0.0.0.

VirtualVolume (When C(virtual_volume) is in a given I(gather_subset), list, [{'id': '85643b54-9429-49ee-b7c3-b061fcdaab7c', 'name': 'test-centos_2.vmdk', 'size': 17179869184, 'type': 'Primary', 'usage_type': 'Data', 'appliance_id': 'A1', 'storage_container_id': '4dff1460-4d1e-48b6-98d8-cae8d7bf63b5', 'io_priority': 'Medium', 'profile_id': 'f4e5bade-15a2-4805-bf8e-52318c4ce443', 'replication_group_id': None, 'creator_type': 'User', 'is_readonly': False, 'migration_session_id': None, 'virtual_machine_uuid': '503629e5-8677-b26f-bf2d-e9f639bcc77f', 'family_id': '9ce8d828-14e3-44f8-bde1-a97f440a7259', 'parent_id': None, 'source_id': None, 'source_timestamp': None, 'creation_timestamp': '2022-12-27T10:01:32.622+00:00', 'naa_name': 'naa.68ccf09800918d7f008769d29bc6a43a', 'is_replication_destination': False, 'location_history': None, 'protection_policy_id': None, 'nsid': 5114, 'nguid': 'nguid.918d7f008769d29b8ccf096800c6a43a', 'type_l10n': 'Primary', 'usage_type_l10n': 'Data', 'io_priority_l10n': 'Medium', 'creator_type_l10n': 'User', 'host_virtual_volume_mappings': []}])

Provides details of all virtual volumes.

id (, str, )

The unique identifier of the virtual volume.

name (, str, )

The name of the virtual volume, based on metadata provided by vSphere.

size (, int, )

The size of the virtual volume in bytes.

type (, str, )

The logical type of a virtual volume.

usage_type (, str, )

VMware's usage of the vVol.

appliance_id (, str, )

The appliance where the virtual volume resides.

storage_container_id (, str, )

The storage container where the virtual volume resides.

io_priority (, str, )

The I/O priority for quality of service rules.

profile_id (, str, )

The ID of the storage profile governing this virtual volume.

replication_group_id (, str, )

The unique identifier of the replication group object that this virtual volume belongs to.

creator_type (, str, )

Creator type of the storage resource.

User - A resource created by a user.

System - A resource created by the replication engine.

Scheduler - A resource created by the snapshot scheduler.

is_readonly (, bool, )

Indicates whether the virtual volume is read-only.

migration_session_id (, str, )

If the virtual volume is part of a migration activity, the session ID for that migration.

virtual_machine_uuid (, str, )

UUID of the virtual machine that owns this virtual volume.

family_id (, str, )

Family id of the virtual volume.

parent_id (, str, )

For snapshots and clones, the ID of the parent virtual volume.

source_id (, str, )

Id of the virtual volume from which the content has been sourced.

source_timestamp (, str, )

The source data time-stamp of the virtual volume.

creation_timestamp (, str, )

Timestamp of the moment virtual volume was created at.

naa_name (, str, )

The NAA name used by hosts for I/O.

is_replication_destination (, bool, )

Indicates whether virtual volume is replication destination or not.

location_history (, complex, )

Storage resource location history.

from_appliance_id (, str, )

Unique identifier of the appliance from which the volume was relocated.

to_appliance_id (, str, )

Unique identifier of the appliance to which the volume was relocated.

reason (, str, )

Reason for storage resource relocation.

Initial - Initial placement.

Manual - Manual migration operation initiated by user.

Recommended - Storage system recommended migration.

migrated_on (, str, )

Time when the storage resource location changed.

reason_l10n (, str, )

Localized message string corresponding to reason.

protection_policy_id (, str, )

The unique identifier of the protection policy applied to this virtual volume.

nsid (, str, )

NVMe Namespace unique identifier in the NVMe subsystem.

nguid (, str, )

NVMe Namespace globally unique identifier.

type_l10n (, str, )

Localized message string corresponding to type.

usage_type_l10n (, str, )

Localized message string corresponding to usage_type.

io_priority_l10n (, str, )

Localized message string corresponding to io_priority.

creator_type_l10n (, str, )

Localized message string corresponding to creator_type.

host_virtual_volume_mappings (, complex, )

Virtual volume mapping details.

id (, str, )

Unique identifier of a mapping between a host and a virtual volume.

host_id (, str, )

Unique identifier of a host attached to a virtual volume.

host_group_id (, str, )

Unique identifier of a host group attached to a virtual volume.

virtual_volume_id (, str, )

Unique identifier of the virtual volume to which the host is attached.

Status

Authors

• Arindam Datta (@dattaarindam) <[email protected]>
• Vivek Soni (@v-soni11) <[email protected]>
• Akash Shendge (@shenda1) <[email protected]>
• Bhavneet Sharma (@sharmb5) <[email protected]>
• Trisha Datta (@trisha-dell) <[email protected]>