dellemc.powerstore.vcenter (3.2.0) — module

Manage vCenter on a PowerStore storage system

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

Authors: Bhavneet Sharma (@sharmb5) <ansible.team@dell.com>

Install collection

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


Add to requirements.yml

  collections:
    - name: dellemc.powerstore
      version: 3.2.0

Description

Managing vCenter on a PowerStore Storage System includes adding a vCenter, getting details, modifying, and removing a vCenter.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get details of vCenter
  dellemc.powerstore.vcenter:
    array_ip: "{{array_ip}}"
    user: "{{user}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    vcenter_id: "24d333-59f-423c-205-c6181ea81b"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Add a vcenter
  dellemc.powerstore.vcenter:
    array_ip: "{{array_ip}}"
    user: "{{user}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    address: "XX.XX.XX.XX"
    vcenter_username: "user-name"
    vcenter_password: "password"
    update_password: "on_create"
    vasa_provider_credentials:
      username: "admin"
      password: "pass"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Modify a vCenter attribute
  dellemc.powerstore.vcenter:
    array_ip: "{{array_ip}}"
    user: "{{user}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    vcenter_id: "24d333-59f-423c-205-c6181ea81b"
    address: "XX.XX.XX.YY"
    vcenter_username: "user-name"
    vcenter_password: "password"
    update_password: "always"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove a vcenter
  dellemc.powerstore.vcenter:
    array_ip: "{{array_ip}}"
    user: "{{user}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    vcenter_id: "24d333-59f-423c-205-c6181ea81b"
    delete_vasa_provider: true
    state: "absent"

Inputs

    
port:
    description:
    - Port number for the PowerStore array.
    - If not passed, it will take 443 as default.
    type: int

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

state:
    choices:
    - present
    - absent
    default: present
    description:
    - The state of the vCenter instance after the task is performed.
    - For get, create, and modify operations it should be set to C(present).
    type: str

address:
    description:
    - IP address of vCenter, in IPv4, IPv6, hostname format.
    - Mandatory while adding a vCenter.
    - To modify the address, a new address of the same vCenter must be passed.
    type: str

timeout:
    default: 120
    description:
    - Time after which the connection will get terminated.
    - It is to be mentioned in seconds.
    type: int

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

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

vcenter_id:
    description:
    - Unique identifier of the vCenter instance.
    type: str

validate_certs:
    aliases:
    - verifycert
    default: true
    description:
    - Boolean variable to specify whether to validate SSL certificate or not.
    - C(true) - indicates that the SSL certificate should be verified. Set the environment
      variable REQUESTS_CA_BUNDLE to the path of the SSL certificate.
    - C(false) - indicates that the SSL certificate should not be verified.
    type: bool

update_password:
    choices:
    - always
    - on_create
    default: always
    description:
    - This parameter controls the way the I(vcenter_password) is updated during addition
      and modification of the vCenter.
    - C(always) will update password for each execution.
    - C(on_create) will only set while adding a vCenter or modifying the I(vcenter_username.)
    - For modifying I(vcenter_password), set the I(update_password) to C(always).
    type: str

vcenter_password:
    description:
    - Password to login to vcenter.
    - Mandatory while adding a vCenter.
    type: str

vcenter_username:
    description:
    - User name to login to vcenter.
    - Mandatory while adding a vCenter.
    - I(vcenter_password) needs to be provided to modify the user name.
    type: str

delete_vasa_provider:
    description:
    - Whether to remove VASA provider.
    - When C(true), remove the VASA provider from vCenter. This will only happen if provider
      is not connected to any other PowerStore system.
    - C(false) is the API default.
    type: bool

vasa_provider_credentials:
    description:
    - Credentials required for registering VASA vendor provider.
    suboptions:
      password:
        description:
        - Password of the local user account which will be used by vSphere to register
          VASA provider.
        - Mandatory while registering VASA provider.
        required: true
        type: str
      username:
        description:
        - Username of the local user account which will be used by vSphere to register
          VASA provider.
        - Mandatory while registering VASA provider.
        required: true
        type: str
    type: dict

Outputs

changed:
  description: Shows whether or not the resource has changed.
  returned: always
  sample: 'false'
  type: bool
vcenter_details:
  contains:
    address:
      description: IP address of vCenter hosts, in IPv4, IPv6 or hostname format.
      type: str
    datastores:
      description: Data stores that exist on a specific vCenter. Was added in PowerStore
        version 3.0.0.0.
      type: list
    id:
      description: Unique identifier of vCenter instance.
      type: str
    instance_uuid:
      description: UUID instance of vCenter.
      type: str
    username:
      description: User name to login to vCenter.
      type: str
    vendor_provider_status:
      description: General status of the VASA vendor provider in vCenter.
      type: list
    vendor_provider_status_l10n:
      description: Localized message string corresponding to vendor_provider_status.
      type: str
    version:
      description: Version of vCenter including its build number. Was added in PowerStore
        version 3.0.0.0.
      type: str
    virtual_machines:
      description: Virtual machines associated with vCenter.
      type: list
    vsphere_host:
      description: All the vSphere hosts that exist on a specific vCenter. Was added
        in PowerStore version 3.0.0.0.
      type: list
  description: Details of the vCenter instance.
  returned: When vCenter exists.
  sample:
    address: 10.x.x.x
    datastores: []
    id: 0d330d6c-3fe6-41c6-8023-5bd3fa7c61cd
    instance_uuid: c4c14fbb-828b-40f3-99bb-5bd4db723516
    username: administrator
    vendor_provider_status: Online
    vendor_provider_status_l10n: Online
    version: 7.0.3
    virtual_machines: []
    vsphere_host: []
  type: complex