dellemc.powerstore.dellemc_powerstore_cluster (1.3.0) — module

Manage cluster related opeartions on PowerStore.

| "added in version" 1.3.0 of dellemc.powerstore"

Authors: P Srinivas Rao (@srinivas-rao5) <ansible.team@dell.com>

preview | supported by community

Install collection

Install with ansible-galaxy collection install dellemc.powerstore:==1.3.0


Add to requirements.yml

  collections:
    - name: dellemc.powerstore
      version: 1.3.0

Description

Managing cluster on PowerStore storage system includes getting details and modifying cluster configuration parameters.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: get the details of cluster using id
  dellemc_powerstore_cluster:
    array_ip: "{{array_ip}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    cluster_id: "0"
    state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Modify details of cluster using the name
  dellemc_powerstore_cluster:
    array_ip: "{{array_ip}}"
    verifycert: "{{verifycert}}"
    user: "{{user}}"
    password: "{{password}}"
    cluster_name: "RT-D1320"
    appliance_id: "A1"
    is_ssh_enabled: True
    service_password: "S@mple_password"
    chap_mode: "Disabled"
    new_name: "new_RT-D1320"
    state: "present"

Inputs

    
user:
    description:
    - The username of the PowerStore host.
    required: true
    type: str

state:
    choices:
    - absent
    - present
    description:
    - Define whether the cluster should exist or not.
    - present  indicates that the cluster should exist on the system.
    - absent  indicates that the cluster should not exist on the system.
    required: true
    type: str

array_ip:
    description:
    - IP or FQDN of the PowerStore management system.
    required: true
    type: str

new_name:
    description:
    - The new name for the cluster.
    type: str

password:
    description:
    - The password of the PowerStore host.
    required: true
    type: str

chap_mode:
    choices:
    - Disabled
    - Single
    - Mutual
    description:
    - The mode that describes or sets the iSCSI CHAP mode for the cluster.
    type: str

cluster_id:
    description:
    - Id of the cluster.
    type: str

verifycert:
    choices:
    - true
    - false
    description:
    - 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.
    required: true
    type: bool

appliance_id:
    description:
    - ID of the appliance.
    - appliance_id and appliance_name are mutually exclusive.
    - is_ssh_enabled has to be passed along with appliance_id.
    type: str

cluster_name:
    description:
    - The Name of cluster.
    type: str

physical_mtu:
    description:
    - MTU for ethernet ports in the cluster.
    - The MTU can be set between 1500 to 9000.
    type: int

appliance_name:
    description:
    - Name of the appliance.
    - appliance_id and appliance_name are mutually exclusive.
    - is_ssh_enabled has to be passed along with appliance_name.
    type: str

is_ssh_enabled:
    description:
    - Whether SSH access is enabled for the cluster.
    - Either appliance_id or appliance_name is to be passed along with is_ssh_enabled.
    type: bool

service_password:
    description:
    - The password for the service user.
    type: str

Outputs

changed:
  description: Whether or not the resource has changed
  returned: always
  sample: true
  type: bool
cluster_details:
  contains:
    appliance_count:
      description: Number of appliances configured in this cluster.
      type: int
    appliance_details:
      contains:
        id:
          description: Id of the appliance.
          type: str
        name:
          description: Name of the appliance.
          type: str
      description: Name and Id of the appliance for which is_ssh_enabled parameter
        is used.
      returned: When appliance name or id is passed in the playbook task.
      type: complex
    compatibility_level:
      description: The behavioral version of the software version API, It is used
        to ensure the compatibility across potentially different software versions.
      type: int
    global_id:
      description: The global unique identifier of the cluster.
      type: str
    id:
      description: The ID of the cluster.
      type: str
    is_encryption_enabled:
      description: Whether or not Data at Rest Encryption is enabled on the cluster.
      type: bool
    is_ssh_enabled:
      description: Whether or not the ssh is enabled.
      type: bool
    management_address:
      description: The floating management IP address for the cluster in IPv4 or IPv6
        format.
      type: str
    master_appliance_id:
      description: The unique identifier of the appliance acting as primary. This
        parameter is deprecated in version 2.0.0.0.
      type: str
    name:
      description: Name of the cluster.
      type: str
    physical_mtu:
      description: MTU for the cluster.
      type: int
    primary_appliance_id:
      description: The unique identifier of the appliance acting as primary. This
        parameter was added in version 2.0.0.0.
      type: str
    service_config_details:
      contains:
        appliance_id:
          description: Id of the appliance for which the service configuration exists.
          type: str
        id:
          description: Id of the service configuration.
          type: str
        is_ssh_enabled:
          description: Whether the ssh is enabled for the appliance or not.
          type: bool
      description: Details of the service config for the entered appliance.
      returned: When is_ssh_enabled is passed in the playbook task
      type: complex
    service_user_details:
      contains:
        id:
          description: Id of the service user.
          type: str
        is_built_in:
          description: Whether the service user is built in or not.
          type: bool
        is_default_password:
          description: Whether the service user has default password or not.
          type: bool
        name:
          description: Name of the service user.
          type: str
      description: Details of the service user for which the password can be updated.
      returned: when the cluster exists.
      type: complex
    state:
      description: Possible cluster states.
      type: str
    storage_discovery_address:
      description: The floating storage discovery IP address for the cluster in IPv4
        or IPv6 format.
      type: str
    system_time:
      description: Current clock time for the system. System time and all the system
        reported times are in UTC (GMT+0:00) format.
      type: str
  description: The cluster details.
  returned: When Cluster exists.
  type: complex