dellemc.openmanage.ome_network_vlan (2.1.5) — module

Install collection

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

Add to requirements.yml

  collections:
    - name: dellemc.openmanage
      version: 2.1.5

Description

This module allows to:

Create a VLAN on OpenManage Enterprise

Modify or delete an existing VLAN on OpenManage Enterprise

Requirements

• python >= 2.7.17

Usage examples

Scanned by Steampunk Spotter

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

---
- name: "Create a VLAN range"
  dellemc.openmanage.ome_network_vlan:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    state: present
    name: "vlan1"
    description: "VLAN desc"
    type: "General Purpose (Bronze)"
    vlan_minimum: 35
    vlan_maximum: 40
  tags: create_vlan_range

Scanned by Steampunk Spotter

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

- name: "Create a VLAN with a single value"
  dellemc.openmanage.ome_network_vlan:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    state: present
    name: "vlan2"
    description: "VLAN desc"
    type: "General Purpose (Bronze)"
    vlan_minimum: 127
    vlan_maximum: 127
  tags: create_vlan_single

Scanned by Steampunk Spotter

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

- name: "Modify a VLAN"
  dellemc.openmanage.ome_network_vlan:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    state: present
    name: "vlan1"
    new_name: "vlan_gold1"
    description: "new description"
    type: "General Purpose (Gold)"
    vlan_minimum: 45
    vlan_maximum: 50
  tags: modify_vlan

Scanned by Steampunk Spotter

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

- name: "Delete a VLAN"
  dellemc.openmanage.ome_network_vlan:
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"
    state: "absent"
    name: "vlan1"
  tags: delete_vlan

Inputs

    
name:
    description: Provide the I(name) of the VLAN to be created, deleted or modified.
    required: true
    type: str

port:
    default: 443
    description: Target HTTPS port.
    type: int

type:
    choices:
    - General Purpose (Bronze)
    - General Purpose (Silver)
    - General Purpose (Gold)
    - General Purpose (Platinum)
    - Cluster Interconnect
    - Hypervisor Management
    - Storage - iSCSI
    - Storage - FCoE
    - Storage - Data Replication
    - VM Migration
    - VMWare FT Logging
    description:
    - Types of supported VLAN networks.
    - For the description of each network type, use API U(https://I(hostname)/api/NetworkConfigurationService/NetworkTypes).
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - C(present) creates a new VLAN or modifies an existing VLAN.
    - C(absent) deletes an existing VLAN.
    - I(WARNING) Deleting a VLAN can impact the network infrastructure.
    type: str

hostname:
    description: Target IP address or hostname.
    required: true
    type: str

new_name:
    description: Provide the I(name) of the VLAN to be modified.
    type: str

password:
    description: Target user password.
    required: true
    type: str

username:
    description: Target username.
    required: true
    type: str

description:
    description: short description of the VLAN to be created or modified.
    type: str

vlan_maximum:
    description:
    - The maximum VLAN value of the range.
    - A single value VLAN is created if the vlan_maximum and vlan_minmum values are the
      same.
    type: int

vlan_minimum:
    description:
    - The minimum VLAN value of the range.
    type: int

Outputs

error_info:
  description: Details of the HTTP Error.
  returned: on HTTP error
  sample:
    '@Message.ExtendedInfo':
    - Message: Unable to create or update the network because the entered VLAN minimum
        0 is not within a valid range ( 1  -  4000  or  4021  -  4094 ).
      MessageArgs:
      - '0'
      - '1'
      - '4000'
      - '4021'
      - '4094'
      MessageId: CTEM1043
      RelatedProperties: []
      Resolution: Enter a valid VLAN minimum as identified in the message and retry
        the operation.
      Severity: Warning
    code: Base.1.0.GeneralError
    message: A general error has occurred. See ExtendedInfo for more information.
  type: dict
msg:
  description: Overall status of the VLAN operation.
  returned: always
  sample: Successfully created the VLAN.
  type: str
vlan_status:
  description: Details of the VLAN that is either created or modified.
  returned: when I(state=present)
  sample:
    '@odata.context': /api/$metadata#NetworkConfigurationService.Network
    '@odata.id': /api/NetworkConfigurationService/Networks(1234)
    '@odata.type': '#NetworkConfigurationService.Network'
    CreatedBy: admin
    CreationTime: '2020-01-01 05:54:36.113'
    Description: VLAN description
    Id: 1234
    InternalRefNWUUId: 6d6effcc-eca4-44bd-be07-1234ab5cd67e
    Name: vlan1
    Type: 1
    UpdatedBy: null
    UpdatedTime: '2020-01-01 05:54:36.113'
    VlanMaximum: 130
    VlanMinimum: 140
  type: dict