dellemc.openmanage.ome_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 allows to retrieve the following. - A list of all the network VLANs with their detailed information. - Information about a specific network VLAN using VLAN I(id) or VLAN I(name).

Requirements

• python >= 3.8.6

Usage examples

Scanned by Steampunk Spotter

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

---
- name: Retrieve information about all network VLANs(s) available in the device
  dellemc.openmanage.ome_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 information about a network VLAN using the VLAN ID
  dellemc.openmanage.ome_network_vlan_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    id: 12345

Scanned by Steampunk Spotter

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

- name: Retrieve information about a network VLAN using the VLAN name
  dellemc.openmanage.ome_network_vlan_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    name: "Network VLAN - 1"

Inputs

    
id:
    description:
    - A unique identifier of the network VLAN available in the device.
    - I(id) and I(name) are mutually exclusive.
    type: int

name:
    description:
    - A unique name of the network VLAN available in the device.
    - I(name) and I(id) are mutually exclusive.
    type: str

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

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: Detailed information of the network VLAN(s).
  returned: success
  sample:
    msg: Successfully retrieved the network VLAN information.
    network_vlan_info:
    - CreatedBy: admin
      CreationTime: '2020-09-02 18:48:42.129'
      Description: Description of Logical Network - 1
      Id: 20057
      InternalRefNWUUId: 42b9903d-93f8-4184-adcf-0772e4492f71
      Name: Network VLAN - 1
      Type:
        Description: 'This is the network for general purpose traffic. QOS Priority
          : Bronze.'
        Id: 1
        Name: General Purpose (Bronze)
        NetworkTrafficType: Ethernet
        QosType:
          Id: 4
          Name: Bronze
        VendorCode: GeneralPurpose
      UpdatedBy: null
      UpdatedTime: '2020-09-02 18:48:42.129'
      VlanMaximum: 111
      VlanMinimum: 111
    - CreatedBy: admin
      CreationTime: '2020-09-02 18:49:11.507'
      Description: Description of Logical Network - 2
      Id: 20058
      InternalRefNWUUId: e46ccb3f-ef57-4617-ac76-46c56594005c
      Name: Network VLAN - 2
      Type:
        Description: 'This is the network for general purpose traffic. QOS Priority
          : Silver.'
        Id: 2
        Name: General Purpose (Silver)
        NetworkTrafficType: Ethernet
        QosType:
          Id: 3
          Name: Silver
        VendorCode: GeneralPurpose
      UpdatedBy: null
      UpdatedTime: '2020-09-02 18:49:11.507'
      VlanMaximum: 112
      VlanMinimum: 112
  type: str