ibm.storage_virtualize.ibm_svc_manage_callhome (2.3.1) — module

Install collection

Install with ansible-galaxy collection install ibm.storage_virtualize:==2.3.1

Add to requirements.yml

  collections:
    - name: ibm.storage_virtualize
      version: 2.3.1

Description

Ansible interface to manage cloud and email Call Home feature.

Usage examples

Scanned by Steampunk Spotter

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

- name: Configure callhome with both email and cloud
  ibm.storage_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"

Inputs

    
city:
    description:
    - Specifies the user's city as it should appear in Call Home email.
    - Required when I(state=enabled).
    type: str

state:
    choices:
    - enabled
    - disabled
    description:
    - Enables or updates (C(enabled)) or disables (C(disabled)) Call Home feature.
    required: true
    type: str

token:
    description:
    - The authentication token to verify a user on the Storage Virtualize system.
    - To generate a token, use the ibm_svc_auth module.
    type: str

domain:
    description:
    - Domain for the Storage Virtualize system.
    - Valid when hostname is used for the parameter I(clustername).
    type: str

address:
    description:
    - Specifies the first line of the user's address as it should appear in Call Home
      email.
    - Required when I(state=enabled).
    type: str

country:
    description:
    - Specifies the country in which the machine resides as it should appear in Call Home
      email.
    - Required when I(state=enabled).
    type: str

sslcert:
    description:
    - Specifies the file path of proxy's certificate.
    - Applies when I(state=enabled) and I(proxy_type=certificate).
    type: str

location:
    description:
    - Specifies the physical location of the system that has reported the error.
    - Required when I(state=enabled).
    type: str

log_path:
    description:
    - Path of debug log file.
    type: str

password:
    description:
    - REST API password for the Storage Virtualize system.
    - The parameters I(username) and I(password) are required if not using I(token) to
      authenticate a user.
    type: str

province:
    description:
    - Specifies the user's state or province as it should appear in Call Home email.
    - Required when I(state=enabled).
    type: str

serverIP:
    description:
    - Specifies the IP address of the email server.
    - Required when I(state=enabled) and I(callhome_type=email) or I(callhome_type=both).
    type: str

username:
    description:
    - REST API username for the Storage Virtualize system.
    - The parameters I(username) and I(password) are required if not using I(token) to
      authenticate a user.
    type: str

inventory:
    choices:
    - 'on'
    - 'off'
    description:
    - Specifies whether the recipient mentioned in parameter I(contact_email) receives
      inventory email notifications.
    - Applies when I(state=enabled). If unspecified, default value 'off' will be used.
    type: str

proxy_url:
    description:
    - Specifies the proxy server URL with a protocol prefix in fully qualified domain
      name format.
    - Applies when I(state=enabled) and I(proxy_type=open_proxy) or I(proxy_type=basic_authentication).
    type: str

postalcode:
    description:
    - Specifies the user's zip code or postal code as it should appear in Call Home email.
    - Required when I(state=enabled).
    type: str

proxy_port:
    description:
    - Specifies the proxy server port number. The value must be in the range 1 - 65535.
    - Applies when I(state=enabled) and I(proxy_type=open_proxy) or I(proxy_type=basic_authentication).
    type: int

proxy_type:
    choices:
    - open_proxy
    - basic_authentication
    - certificate
    - no_proxy
    description:
    - Specifies the proxy type.
    - Required when I(state=enabled), to create or modify Call Home feature.
    - Proxy gets deleted for I(proxy_type=no_proxy).
    - The parameter is mandatory when I(callhome_type='cloud services')) or I(callhome_type='both').
    type: str

serverPort:
    description:
    - Specifies the port number of the email server.
    - The value must be in the range 1 - 65535.
    - Required when I(state=enabled) and I(callhome_type=email) or I(callhome_type=both).
    type: int

clustername:
    description:
    - The hostname or management IP of the Storage Virtualize system.
    required: true
    type: str

company_name:
    description:
    - Specifies the user's organization as it should appear in Call Home email.
    - Required when I(state=enabled).
    type: str

contact_name:
    description:
    - Specifies the name of the person receiving the email.
    - Required when I(state=enabled).
    type: str

callhome_type:
    choices:
    - cloud services
    - email
    - both
    description:
    - Specifies the transmission type.
    required: true
    type: str

contact_email:
    description:
    - Specifies the email of the person.
    - Required when I(state=enabled).
    type: str

censorcallhome:
    choices:
    - 'on'
    - 'off'
    description:
    - Specifies that sensitive data is deleted from the enhanced Call Home data.
    - Applies when I(state=enabled).
    - If unspecified, default value 'off' will be used.
    type: str

proxy_password:
    description:
    - Specifies the proxy's password.
    - Applies when I(state=enabled) and I(proxy_type=basic_authentication).
    type: str

proxy_username:
    description:
    - Specifies the proxy's username.
    - Applies when I(state=enabled) and I(proxy_type=basic_authentication).
    type: str

validate_certs:
    default: false
    description:
    - Validates certification.
    type: bool

enhancedcallhome:
    choices:
    - 'on'
    - 'off'
    description:
    - Specifies that the Call Home function is to send enhanced reports to the support
      center.
    - Applies when I(state=enabled).
    - If unspecified, default value 'off' will be used.
    type: str

invemailinterval:
    description:
    - 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 I(inventory) is set to 'on'.
    type: int

phonenumber_primary:
    description:
    - Specifies the primary contact telephone number.
    - Required when I(state=enabled).
    type: str

phonenumber_secondary:
    description:
    - Specifies the secondary contact telephone number.
    - Required when I(state=enabled).
    type: str