dellemc.openmanage.ome_network_port_breakout (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 automate breaking out of IOMs in fabric mode into logical sub ports.

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

Requirements

• python >= 3.8.6

Usage examples

Scanned by Steampunk Spotter

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

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

Scanned by Steampunk Spotter

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

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

Inputs

    
port:
    default: 443
    description: 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 Modular IP address or hostname.
    required: true
    type: str

password:
    description:
    - 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 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

target_port:
    description: '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.'
    required: true
    type: str

breakout_type:
    description:
    - The preferred breakout type. For example, 4X10GE.
    - To revoke the default breakout configuration, enter 'HardwareDefault'.
    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

breakout_status:
  description: Details of the OpenManage Enterprise jobs.
  returned: success
  sample:
    Builtin: false
    CreatedBy: root
    Editable: true
    EndTime: null
    Id: 11111
    JobDescription: ''
    JobName: Breakout Port
    JobStatus:
      Id: 1112
      Name: New
    JobType:
      Id: 3
      Internal: false
      Name: DeviceAction_Task
    LastRun: null
    LastRunStatus:
      Id: 1113
      Name: NotRun
    NextRun: null
    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: null
    State: Enabled
    Targets:
    - Data: ''
      Id: 11112
      JobId: 34206
      TargetType:
        Id: 1000
        Name: DEVICE
    UpdatedBy: null
    UserGenerated: true
    Visible: true
  type: dict
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: Overall status of the port configuration.
  returned: always
  sample: Port breakout configuration job submitted successfully.
  type: str