dellemc.vxrail.dellemc_vxrail_callhome_enable (2.2.0) — module

Install collection

Install with ansible-galaxy collection install dellemc.vxrail:==2.2.0

Add to requirements.yml

  collections:
    - name: dellemc.vxrail
      version: 2.2.0

Description

This module will enable call home functionality by enabling remote connectivity service.

Usage examples

Scanned by Steampunk Spotter

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

  - name: Enable call home functionality
    dellemc_vxrail_callhome_enable:
        vxmip: "{{ vxmip }}"
        vcadmin: "{{ vcadmin }}"
        vcpasswd: "{{ vcpasswd }}"
        serial_number: "{{ serial_number }}"
        connection_type: "{{ connection_type }}"
        pin: "{{ pin }}"
        access_key: "{{ access_key }}"
        proxy_type: "{{ proxy_type }}"
        proxy_protocol: "{{ proxy_protocol }}"
        proxy_address: "{{ proxy_address }}"
        proxy_port: "{{ proxy_port }}"
        proxy_user: "{{ proxy_user }}"
        proxy_passwd: "{{ proxy_passwd }}"
        gateways_host: "{{ gateways_host }}"
        gateways_port: "{{ gateways_port }}"
        customer_contact_order: "{{ customer_contact_order }}"
        customer_first_name: "{{ customer_first_name }}"
        customer_last_name: "{{ customer_last_name }}"
        customer_phone_number: "{{ customer_phone_number }}"
        customer_email_address: "{{ customer_email_address }}"
        customer_pref_language: "{{ customer_pref_language }}"
        timeout: "{{ timeout }}"
        api_version_number: "{{ api_version_number }}"

Inputs

    
pin:
    description: the PIN code
    required: false
    type: str

vxmip:
    description: The IP address of the VxRail Manager System
    required: true
    type: str

timeout:
    default: 300
    description: Time out value for enabling callhome, the default value is 300 seconds
    required: false
    type: int

vcadmin:
    description: Administrative account of the vCenter Server the VxRail Manager is registered
      to
    required: true
    type: str

vcpasswd:
    description: The password for the administrator account provided in vcadmin
    required: true
    type: str

access_key:
    description: the access key
    required: false
    type: str

proxy_port:
    description: The port of proxy
    required: false
    type: str

proxy_type:
    description: The type of proxy, allowed values is USER,SYSTEM and NA
    required: false
    type: str

proxy_user:
    description: The user account of the proxy
    required: false
    type: str

proxy_passwd:
    description: The password for the user account provided in proxy
    required: false
    type: str

gateways_host:
    description: The host ip of gateways
    required: false
    type: str

gateways_port:
    description: The port of gateways
    required: false
    type: str

proxy_address:
    description: The address of proxy
    required: false
    type: str

serial_number:
    description: The node serial number for ESE enablement
    required: true
    type: str

proxy_protocol:
    description: The protocol of proxy, allowed values is SOCK5, HTTP and HTTPS
    required: false
    type: str

connection_type:
    description: The connection type of callhome, allowed values is DIRECT and GATEWAY
    required: true
    type: str

api_version_number:
    description: A specific version number to use for the API call. If not included, will
      use the highest version by default
    required: false
    type: int

customer_last_name:
    description: The last name of customer
    required: false
    type: str

customer_first_name:
    description: The first name of customer
    required: false
    type: str

customer_phone_number:
    description: The phone_number of customer
    required: false
    type: str

customer_contact_order:
    description: The contact order of customer
    required: false
    type: int

customer_email_address:
    description: The email address of customer
    required: false
    type: str

customer_pref_language:
    description: The preferred language of customer
    required: false
    type: str

Outputs

Enable_Callhome_API:
  description: Enable call home functionality
  returned: always
  sample: "{\n  \"message\": \"Callhome is enabled successfully.\"\n}"
  type: dict