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 1.10.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.

New in ibm.spectrum_virtualize 1.7.0

Synopsis

  • Ansible interface to manage cloud and email Call Home feature.

Parameters

Parameter

Comments

address

string

Specifies the first line of the user’s address as it should appear in Call Home email.

Required when state=enabled.

callhome_type

string / required

Specifies the transmission type.

Choices:

  • "cloud services"

  • "email"

  • "both"

censorcallhome

string

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:

  • "on"

  • "off"

city

string

Specifies the user’s city as it should appear in Call Home email.

Required when state=enabled.

clustername

string / required

The hostname or management IP of the Spectrum Virtualize storage system.

company_name

string

Specifies the user’s organization as it should appear in Call Home email.

Required when state=enabled.

contact_email

string

Specifies the email of the person.

Required when state=enabled.

contact_name

string

Specifies the name of the person receiving the email.

Required when state=enabled.

country

string

Specifies the country in which the machine resides as it should appear in Call Home email.

Required when state=enabled.

domain

string

Domain for the Spectrum Virtualize storage system.

Valid when hostname is used for the parameter clustername.

enhancedcallhome

string

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:

  • "on"

  • "off"

invemailinterval

integer

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’.

inventory

string

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:

  • "on"

  • "off"

location

string

Specifies the physical location of the system that has reported the error.

Required when state=enabled.

log_path

string

Path of debug log file.

password

string

REST API password for the Spectrum Virtualize storage system.

The parameters username and password are required if not using token to authenticate a user.

phonenumber_primary

string

Specifies the primary contact telephone number.

Required when state=enabled.

phonenumber_secondary

string

Specifies the secondary contact telephone number.

Required when state=enabled.

postalcode

string

Specifies the user’s zip code or postal code as it should appear in Call Home email.

Required when state=enabled.

province

string

Specifies the user’s state or province as it should appear in Call Home email.

Required when state=enabled.

proxy_password

string

Specifies the proxy’s password.

Applies when state=enabled and proxy_type=basic_authentication.

proxy_port

integer

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.

proxy_type

string

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:

  • "open_proxy"

  • "basic_authentication"

  • "certificate"

  • "no_proxy"

proxy_url

string

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.

proxy_username

string

Specifies the proxy’s username.

Applies when state=enabled and proxy_type=basic_authentication.

serverIP

string

Specifies the IP address of the email server.

Required when state=enabled and callhome_type=email or callhome_type=both.

serverPort

integer

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.

sslcert

string

Specifies the file path of proxy’s certificate.

Applies when state=enabled and proxy_type=certificate.

state

string / required

Enables or updates (enabled) or disables (disabled) Call Home feature.

Choices:

  • "enabled"

  • "disabled"

token

string

The authentication token to verify a user on the Spectrum Virtualize storage system.

To generate a token, use the ibm_svc_auth module.

username

string

REST API username for the Spectrum Virtualize storage system.

The parameters username and password are required if not using token to authenticate a user.

validate_certs

boolean

Validates certification.

Choices:

  • false ← (default)

  • true

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"

Authors

  • Sreshtant Bohidar(@Sreshtant-Bohidar)