dellemc.openmanage.ome_server_interface_profiles (9.1.0) — module

Configure server interface profiles

| "added in version" 5.1.0 of dellemc.openmanage"

Authors: Jagadeesh N V (@jagadeeshnv)

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 configure server interface profiles on OpenManage Enterprise Modular.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
---
- name: Modify Server Interface Profile for the server using the service tag
  dellemc.openmanage.ome_server_interface_profiles:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    device_service_tag:
      - SVCTAG1
      - SVCTAG2
    nic_teaming: LACP
    nic_configuration:
      - nic_identifier: NIC.Mezzanine.1A-1-1
        team: false
        untagged_network: 2
        tagged_networks:
          names:
            - vlan1
      - nic_identifier: NIC.Mezzanine.1A-2-1
        team: true
        untagged_network: 3
        tagged_networks:
          names:
            - range120-125
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Modify Server Interface Profile for the server using the device id
  dellemc.openmanage.ome_server_interface_profiles:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    device_id:
      - 34523
      - 48999
    nic_teaming: NoTeaming
    nic_configuration:
      - nic_identifier: NIC.Mezzanine.1A-1-1
        team: false
        untagged_network: 2
        tagged_networks:
          names:
            - vlan2
      - nic_identifier: NIC.Mezzanine.1A-2-1
        team: true
        untagged_network: 3
        tagged_networks:
          names:
            - range120-125

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

job_wait:
    default: true
    description:
    - Provides the option to wait for job completion.
    type: bool

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:
    - Device id of the Server under chassis fabric.
    - I(device_id) and I(device_service_tag) is mutually exclusive.
    elements: int
    type: list

nic_teaming:
    choices:
    - LACP
    - NoTeaming
    - Other
    description:
    - NIC teaming options.
    - C(NoTeaming) the NICs are not bonded and provide no load balancing or redundancy.
    - C(LACP) use LACP for NIC teaming.
    - C(Other) use other technology for NIC teaming.
    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

job_wait_timeout:
    default: 120
    description:
    - The maximum wait time of I(job_wait) in seconds. The job is  tracked only for this
      duration.
    - This option is applicable when I(job_wait) is C(true).
    type: int

nic_configuration:
    description: NIC configuration for the Servers to be applied.
    elements: dict
    suboptions:
      nic_identifier:
        description:
        - ID of the NIC or port number.
        - C(Note) This will not be validated.
        required: true
        type: str
      tagged_networks:
        description:
        - List of tagged networks
        - Network cannot be added as a tagged network if it is already assigned to untagged
          network
        suboptions:
          names:
            description:
            - List of network name to be marked as tagged networks
            - The I(names) can be retrieved using the M(dellemc.openmanage.ome_network_vlan_info)
            elements: str
            required: true
            type: list
          state:
            choices:
            - present
            - absent
            default: present
            description:
            - Indicates if a list of networks needs to be added or deleted.
            - C(present) to add the network to the tagged list
            - C(absent) to delete the Network from the tagged list
            type: str
        type: dict
      team:
        description:
        - Group two or more ports. The ports must be connected to the same pair of Ethernet
          switches.
        - I(team) is applicable only if I(nic_teaming) is C(LACP).
        type: bool
      untagged_network:
        description:
        - The maximum or minimum VLAN id of the network to be untagged.
        - The I(untagged_network) can be retrieved using the M(dellemc.openmanage.ome_network_vlan_info)
        - If I(untagged_network) needs to be unset this needs to be sent as C(0)
        - C(Note) The network cannot be added as a untagged network if it is already assigned
          to a tagged network.
        type: int
    type: list

device_service_tag:
    description:
    - Service tag of the Server under chassis fabric.
    - I(device_service_tag) and I(device_id) is mutually exclusive.
    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
job_id:
  description: Job ID of the task to apply the server interface profiles.
  returned: on applying the Interface profiles
  sample: 14123
  type: int
msg:
  description: Status of the overall server interface operation.
  returned: always
  sample: Successfully triggered apply server profiles job.
  type: str