wti.remote.cpm_interface_config (1.0.5) — module

Install collection

Install with ansible-galaxy collection install wti.remote:==1.0.5

Add to requirements.yml

  collections:
    - name: wti.remote
      version: 1.0.5

Description

Set network interface parameters in WTI OOB and PDU devices

Usage examples

Scanned by Steampunk Spotter

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

# Set Network Interface Parameters
- name: Set the Interface Parameters for port eth1 of a WTI device
  cpm_interface_config:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false
    interface: "eth1"
    ipv4address: "192.168.0.14"
    ipv4netmask: "255.255.255.0"
    ipv4gateway: "192.168.0.1"
    negotiation: 0

Scanned by Steampunk Spotter

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

# Set Network Interface Parameters
- name: Set the Interface Parameters for port eth1 to DHCP of a WTI device
  cpm_interface_config:
    cpm_url: "nonexist.wti.com"
    cpm_username: "super"
    cpm_password: "super"
    use_https: true
    validate_certs: false
    interface: "eth1"
    negotiation: 0
    ipv4dhcpenable: 1
    ipv4dhcphostname: ""
    ipv4dhcplease: -1
    ipv4dhcpobdns: 0
    ipv4dhcpupdns: 0
    ipv4dhcpdefgateway: 0

Inputs

    
cpm_url:
    description:
    - This is the URL of the WTI device to send the module.
    required: true
    type: str

interface:
    choices:
    - eth0
    - eth1
    - ppp0
    - qmimux0
    description:
    - This is the ethernet port name that is getting configured.
    required: false
    type: str

use_https:
    default: true
    description:
    - Designates to use an https connection or http connection.
    required: false
    type: bool

use_proxy:
    default: false
    description:
    - Flag to control if the lookup will observe HTTP proxy environment variables when
      present.
    required: false
    type: bool

ipv4address:
    description:
    - IPv4 format IP address for the defined interface Port.
    required: false
    type: str

ipv4gateway:
    description:
    - IPv4 format Gateway address for the defined interface Port.
    required: false
    type: str

ipv4netmask:
    description:
    - IPv4 format Netmask for the defined interface Port.
    required: false
    type: str

ipv6address:
    description:
    - IPv6 format IP address for the defined interface Port.
    required: false
    type: str

ipv6gateway:
    description:
    - IPv6 format Gateway address for the defined interface Port.
    required: false
    type: str

negotiation:
    choices:
    - 0
    - 1
    - 2
    - 3
    - 4
    - 5
    - 6
    description:
    - This is the speed of the interface port being configured.
    - 0=Auto, 1=10/half, 2=10/full, 3=100/half, 4=100/full, 5=1000/half, 6=1000/full
    required: false
    type: int

cpm_password:
    description:
    - This is the Password of the WTI device to send the module.
    required: true
    type: str

cpm_username:
    description:
    - This is the Username of the WTI device to send the module.
    required: true
    type: str

ipv4dhcplease:
    description:
    - IPv4 DHCP Lease Time.
    required: false
    type: int

ipv4dhcpobdns:
    choices:
    - 0
    - 1
    description:
    - IPv6 DHCP Obtain DNS addresses auto.
    required: false
    type: int

ipv4dhcpupdns:
    choices:
    - 0
    - 1
    description:
    - IPv4 DHCP DNS Server Update.
    required: false
    type: int

ipv4dhcpenable:
    choices:
    - 0
    - 1
    description:
    - Enable IPv4 DHCP request call to obtain confufuration information.
    required: false
    type: int

validate_certs:
    default: true
    description:
    - If false, SSL certificates will not be validated. This should only be used
    - on personally controlled sites using self-signed certificates.
    required: false
    type: bool

ipv4dhcphostname:
    description:
    - Define IPv4 DHCP Hostname.
    required: false
    type: str

ipv6subnetprefix:
    description:
    - IPv6 format Subnet Prefix for the defined interface Port.
    required: false
    type: str

ipv4dhcpdefgateway:
    choices:
    - 0
    - 1
    description:
    - Enable or Disable this ports configuration as the default IPv4 route for the device.
    required: false
    type: int

Outputs

data:
  contains:
    interface:
      description: Current k/v pairs of interface info for the WTI device after module
        execution.
      returned: always
      sample:
        ietf-ipv4:
          address:
          - gateway: ''
            ip: 10.10.10.2
            netmask: 255.255.255.0
          dhcpclient:
          - enable: 0
            hostname: ''
            lease: -1
            obdns: 1
            updns: 1
        ietf-ipv6:
          address:
          - gateway: ''
            ip: ''
            netmask: ''
        is_gig: '1'
        is_up: '0'
        mac_address: 00-09-9b-02-45-db
        name: eth1
        negotiation: '0'
        speed: '10'
        type: '0'
      type: dict
    totalports:
      description: Total interface ports requested of the WTI device.
      returned: success
      sample: 1
      type: int
  description: The output JSON returned from the commands sent
  returned: always
  type: complex