discovery:deviceinterface : Device Interface object.

Interfaces on devices discovered by Network Automation

Object Reference

References to discovery:deviceinterface are object references. The name part of a Discovery Device Interface object reference has the following components:

  • Name of the device interface

Example: discovery:deviceinterface/ZG5zLmJpbmRfY25h:deviceinterface

Restrictions

The object does not support the following operations:

  • Create (insert)
  • Delete
  • Scheduling
  • CSV export

The object cannot be managed on Cloud Platform members.

Fields

These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.

The basic version of the object contains the field(s): name, type.

admin_status

admin_status

Administrative state of the interface.

Type

String.

Valid values are:
  • DOWN
  • UP

Search

The field is not available for search.

Notes

The admin_status cannot be updated.

admin_status cannot be written.

admin_status_task_info

admin_status_task_info

The configured admin status task info of the interface.

Type

A/An Port Config Admin Status struct.

Search

The field is not available for search.

Notes

The admin_status_task_info cannot be updated.

admin_status_task_info cannot be written.

cap_if_admin_status_ind

cap_if_admin_status_ind

Determines whether to modify the admin status of the interface.

Type

Bool.

Search

The field is not available for search.

Notes

The cap_if_admin_status_ind cannot be updated.

cap_if_admin_status_ind cannot be written.

cap_if_admin_status_na_reason

cap_if_admin_status_na_reason

The reason that the edit admin status action is not available.

Type

String.

Values with leading or trailing white space are not valid for this field.

Search

The field is not available for search.

Notes

The cap_if_admin_status_na_reason cannot be updated.

cap_if_admin_status_na_reason cannot be written.

cap_if_description_ind

cap_if_description_ind

Determines whether to modify the description of the interface.

Type

Bool.

Search

The field is not available for search.

Notes

The cap_if_description_ind cannot be updated.

cap_if_description_ind cannot be written.

cap_if_description_na_reason

cap_if_description_na_reason

The reason that the edit description action is not available.

Type

String.

Values with leading or trailing white space are not valid for this field.

Search

The field is not available for search.

Notes

The cap_if_description_na_reason cannot be updated.

cap_if_description_na_reason cannot be written.

cap_if_net_deprovisioning_ipv4_ind

cap_if_net_deprovisioning_ipv4_ind

Determines whether to deprovision a IPv4 network from the interfaces.

Type

Bool.

Search

The field is not available for search.

Notes

The cap_if_net_deprovisioning_ipv4_ind cannot be updated.

cap_if_net_deprovisioning_ipv4_ind cannot be written.

cap_if_net_deprovisioning_ipv4_na_reason

cap_if_net_deprovisioning_ipv4_na_reason

The reason that the deprovision a IPv4 network from the interface.

Type

String.

Values with leading or trailing white space are not valid for this field.

Search

The field is not available for search.

Notes

The cap_if_net_deprovisioning_ipv4_na_reason cannot be updated.

cap_if_net_deprovisioning_ipv4_na_reason cannot be written.

cap_if_net_deprovisioning_ipv6_ind

cap_if_net_deprovisioning_ipv6_ind

Determines whether to deprovision a IPv6 network from the interfaces.

Type

Bool.

Search

The field is not available for search.

Notes

The cap_if_net_deprovisioning_ipv6_ind cannot be updated.

cap_if_net_deprovisioning_ipv6_ind cannot be written.

cap_if_net_deprovisioning_ipv6_na_reason

cap_if_net_deprovisioning_ipv6_na_reason

The reason that the deprovision a IPv6 network from the interface.

Type

String.

Values with leading or trailing white space are not valid for this field.

Search

The field is not available for search.

Notes

The cap_if_net_deprovisioning_ipv6_na_reason cannot be updated.

cap_if_net_deprovisioning_ipv6_na_reason cannot be written.

cap_if_net_provisioning_ipv4_ind

cap_if_net_provisioning_ipv4_ind

Determines whether to modify the IPv4 network associated to the interface.

Type

Bool.

Search

The field is not available for search.

Notes

The cap_if_net_provisioning_ipv4_ind cannot be updated.

cap_if_net_provisioning_ipv4_ind cannot be written.

cap_if_net_provisioning_ipv4_na_reason

cap_if_net_provisioning_ipv4_na_reason

The reason that IPv4 network provisioning is not available.

Type

String.

Values with leading or trailing white space are not valid for this field.

Search

The field is not available for search.

Notes

The cap_if_net_provisioning_ipv4_na_reason cannot be updated.

cap_if_net_provisioning_ipv4_na_reason cannot be written.

cap_if_net_provisioning_ipv6_ind

cap_if_net_provisioning_ipv6_ind

Determines whether to modify the IPv6 network associated to the interface.

Type

Bool.

Search

The field is not available for search.

Notes

The cap_if_net_provisioning_ipv6_ind cannot be updated.

cap_if_net_provisioning_ipv6_ind cannot be written.

cap_if_net_provisioning_ipv6_na_reason

cap_if_net_provisioning_ipv6_na_reason

The reason that IPv6 network provisioning is not available.

Type

String.

Values with leading or trailing white space are not valid for this field.

Search

The field is not available for search.

Notes

The cap_if_net_provisioning_ipv6_na_reason cannot be updated.

cap_if_net_provisioning_ipv6_na_reason cannot be written.

cap_if_vlan_assignment_ind

cap_if_vlan_assignment_ind

Determines whether to modify the VLAN assignement of the interface.

Type

Bool.

Search

The field is not available for search.

Notes

The cap_if_vlan_assignment_ind cannot be updated.

cap_if_vlan_assignment_ind cannot be written.

cap_if_vlan_assignment_na_reason

cap_if_vlan_assignment_na_reason

The reason that VLAN assignment action is not available.

Type

String.

Values with leading or trailing white space are not valid for this field.

Search

The field is not available for search.

Notes

The cap_if_vlan_assignment_na_reason cannot be updated.

cap_if_vlan_assignment_na_reason cannot be written.

cap_if_voice_vlan_ind

cap_if_voice_vlan_ind

Determines whether to modify the voice VLAN assignement of the interface.

Type

Bool.

Search

The field is not available for search.

Notes

The cap_if_voice_vlan_ind cannot be updated.

cap_if_voice_vlan_ind cannot be written.

cap_if_voice_vlan_na_reason

cap_if_voice_vlan_na_reason

The reason that voice VLAN assignment action is not available.

Type

String.

Values with leading or trailing white space are not valid for this field.

Search

The field is not available for search.

Notes

The cap_if_voice_vlan_na_reason cannot be updated.

cap_if_voice_vlan_na_reason cannot be written.

description

description

The description of the interface.

Type

String.

Values with leading or trailing white space are not valid for this field.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The description cannot be updated.

description cannot be written.

description_task_info

description_task_info

The configured description task info of the interface.

Type

A/An Port Config Descrition struct.

Search

The field is not available for search.

Notes

The description_task_info cannot be updated.

description_task_info cannot be written.

device

device

The ref to the device to which the interface belongs.

Type

String.

This field supports nested return fields as described here.

Search

The field is not available for search.

Notes

The device cannot be updated.

device cannot be written.

duplex

duplex

The duplex state of the interface.

Type

String.

Valid values are:
  • FULL
  • HALF
  • UNKNOWN
  • UNSUPPORTED

Search

The field is not available for search.

Notes

The duplex cannot be updated.

duplex cannot be written.

extattrs

extattrs

Extensible attributes associated with the object.

For valid values for extensible attributes, see the following information.

Type

Extensible attributes.

This field allows +/- to be specified as part of the field name when updating the object, see the following information.

Create

The default value is empty.

Search

For how to search extensible attributes, see the following information.

ifaddr_infos

ifaddr_infos

List of IFaddr information associated with the interface.

Type

A/An IfAddr information struct array.

Search

The field is not available for search.

Notes

The ifaddr_infos cannot be updated.

ifaddr_infos cannot be written.

index

index

The interface index number, as reported by SNMP.

Type

Integer.

Search

The field is not available for search.

Notes

The index cannot be updated.

index cannot be written.

last_change

last_change

Timestamp of the last interface property change detected.

Type

Timestamp.

Search

The field is not available for search.

Notes

The last_change cannot be updated.

last_change cannot be written.

mac

mac

The MAC address of the interface.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The mac cannot be updated.

mac cannot be written.

ms_ad_user_data

ms_ad_user_data

The Microsoft Active Directory user related information.

Type

A/An Active Directory User Data struct.

Search

The field is not available for search.

Notes

The ms_ad_user_data cannot be updated.

ms_ad_user_data cannot be written.

name

name

The interface system name.

Type

String.

Values with leading or trailing white space are not valid for this field.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The name is part of the base object.

The name cannot be updated.

name cannot be written.

network_view

network_view

Th name of the network view.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The network_view cannot be updated.

network_view cannot be written.

oper_status

oper_status

Operating state of the interface.

Type

String.

Valid values are:
  • DOWN
  • UP

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The oper_status cannot be updated.

oper_status cannot be written.

port_fast

port_fast

The Port Fast status of the interface.

Type

String.

Valid values are:
  • DISABLED
  • ENABLED

Search

The field is not available for search.

Notes

The port_fast cannot be updated.

port_fast cannot be written.

reserved_object

reserved_object

The reference to object(Host/FixedAddress/GridMember) to which this port is reserved.

Type

String.

This field supports nested return fields as described here.

Search

The field is not available for search.

Notes

The reserved_object cannot be updated.

reserved_object cannot be written.

speed

speed

The interface speed in bps.

Type

Unsigned integer.

Search

The field is available for search via

  • ‘!=’ (negative search)
  • ‘=’ (exact equality)
  • ‘<=’ (less than search)
  • ‘>=’ (greater than search)

Notes

The speed cannot be updated.

speed cannot be written.

trunk_status

trunk_status

Indicates if the interface is tagged as a VLAN trunk or not.

Type

String.

Valid values are:
  • OFF
  • ON

Search

The field is not available for search.

Notes

The trunk_status cannot be updated.

trunk_status cannot be written.

type

type

The type of interface.

Type

String.

Values with leading or trailing white space are not valid for this field.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The type is part of the base object.

The type cannot be updated.

type cannot be written.

vlan_info_task_info

vlan_info_task_info

The configured VLAN status task info of the interface.

Type

A/An Port Config VLAN info struct.

Search

The field is not available for search.

Notes

The vlan_info_task_info cannot be updated.

vlan_info_task_info cannot be written.

vlan_infos

vlan_infos

The list of VLAN information associated with the interface.

Type

A/An VLAN information struct array.

Search

The field is not available for search.

Notes

The vlan_infos cannot be updated.

vlan_infos cannot be written.

vrf_description

vrf_description

The description of the Virtual Routing and Forwarding (VRF) associated with the interface.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The vrf_description cannot be updated.

vrf_description cannot be written.

vrf_name

vrf_name

The name of the Virtual Routing and Forwarding (VRF) associated with the interface.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The vrf_name cannot be updated.

vrf_name cannot be written.

vrf_rd

vrf_rd

The route distinguisher of the Virtual Routing and Forwarding (VRF) associated with the interface.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The vrf_rd cannot be updated.

vrf_rd cannot be written.

Fields List

Field Type Req R/O Base Search
admin_status String N Y N N/A
admin_status_task_info struct N Y N N/A
cap_if_admin_status_ind Bool N Y N N/A
cap_if_admin_status_na_reason String N Y N N/A
cap_if_description_ind Bool N Y N N/A
cap_if_description_na_reason String N Y N N/A
cap_if_net_deprovisioning_ipv4_ind Bool N Y N N/A
cap_if_net_deprovisioning_ipv4_na_reason String N Y N N/A
cap_if_net_deprovisioning_ipv6_ind Bool N Y N N/A
cap_if_net_deprovisioning_ipv6_na_reason String N Y N N/A
cap_if_net_provisioning_ipv4_ind Bool N Y N N/A
cap_if_net_provisioning_ipv4_na_reason String N Y N N/A
cap_if_net_provisioning_ipv6_ind Bool N Y N N/A
cap_if_net_provisioning_ipv6_na_reason String N Y N N/A
cap_if_vlan_assignment_ind Bool N Y N N/A
cap_if_vlan_assignment_na_reason String N Y N N/A
cap_if_voice_vlan_ind Bool N Y N N/A
cap_if_voice_vlan_na_reason String N Y N N/A
description String N Y N : = ~
description_task_info struct N Y N N/A
device String N Y N N/A
duplex String N Y N N/A
extattrs Extattr N N N ext
ifaddr_infos [struct] N Y N N/A
index Integer N Y N N/A
last_change Timestamp N Y N N/A
link_aggregation Bool N Y N N/A
mac String N Y N : = ~
ms_ad_user_data struct N Y N N/A
name String N Y Y : = ~
network_view String N Y N =
oper_status String N Y N =
port_fast String N Y N N/A
reserved_object String N Y N N/A
speed Unsigned int N Y N ! < = >
trunk_status String N Y N N/A
type String N Y Y : = ~
vlan_info_task_info struct N Y N N/A
vlan_infos [struct] N Y N N/A
vrf_description String N Y N =
vrf_name String N Y N =
vrf_rd String N Y N =