community.vmware.vmware_vcenter_settings_info (4.2.0) — module

Install collection

Install with ansible-galaxy collection install community.vmware:==4.2.0

Add to requirements.yml

  collections:
    - name: community.vmware
      version: 4.2.0

Description

This module can be used to gather information about vCenter settings.

Usage examples

Scanned by Steampunk Spotter

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

- name: "Gather info about vCenter settings"
  community.vmware.vmware_vcenter_settings_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
  register: vcenter_settings_info

Scanned by Steampunk Spotter

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

- name: "Gather some info from vCenter using the vSphere API output schema"
  community.vmware.vmware_vcenter_settings_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    schema: vsphere
    properties:
      - config.workflow.port
  register: vcenter_settings_info_vsphere_api

Inputs

    
port:
    default: 443
    description:
    - The port number of the vSphere vCenter or ESXi server.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_PORT)
      will be used instead.
    type: int

schema:
    choices:
    - summary
    - vsphere
    default: summary
    description:
    - Specify the output schema desired.
    - The 'summary' output schema is the legacy output from the module.
    - The 'vsphere' output schema is the vSphere API class definition which requires pyvmomi>6.7.1.
    type: str

hostname:
    description:
    - The hostname or IP address of the vSphere vCenter or ESXi server.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_HOST)
      will be used instead.
    type: str

password:
    aliases:
    - pass
    - pwd
    description:
    - The password of the vSphere vCenter or ESXi server.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_PASSWORD)
      will be used instead.
    type: str

username:
    aliases:
    - admin
    - user
    description:
    - The username of the vSphere vCenter or ESXi server.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_USER)
      will be used instead.
    type: str

properties:
    description:
    - Specify the properties to retrieve.
    - 'Example:'
    - '   properties: ['
    - '      "config.workflow.port"'
    - '   ]'
    - Only valid when O(schema=vsphere).
    elements: str
    type: list

proxy_host:
    description:
    - Address of a proxy that will receive all HTTPS requests and relay them.
    - The format is a hostname or a IP.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_PROXY_HOST)
      will be used instead.
    required: false
    type: str

proxy_port:
    description:
    - Port of the HTTP proxy that will receive all HTTPS requests and relay them.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_PROXY_PORT)
      will be used instead.
    required: false
    type: int

validate_certs:
    default: true
    description:
    - Allows connection when SSL certificates are not valid. Set to V(false) when certificates
      are not trusted.
    - If the value is not specified in the task, the value of environment variable E(VMWARE_VALIDATE_CERTS)
      will be used instead.
    type: bool

Outputs

vcenter_config_info:
  description: dict of vCenter settings
  returned: success
  sample: "{\n    \"db_event_cleanup_previous\": true,\n    \"db_event_retention_previous\"\
    : 30,\n    \"db_max_connections_previous\": 50,\n    \"db_task_cleanup_previous\"\
    : true,\n    \"db_task_retention_previous\": 30,\n    \"directory_query_limit_previous\"\
    : true,\n    \"directory_query_limit_size_previous\": 5000,\n    \"directory_timeout_previous\"\
    : 60,\n    \"directory_validation_period_previous\": 1440,\n    \"directory_validation_previous\"\
    : true,\n    \"logging_options_previous\": \"info\",\n    \"mail_sender_previous\"\
    : \"\",\n    \"mail_server_previous\": \"\",\n    \"runtime_managed_address_previous\"\
    : \"\",\n    \"runtime_server_name_previous\": \"vcenter.local\",\n    \"runtime_unique_id_previous\"\
    : 48,\n    \"snmp_1_community_previous\": \"public\",\n    \"snmp_1_enabled_previous\"\
    : true,\n    \"snmp_1_url_previous\": \"localhost\",\n    \"snmp_2_community_previous\"\
    : \"\",\n    \"snmp_2_enabled_previous\": false,\n    \"snmp_2_url_previous\"\
    : \"\",\n    \"snmp_3_community_previous\": \"\",\n    \"snmp_3_enabled_previous\"\
    : false,\n    \"snmp_3_url_previous\": \"\",\n    \"snmp_4_community_previous\"\
    : \"\",\n    \"snmp_4_enabled_previous\": false,\n    \"snmp_4_url_previous\"\
    : \"\",\n    \"snmp_receiver_1_port_previous\": 162,\n    \"snmp_receiver_2_port_previous\"\
    : 162,\n    \"snmp_receiver_3_port_previous\": 162,\n    \"snmp_receiver_4_port_previous\"\
    : 162,\n    \"timeout_long_operations_previous\": 120,\n    \"timeout_normal_operations_previous\"\
    : 30\n}\n"
  type: dict