dellemc.openmanage.ome_network_port_breakout – This module allows to automate the port portioning or port breakout to logical sub ports

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_network_port_breakout.

New in version 2.1.0: of dellemc.openmanage

Synopsis

  • This module allows to automate breaking out of IOMs in fabric mode into logical sub ports.

  • The port breakout operation is only supported in OpenManage Enterprise Modular.

Requirements

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

  • python >= 2.7.17

Parameters

Parameter Choices/Defaults Comments
breakout_type
string / required
The preferred breakout type. For example, 4X10GE.
To revoke the default breakout configuration, enter 'HardwareDefault'.
hostname
string / required
OpenManage Enterprise Modular IP address or hostname.
password
string / required
OpenManage Enterprise Modular password.
port
integer
Default:
443
OpenManage Enterprise Modular HTTPS port.
target_port
string / required
The ID of the port in the switch to breakout. Enter the port ID in the format: service tag:port. For example, 2HB7NX2:ethernet1/1/13.
username
string / required
OpenManage Enterprise Modular username.

Notes

Note

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

  • This module supports check_mode.

Examples

---
- name: Port breakout configuration
  dellemc.openmanage.ome_network_port_breakout:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    target_port: "2HB7NX2:phy-port1/1/11"
    breakout_type: "1X40GE"

- name: Revoke the default breakout configuration
  dellemc.openmanage.ome_network_port_breakout:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    target_port: "2HB7NX2:phy-port1/1/11"
    breakout_type: "HardwareDefault"

Return Values

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

Key Returned Description
breakout_status
dictionary
success
Details of the OpenManage Enterprise jobs.

Sample:
{'Builtin': False, 'CreatedBy': 'root', 'Editable': True, 'EndTime': None, 'Id': 11111, 'JobDescription': '', 'JobName': 'Breakout Port', 'JobStatus': {'Id': 1112, 'Name': 'New'}, 'JobType': {'Id': 3, 'Internal': False, 'Name': 'DeviceAction_Task'}, 'LastRun': None, 'LastRunStatus': {'Id': 1113, 'Name': 'NotRun'}, 'NextRun': None, 'Params': [{'JobId': 11111, 'Key': 'operationName', 'Value': 'CONFIGURE_PORT_BREAK_OUT'}, {'JobId': 11111, 'Key': 'interfaceId', 'Value': '2HB7NX2:phy-port1/1/11'}, {'JobId': 11111, 'Key': 'breakoutType', 'Value': '1X40GE'}], 'Schedule': 'startnow', 'StartTime': None, 'State': 'Enabled', 'Targets': [{'Data': '', 'Id': 11112, 'JobId': 34206, 'TargetType': {'Id': 1000, 'Name': 'DEVICE'}}], 'UpdatedBy': None, 'UserGenerated': True, 'Visible': True}
error_info
dictionary
on HTTP error
Details of the 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.'}}
msg
string
always
Overall status of the port configuration.

Sample:
Port breakout configuration job submitted successfully.


Authors

  • Felix Stephen (@felixs88)