ce_link_status – Get interface link status on HUAWEI CloudEngine switches — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# ce_link_status – Get interface link status on HUAWEI CloudEngine switches

New in version 2.4.

- Synopsis
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- Get interface link status on HUAWEI CloudEngine switches.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
interface - / required |  | For the interface parameter, you can enter `all` to display information about all interfaces, an interface type such as `40GE` to display information about interfaces of the specified type, or full name of an interface such as `40GE1/0/22` or `vlanif10` to display information about the specific interface.

## Notes

Note

- Current physical state shows an interface’s physical status.
- Current link state shows an interface’s link layer protocol status.
- Current IPv4 state shows an interface’s IPv4 protocol status.
- Current IPv6 state shows an interface’s IPv6 protocol status.
- Inbound octets(bytes) shows the number of bytes that an interface received.
- Inbound unicast(pkts) shows the number of unicast packets that an interface received.
- Inbound multicast(pkts) shows the number of multicast packets that an interface received.
- Inbound broadcast(pkts) shows the number of broadcast packets that an interface received.
- Inbound error(pkts) shows the number of error packets that an interface received.
- Inbound drop(pkts) shows the total number of packets that were sent to the interface but dropped by an interface.
- Inbound rate(byte/sec) shows the rate at which an interface receives bytes within an interval.
- Inbound rate(pkts/sec) shows the rate at which an interface receives packets within an interval.
- Outbound octets(bytes) shows the number of the bytes that an interface sent.
- Outbound unicast(pkts) shows the number of unicast packets that an interface sent.
- Outbound multicast(pkts) shows the number of multicast packets that an interface sent.
- Outbound broadcast(pkts) shows the number of broadcast packets that an interface sent.
- Outbound error(pkts) shows the total number of packets that an interface sent but dropped by the remote interface.
- Outbound drop(pkts) shows the number of dropped packets that an interface sent.
- Outbound rate(byte/sec) shows the rate at which an interface sends bytes within an interval.
- Outbound rate(pkts/sec) shows the rate at which an interface sends packets within an interval.
- Speed shows the rate for an Ethernet interface.
- This module requires the netconf system service be enabled on the remote device being managed.
- Recommended connection is `netconf`.
- This module also works with `local` connections for legacy playbooks.

## Examples

    - name: Link status test
      hosts: cloudengine
      connection: local
      gather_facts: no
      vars:
        cli:
          host: "{{ inventory_hostname }}"
          port: "{{ ansible_ssh_port }}"
          username: "{{ username }}"
          password: "{{ password }}"
          transport: cli

      tasks:

      - name: Get specified interface link status information
        ce_link_status:
          interface: 40GE1/0/1
          provider: "{{ cli }}"

      - name: Get specified interface type link status information
        ce_link_status:
          interface: 40GE
          provider: "{{ cli }}"

      - name: Get all interfaces link status information
        ce_link_status:
          interface: all
          provider: "{{ cli }}"

## Return Values

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

Key | Returned | Description
--- | --- | ---
result dictionary | always | Interface link status information Sample: {'40ge2/0/8': {'Current IPv4 state': 'down', 'Current IPv6 state': 'down', 'Current link state': 'up', 'Current physical state': 'up', 'Inbound broadcast(pkts)': '0', 'Inbound drop(pkts)': '0', 'Inbound error(pkts)': '0', 'Inbound multicast(pkts)': '20151', 'Inbound octets(bytes)': '7314813', 'Inbound rate(byte/sec)': '11', 'Inbound rate(pkts/sec)': '0', 'Inbound unicast(pkts)': '0', 'Outbound broadcast(pkts)': '1', 'Outbound drop(pkts)': '0', 'Outbound error(pkts)': '0', 'Outbound multicast(pkts)': '20152', 'Outbound octets(bytes)': '7235021', 'Outbound rate(byte/sec)': '11', 'Outbound rate(pkts/sec)': '0', 'Outbound unicast(pkts)': '0', 'Speed': '40GE'}}

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Zhijin Zhou (@QijunPan)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.