dellemc.powerscale.info (3.0.0) — module

Gathering information about PowerScale Storage

| "added in version" 1.2.0 of dellemc.powerscale"

Authors: Ambuj Dubey (@AmbujDube) <ansible.team@dell.com>, Spandita Panigrahi(@panigs7) <ansible.team@dell.com>, Pavan Mudunuri(@Pavan-Mudunuri) <ansible.team@dell.com>, Ananthu S Kuttattu(@kuttattz) <ansible.team@dell.com>, Bhavneet Sharma(@Bhavneet-Sharma) <ansible.team@dell.com>, Trisha Datta(@trisha-dell) <ansible.team@dell.com>, Meenakshi Dembi(@dembim) <ansible.team.dell.com>, Sachin Apagundi(@sachin-apa) <ansible.team.dell.com>

Install collection

Install with ansible-galaxy collection install dellemc.powerscale:==3.0.0


Add to requirements.yml

  collections:
    - name: dellemc.powerscale
      version: 3.0.0

Description

Gathering information about Specified PowerScale Storage entities, includes attributes, access zones, nodes, authentication providers for all access zones, users and groups for an access zone.

Get list of smb_shares, nfs_exports, nfs_aliases, active clients, SyncIQ reports, SyncIQ target reports, SyncIQ target cluster certificates, SyncIQ policies, SyncIQ performance rules.

Get list of network groupnets, network pools for all access zones or a specific access zone, network rules, network subnets, network interfaces, node pools, storage pool tiers, smb open files, s3 buckets, ntp_servers.

Get list of user mapping rules, ldap providers of the PowerScale cluster.

Get NFS zone settings details of the PowerScale cluster.

Get NFS default settings details of the PowerScale cluster.

Get NFS global settings details of the PowerScale cluster.

Get SyncIQ global settings details of the PowerScale cluster.

Get SMB Global Settings details of the PowerScale cluster.

Get cluster owner, cluster identity and email settings details of the PowerScale cluster.

Get SNMP settings details of the PowerScale cluster.

Retrieve a list of server certificate details.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get attributes of the PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{onefs_host}}"
    port_no: "{{powerscaleport}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    gather_subset:
      - attributes
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get access_zones of the PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{onefs_host}}"
    port_no: "{{powerscaleport}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    gather_subset:
      - access_zones
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get nodes of the PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{onefs_host}}"
    port_no: "{{powerscaleport}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    gather_subset:
      - nodes
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get list of authentication providers for all access zones of the PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{onefs_host}}"
    port_no: "{{powerscaleport}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    gather_subset:
      - providers
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get list of users for an access zone of the PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{onefs_host}}"
    port_no: "{{powerscaleport}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    access_zone: "{{access_zone}}"
    gather_subset:
      - users
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get list of groups for an access zone of the PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{onefs_host}}"
    port_no: "{{powerscaleport}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    access_zone: "{{access_zone}}"
    gather_subset:
      - groups
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get list of smb shares in the PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{onefs_host}}"
    port_no: "{{powerscaleport}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    access_zone: "{{access_zone}}"
    gather_subset:
      - smb_shares
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get list of nfs exports in the PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{onefs_host}}"
    port_no: "{{powerscaleport}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    access_zone: "{{access_zone}}"
    gather_subset:
      - nfs_exports
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get list of nfs aliases in the PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{onefs_host}}"
    port_no: "{{powerscaleport}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    access_zone: "{{access_zone}}"
    gather_subset:
      - nfs_aliases
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get list of clients in the PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{onefs_host}}"
    port_no: "{{powerscaleport}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    gather_subset:
      - clients
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get list of SyncIQ reports and SyncIQ target Reports in the PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{onefs_host}}"
    port_no: "{{powerscaleport}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    gather_subset:
      - synciq_reports
      - synciq_target_reports
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get list of SyncIQ policies in the PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{onefs_host}}"
    port_no: "{{powerscaleport}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    gather_subset:
      - synciq_policies
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get list of SyncIQ target cluster certificates in the PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{onefs_host}}"
    port_no: "{{powerscaleport}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    gather_subset:
      - synciq_target_cluster_certificates
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get list of SyncIQ performance rules in the PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{onefs_host}}"
    port_no: "{{powerscaleport}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    gather_subset:
      - synciq_performance_rules
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get list of network groupnets of the PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{onefs_host}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    gather_subset:
      - network_groupnets
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get list of network pools of the PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{onefs_host}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    gather_subset:
      - network_pools
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get list of network pools for all access zones of the PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{onefs_host}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    include_all_access_zones: true
    gather_subset:
      - network_pools
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get list of network rules of the PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{onefs_host}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    gather_subset:
      - network_rules
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get list of network interfaces of the PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{onefs_host}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    gather_subset:
      - network_interfaces
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get list of network subnets of the PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{onefs_host}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    gather_subset:
      - network_subnets
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get list of node pools of the PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{onefs_host}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    gather_subset:
      - node_pools
  register: subset_result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get list of storage pool tiers of the PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{onefs_host}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    gather_subset:
      - storagepool_tiers
  register: subset_result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get list of smb open files of the PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{onefs_host}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    gather_subset:
      - smb_files
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get list of user mapping rule of the PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{onefs_host}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    gather_subset:
      - user_mapping_rules
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get list of ldap providers of the PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{onefs_host}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    gather_subset:
      - ldap
    scope: "effective"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get the NFS zone settings of the PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{onefs_host}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    gather_subset:
      - nfs_zone_settings
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get the NFS default settings of the PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{onefs_host}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    gather_subset:
      - nfs_default_settings
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get the NFS global settings of the PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{onefs_host}}"
    verify_ssl: "{{verify_ssl}}"
    api_user: "{{api_user}}"
    api_password: "{{api_password}}"
    gather_subset:
      - nfs_global_settings
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get SyncIQ global settings details of the PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{ onefs_host }}"
    verify_ssl: "{{ verify_ssl }}"
    api_user: "{{ api_user }}"
    api_password: "{{ api_password }}"
    gather_subset:
      - synciq_global_settings
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get S3 bucket list for the PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{ onefs_host }}"
    verify_ssl: "{{ verify_ssl }}"
    api_user: "{{ api_user }}"
    api_password: "{{ api_password }}"
    gather_subset:
      - s3_buckets
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get SMB global settings from PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{ onefs_host }}"
    verify_ssl: "{{ verify_ssl }}"
    api_user: "{{ api_user }}"
    api_password: "{{ api_password }}"
    gather_subset:
      - smb_global_settings
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get the list of server certificate.
  dellemc.powerscale.info:
    onefs_host: "{{ onefs_host }}"
    verify_ssl: "{{ verify_ssl }}"
    api_user: "{{ api_user }}"
    api_password: "{{ api_password }}"
    gather_subset:
      - server_certificate
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get NTP servers from PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{ onefs_host }}"
    verify_ssl: "{{ verify_ssl }}"
    api_user: "{{ api_user }}"
    api_password: "{{ api_password }}"
    gather_subset:
      - ntp_servers
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get SNMP settings from PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{ onefs_host }}"
    verify_ssl: "{{ verify_ssl }}"
    api_user: "{{ api_user }}"
    api_password: "{{ api_password }}"
    gather_subset:
      - snmp_settings
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get email settings details from PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{ onefs_host }}"
    verify_ssl: "{{ verify_ssl }}"
    api_user: "{{ api_user }}"
    api_password: "{{ api_password }}"
    gather_subset:
      - email_settings
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get cluster identity details from PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{ onefs_host }}"
    verify_ssl: "{{ verify_ssl }}"
    api_user: "{{ api_user }}"
    api_password: "{{ api_password }}"
    gather_subset:
      - cluster_identity
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get cluster owner details from PowerScale cluster
  dellemc.powerscale.info:
    onefs_host: "{{ onefs_host }}"
    verify_ssl: "{{ verify_ssl }}"
    api_user: "{{ api_user }}"
    api_password: "{{ api_password }}"
    gather_subset:
      - cluster_owner

Inputs

    
scope:
    choices:
    - effective
    - user
    - default
    default: effective
    description:
    - The scope of ldap. If no scope is specified, the C(effective) scope would be taken
      by default.
    - If specified as C(effective) or not specified, all fields are returned.
    - If specified as C(user), only fields with non-default values are shown.
    - If specified as C(default), the original values are returned.
    type: str

port_no:
    default: '8080'
    description:
    - Port number of the PowerScale cluster.It defaults to 8080 if not specified.
    required: false
    type: str

api_user:
    description:
    - username of the PowerScale cluster.
    required: true
    type: str

onefs_host:
    description:
    - IP address or FQDN of the PowerScale cluster.
    required: true
    type: str

verify_ssl:
    choices:
    - true
    - false
    description:
    - boolean variable to specify whether to validate SSL certificate or not.
    - C(true) - indicates that the SSL certificate should be verified.
    - C(false) - indicates that the SSL certificate should not be verified.
    required: true
    type: bool

access_zone:
    default: System
    description:
    - The access zone. If no Access Zone is specified, the 'System' access zone would
      be taken by default.
    type: str

api_password:
    description:
    - the password of the PowerScale cluster.
    required: true
    type: str

gather_subset:
    choices:
    - attributes
    - access_zones
    - nodes
    - providers
    - users
    - groups
    - smb_shares
    - nfs_exports
    - nfs_aliases
    - clients
    - synciq_reports
    - synciq_target_reports
    - synciq_policies
    - synciq_target_cluster_certificates
    - synciq_performance_rules
    - network_groupnets
    - network_subnets
    - network_pools
    - network_rules
    - network_interfaces
    - node_pools
    - storagepool_tiers
    - smb_files
    - user_mapping_rules
    - ldap
    - nfs_zone_settings
    - nfs_default_settings
    - nfs_global_settings
    - synciq_global_settings
    - s3_buckets
    - smb_global_settings
    - ntp_servers
    - email_settings
    - cluster_identity
    - cluster_owner
    - snmp_settings
    - server_certificate
    description:
    - List of string variables to specify the PowerScale Storage System entities for which
      information is required.
    - List of all PowerScale Storage System entities supported by the module.
    - Attributes - C(attributes).
    - Access zones - C(access_zones).
    - Nodes - C(nodes).
    - Providers - C(providers).
    - Users - C(users).
    - Groups - C(groups).
    - Smb shares - C(smb_shares).
    - Nfs exports - C(nfs_exports).
    - Nfs aliases - C(nfs_aliases).
    - Clients - C(clients).
    - Synciq reports - C(synciq_reports).
    - Synciq target reports - C(synciq_target_reports).
    - Synciq policies - C(synciq_policies).
    - Synciq target cluster certificates - C(synciq_target_cluster_certificates).
    - Synciq performance rules - C(synciq_performance_rules).
    - Network groupnets - C(network_groupnets).
    - Network pools - C(network_pools).
    - Network rules - C(network_rules).
    - Network interfaces - C(network_interfaces).
    - Network subnets - C(network_subnets).
    - Node pools - C(node_pools).
    - Storagepool tiers - C(storagepool_tiers).
    - SMB files - C(smb_files).
    - User mapping rules - C(user_mapping_rules).
    - LDAPs - C(ldap).
    - NFS zone settings - C(nfs_zone_settings).
    - NFS default settings - C(nfs_default_settings).
    - SyncIQ global settings - C(synciq_global_settings).
    - S3 buckets - C(s3_buckets).
    - The list of I(attributes), I(access_zones) and I(nodes) is for the entire PowerScale
      cluster.
    - The list of providers for the entire PowerScale cluster.
    - The list of users and groups is specific to the specified access zone.
    - The list of syncIQ reports and syncIQ target reports for the entire PowerScale cluster.
    - The list of syncIQ policies, syncIQ target cluster certificates and syncIQ performance
      rules for the entire PowerScale cluster.
    - The list of network pools is specific to the specified access zone or for all access
      zones.
    - The list of network groupnets, network subnets, network rules and network interfaces
      is for the entire PowerScale cluster.
    - The list of smb open files for the entire PowerScale cluster.
    - The list of user mapping rules of PowerScale cluster.
    - The list of ldap providers of PowerScale cluster.
    - SMB global settings - C(smb_global_settings).
    - NTP servers C(ntp_servers)
    - Email settings C(email_settings)
    - Cluster identity C(cluster_identity)
    - Cluster owner C(cluster_owner)
    - SNMP settings - C(snmp_settings).
    - Server certificate - C(server_certificate).
    elements: str
    required: true
    type: list

include_all_access_zones:
    description:
    - Specifies if requested component details need to be fetched from all access zones.
    - It is mutually exclusive with I(access_zone).
    type: bool

Outputs

AccessZones:
  contains:
    zones:
      description: List of different access zone.
      type: list
  description: Access zones of  the PowerScale storage system.
  returned: When C(access_zones) is in a given I(gather_subset)
  sample:
  - zones:
    - alternate_system_provider: lsa-file-provider:MinimumRequired
      auth_providers:
      - lsa-local-provider:sampe-az
      cache_entry_expiry: 14400
      groupnet: groupnet0
      home_directory_umask: 63
      id: Bhavneet-SS
      ifs_restricted: []
      name: Bhavneet-SS
      negative_cache_entry_expiry: 60
      netbios_name: ''
      path: /ifs
      skeleton_directory: /usr/share/skel
      system: false
      system_provider: lsa-file-provider:System
      user_mapping_rules: []
      zone_id: 18
  type: dict
Attributes:
  contains:
    Cluster_Version:
      description: Cluster version of the PowerScale storage system.
      type: dict
    Config:
      description: Config details of the PowerScale storage system.
      type: dict
    Contact_Info:
      description: Contact details of the PowerScale storage system.
      type: dict
    External_IP:
      description: External IPs of the PowerScale storage system.
      type: dict
    Logon_msg:
      description: Log-on messages of the PowerScale storage system.
      type: dict
  description: Different Attributes of the PowerScale storage system.
  returned: When C(attributes) is in a given I(gather_subset)
  sample:
    Cluster_Version:
      errors: []
      nodes:
      - build: B_9_5_0_005(RELEASE)
        id: 1
        release: x.x.0.0
        revision: '124'
        type: Isilon OneFS
        version: Isilon OneFS x.x.0.0
      total: 3
    Config:
      description: ''
      devices:
      - devid: 1
        guid: 000e1e84be90ac5e7d62df0dfc180d3d0ccb
        is_up: true
        lnn: 1
      encoding: utf-8
      guid: 000e1e84be902f5f7d62ef254853667f0792
      has_quorum: true
      is_compliance: false
      is_virtual: false
      is_vonefs: false
      join_mode: Manual
      local_devid: 1
      local_lnn: 1
      local_serial: xxxx-xxxx-xxxxx
      name: LAB-IsilonS-xxxxx
      onefs_version:
        build: B_x_x_0_005(RELEASE)
        copyright: Copyright (c) 2001-2022 Dell Inc. All Rights Reserved.
        reldate: xxxx
        release: x.x.0.0
        revision: '649926064822288389'
        type: Isilon OneFS
        version: Isilon OneFS x.x.0.0
      timezone:
        abbreviation: GMT
        custom: ''
        name: Greenwich Mean Time
        path: GMT
      upgrade_type: null
    Contact_Info: {}
    External_IP: {}
    Logon_msg: {}
  type: dict
Clients:
  contains:
    local_address:
      description: Local address of the client.
      type: str
    local_name:
      description: Local name of the client.
      type: str
    node:
      description: Node on which client exists.
      type: int
    protocol:
      description: Protocol that client uses.
      type: str
    remote_address:
      description: Remote address of the client.
      type: str
    remote_name:
      description: Remote address of the client.
      type: str
  description: List all clients present in the PowerScale system.
  returned: When C(clients) is in a given I(gather_subset)
  sample:
  - local_address: x.x.x.x
    local_name: x.x.x.x
    node: 1
    protocol: nfs4
    remote_address: x.x.x.x
    remote_name: x.x.x.x
  type: list
Groups:
  contains:
    groups:
      contains:
        id:
          description: ID of the groups.
          type: str
        name:
          description: Name of the groups.
          type: str
        provider:
          description: The provider of the groups.
          type: str
      description: List of groups details.
      type: list
  description: List of all groups.
  returned: When C(groups) is in a given I(gather_subset)
  sample:
  - groups:
    - dn: CN=Administrators,CN=Builtin,DC=PIE-ISILONS-xxx
      dns_domain: null
      domain: BUILTIN
      generated_gid: false
      gid:
        id: GID:1544
        name: null
        type: null
      id: Administrators
      member_of: null
      name: Administrators
      object_history: []
      provider: lsa-local-provider:System
      sam_account_name: Administrators
      sid:
        id: SID:S-1-5-32-544
        name: null
        type: null
      type: group
  type: list
LdapProviders:
  contains:
    base_dn:
      description: Specifies the root of the tree in which to search identities.
      type: str
    bind_dn:
      description: Specifies the distinguished name for binding to the LDAP server.
      type: str
    groupnet:
      description: Groupnet identifier.
      type: str
    linked_access_zones:
      description: List of access zones linked to the authentication provider.
      type: list
    name:
      description: Specifies the name of the LDAP provider.
      type: str
    server_uris:
      description: Specifies the server URIs.
      type: str
    status:
      description: Specifies the status of the provider.
      type: str
  description: Provide details of LDAP providers.
  returned: When C(ldap) is in a given I(gather_subset)
  sample:
  - base_dn: dc=sample,dc=ldap,dc=domain,dc=com
    bind_dn: cn=administrator,dc=sample,dc=ldap,dc=domain,dc=com
    groupnet: groupnet
    linked_access_zones:
    - System
    name: sample-ldap
    server_uris: ldap://xx.xx.xx.xx
    status: online
  type: list
NetworkGroupnets:
  contains:
    id:
      description: ID of the groupnet.
      type: str
    name:
      description: Name of the groupnet.
      type: str
  description: List of Network Groupnets.
  returned: When C(network_groupnets) is in a given I(gather_subset)
  sample:
  - id: sample
    name: groupnet0
  type: list
NetworkInterfaces:
  contains:
    flags:
      description: List of interface flags.
      type: list
    id:
      description: ID of the interface.
      type: str
    ip_addrs:
      description: List of IP addresses.
      type: list
    ipv4_gateway:
      description: Address of the default IPv4 gateway.
      type: str
    ipv6_gateway:
      description: Address of the default IPv6 gateway.
      type: str
    lnn:
      description: Interface's lnn.
      type: int
    mtu:
      description: The mtu the interface.
      type: int
    name:
      description: Name of the interface.
      type: str
    nic_name:
      description: NIC name.
      type: str
    owners:
      description: List of owners.
      type: list
    speed:
      description: Interface's speed.
      type: int
    status:
      description: Status of the interface.
      type: str
    type:
      description: Type of the interface.
      type: str
    vlans:
      description: List of VLANs.
      type: list
  description: List of Network interfaces.
  returned: When C(network_interfaces) is in a given I(gather_subset)
  sample:
  - flags: []
    id: 3:ext-agg
    ip_addrs: []
    ipv4_gateway: null
    ipv6_gateway: null
    lnn: 3
    mtu: 0
    name: ext-agg
    nic_name: lagg0
    owners: []
    speed: null
    status: inactive
    type: aggregated
    vlans: []
  type: list
NetworkPools:
  contains:
    id:
      description: ID of the Network Pool.
      type: str
    name:
      description: Name of the Network Pool.
      type: str
  description: List of Network Pools.
  returned: When C(network_pools) is in a given I(gather_subset)
  sample:
  - id: groupnet0.subnet0.pool0
    name: pool0
  type: list
NetworkRules:
  contains:
    id:
      description: Name of the Network Pool.
      type: str
    name:
      description: Name of the Network Pool.
      type: str
  description: List of the Network rules.
  returned: When C(network_rules) is in a given I(gather_subset)
  sample:
  - id: groupnet0.subnet0.pool0.test_rule
    name: test_rule
  type: list
NetworkSubnets:
  contains:
    id:
      description: Name of the Network Pool.
      type: str
    name:
      description: Name of the Network Pool.
      type: str
  description: List of the Network subnets.
  returned: When C(network_subnets) is in a given I(gather_subset)
  sample:
  - id: groupnet0.subnet0.pool0.test_rule
    name: test_rule
  type: list
NfsAliases:
  contains:
    health:
      description: Specifies the health of the NFS alias.
      type: str
    id:
      description: ID of the NFS alias.
      type: str
    name:
      description: Name of the NFS alias.
      type: str
    path:
      description: Path of the NFS alias.
      type: str
    zone:
      description: Access zone of the NFS alias.
      type: str
  description: List of NFS Aliases.
  returned: When C(nfs_aliases) is in a given I(gather_subset)
  sample:
  - health: path not found
    id: /ifs_#$%^&*()
    name: /ifs_#$%^&*()
    path: /ifs/sample_alias_1
    zone: System
  type: list
NfsExports:
  contains:
    id:
      description: ID of the NFS exports.
      type: str
    path:
      description: Path of the NFS exports.
      type: list
  description: List of NFS exports.
  returned: When C(nfs_exports) is in a given I(gather_subset)
  sample:
  - id: 205
    paths:
    - /ifs/data/sample/fs1
  type: list
NfsGlobalSettings:
  contains:
    nfsv3_enabled:
      description: Whether NFSv3 protocol is enabled/disabled.
      type: bool
    nfsv3_rdma_enabled:
      description: Whether rdma is enabled for NFSv3 protocol.
      type: bool
    nfsv40_enabled:
      description: Whether version 0 of NFSv4 protocol is enabled/disabled.
      type: bool
    nfsv41_enabled:
      description: Whether version 1 of NFSv4 protocol is enabled/disabled.
      type: bool
    nfsv42_enabled:
      description: Whether version 2 of NFSv4 protocol is enabled/disabled.
      type: bool
    nfsv4_enabled:
      description: Whether NFSv4 protocol is enabled/disabled.
      type: bool
    rpc_maxthreads:
      description: Specifies the maximum number of threads in the nfsd thread pool.
      type: int
    rpc_minhreads:
      description: Specifies the minimum number of threads in the nfsd thread pool.
      type: int
    rquota_enabled:
      description: Whether the rquota protocol is enabled/disabled.
      type: bool
    service:
      description: Whether the NFS service is enabled/disabled.
      type: bool
  description: Details of NFS global settings.
  returned: When C(nfs_global_settings) is in a given I(gather_subset)
  sample:
    nfsv3_enabled: false
    nfsv3_rdma_enabled: true
    nfsv40_enabled: true
    nfsv41_enabled: true
    nfsv42_enabled: false
    nfsv4_enabled: true
    rpc_maxthreads: 20
    rpc_minthreads: 17
    rquota_enabled: true
    service: true
  type: dict
NfsZoneSettings:
  contains:
    nfsv4_allow_numeric_ids:
      description: If C(true), sends owners and groups as UIDs and GIDs when look
        up fails or if the I(nfsv4_no_names) property is set to 1.
      type: bool
    nfsv4_domain:
      description: Specifies the domain through which users and groups are associated.
      type: str
    nfsv4_no_domain:
      description: If C(true), sends owners and groups without a domain name.
      type: bool
    nfsv4_no_domain_uids:
      description: If C(true), sends UIDs and GIDs without a domain name.
      type: bool
    nfsv4_no_names:
      description: If C(true), sends owners and groups as UIDs and GIDs.
      type: bool
    nfsv4_replace_domain:
      description: If C(true), replaces the owner or group domain with an NFS domain
        name.
      type: bool
    zone:
      description: Specifies the access zone in which the NFS zone settings apply.
      type: str
  description: Details of NFS zone settings.
  returned: When C(nfs_zone_settings) is in a given I(gather_subset)
  sample:
    nfsv4_allow_numeric_ids: true
    nfsv4_domain: sample.com
    nfsv4_no_domain: true
    nfsv4_no_domain_uids: true
    nfsv4_no_names: true
    nfsv4_replace_domain: true
    zone: System
  type: dict
NodePools:
  contains:
    id:
      description: ID of the node pool.
      type: str
    lnns:
      description: Node pool's lnns.
      type: list
    name:
      description: Name of the node pool.
      type: str
    protection_policy:
      description: Protection policy of the node pool.
      type: str
    usage:
      description: Usage of the node pool.
      type: dict
  description: List of the Node pools.
  returned: When C(node_pools) is in a given I(gather_subset)
  sample:
  - can_disable_l3: true
    can_enable_l3: true
    health_flags:
    - missing_drives
    id: 1
    l3: true
    l3_status: l3
    lnns:
    - 1
    manual: false
    name: s210_6.9tb_1.6tb-ssd_64gb
    node_type_ids:
    - 1
    protection_policy: +2d:1n
    tier: null
    transfer_limit_pct: 90
    transfer_limit_state: default
    usage: {}
  type: list
Nodes:
  contains:
    nodes:
      description: Specifies the deatils of the node.
      type: list
    total:
      description: Total number of nodes.
      type: int
  description: Contain the list of Nodes in the PowerScale cluster.
  returned: When C(nodes) is in a given I(gather_subset)
  sample:
    nodes: []
    total: 1
  type: dict
Providers:
  contains:
    provider_instances:
      contains:
        active_server:
          description: Active server of the provider.
          type: str
        connections:
          description: Different connections of provider.
          type: str
        groupnet:
          description: Groupnet of the provider.
          type: str
        id:
          description: ID of the provider.
          type: str
        name:
          description: Name of the provider.
          type: str
        status:
          description: Status of the provider.
          type: str
        type:
          description: Type of the provider
          type: str
        zone_name:
          description: Access zone of the provider.
          type: str
      description: List of providers.
      type: list
  description: Contains different type of providers in the PowerScale system.
  returned: When C(providers) is in a given I(gather_subset)
  sample:
    provider_instances:
    - active_server: null
      connections: []
      groupnet: null
      id: lsa-local-provider:System
      name: System
      status: active
      type: local
      zone_name: System
  type: list
S3_bucket_details:
  contains:
    acl:
      contains:
        grantee:
          contains:
            id:
              description: ID of the grantee.
              type: str
            name:
              description: Name of the grantee.
              type: str
            type:
              description: Specifies the type of the grantee.
              type: str
          description: Specifies details of grantee.
          type: dict
        permission:
          description: Specifies the S3 permission being allowed.
          type: str
      description: Specifies the properties of S3 access controls.
      type: list
    description:
      description: Specifies the description of the S3 bucket.
      type: str
    id:
      description: S3 bucket ID.
      type: str
    name:
      description: S3 bucket name.
      type: str
    object_acl_policy:
      description: Set behaviour of object acls for a specified S3 bucket.
      type: str
    owner:
      description: Specifies the owner of the S3 bucket.
      type: str
    path:
      description: Path of S3 bucket with in C('/ifs').
      type: str
    zid:
      description: Zone id.
      type: int
    zone:
      description: Access zone name.
      type: str
  description: The updated S3 Bucket details.
  returned: When C(s3_buckets) is in a given I(gather_subset)
  sample:
    access_zone: System
    acl:
    - grantee:
        id: ID
        name: ansible-user
        type: user
      permission: READ
    description: description
    id: ansible_S3_bucket
    name: ansible_S3_bucket
    object_acl_policy: replace
    owner: ansible-user
    path: /ifs/<sample-path>
    zid: 1
  type: dict
ServerCertificate:
  contains:
    certificate_monitor_enabled:
      description: Boolean value indicating whether certificate expiration monitoring
        is enabled.
      type: bool
    certificate_pre_expiration_threshold:
      description: The number of seconds before certificate expiration that the certificate
        expiration monitor will start raising alerts.
      type: int
    description:
      description: Description of the certificate.
      type: str
    dnsnames:
      description: Subject alternative names of the certificate.
      type: list
    fingerprints:
      description: Fingerprint details of the certificate.
      type: str
    id:
      description: System assigned certificate id.
      type: str
    issuer:
      description: Name of the certificate issuer.
      type: str
    name:
      description: Name for the certificate.
      type: str
    not_after:
      description: The date and time from which the certificate becomes valid and
        can be used for authentication and encryption.
      type: str
    not_before:
      description: The date and time until which the certificate is valid and can
        be used for authentication and encryption.
      type: str
    status:
      description: Status of the certificate.
      type: str
    subject:
      description: Subject of the certificate.
      type: str
  description: The Server certificate details.
  returned: When C(server_certificate) is in a given I(gather_subset)
  sample:
  - certificate_monitor_enabled: true
    certificate_pre_expiration_threshold: 4294
    description: This the example test description
    dnsnames:
    - powerscale
    fingerprints:
    - type: SHA1
      value: 68:b2:d5:5d:cc:b0:70:f1:f0:39:3a:bb:e0:44:49:70:6e:05:c3:ed
    - type: SHA256
      value: 69:99:b9:c0:29:49:c9:62:e8:4b:60:05:60:a8:fa:f0:01:ab:24:43:8a:47:4c:2f:66:2c:95:a1:7c:d8:10:34
    id: 6999b9c02949c962e84b600560a8faf001ab24438a474c2f662c95a17cd81034
    issuer: C=IN, ST=Karnataka, L=Bangalore, O=Dell, OU=ISG, CN=powerscale, emailAddress=contact@dell.com
    name: test
    not_after: 1769586969
    not_before: 1706514969
    status: valid
    subject: C=IN, ST=Karnataka, L=Bangalore, O=Dell, OU=ISG, CN=powerscale, emailAddress=contact@dell.com
  type: list
SmbGlobalSettings:
  contains:
    access_based_share_enum:
      description: Only enumerate files and folders the requesting user has access
        to.
      type: bool
    audit_fileshare:
      description: Specify level of file share audit events to log.
      type: str
    audit_logon:
      description: Specify the level of logon audit events to log.
      type: str
    dot_snap_accessible_child:
      description: Allow access to .snapshot directories in share subdirectories.
      type: bool
    dot_snap_accessible_root:
      description: Allow access to the .snapshot directory in the root of the share.
      type: bool
    dot_snap_visible_child:
      description: Show .snapshot directories in share subdirectories.
      type: bool
    dot_snap_visible_root:
      description: Show the .snapshot directory in the root of a share.
      type: bool
    enable_security_signatures:
      description: Indicates whether the server supports signed SMB packets.
      type: bool
    guest_user:
      description: Specifies the fully-qualified user to use for guest access.
      type: str
    ignore_eas:
      description: Specify whether to ignore EAs on files.
      type: bool
    onefs_cpu_multiplier:
      description: Specify the number of OneFS driver worker threads per CPU.
      type: int
    onefs_num_workers:
      description: Set the maximum number of OneFS driver worker threads.
      type: int
    reject_unencrypted_access:
      description: If SMB3 encryption is enabled, reject unencrypted access from clients.
      type: bool
    require_security_signatures:
      description: Indicates whether the server requires signed SMB packets.
      type: bool
    server_side_copy:
      description: Enable Server Side Copy.
      type: bool
    server_string:
      description: Provides a description of the server.
      type: str
    service:
      description: Specify whether service is enabled.
      type: bool
    srv_cpu_multiplier:
      description: Specify the number of SRV service worker threads per CPU.
      type: int
    srv_num_workers:
      description: Set the maximum number of SRV service worker threads.
      type: int
    support_multichannel:
      description: Support multichannel.
      type: bool
    support_netbios:
      description: Support NetBIOS.
      type: bool
    support_smb2:
      description: The support SMB2 attribute.
      type: bool
    support_smb3_encryption:
      description: Support the SMB3 encryption on the server.
      type: bool
  description: The updated SMB global settings details.
  returned: always
  sample:
    access_based_share_enum: false
    audit_fileshare: null
    audit_logon: null
    dot_snap_accessible_child: true
    dot_snap_accessible_root: true
    dot_snap_visible_child: false
    dot_snap_visible_root: true
    enable_security_signatures: false
    guest_user: nobody
    ignore_eas: false
    onefs_cpu_multiplier: 4
    onefs_num_workers: 0
    reject_unencrypted_access: false
    require_security_signatures: false
    server_side_copy: false
    server_string: PowerScale Server
    service: true
    srv_cpu_multiplier: null
    srv_num_workers: null
    support_multichannel: true
    support_netbios: false
    support_smb2: true
    support_smb3_encryption: true
  type: dict
SmbOpenFiles:
  contains:
    file:
      description: Path of file within /ifs.
      type: str
    id:
      description: The ID of the SMB open file.
      type: int
    locks:
      description: The number of locks user holds on file.
      type: int
    permission:
      description: The user's permissions on file.
      type: list
    user:
      description: User holding file open.
      type: str
  description: List of SMB open files.
  returned: When C(smb_files) is in a given I(gather_subset)
  sample:
  - file: C:\ifs
    id: 1370
    locks: 0
    permissions:
    - read
    user: admin
  type: list
SmbShares:
  contains:
    id:
      description: ID of the SMB Share.
      type: str
    name:
      description: Name of the SMB Share.
      type: str
  description: List of the SMB Shares.
  returned: When C(smb_shares) is in a given I(gather_subset)
  sample:
  - id: Atest
    name: Atest
  type: list
SnmpSettings:
  contains:
    read_only_community:
      description: SNMP Read-only community name.
      type: str
    service:
      description: Whether the SNMP Service is enabled.
      type: bool
    snmp_v1_v2c_access:
      description: Whether the SNMP v2c access is enabled.
      type: bool
    snmp_v3_access:
      description: Whether the SNMP v3 access is enabled.
      type: bool
    snmp_v3_auth_protocol:
      description: SNMP v3 authentication protocol.
      type: str
    snmp_v3_priv_protocol:
      description: SNMP v3 privacy protocol.
      type: str
    snmp_v3_read_only_user:
      description: SNMP v3 read-only user.
      type: str
    snmp_v3_security_level:
      description: SNMP v3 security level.
      type: str
    system_contact:
      description: SNMP system owner contact information.
      type: str
    system_location:
      description: The cluster description of the SNMP system.
      type: str
  description: The SNMP settings details.
  returned: When C(snmp_settings) is in a given I(gather_subset)
  sample:
    read_only_community: public
    service: true
    snmp_v1_v2c_access: true
    snmp_v3_access: true
    snmp_v3_auth_protocol: MD5
    snmp_v3_priv_protocol: DES
    snmp_v3_read_only_user: general
    snmp_v3_security_level: authPriv
    system_contact: system
    system_location: cluster
  type: dict
StoragePoolTiers:
  contains:
    children:
      description: Children in the storage pool tiers.
      type: list
    id:
      description: ID of the storage pool tier.
      type: str
    lnns:
      description: Storage pool tier's lnn.
      type: list
    name:
      description: Name of the storage pool tier.
      type: str
    usage:
      description: Usage of the storage pool tiers.
      type: list
  description: List of the storage pool tiers.
  returned: When C(storagepool_tiers) is in a given I(gather_subset)
  sample:
  - children: []
    id: 984
    lnns: []
    name: Ansible_Tier_1
    usage: {}
  type: list
SynciqGlobalSettings:
  contains:
    bandwidth_reservation_reserve_absolute:
      description: The absolute bandwidth reservation for SyncIQ.
      type: int
    bandwidth_reservation_reserve_percentage:
      description: The percentage-based bandwidth reservation for SyncIQ.
      type: int
    cluster_certificate_id:
      description: The ID of the cluster certificate used for SyncIQ.
      type: str
    encryption_cipher_list:
      description: The list of encryption ciphers used for SyncIQ.
      type: str
    encryption_required:
      description: Whether encryption is required or not for SyncIQ.
      type: bool
    force_interface:
      description: Whether the force interface is enabled or not for SyncIQ.
      type: bool
    max_concurrent_jobs:
      description: The maximum number of concurrent jobs for SyncIQ.
      type: int
    ocsp_address:
      description: The address of the OCSP server used for SyncIQ certificate validation.
      type: str
    ocsp_issuer_certificate_id:
      description: The ID of the issuer certificate used for OCSP validation in SyncIQ.
      type: str
    preferred_rpo_alert:
      description: Whether the preferred RPO alert is enabled or not for SyncIQ.
      type: bool
    renegotiation_period:
      description: The renegotiation period in seconds for SyncIQ.
      type: int
    report_email:
      description: The email address to which SyncIQ reports are sent.
      type: str
    report_max_age:
      description: The maximum age in days of reports that are retained by SyncIQ.
      type: int
    report_max_count:
      description: The maximum number of reports that are retained by SyncIQ.
      type: int
    restrict_target_network:
      description: Whether to restrict the target network in SyncIQ.
      type: bool
    rpo_alerts:
      description: Whether RPO alerts are enabled or not in SyncIQ.
      type: bool
    service:
      description: Specifies whether the SyncIQ service is currently on, off, or paused.
      type: str
    service_history_max_age:
      description: The maximum age in days of service history that is retained by
        SyncIQ.
      type: int
    service_history_max_count:
      description: The maximum number of service history records that are retained
        by SyncIQ.
      type: int
    source_network:
      description: The source network used by SyncIQ.
      type: str
    tw_chkpt_interval:
      description: The interval between checkpoints in seconds in SyncIQ.
      type: int
    use_workers_per_node:
      description: Whether to use workers per node in SyncIQ or not.
      type: bool
  description: The SyncIQ global settings details.
  returned: always
  sample:
    bandwidth_reservation_reserve_absolute: null
    bandwidth_reservation_reserve_percentage: 1
    cluster_certificate_id: xxxx
    encryption_cipher_list: ''
    encryption_required: true
    force_interface: false
    max_concurrent_jobs: 16
    ocsp_address: ''
    ocsp_issuer_certificate_id: ''
    preferred_rpo_alert: 0
    renegotiation_period: 28800
    report_email: []
    report_max_age: 31536000
    report_max_count: 2000
    restrict_target_network: false
    rpo_alerts: true
    service: 'off'
    service_history_max_age: 31536000
    service_history_max_count: 2000
    source_network: null
    tw_chkpt_interval: null
    use_workers_per_node: false
  type: dict
SynciqPerformanceRules:
  contains:
    enabled:
      description: Whether SyncIQ performance rule enabled.
      type: bool
    id:
      description: ID of the SyncIQ performance rule.
      type: str
    limit:
      description: Limits of the SyncIQ performance rule.
      type: str
    schedule:
      description: Schedule of the SyncIQ performance rule.
      type: dict
    type:
      description: The type of the SyncIQ performance rule.
      type: str
  description: List of SyncIQ performance rules.
  returned: When C(synciq_performance_rules) is in a given I(gather_subset)
  sample:
  - enabled: true
    id: fc-0
    limit: 1files/sec
    schedule: {}
    type: file_count
  type: list
SynciqPolicies:
  contains:
    enabled:
      description: Whether SyncIQ policies enabled.
      type: bool
    id:
      description: ID of the SyncIQ policies.
      type: str
    name:
      description: Name of the SyncIQ policies.
      type: str
    schedule:
      description: Schedule of the SyncIQ policies.
      type: str
    source_root_path:
      description: Source path of the SyncIQ policies.
      type: str
    target_path:
      description: Target path of the SyncIQ policies.
      type: str
  description: List of the SyncIQ policies.
  returned: When C(synciq_policies) is in a given I(gather_subset)
  sample:
  - enabled: true
    id: 1ee8ad74f6f147894d21e339d57c3d1b
    name: dk2-nginx-10-230-24-249-Five_Minutes
    schedule: when-source-modified
    source_root_path: /ifs/data/sample-x.x.x.x-Five_Minutes
    target_path: /ifs/data/dk2-nginx-x.x.x.x-Five_Minutes
  type: list
SynciqReports:
  contains:
    id:
      description: ID of the SyncIQ reports.
      type: str
    name:
      description: Name of the SyncIQ reports.
      type: str
  description: List of the SyncIQ reports.
  returned: When C(synciq_reports) is in a given I(gather_subset)
  sample:
  - id: 1ee8ad74f6f147894d21e339d57c3d1b
    name: dk2-nginx-10-230-24-249-Five_Minutes
  type: list
SynciqTargetClusterCertificate:
  contains:
    id:
      description: ID of the SyncIQ Target cluster certificates.
      type: str
    name:
      description: Name of the SyncIQ Target cluster certificates.
      type: str
  description: List of the SyncIQ Target cluster certificates.
  returned: When C(synciq_target_cluster_certificates) is in a given I(gather_subset)
  sample:
  - id: 077f119e54ec2c12c74f011433cd33ac5c
    name: sample
  type: list
SynciqTargetReports:
  contains:
    id:
      description: ID of the SyncIQ Target reports.
      type: str
    name:
      description: Name of the SyncIQ Target reports.
      type: str
  description: List of the SyncIQ Target reports.
  returned: When C(synciq_target_reports) is in a given I(gather_subset)
  sample:
  - id: cicd-repctl-0419-t151741-10-247-100-10-Five_Minutes
    name: cicd-repctl-0419-t1741-10-247-100-10-Five_Minutes
  type: list
UserMappingRules:
  contains:
    apply_order:
      description: Current order of the rule.
      type: int
    operator:
      description: The operation that a rule carries out.
      type: str
    options:
      description: The operation that a rule carries out.
      type: dict
    user1:
      description: A UNIX user or an Active Directory user.
      type: dict
    user2:
      description: A UNIX user or an Active Directory user.
      type: dict
  description: List of the User mapping rules.
  returned: When C(user_mapping_rules) is in a given I(gather_subset)
  sample:
  - apply_order: 1
    operator: append
    options:
      _break: false
      default_user: null
      group: true
      groups: true
      user: true
    user1:
      domain: null
      user: test_user_2
    user2:
      domain: null
      user: test_user_1
  type: list
Users:
  contains:
    users:
      contains:
        id:
          description: ID of the user.
          type: str
        name:
          description: Name of the user.
          type: str
        provider:
          description: The provider of the user.
          type: str
      description: List of users details.
      type: list
  description: List of all Users.
  returned: When C(users) is in a given I(gather_subset)
  sample:
  - users:
    - dn: CN=test_ans_user,CN=Users,DC=X-ISILON-X
      dns_domain: null
      domain: x-ISILON-X
      email: testuser_ans@dell.com
      gid:
        id: GID:1800
        name: null
        type: null
      home_directory: /ifs/home/test_ans_user
      id: test_ans_user
      name: test_ans_user
      on_disk_user_identity:
        id: UID:2016
        name: null
        type: null
      password_expired: false
      primary_group_sid:
        id: SID:S-1-5-21-2193650305-1279797252-961391754-800
        name: null
        type: null
      prompt_password_change: false
      provider: lsa-local-provider:System
      sam_account_name: test_ans_user
      shell: /bin/zsh
      sid:
        id: SID:S-1-5-21-2193650305-1279797252-961391754-1025
        name: null
        type: null
      ssh_public_keys: []
      type: user
      uid:
        id: UID:2016
        name: null
        type: null
      upn: test_ans_user@x-ISILON-X
      user_can_change_password: true
  type: list
changed:
  description: Shows Whether or not the resource has changed.
  returned: always
  sample: 'false'
  type: bool
cluster_identity:
  contains:
    description:
      description: Description of PowerScale cluster.
      type: str
    logon:
      contains:
        motd:
          description: Details of logon message.
          type: str
        motd_header:
          description: Details of logon message title.
          type: str
      description: Details of logon message shown on Powerscale login screen.
      type: dict
    mttdl_level_msg:
      description: mttdl_level_msg.
      type: str
    name:
      description: Name of PowerScale cluster.
      type: str
  description: Details related to cluster identity.
  returned: Always
  sample:
    cluster_identity:
      description: asdadasdasdasdadadadds
      logon:
        motd: This is new description
        motd_header: This is the new title
      mttdl_level_msg: none
      name: PIE-IsilonS-24241-Clusterwrerwerwrewr
  type: dict
cluster_owner:
  contains:
    company:
      description: Name of the company.
      type: str
    location:
      description: Location of the company.
      type: str
    primary_email:
      description: Email of primary system admin.
      type: str
    primary_name:
      description: Name of primary system admin.
      type: str
    primary_phone1:
      description: Phone1 of primary system admin.
      type: str
    primary_phone2:
      description: Phone2 of primary system admin.
      type: str
    secondary_email:
      description: Email of secondary system admin.
      type: str
    secondary_name:
      description: Name of secondary system admin.
      type: str
    secondary_phone1:
      description: Phone1 of secondary system admin.
      type: str
    secondary_phone2:
      description: Phone2 of secondary system admin.
      type: str
  description: Details related to cluster identity.
  returned: Always
  sample:
    cluster_owner:
      company: Test company
      location: Test location
      primary_email: primary_email@email.com
      primary_name: primary_name
      primary_phone1: primary_phone1
      primary_phone2: primary_phone2
      secondary_email: secondary_email@email.com
      secondary_name: secondary_name
      secondary_phone1: secondary_phone1
      secondary_phone2: secondary_phone2
  type: dict
email_settings:
  contains:
    settings:
      contains:
        batch_mode:
          description: This setting determines how notifications will be batched together
            to be sent by email.
          type: str
        mail_relay:
          description: The address of the SMTP server to be used for relaying the
            notification messages.
          type: str
        mail_sender:
          description: The full email address that will appear as the sender of notification
            messages.
          type: str
        mail_subject:
          description: The subject line for notification messages from this cluster.
          type: str
        smtp_auth_passwd_set:
          description: Indicates if an SMTP authentication password is set.
          type: bool
        smtp_auth_security:
          description: The type of secure communication protocol to use if SMTP is
            being used.
          type: str
        smtp_auth_username:
          description: Username to authenticate with if SMTP authentication is being
            used.
          type: str
        smtp_port:
          description: The port on the SMTP server to be used for relaying the notification
            messages.
          type: int
        use_smtp_auth:
          description: If true, this cluster will send SMTP authentication credentials
            to the SMTP relay server in order to send its notification emails.
          type: bool
        user_template:
          description: Location of a custom template file that can be used to specify
            the layout of the notification emails.
          type: str
      description: Details of the settings.
      returned: Always
      type: dict
  description: Details of the email settings.
  returned: Always
  sample:
    settings:
      batch_mode: none
      mail_relay: 10.**.**.**
      mail_sender: powerscale@dell.com
      mail_subject: Powerscale Cluster notifications
      smtp_auth_passwd_set: false
      smtp_auth_security: none
      smtp_auth_username: ''
      smtp_port: 25
      use_smtp_auth: false
      user_template: ''
  type: dict
nfs_default_settings:
  contains:
    block_size:
      description: Specifies the block size returned by the NFS statfs procedure.
      type: dict
    can_set_time:
      description: True if the client can set file times through the NFS set attribute
        request. This parameter does not affect server behavior, but is included to
        accommodate legacy client requirements.
      type: bool
    commit_asynchronous:
      description: True if NFS commit requests execute asynchronously.
      type: bool
    directory_transfer_size:
      description: Specifies the preferred size for directory read operations. This
        value is used to advise the client of optimal settings for the server, but
        is not enforced.
      type: dict
    encoding:
      description: Specifies the default character set encoding of the clients connecting
        to the export, unless otherwise specified.
      type: str
    map_failure:
      description: Mapping of users to a specific user and/or group ID after a failed
        auth attempt.
      type: dict
    map_lookup_uid:
      description: True if incoming user IDs (UIDs) are mapped to users in the OneFS
        user database. When set to False, incoming UIDs are applied directly to file
        operations.
      type: bool
    map_non_root:
      description: Mapping of non-root users to a specific user and/or group ID.
      type: dict
    map_root:
      description: Mapping of incoming root users to a specific user and/or group
        ID.
      type: dict
    max_file_size:
      description: Specifies the maximum file size for any file accessed from the
        export. This parameter does not affect server behavior, but is included to
        accommodate legacy client requirements.
      type: dict
    name_max_size:
      description: Specifies the reported maximum length of a file name. This parameter
        does not affect server behavior, but is included to accommodate legacy client
        requirements.
      type: dict
    read_transfer_max_size:
      description: Specifies the maximum buffer size that clients should use on NFS
        read requests. This value is used to advise the client of optimal settings
        for the server, but is not enforced.
      type: dict
    read_transfer_multiple:
      description: Specifies the preferred multiple size for NFS read requests. This
        value is used to advise the client of optimal settings for the server, but
        is not enforced.
      type: dict
    read_transfer_size:
      description: Specifies the preferred size for NFS read requests. This value
        is used to advise the client of optimal settings for the server, but is not
        enforced.
      type: dict
    readdirplus:
      description: True if 'readdirplus' requests are enabled. Enabling this property
        might improve network performance and is only available for NFSv3.
      type: bool
    return_32bit_file_ids:
      description: Limits the size of file identifiers returned by NFSv3+ to 32-bit
        values (may require remount).
      type: bool
    security_flavors:
      description: Specifies the authentication types that are supported for this
        export.
      type: list
    setattr_asynchronous:
      description: True if set attribute operations execute asynchronously.
      type: bool
    symlinks:
      description: True if symlinks are supported. This value is used to advise the
        client of optimal settings for the server, but is not enforced.
      type: bool
    time_delta:
      description: Specifies the resolution of all time values that are returned to
        the clients.
      type: dict
    write_datasync_action:
      description: Specifies the synchronization type for data sync action.
      type: str
    write_datasync_reply:
      description: Specifies the synchronization type for data sync reply.
      type: str
    write_filesync_action:
      description: Specifies the synchronization type for file sync action.
      type: str
    write_filesync_reply:
      description: Specifies the synchronization type for file sync reply.
      type: str
    write_transfer_max_size:
      description: Specifies the maximum buffer size that clients should use on NFS
        write requests. This value is used to advise the client of optimal settings
        for the server, but is not enforced.
      type: dict
    write_transfer_multiple:
      description: Specifies the preferred multiple size for NFS write requests. This
        value is used to advise the client of optimal settings for the server, but
        is not enforced.
      type: dict
    write_transfer_size:
      description: Specifies the preferred multiple size for NFS write requests. This
        value is used to advise the client of optimal settings for the server, but
        is not enforced.
      type: dict
    write_unstable_action:
      description: Specifies the synchronization type for unstable action.
      type: str
    write_unstable_reply:
      description: Specifies the synchronization type for unstable reply.
      type: str
    zone:
      description: The zone to which the NFS default settings apply.
      type: str
  description: The NFS default settings.
  returned: always
  sample:
    block_size: 8192
    can_set_time: true
    commit_asynchronous: false
    directory_transfer_size: 131072
    encoding: DEFAULT
    map_failure:
      enabled: false
      primary_group:
        id: None
        name: None
        type: None
      secondary_groups: []
      user:
        id: USER:nobody
        name: None
        type: None
    map_lookup_uid: false
    map_non_root:
      enabled: false
      primary_group:
        id: None
        name: None
        type: None
      secondary_groups: []
      user:
        id: USER:nobody
        name: None
        type: None
    map_root:
      enabled: true
      primary_group:
        id: None
        name: None
        type: None
      secondary_groups: []
      user:
        id: USER:nobody
        name: None
        type: None
    max_file_size: 9223372036854775807
    name_max_size: 255
    read_transfer_max_size: 1048576
    read_transfer_multiple: 512
    read_transfer_size: 131072
    readdirplus: true
    return_32bit_file_ids: false
    setattr_asynchronous: false
    symlinks: true
    time_delta: 1e-09
    write_datasync_action: DATASYNC
    write_datasync_reply: DATASYNC
    write_filesync_action: FILESYNC
    write_filesync_reply: FILESYNC
    write_transfer_max_size: 1048576
    write_transfer_multiple: 512
    write_transfer_size: 524288
    write_unstable_action: UNSTABLE
    write_unstable_reply: UNSTABLE
    zone: sample-zone
  type: dict
ntp_servers:
  contains:
    servers:
      contains:
        id:
          description: Field id.
          type: str
        key:
          description: Key value from I(key_file) that maps to this server.
          type: str
        name:
          description: NTP server name.
          type: str
      description: List of servers.
      type: list
  description: List of NTP servers.
  returned: Always
  sample:
    servers:
    - id: 10.**.**.**
      key: null
      name: 10.**.**.**
  type: dict