dellemc.vxrail.dellemc_vxrail_system_get_proxy (2.2.0) — module

Retrieve VxRail System Proxy Settings

| "added in version" 1.4.0 of dellemc.vxrail"

Authors: VxRail Development Team(@VxRailDevTeam) <ansible.team@dell.com>

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 retrieve the VxRail System Proxy Settings.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Get VxRail System Proxy Information
    dellemc_vxrail_system_get_proxy:
        vxmip: "{{ vxmip }}"
        vcadmin: "{{ vcadmin }}"
        vcpasswd: "{{ vcpasswd }}"
        api_version_number: "{{ api_version_number }}"
        timeout : "{{ timeout }}"

Inputs

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

timeout:
    default: 60
    description: Time out value for getting proxy information, the default value is 60
      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

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

Outputs

System_Proxy_Info:
  description: The retrieved VxRail system proxy information
  returned: always
  sample: "{\n    \"server\": \"192.168.106.108\",\n    \"port\": 3128,\n    \"username\"\
    : \"proxyclient\",\n    \"type\": \"SOCKS\",\n    \"socks_version\": 5\n}"
  type: dict