dellemc.openmanage.ome_smart_fabric_uplink (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 create, modify or delete an uplink for a fabric.

Requirements

• python >= 3.8.6

Usage examples

Scanned by Steampunk Spotter

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

---
- name: Create an Uplink
  dellemc.openmanage.ome_smart_fabric_uplink:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: "present"
    fabric_name: "fabric1"
    name: "uplink1"
    description: "CREATED from OMAM"
    uplink_type: "Ethernet"
    ufd_enable: "Enabled"
    primary_switch_service_tag: "ABC1234"
    primary_switch_ports:
      - ethernet1/1/13
      - ethernet1/1/14
    secondary_switch_service_tag: "XYZ1234"
    secondary_switch_ports:
      - ethernet1/1/13
      - ethernet1/1/14
    tagged_networks:
      - vlan1
      - vlan3
    untagged_network: vlan2
  tags: create_uplink

Scanned by Steampunk Spotter

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

- name: Modify an existing uplink
  dellemc.openmanage.ome_smart_fabric_uplink:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: "present"
    fabric_name: "fabric1"
    name: "uplink1"
    new_name: "uplink2"
    description: "Modified from OMAM"
    uplink_type: "Ethernet"
    ufd_enable: "Disabled"
    primary_switch_service_tag: "DEF1234"
    primary_switch_ports:
      - ethernet1/2/13
      - ethernet1/2/14
    secondary_switch_service_tag: "TUV1234"
    secondary_switch_ports:
      - ethernet1/2/13
      - ethernet1/2/14
    tagged_networks:
      - vlan11
      - vlan33
    untagged_network: vlan22
  tags: modify_uplink

Scanned by Steampunk Spotter

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

- name: Delete an Uplink
  dellemc.openmanage.ome_smart_fabric_uplink:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: "absent"
    fabric_name: "fabric1"
    name: "uplink1"
  tags: delete_uplink

Scanned by Steampunk Spotter

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

- name: Modify an Uplink name
  dellemc.openmanage.ome_smart_fabric_uplink:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: "present"
    fabric_name: "fabric1"
    name: "uplink1"
    new_name: "uplink2"
  tags: modify_uplink_name

Scanned by Steampunk Spotter

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

- name: Modify Uplink ports
  dellemc.openmanage.ome_smart_fabric_uplink:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: "present"
    fabric_name: "fabric1"
    name: "uplink1"
    description: "uplink ports modified"
    primary_switch_service_tag: "ABC1234"
    primary_switch_ports:
      - ethernet1/1/6
      - ethernet1/1/7
    secondary_switch_service_tag: "XYZ1234"
    secondary_switch_ports:
      - ethernet1/1/9
      - ethernet1/1/10
  tags: modify_ports

Scanned by Steampunk Spotter

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

- name: Modify Uplink networks
  dellemc.openmanage.ome_smart_fabric_uplink:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    state: "present"
    fabric_name: "fabric1"
    name: "create1"
    description: "uplink networks modified"
    tagged_networks:
      - vlan4
  tags: modify_networks

Inputs

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

port:
    default: 443
    description: OpenManage Enterprise Modular HTTPS port.
    type: int

state:
    choices:
    - present
    - absent
    default: present
    description:
    - C(present) - Creates a new uplink with the provided I(name). - Modifies an existing
      uplink with the provided I(name).
    - "C(absent) \u2013 Deletes the uplink with the provided I(name)."
    - I(WARNING) Delete operation can impact the network infrastructure.
    type: str

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

new_name:
    description: Provide the new I(new_name) for the uplink.
    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

ufd_enable:
    choices:
    - Enabled
    - Disabled
    description:
    - Add or Remove the uplink to the Uplink Failure Detection (UFD) group. The UFD group
      identifies the loss of connectivity to the upstream switch and notifies the servers
      that are connected to the switch. During an uplink failure, the switch disables
      the corresponding downstream server ports. The downstream servers can then select
      alternate connectivity routes, if available.
    - I(WARNING) The firmware version of the I/O Module running the Fabric Manager must
      support this configuration feature. If not, uplink creation will be successful with
      an appropriate error message in response.
    type: str

description:
    description: Provide a short description for the uplink to be created or modified.
    type: str

fabric_name:
    description: Provide the I(fabric_name) of the fabric for which the uplink is to be
      configured.
    required: true
    type: str

uplink_type:
    choices:
    - Ethernet
    - FCoE
    - FC Gateway
    - FC Direct Attach
    - Ethernet - No Spanning Tree
    description:
    - Specify the uplink type.
    - I(NOTE) The uplink type cannot be changed for an existing uplink.
    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

tagged_networks:
    description: VLANs to be associated with the uplink I(name).
    elements: str
    type: list

untagged_network:
    description: Specify the name of the VLAN to be added as untagged to the uplink.
    type: str

primary_switch_ports:
    description:
    - The IOM slots to be connected to the primary switch.
    - I(primary_switch_service_tag) is mandatory for this option.
    elements: str
    type: list

secondary_switch_ports:
    description:
    - The IOM slots to be connected to the secondary switch.
    - I(secondary_switch_service_tag) is mandatory for this option.
    elements: str
    type: list

primary_switch_service_tag:
    description: Service tag of the primary switch.
    type: str

secondary_switch_service_tag:
    description: Service tag of the secondary switch.
    type: str

Outputs

additional_info:
  description: Additional details of the fabric operation.
  returned: when I(state=present) and additional information present in response.
  sample:
    error:
      '@Message.ExtendedInfo':
      - Message: Unable to configure the Uplink Failure Detection mode on the uplink
          because the firmware version of the I/O Module running the Fabric Manager
          does not support the configuration feature.
        MessageArgs: []
        MessageId: CDEV7151
        RelatedProperties: []
        Resolution: Update the firmware version of the I/O Module running the Fabric
          Manager and retry the operation. For information about the recommended I/O
          Module firmware versions, see the OpenManage Enterprise-Modular User's Guide
          available on the support site.
        Severity: Informational
      code: Base.1.0.GeneralError
      message: A general error has occurred. See ExtendedInfo for more information.
  type: dict
error_info:
  description: Details of the HTTP Error.
  returned: on HTTP error
  sample:
    error:
      '@Message.ExtendedInfo':
      - Message: Unable to complete the request because the resource URI does not
          exist or is not implemented.
        MessageArgs: []
        MessageId: CGEN1006
        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.
  type: dict
msg:
  description: Overall status of the uplink operation.
  returned: always
  sample: Successfully modified the uplink.
  type: str
uplink_id:
  description: Returns the ID when an uplink is created or modified.
  returned: when I(state=present)
  sample: ddc3d260-fd71-46a1-97f9-708e12345678
  type: str