XLAB Steampunk logo Try Spotter
 / home / dellemc / dellemc.powerscale / 1.4.0 / module / dellemc_powerscale_gatherfacts

dellemc.powerscale.dellemc_powerscale_gatherfacts (1.4.0) — module

Gathering information about DellEMC 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>

preview | supported by community

Install collection | Add to requirements.yml | Description | Requirements | Usage examples | Inputs

Install collection

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


Add to requirements.yml

  collections:
    - name: dellemc.powerscale
      version: 1.4.0

Description

Gathering information about DellEMC PowerScale Storage System includes Get attributes of the PowerScale cluster, Get list of access zones in the PowerScale cluster, Get list of nodes in the PowerScale cluster, Get list of authentication providers for all access zones or a specific access zone, Get list of users and groups for an access zone. Get list of smb_shares in the PowerScale cluster, Get list of nfs_exports in the PowerScale cluster, Get list of active clients in the PowerScale cluster, Get list of SyncIQ reports in the PowerScale cluster, Get list of SyncIQ target reports in the PowerScale cluster, Get list of SyncIQ target cluster certificates in the PowerScale cluster, Get list of SyncIQ policies in the PowerScale cluster. Get list of SyncIQ performance rules in the PowerScale cluster. Get list of network groupnets of the PowerScale cluster. Get list of network pools for all access zones or a specific access zone of the PowerScale cluster. Get list of network rules of the PowerScale cluster. Get list of network subnets of the PowerScale cluster. Get list of network interfaces of the PowerScale cluster.


Requirements

Usage examples

Scanned by Steampunk Spotter
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Get attributes of the PowerScale cluster
    dellemc_powerscale_gatherfacts:
      onefs_host: "{{onefs_host}}"
      port_no: "{{powerscaleport}}"
      verify_ssl: "{{verify_ssl}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      gather_subset:
        - attributes
Scanned by Steampunk Spotter
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Get access_zones of the PowerScale cluster
    dellemc_powerscale_gatherfacts:
      onefs_host: "{{onefs_host}}"
      port_no: "{{powerscaleport}}"
      verify_ssl: "{{verify_ssl}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      gather_subset:
        - access_zones
Scanned by Steampunk Spotter
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Get nodes of the PowerScale cluster
    dellemc_powerscale_gatherfacts:
      onefs_host: "{{onefs_host}}"
      port_no: "{{powerscaleport}}"
      verify_ssl: "{{verify_ssl}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      gather_subset:
        - nodes
Scanned by Steampunk Spotter
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Get list of authentication providers for an access zone of the
          PowerScale cluster
    dellemc_powerscale_gatherfacts:
      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:
        - providers
Scanned by Steampunk Spotter
  • 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_gatherfacts:
      onefs_host: "{{onefs_host}}"
      port_no: "{{powerscaleport}}"
      verify_ssl: "{{verify_ssl}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      include_all_access_zones: True
      gather_subset:
        - providers
Scanned by Steampunk Spotter
  • 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_gatherfacts:
      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
Scanned by Steampunk Spotter
  • 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_gatherfacts:
      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
Scanned by Steampunk Spotter
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Get list of smb shares in the PowerScale cluster
    dellemc_powerscale_gatherfacts:
      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
Scanned by Steampunk Spotter
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Get list of nfs exports in the PowerScale cluster
    dellemc_powerscale_gatherfacts:
      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
Scanned by Steampunk Spotter
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Get list of clients in the PowerScale cluster
    dellemc_powerscale_gatherfacts:
      onefs_host: "{{onefs_host}}"
      port_no: "{{powerscaleport}}"
      verify_ssl: "{{verify_ssl}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      gather_subset:
        - clients
Scanned by Steampunk Spotter
  • 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_gatherfacts:
      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
Scanned by Steampunk Spotter
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Get list of SyncIQ policies in the PowerScale cluster
    dellemc_powerscale_gatherfacts:
      onefs_host: "{{onefs_host}}"
      port_no: "{{powerscaleport}}"
      verify_ssl: "{{verify_ssl}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      gather_subset:
        - synciq_policies
Scanned by Steampunk Spotter
  • 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_gatherfacts:
      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
Scanned by Steampunk Spotter
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Get list of SyncIQ performance rules in the PowerScale cluster
    dellemc_powerscale_gatherfacts:
      onefs_host: "{{onefs_host}}"
      port_no: "{{powerscaleport}}"
      verify_ssl: "{{verify_ssl}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      gather_subset:
        - synciq_performance_rules
Scanned by Steampunk Spotter
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Get list of network groupnets of the PowerScale cluster
    dellemc_powerscale_gatherfacts:
      onefs_host: "{{onefs_host}}"
      verify_ssl: "{{verify_ssl}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      gather_subset:
        - network_groupnets
Scanned by Steampunk Spotter
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Get list of network pools of the PowerScale cluster
    dellemc_powerscale_gatherfacts:
      onefs_host: "{{onefs_host}}"
      verify_ssl: "{{verify_ssl}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      gather_subset:
        - network_pools
Scanned by Steampunk Spotter
  • 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_gatherfacts:
      onefs_host: "{{onefs_host}}"
      verify_ssl: "{{verify_ssl}}"
      api_user: "{{api_user}}"
      include_all_access_zones: True
      gather_subset:
        - network_pools
Scanned by Steampunk Spotter
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Get list of network rules of the PowerScale cluster
    dellemc_powerscale_gatherfacts:
      onefs_host: "{{onefs_host}}"
      verify_ssl: "{{verify_ssl}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      gather_subset:
        - network_rules
Scanned by Steampunk Spotter
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Get list of network interfaces of the PowerScale cluster
    dellemc_powerscale_gatherfacts:
      onefs_host: "{{onefs_host}}"
      verify_ssl: "{{verify_ssl}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      gather_subset:
        - network_interfaces
Scanned by Steampunk Spotter
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Get list of network subnets of the PowerScale cluster
    dellemc_powerscale_gatherfacts:
      onefs_host: "{{onefs_host}}"
      verify_ssl: "{{verify_ssl}}"
      api_user: "{{api_user}}"
      api_password: "{{api_password}}"
      gather_subset:
        - network_subnets

Inputs

    
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.
    - True - indicates that the SSL certificate should be verified.
    - 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
    - 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
    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
    - access_zones
    - nodes
    - providers
    - users
    - groups
    - smb_shares
    - nfs_exports
    - clients
    - synciq_reports
    - synciq_target_reports
    - synciq_policies
    - synciq_target_cluster_certificates
    - synciq_performance_rules
    - network_groupnets
    - network_pools
    - network_rules
    - network_interfaces
    - network_subnets
    - The list of attributes, access_zones and nodes is for the entire PowerScale cluster
    - The list of providers, 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
    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 access_zone.
    type: bool
Got feedback? steampunk@xlab.si | © 2024. All rights reserved.
Cookie policy-Privacy policy-Terms of use-Security policy