dellemc.openmanage.ome_smart_fabric_uplink_info (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 retrieve details of fabric uplink on OpenManage Enterprise Modular.

Requirements

• python >= 3.9.6

Usage examples

Scanned by Steampunk Spotter

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

---
- name: Retrieve all fabric uplink information using fabric_id.
  dellemc.openmanage.ome_smart_fabric_uplink_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    fabric_id: "61c20a59-9ed5-4ae5-b850-5e5acf42d2f2"

Scanned by Steampunk Spotter

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

- name: Retrieve all fabric uplink information using fabric_name.
  dellemc.openmanage.ome_smart_fabric_uplink_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    fabric_name: "f1"

Scanned by Steampunk Spotter

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

- name: Retrieve specific fabric information using uplink_id.
  dellemc.openmanage.ome_smart_fabric_uplink_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    fabric_id: "61c20a59-9ed5-4ae5-b850-5e5acf42d2f2"
    uplink_id: "1ad54420-b145-49a1-9779-21a579ef6f2d"

Scanned by Steampunk Spotter

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

- name: Retrieve specific fabric information using uplink_name.
  dellemc.openmanage.ome_smart_fabric_uplink_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    fabric_id: "61c20a59-9ed5-4ae5-b850-5e5acf42d2f2"
    uplink_name: "u1"

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

fabric_id:
    description:
    - Unique id of the fabric.
    - I(fabric_id) is mutually exclusive with I(fabric_name).
    type: str

uplink_id:
    description:
    - Unique id of the uplink.
    - I(uplink_id) is mutually exclusive with I(uplink_name).
    - I(fabric_id) or I(fabric_name) is required along with I(uplink_id).
    type: str

fabric_name:
    description:
    - Unique name of the fabric.
    - I(fabric_name) is mutually exclusive with I(fabric_id).
    type: str

uplink_name:
    description:
    - Unique name of the uplink.
    - I(uplink_name) is mutually exclusive with I(uplink_id).
    - I(fabric_id) or I(fabric_name) is required along with I(uplink_name).
    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

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: Status of fabric uplink information retrieval.
  returned: always
  sample: Successfully retrieved the fabric uplink information.
  type: str
uplink_info:
  description: Information about the fabric uplink.
  returned: on success
  sample:
  - Description: ''
    Id: 1ad54420-b145-49a1-9779-21a579ef6f2d
    MediaType: Ethernet
    Name: u1
    NativeVLAN: 1
    Networks:
    - CreatedBy: system
      CreationTime: '2018-09-25 14:46:12.374'
      Description: null
      Id: 10155
      InternalRefNWUUId: f15a36b6-e3d3-46b2-9e7d-bf9cd66e180d
      Name: testvlan
      Type: 1
      UpdatedBy: root
      UpdatedTime: '2019-06-27 15:06:22.836'
      VlanMaximum: 143
      VlanMinimum: 143
    Ports:
    - AdminStatus: Enabled
      BlinkStatus: 'OFF'
      ConfiguredSpeed: '0'
      CurrentSpeed: '0'
      Description: ''
      Id: SVCTAG1:ethernet1/1/35
      MaxSpeed: '0'
      MediaType: Ethernet
      Name: ''
      NodeServiceTag: SVCTAG1
      OpticsType: NotPresent
      PortNumber: ethernet1/1/35
      Role: Uplink
      Status: Down
      Type: PhysicalEthernet
    - AdminStatus: Enabled
      BlinkStatus: 'OFF'
      ConfiguredSpeed: '0'
      CurrentSpeed: '0'
      Description: ''
      Id: SVCTAG1:ethernet1/1/35
      MaxSpeed: '0'
      MediaType: Ethernet
      Name: ''
      NodeServiceTag: SVCTAG1
      OpticsType: NotPresent
      PortNumber: ethernet1/1/35
      Role: Uplink
      Status: Down
      Type: PhysicalEthernet
    Summary:
      NetworkCount: 1
      PortCount: 2
    UfdEnable: Disabled
  type: list