community.vmware.vmware_dvs_portgroup_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 DVS portgroup configurations.

Usage examples

Scanned by Steampunk Spotter

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

- name: Get info about DVPG
  community.vmware.vmware_dvs_portgroup_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
  register: dvpg_info

Scanned by Steampunk Spotter

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

- name: Get number of ports for portgroup 'dvpg_001' in 'dvs_001'
  debug:
    msg: "{{ item.num_ports }}"
  with_items:
    - "{{ dvpg_info.dvs_portgroup_info['dvs_001'] | json_query(query) }}"
  vars:
    query: "[?portgroup_name=='dvpg_001']"

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

dvswitch:
    description:
    - Name of a dvswitch to look for.
    required: false
    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

datacenter:
    description:
    - Name of the datacenter.
    required: true
    type: str

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

show_uplinks:
    default: true
    description:
    - Show or hide uplinks of DVS portgroup.
    type: bool

show_vlan_info:
    default: false
    description:
    - Show or hide vlan information of the DVS portgroup.
    type: bool

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

show_port_policy:
    default: true
    description:
    - Show or hide port policies of DVS portgroup.
    type: bool

show_mac_learning:
    default: true
    description:
    - Show or hide MAC learning information of the DVS portgroup.
    type: bool

show_network_policy:
    default: true
    description:
    - Show or hide network policies of DVS portgroup.
    type: bool

show_teaming_policy:
    default: true
    description:
    - Show or hide teaming policies of DVS portgroup.
    type: bool

Outputs

dvs_portgroup_info:
  description: metadata about DVS portgroup configuration
  returned: on success
  sample:
    dvs_0:
    - active_uplinks:
      - uplink 1
      description: null
      dvswitch_name: dvs_001
      key: dvportgroup-1014
      mac_learning:
        allow_unicast_flooding: null
        enabled: false
        limit: null
        limit_policy: null
      moid: dvportgroup-1014
      network_policy:
        forged_transmits: false
        mac_changes: false
        promiscuous: false
      num_ports: 8
      port_allocation: elastic
      port_binding: static
      port_policy:
        block_override: true
        ipfix_override: false
        live_port_move: false
        network_rp_override: false
        port_config_reset_at_disconnect: true
        security_override: false
        shaping_override: false
        traffic_filter_override: false
        uplink_teaming_override: false
        vendor_config_override: false
        vlan_override: false
      portgroup_name: dvpg_001
      standby_uplinks: []
      teaming_policy:
        inbound_policy: true
        notify_switches: true
        policy: loadbalance_srcid
        rolling_order: false
      type: earlyBinding
      vlan_info:
        pvlan: false
        trunk: false
        vlan_id: 0
  type: dict