ibm.spectrum_virtualize.ibm_svc_manage_callhome module – This module manages Call Home feature configuration on IBM Spectrum Virtualize family storage systems
Note
This module is part of the ibm.spectrum_virtualize collection (version 2.0.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install ibm.spectrum_virtualize
.
To use it in a playbook, specify: ibm.spectrum_virtualize.ibm_svc_manage_callhome
.
Note
The ibm.spectrum_virtualize collection has been renamed to ibm.storage_virtualize and will be removed from Ansible 12. The content of ibm.spectrum_virtualize will be replaced by redirects to ibm.storage_virtualize in Ansible 10. If you use content from ibm.spectrum_virtualize, please update FQCNs in your playbooks and roles! When creating new playbooks or roles, directly use content from ibm.storage_virtualize instead.
New in ibm.spectrum_virtualize 1.7.0
Synopsis
Ansible interface to manage cloud and email Call Home feature.
Parameters
Parameter |
Comments |
---|---|
Specifies the first line of the user’s address as it should appear in Call Home email. Required when state=enabled. |
|
Specifies the transmission type. Choices:
|
|
Specifies that sensitive data is deleted from the enhanced Call Home data. Applies when state=enabled. If unspecified, default value ‘off’ will be used. Choices:
|
|
Specifies the user’s city as it should appear in Call Home email. Required when state=enabled. |
|
The hostname or management IP of the Spectrum Virtualize storage system. |
|
Specifies the user’s organization as it should appear in Call Home email. Required when state=enabled. |
|
Specifies the email of the person. Required when state=enabled. |
|
Specifies the name of the person receiving the email. Required when state=enabled. |
|
Specifies the country in which the machine resides as it should appear in Call Home email. Required when state=enabled. |
|
Domain for the Spectrum Virtualize storage system. Valid when hostname is used for the parameter clustername. |
|
Specifies that the Call Home function is to send enhanced reports to the support center. Applies when state=enabled. If unspecified, default value ‘off’ will be used. Choices:
|
|
Specifies the interval at which inventory emails are sent to the configured email recipients. The interval is measured in days. The value must be in the range 0 - 15. Setting the value to ‘0’ turns off the inventory email notification function. Valid if inventory is set to ‘on’. |
|
Specifies whether the recipient mentioned in parameter contact_email receives inventory email notifications. Applies when state=enabled. If unspecified, default value ‘off’ will be used. Choices:
|
|
Specifies the physical location of the system that has reported the error. Required when state=enabled. |
|
Path of debug log file. |
|
REST API password for the Spectrum Virtualize storage system. The parameters username and password are required if not using token to authenticate a user. |
|
Specifies the primary contact telephone number. Required when state=enabled. |
|
Specifies the secondary contact telephone number. Required when state=enabled. |
|
Specifies the user’s zip code or postal code as it should appear in Call Home email. Required when state=enabled. |
|
Specifies the user’s state or province as it should appear in Call Home email. Required when state=enabled. |
|
Specifies the proxy’s password. Applies when state=enabled and proxy_type=basic_authentication. |
|
Specifies the proxy server port number. The value must be in the range 1 - 65535. Applies when state=enabled and proxy_type=open_proxy or proxy_type=basic_authentication. |
|
Specifies the proxy type. Required when state=enabled, to create or modify Call Home feature. Proxy gets deleted for proxy_type=no_proxy. The parameter is mandatory when callhome_type=’cloud services’) or callhome_type=’both’. Choices:
|
|
Specifies the proxy server URL with a protocol prefix in fully qualified domain name format. Applies when state=enabled and proxy_type=open_proxy or proxy_type=basic_authentication. |
|
Specifies the proxy’s username. Applies when state=enabled and proxy_type=basic_authentication. |
|
Specifies the IP address of the email server. Required when state=enabled and callhome_type=email or callhome_type=both. |
|
Specifies the port number of the email server. The value must be in the range 1 - 65535. Required when state=enabled and callhome_type=email or callhome_type=both. |
|
Specifies the file path of proxy’s certificate. Applies when state=enabled and proxy_type=certificate. |
|
Enables or updates ( Choices:
|
|
The authentication token to verify a user on the Spectrum Virtualize storage system. To generate a token, use the ibm_svc_auth module. |
|
REST API username for the Spectrum Virtualize storage system. The parameters username and password are required if not using token to authenticate a user. |
|
Validates certification. Choices:
|
Notes
Note
This module supports
check_mode
.
Examples
- name: Configure callhome with both email and cloud
ibm.spectrum_virtualize.ibm_svc_manage_callhome:
clustername: "{{ clustername }}"
username: "{{ username }}"
password: "{{ password }}"
log_path: "/tmp/playbook.debug"
state: "enabled"
callhome_type: "both"
address: "{{ address }}"
city: "{{ city }}"
company_name: "{{ company_name }}"
contact_email: "{{ contact_email }}"
contact_name: "{{ contact_name }}"
country: "{{ country }}"
location: "{{ location }}"
phonenumber_primary: "{{ primary_phonenumber }}"
postalcode: "{{ postal_code }}"
province: "{{ province }}"
proxy_type: "{{ proxy_type }}"
proxy_url: "{{ proxy_url }}"
proxy_port: "{{ proxy_port }}"
serverIP: "{{ server_ip }}"
serverPort: "{{ server_port }}"
inventory: "on"
invemailinterval: 1
enhancedcallhome: "on"
censorcallhome: "on"