dellemc.powerstore.ntp (3.2.0) — module

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

Performs all NTP operations on a PowerStore Storage System. This module supports get details of an existing NTP instance. You can modify existing NTP instance with supported parameters.

Requirements

• A Dell PowerStore storage system version 3.0.0.0 or later.
• Ansible-core 2.14 or later.
• PyPowerStore 3.1.0.
• Python 3.9, 3.10 or 3.11.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get details of NTP instance
  dellemc.powerstore.ntp:
    array_ip: "{{array_ip}}"
    user: "{{user}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    ntp_id: "NTP1"
    state: "present"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Add addresses to NTP instance
  dellemc.powerstore.ntp:
    array_ip: "{{array_ip}}"
    user: "{{user}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    ntp_id: "NTP1"
    ntp_addresses:
      - "XX.XX.XX.XX"
      - "YY.YY.YY.YY"
    ntp_address_state: "present-in-ntp"
    state: "present"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Remove addresses from NTP instance
  dellemc.powerstore.ntp:
    array_ip: "{{array_ip}}"
    user: "{{user}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    ntp_id: "NTP1"
    ntp_addresses:
      - "YY.YY.YY.YY"
    ntp_address_state: "absent-in-ntp"
    state: "present"

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
    description:
    - The state of the NTP instance after the task is performed.
    - For get and modify operations it should be set to C(present).
    required: true
    type: str

ntp_id:
    description:
    - Unique identifier of the NTP instance.
    required: true
    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

ntp_addresses:
    description:
    - NTP server addresses, may contain host names or IPv4 addresses.
    elements: str
    type: list

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

ntp_address_state:
    choices:
    - present-in-ntp
    - absent-in-ntp
    description:
    - State of the addresses mentioned in I(ntp_addresses).
    type: str

Outputs

changed:
  description: Shows whether or not the resource has changed.
  returned: always
  sample: 'false'
  type: bool
ntp_details:
  contains:
    addresses:
      description: NTP server addresses, may contain host names or IPv4 addresses.
      type: str
    id:
      description: Unique identifier of NTP instance.
      type: str
  description: Details of the NTP instance.
  returned: When NTP exists.
  sample:
    addresses:
    - 1.2.3.4
    - 5.6.7.8
    id: NTP1
  type: complex