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>
Install with ansible-galaxy collection install dellemc.powerscale:==3.0.0
collections:
- name: dellemc.powerscale
version: 3.0.0Managing general settings on the PowerScale storage system which includes the following.
Get and update operations for email settings.
Add remove and get operations for NTP servers.
Get and update operation for cluster identity.
Get and update operation for cluster owner.
- name: Get email settings
dellemc.powerscale.settings:
onefs_host: "{{onefs_host}}"
api_user: "{{api_user}}"
api_password: "{{api_password}}"
verify_ssl: "{{verify_ssl}}"
- 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: 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: 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.**.***"
- name: Update cluster owner details
dellemc.powerscale.settings:
onefs_host: "{{onefs_host}}"
api_user: "{{api_user}}"
api_password: "{{api_password}}"
verify_ssl: "{{verify_ssl}}"
state: "{{state_present}}"
company: "Test company"
location: "Test location"
primary_contact:
name: "primary_name11"
phone1: "primary_phone11"
phone2: "primary_phone21"
email: "primary_email1@email.com"
secondary_contact:
name: "secondary_name11"
phone1: "secondary_phone11"
phone2: "secondary_phone21"
email: "secondary_email1@email.com"
- name: Update cluster identity details
dellemc.powerscale.settings:
onefs_host: "{{onefs_host}}"
api_user: "{{api_user}}"
api_password: "{{api_password}}"
verify_ssl: "{{verify_ssl}}"
state: "{{state_present}}"
name: "PIE-IsilonS-24241-Cluster"
description: "This is new description for the cluster"
logon_details:
message_title: "This is the new title"
description: "This is new description"
- name: Update all settings
dellemc.powerscale.settings:
onefs_host: "{{onefs_host}}"
api_user: "{{api_user}}"
api_password: "{{api_password}}"
verify_ssl: "{{verify_ssl}}"
state: "{{state_present}}"
name: "PIE-IsilonS-24241-Cluster"
description: "This is new description for the cluster"
logon_details:
message_title: "This is the new title"
description: "This is new description"
company: "Test company"
location: "Test location"
primary_contact:
name: "primary_name11"
phone1: "primary_phone11"
phone2: "primary_phone21"
email: "primary_email1@email.com"
secondary_contact:
name: "secondary_name11"
phone1: "secondary_phone11"
phone2: "secondary_phone21"
email: "secondary_email1@email.com"
mail_relay: "mailrelay.itp.dell.com"
mail_sender: "lab-a2@dell.com"
mail_subject: "lab-a2-alerts"
ntp_servers:
- "10.106.**.***"
- "10.106.**.***"
name:
description:
- Name of PowerScale Cluster.
type: str
state:
choices:
- absent
- present
default: present
description:
- The state option is used to mention the existence of pool.
type: str
company:
description:
- Name of the company.
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
location:
description:
- Location of the company.
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.
- C(true) - indicates that the SSL certificate should be verified.
- C(false) - indicates that the SSL certificate should not be verified.
required: true
type: bool
description:
description:
- Description of PowerScale Cluster.
type: str
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
logon_details:
description:
- Details related to login to the Powerscale Cluster.
suboptions:
description:
description:
- Message description to be shown on the login screen.
type: str
message_title:
description:
- Message to be shown on the login screen.
type: str
type: dict
ntp_server_id:
description:
- ID of NTP server.
type: str
email_settings:
description:
- (deprecated) This is an addition flag to view the email settings.
- This option is deprecated and will be removed in the later version.
type: bool
primary_contact:
description:
- Contact details of primary system admin.
suboptions:
email:
description:
- Email of primary system admin.
type: str
name:
description:
- Name of primary system admin.
type: str
phone1:
description:
- Phone1 of primary system admin.
type: str
phone2:
description:
- Phone2 of primary system admin.
type: str
type: dict
secondary_contact:
description:
- Contact details of secondary system admin.
suboptions:
email:
description:
- Email of secondary system admin.
type: str
name:
description:
- Name of secondary system admin.
type: str
phone1:
description:
- Phone1 of secondary system admin.
type: str
phone2:
description:
- Phone2 of secondary system admin.
type: str
type: dict
changed:
description: Whether or not the resource has changed.
returned: Always
sample: 'false'
type: bool
cluster_identity:
contains:
description:
description: Description of PowerScale cluster.
type: str
logon:
contains:
motd:
description: Details of logon message.
type: str
motd_header:
description: Details of logon message title.
type: str
description: Details of logon message shown on Powerscale login screen.
type: dict
mttdl_level_msg:
description: mttdl_level_msg.
type: str
name:
description: Name of PowerScale cluster.
type: str
description: Details related to cluster identity.
returned: Always
sample:
cluster_identity:
description: asdadasdasdasdadadadds
logon:
motd: This is new description
motd_header: This is the new title
mttdl_level_msg: none
name: PIE-IsilonS-24241-Clusterwrerwerwrewr
type: dict
cluster_owner:
contains:
company:
description: Name of the company.
type: str
location:
description: Location of the company.
type: str
primary_email:
description: Email of primary system admin.
type: str
primary_name:
description: Name of primary system admin.
type: str
primary_phone1:
description: Phone1 of primary system admin.
type: str
primary_phone2:
description: Phone2 of primary system admin.
type: str
secondary_email:
description: Email of secondary system admin.
type: str
secondary_name:
description: Name of secondary system admin.
type: str
secondary_phone1:
description: Phone1 of secondary system admin.
type: str
secondary_phone2:
description: Phone2 of secondary system admin.
type: str
description: Details related to cluster identity.
returned: Always
sample:
cluster_owner:
company: Test company
location: Test location
primary_email: primary_email@email.com
primary_name: primary_name
primary_phone1: primary_phone1
primary_phone2: primary_phone2
secondary_email: secondary_email@email.com
secondary_name: secondary_name
secondary_phone1: secondary_phone1
secondary_phone2: secondary_phone2
type: dict
email_settings:
contains:
settings:
contains:
batch_mode:
description: This setting determines how notifications will be batched together
to be sent by email.
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
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 settings.
returned: Always
type: dict
description: Details of the email settings.
returned: Always
sample:
settings:
batch_mode: none
mail_relay: 10.**.**.**
mail_sender: powerscale@dell.com
mail_subject: Powerscale Cluster notifications
smtp_auth_passwd_set: false
smtp_auth_security: none
smtp_auth_username: ''
smtp_port: 25
use_smtp_auth: false
user_template: ''
type: dict
ntp_servers:
contains:
servers:
contains:
id:
description: Field id.
type: str
key:
description: Key value from I(key_file) that maps to this server.
type: str
name:
description: NTP server name.
type: str
description: List of servers.
type: list
description: List of NTP servers.
returned: Always
sample:
servers:
- id: 10.**.**.**
key: null
name: 10.**.**.**
type: dict