ieisystem.inmanage
  • ieisystem.inmanage.network_link_info – Get network link information
    • Synopsis
    • Requirements
    • Parameters
    • Notes
    • Examples
    • Return Values
      • Authors
ieisystem.inmanage
  • »
  • ieisystem.inmanage.network_link_info – Get network link information
  • View page source

ieisystem.inmanage.network_link_info – Get network link information¶

Note

This plugin is part of the ieisystem.inmanage collection.

To install it use: ansible-galaxy collection install ieisystem.inmanage.

To use it in a playbook, specify: ieisystem.inmanage.network_link_info.

New in version 1.0.0: of ieisystem.inmanage

  • Synopsis

  • Requirements

  • Parameters

  • Notes

  • Examples

  • Return Values

Synopsis¶

  • Get network link information on ieisystem Server.

Requirements¶

The below requirements are needed on the host that executes this module.

  • Python 3.7+

  • inManage

Parameters¶

Parameter Choices/Defaults Comments
host
string
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
password
string
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
provider
dictionary
A dict object containing connection details.
host
string
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
password
string
Specifies the password to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
username
string
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
username
string
Configures the username to use to authenticate the connection to the remote device. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.

Notes¶

Note

  • Supports check_mode.

Examples¶

- name: Link test
  hosts: inmanage
  connection: local
  gather_facts: no
  vars:
    inmanage:
      host: "{{ ansible_ssh_host }}"
      username: "{{ username }}"
      password: "{{ password }}"

  tasks:

  - name: "Get network link information"
    ieisystem.inmanage.network_link_info:
      provider: "{{ inmanage }}"

Return Values¶

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
changed
boolean
always
Check to see if a change was made on the device.

message
string
always
Messages returned after module execution.

state
string
always
Status after module execution.



Authors¶

  • WangBaoshan (@ieisystem)


© Copyright 2024, wangbaoshan

Built with Sphinx using a theme provided by Read the Docs.