dellemc.unity.interface (2.0.0) — module

Install collection

Install with ansible-galaxy collection install dellemc.unity:==2.0.0

Add to requirements.yml

  collections:
    - name: dellemc.unity
      version: 2.0.0

Description

Managing the Interfaces on the Unity storage system includes adding Interfaces to NAS Server, getting details of interface and deleting configured interfaces.

Requirements

• A Dell Unity Storage device version 5.1 or later.
• Ansible-core 2.14 or later.
• Python 3.9, 3.10 or 3.11.
• Storops Python SDK 1.2.11.

Usage examples

Scanned by Steampunk Spotter

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

- name: Add Interface as Backup to NAS Server
  dellemc.unity.interface:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    nas_server_name: "dummy_nas"
    ethernet_port_name: "SP A 4-Port Card Ethernet Port 0"
    role: "BACKUP"
    interface_ip: "xx.xx.xx.xx"
    netmask: "xx.xx.xx.xx"
    gateway: "xx.xx.xx.xx"
    vlan_id: 324
    state: "present"

Scanned by Steampunk Spotter

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

- name: Add Interface as Production to NAS Server
  dellemc.unity.interface:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    nas_server_name: "dummy_nas"
    ethernet_port_name: "SP A 4-Port Card Ethernet Port 0"
    role: "PRODUCTION"
    interface_ip: "xx.xx.xx.xx"
    netmask: "xx.xx.xx.xx"
    gateway: "xx.xx.xx.xx"
    vlan_id: 324
    state: "present"

Scanned by Steampunk Spotter

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

- name: Get interface details
  dellemc.unity.interface:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    nas_server_name: "dummy_nas"
    interface_ip: "xx.xx.xx.xx"
    state: "present"

Scanned by Steampunk Spotter

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

- name: Delete Interface
  dellemc.unity.interface:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    nas_server_name: "dummy_nas"
    interface_ip: "xx.xx.xx.xx"
    state: "absent"

Inputs

    
port:
    default: 443
    description:
    - Port number through which communication happens with Unity management server.
    type: int

role:
    choices:
    - PRODUCTION
    - BACKUP
    description:
    - Indicates whether interface is configured as production or backup.
    type: str

state:
    choices:
    - present
    - absent
    description:
    - Define whether the interface should exist or not.
    required: true
    type: str

gateway:
    description:
    - Gateway of network interface.
    type: str

netmask:
    description:
    - Netmask of network interface.
    type: str

vlan_id:
    description:
    - Vlan id of the interface.
    type: int

password:
    description:
    - The password of the Unity management server.
    required: true
    type: str

username:
    description:
    - The username of the Unity management server.
    required: true
    type: str

interface_ip:
    description:
    - IP of network interface.
    required: true
    type: str

nas_server_id:
    description:
    - ID of the NAS server for which interface will be configured.
    type: str

prefix_length:
    description:
    - Prefix length is mutually exclusive with I(netmask).
    type: int

unispherehost:
    description:
    - IP or FQDN of the Unity management server.
    required: true
    type: str

validate_certs:
    aliases:
    - verifycert
    default: true
    description:
    - Boolean variable to specify whether or not to validate SSL certificate.
    - C(true) - Indicates that the SSL certificate should be verified.
    - C(false) - Indicates that the SSL certificate should not be verified.
    type: bool

nas_server_name:
    description:
    - Name of the NAS server for which interface will be configured.
    type: str

ethernet_port_id:
    description:
    - ID of the ethernet port.
    type: str

ethernet_port_name:
    description:
    - Name of the ethernet port.
    type: str

Outputs

changed:
  description: Whether or not the resource has changed.
  returned: always
  sample: true
  type: bool
interface_details:
  contains:
    existed:
      description: Indicates if interface exists.
      type: bool
    gateway:
      description: Gateway of network interface.
      type: str
    id:
      description: Unique identifier interface.
      type: str
    ip_address:
      description: IP address of interface.
      type: str
    ip_port:
      contains:
        id:
          description: ID of ip_port.
          type: str
      description: Port on which network interface is configured.
      type: dict
    ip_protocol_version:
      description: IP protocol version.
      type: str
    is_disabled:
      description: Indicates whether interface is disabled.
      type: bool
    is_preferred:
      description: Indicates whether interface is preferred.
      type: bool
    mac_address:
      description: Mac address of ip_port.
      type: bool
    name:
      description: System configured name of interface.
      type: bool
    nas_server:
      contains:
        id:
          description: ID of NAS Server.
          type: str
      description: Details of NAS server where interface is configured.
      type: dict
  description: Details of the interface.
  returned: When interface is configured for NAS Server.
  sample:
    existed: true
    gateway: xx.xx.xx.xx
    hash: 8785300560421
    health:
      UnityHealth:
        hash: 8785300565468
    id: if_69
    ip_address: 10.10.10.10
    ip_port:
      UnityIpPort:
        hash: 8785300565300
        id: spb_ocp_0_eth0
    ip_protocol_version: IpProtocolVersionEnum.IPv4
    is_disabled: false
    is_preferred: true
    mac_address: 0C:48:C6:9F:57:BF
    name: 36_APM00213404194
    nas_server:
      UnityNasServer:
        hash: 8785300565417
        id: nas_10
    netmask: 10.10.10.10
    replication_policy: null
    role: FileInterfaceRoleEnum.PRODUCTION
    source_parameters: null
    v6_prefix_length: null
    vlan_id: 324
  type: dict