Try SpotterManages general settings for PowerScale storage system
| "added in version" 1.4.0 of dellemc.powerscale"
Authors: Meenakshi Dembi (@dembim) <ansible.team@dell.com>
preview | supported by community
Install with ansible-galaxy collection install dellemc.powerscale:==1.4.0
collections:
- name: dellemc.powerscale
version: 1.4.0Managing general settings on the PowerScale storage system which includes get and update operations for email settings and add, remove and get operations for NTP servers.
- name: Get email settings
dellemc_powerscale_settings:
onefs_host: "{{onefs_host}}"
api_user: "{{api_user}}"
api_password: "{{api_password}}"
verify_ssl: "{{verify_ssl}}"
email_settings: "{{email_settings}}"
state: "{{state_present}}"
- name: Update email settings
dellemc_powerscale_settings:
onefs_host: "{{onefs_host}}"
api_user: "{{api_user}}"
api_password: "{{api_password}}"
verify_ssl: "{{verify_ssl}}"
state: "{{state_present}}"
mail_relay: "mailrelay.itp.dell.com"
mail_sender: "lab-a2@dell.com"
mail_subject: "lab-a2-alerts"
- name: Add NTP server
dellemc_powerscale_settings:
onefs_host: "{{onefs_host}}"
api_user: "{{api_user}}"
api_password: "{{api_password}}"
verify_ssl: "{{verify_ssl}}"
ntp_servers:
- "10.106.**.***"
- "10.106.**.***"
state: "{{state_present}}"
- name: Add NTP server - Idempotency
dellemc_powerscale_settings:
onefs_host: "{{onefs_host}}"
api_user: "{{api_user}}"
api_password: "{{api_password}}"
verify_ssl: "{{verify_ssl}}"
ntp_servers:
- "10.106.**.***"
- "10.106.**.***"
state: "{{state_present}}"
- name: Get NTP server
dellemc_powerscale_settings:
onefs_host: "{{onefs_host}}"
api_user: "{{api_user}}"
api_password: "{{api_password}}"
verify_ssl: "{{verify_ssl}}"
ntp_server_id: "10.106.**.***"
state: "{{state_present}}"
- name: Remove NTP server
dellemc_powerscale_settings:
onefs_host: "{{onefs_host}}"
api_user: "{{api_user}}"
api_password: "{{api_password}}"
verify_ssl: "{{verify_ssl}}"
ntp_servers:
- "10.106.**.***"
- "10.106.**.***"
state: "{{state_absent}}"
- name: Remove NTP server - Idempotency
dellemc_powerscale_settings:
onefs_host: "{{onefs_host}}"
api_user: "{{api_user}}"
api_password: "{{api_password}}"
verify_ssl: "{{verify_ssl}}"
ntp_servers:
- "10.106.**.***"
- "10.106.**.***"
state: "{{state_absent}}"
- name: Update email settings and add NTP server
dellemc_powerscale_settings:
onefs_host: "{{onefs_host}}"
api_user: "{{api_user}}"
api_password: "{{api_password}}"
verify_ssl: "{{verify_ssl}}"
state: "{{state_present}}"
mail_relay: "mailrelay.itp.dell.com"
mail_sender: "lab-a2@dell.com"
mail_subject: "lab-a2-alerts"
ntp_servers:
- "10.106.**.***"
- "10.106.**.***"
state:
choices:
- absent
- present
description:
- The state option is used to mention the existence of pool.
required: true
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
mail_relay:
description:
- The address of the SMTP server to be used for relaying the notification messages.
- An SMTP server is required in order to send notifications.
- If this str is empty, no emails will be sent.
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
mail_sender:
description:
- The full email address that will appear as the sender of notification messages.
type: str
ntp_servers:
description:
- List of NTP servers which need to be configured.
elements: str
type: list
api_password:
description:
- the password of the PowerScale cluster.
required: true
type: str
mail_subject:
description:
- The subject line for notification messages from this cluster.
type: str
ntp_server_id:
description:
- ID of NTP server.
type: str
email_settings:
description:
- This is an addition flag to view the email settings.
type: bool
changed:
description: Whether or not the resource has changed
returned: Always
type: bool
settings:
contains:
batch_mode:
description: This setting determines how notifications will be batched together
to be sent by email.
type: str
id:
description: Field id.
type: str
key:
description: Key value from key_file that maps to this server.
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
name:
description: NTP server name.
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 email settings.
returned: Always
type: complex