dellemc.openmanage.ome_template_network_vlan – Set tagged and untagged vlans to native network card supported by a template on OpenManage Enterprise

Note

This plugin is part of the dellemc.openmanage collection (version 4.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install dellemc.openmanage.

To use it in a playbook, specify: dellemc.openmanage.ome_template_network_vlan.

New in version 2.0.0: of dellemc.openmanage

Synopsis

  • This module allows to set tagged and untagged vlans to native network card supported by a template on OpenManage Enterprise.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7.5

Parameters

Parameter Choices/Defaults Comments
hostname
string / required
OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname.
nic_identifier
string / required
Display name of NIC port in the template for VLAN configuration.
password
string / required
OpenManage Enterprise or OpenManage Enterprise Modular password.
port
integer
Default:
443
OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port.
propagate_vlan
boolean
added in 3.4.0 of dellemc.openmanage
    Choices:
  • no
  • yes ←
To deploy the modified VLAN settings immediately without rebooting the server.
This option will be applied only when there are changes to the VLAN configuration.
tagged_networks
list / elements=dictionary
List of tagged VLANs and their corresponding NIC ports.
port
integer / required
NIC port number of the tagged VLAN
tagged_network_ids
list / elements=integer
List of IDs of the tagged VLANs
Enter [] to remove the tagged VLAN from a port.
List of tagged_network_ids is combined with list of tagged_network_names when adding tagged VLANs to a port.
tagged_network_names
list / elements=string
List of names of tagged VLANs
Enter [] to remove the tagged VLAN from a port.
List of tagged_network_names is combined with list of tagged_network_ids when adding tagged VLANs to a port.
template_id
integer
Id of the template.
It is mutually exclusive with template_name.
template_name
string
Name of the template.
It is mutually exclusive with template_id.
untagged_networks
list / elements=dictionary
List of untagged networks and their corresponding NIC ports.
port
integer / required
NIC port number of the untagged VLAN.
untagged_network_id
integer
ID of the untagged VLAN
Enter 0 to clear the untagged VLAN from the port.
This option is mutually exclusive with untagged_network_name
untagged_network_name
string
name of the vlan for untagging
provide 0 for clearing the untagging for this port
This parameter is mutually exclusive with untagged_network_id
username
string / required
OpenManage Enterprise or OpenManage Enterprise Modular username.

Notes

Note

  • Run this module from a system that has direct access to DellEMC OpenManage Enterprise.

  • This module supports check_mode.

Examples

---
- name: Add tagged or untagged VLANs to a template using VLAN ID and name
  dellemc.openmanage.ome_template_network_vlan:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    template_id: 78
    nic_identifier: NIC Slot 4
    untagged_networks:
      - port: 1
        untagged_network_id: 127656
      - port: 2
        untagged_network_name: vlan2
    tagged_networks:
      - port: 1
        tagged_network_ids:
          - 12767
          - 12768
      - port: 4
        tagged_network_ids:
          - 12767
          - 12768
        tagged_network_names:
          - vlan3
      - port: 2
        tagged_network_names:
          - vlan4
          - vlan1

- name: Clear the tagged and untagged VLANs from a template
  dellemc.openmanage.ome_template_network_vlan:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    template_id: 78
    nic_identifier: NIC Slot 4
    untagged_networks:
      # For removing the untagged VLANs for the port 1 and 2
      - port: 1
        untagged_network_id: 0
      - port: 2
        untagged_network_name: 0
    tagged_networks:
      # For removing the tagged VLANs for port 1, 4 and 2
      - port: 1
        tagged_network_ids: []
      - port: 4
        tagged_network_ids: []
        tagged_network_names: []
      - port: 2
        tagged_network_names: []

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
error_info
dictionary
on HTTP error
Details of the HTTP Error.

Sample:
{'error': {'@Message.ExtendedInfo': [{'Message': 'Unable to complete the request because TemplateId does not exist or is not applicable for the resource URI.', 'MessageArgs': ['TemplateId'], 'MessageId': 'CGEN1004', 'RelatedProperties': [], 'Resolution': "Check the request resource URI. Refer to the OpenManage Enterprise-Modular User's Guide for more information about resource URI and its properties.", 'Severity': 'Critical'}], 'code': 'Base.1.0.GeneralError', 'message': 'A general error has occurred. See ExtendedInfo for more information.'}}
msg
string
always
Overall status of the template vlan operation.

Sample:
Successfully applied the network settings to template.


Authors

  • Jagadeesh N V(@jagadeeshnv)