dellemc.openmanage.ome_server_interface_profile_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 allows to retrieves the information of server interface profile on 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: Retrieves the server interface profiles of all the device using device ID.
  dellemc.openmanage.ome_server_interface_profile_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    device_id:
      - 10001
      - 10002

Scanned by Steampunk Spotter

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

- name: Retrieves the server interface profiles of all the device using device service tag.
  dellemc.openmanage.ome_server_interface_profile_info:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    device_service_tag:
      - 6GHH6H2
      - 6KHH6H3

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

device_id:
    description:
    - The ID of the device.
    - I(device_id) is mutually exclusive with I(device_service_tag).
    elements: int
    type: list

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

device_service_tag:
    description:
    - The service tag of the device.
    - I(device_service_tag) is mutually exclusive with I(device_id).
    elements: str
    type: list

Outputs

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 server interface profile information.
  returned: on success
  sample: Successfully retrieved the server interface profile information.
  type: str
server_profiles:
  description: Returns the information of collected server interface profile information.
  returned: success
  sample:
  - BondingTechnology: LACP
    Id: 6KZK6K2
    ServerInterfaceProfile:
    - FabricId: 1ea6bf64-3cf0-4e06-a136-5046d874d1e7
      Id: NIC.Mezzanine.1A-1-1
      NativeVLAN: 0
      Networks:
      - CreatedBy: system
        CreationTime: '2018-11-27 10:22:14.140'
        Description: VLAN 1
        Id: 10001
        InternalRefNWUUId: add035b9-a971-400d-a3fa-bb365df1d476
        Name": VLAN 1
        Type: 2
        UpdatedBy: null
        UpdatedTime: '2018-11-27 10:22:14.140'
        VlanMaximum: 1
        VlanMinimum: 1
      NicBonded: true
      OnboardedPort: 59HW8X2:ethernet1/1/1
    - FabricId: 3ea6be04-5cf0-4e05-a136-5046d874d1e6
      Id: NIC.Mezzanine.1A-2-1
      NativeVLAN: 0
      Networks:
      - CreatedBy: system
        CreationTime: '2018-09-25 14:46:12.374'
        Description: null
        Id: 10155
        InternalRefNWUUId: f15a36b6-e3d3-46b2-9e7d-bf9cd66e180d
        Name: jagvlan
        Type: 1
        UpdatedBy: null
        UpdatedTime: '2018-09-25 14:46:12.374'
        VlanMaximum: 143
        VlanMinimum: 143
      NicBonded: false
      OnboardedPort: 6H7J6Z2:ethernet1/1/1
  type: list