dellemc.openmanage.ome_template_network_vlan_info (9.1.0) — module

Install collection

Install with ansible-galaxy collection install dellemc.openmanage:==9.1.0

Add to requirements.yml

  collections:
    - name: dellemc.openmanage
      version: 9.1.0

Description

This module retrieves the network configuration of a template on OpenManage Enterprise or OpenManage Enterprise Modular.

Requirements

• python >= 3.9.6

Usage examples

Scanned by Steampunk Spotter

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

---
- name: Retrieve network details of all templates.
  dellemc.openmanage.ome_template_network_vlan_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"

Scanned by Steampunk Spotter

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

- name: Retrieve network details using template ID
  dellemc.openmanage.ome_template_network_vlan_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    template_id: 1234

Scanned by Steampunk Spotter

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

- name: Retrieve network details using template name
  dellemc.openmanage.ome_template_network_vlan_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    template_name: template1

Inputs

    
port:
    default: 443
    description: OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port.
    type: int

ca_path:
    description:
    - The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for
      the validation.
    type: path
    version_added: 5.0.0
    version_added_collection: dellemc.openmanage

timeout:
    default: 30
    description: The socket level timeout in seconds.
    type: int
    version_added: 5.0.0
    version_added_collection: dellemc.openmanage

hostname:
    description: OpenManage Enterprise or OpenManage Enterprise Modular IP address or
      hostname.
    required: true
    type: str

password:
    description:
    - OpenManage Enterprise or OpenManage Enterprise Modular password.
    - If the password is not provided, then the environment variable C(OME_PASSWORD) is
      used.
    - 'Example: export OME_PASSWORD=password'
    required: true
    type: str

username:
    description:
    - OpenManage Enterprise or OpenManage Enterprise Modular username.
    - If the username is not provided, then the environment variable C(OME_USERNAME) is
      used.
    - 'Example: export OME_USERNAME=username'
    required: true
    type: str

template_id:
    description:
    - Id of the template.
    - This is mutually exclusive with I(template_name).
    type: int

template_name:
    description:
    - Name of the template.
    - This is mutually exclusive with I(template_id).
    - C(Note) If I(template_id) or I(template_name) option is not provided, the module
      retrieves network VLAN info of all templates.
    type: str

validate_certs:
    default: true
    description:
    - If C(false), the SSL certificates will not be validated.
    - Configure C(false) only on personally controlled sites where self-signed certificates
      are used.
    - Prior to collection version C(5.0.0), the I(validate_certs) is C(false) by default.
    type: bool
    version_added: 5.0.0
    version_added_collection: dellemc.openmanage

Outputs

error_info:
  description: Details of the HTTP Error.
  returned: on HTTP error
  sample:
    error:
      '@Message.ExtendedInfo':
      - Message: Unable to process the request because an error occurred.
        MessageArgs: []
        MessageId: GEN1234
        RelatedProperties: []
        Resolution: Retry the operation. If the issue persists, contact your system
          administrator.
        Severity: Critical
      code: Base.1.0.GeneralError
      message: A general error has occurred. See ExtendedInfo for more information.
  type: dict
msg:
  description: Status of template VLAN information retrieval.
  returned: always
  sample: Successfully retrieved the template network VLAN information.
  type: str
vlan_info:
  description: Information about the template network VLAN.
  elements: dict
  returned: success
  sample:
  - NicBondingTechnology: LACP
    NicModel:
      NIC in Mezzanine 1A:
        '1':
          NIC Bonding Enabled: 'true'
          Port: 1
          Vlan Tagged:
          - '32656'
          - '32658'
          Vlan UnTagged: '25367'
        '2':
          NIC Bonding Enabled: 'false'
          Port: 2
          Vlan Tagged:
          - '21474'
          Vlan UnTagged: '32656'
      NIC in Mezzanine 1B:
        '1':
          NICBondingEnabled: 'false'
          Port: 1
          Vlan Tagged:
          - '25367'
          - '32656'
          - '32658'
          - '26898'
          Vlan UnTagged: '21474'
        '2':
          NIC Bonding Enabled: 'true'
          Port: 2
          Vlan Tagged: []
          Vlan UnTagged: '32658'
    TemplateId: 58
    TemplateName: t2
  type: list