Infoblox::Grid::Discovery::DeviceInterface - the discovery interface.
The object provides information about the discovery interface.
This section describes all the methods in Infoblox::Session that you can apply to the object.
Use this method to modify an object in the Infoblox appliance. See Infoblox::Session->modify() for parameters and return values.
# Use this method to modify extensible attributes $object->extattrs({ 'Site' => $extattr1, 'Administrator' => $extattr2 }); # Submit modification my $response = $session->modify( $object );
This section describes all the methods that you can use to set or retrieve the attribute values of the object.
Use this method to retrieve the administrative state of the interface. This is a read-only attribute.
None
The method returns the attribute value that can be 'UP' or 'DOWN'.
# Get attribute value my $value = $object->admin_status();
Use this method to retrieve the configured admin status task information.
None
The method returns the attribute value that can be an Infoblox::Grid::Discovery::Port::Config::AdminStatus object.
# Get attribute value my $value = $object->admin_status_task_info();
Use this method to retrieve the flag indicates whether or not modify the admin status of this interface. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->cap_if_admin_status_ind();
Use this method to retrieve the reason if the edit admin status action is not available. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->cap_if_admin_status_na_reason();
Use this method to retrieve the flag indicates whether or not modify the description of this interface. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->cap_if_description_ind();
Use this method to retrieve the reason if the edit description action is not available. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->cap_if_description_na_reason();
Use this method to retrieve the flag indicates whether or not deprovision the IPv4 network associated to this interface. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->cap_if_net_deprovisioning_ipv4_ind();
Use this method to retrieve the flag indicates whether or not deprovision the IPv6 network associated to this interface. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->cap_if_net_deprovisioning_ipv6_ind();
Use this method to retrieve the reason if the deprovision the IPv4 network from this interface is not available. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->cap_if_net_deprovisioning_ipv4_na_reason();
Use this method to retrieve the reason if the deprovision the IPv6 network from this interface is not available. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->cap_if_net_deprovisioning_ipv6_na_reason();
Use this method to retrieve the flag indicates whether or not modify the IPv4 network associated to this interface. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->cap_if_net_provisioning_ipv4_ind();
Use this method to retrieve the flag indicates whether or not modify the IPv6 network associated to this interface. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->cap_if_net_provisioning_ipv6_ind();
Use this method to retrieve the reason if the IPv4 network provisioning is not available. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->cap_if_net_provisioning_ipv4_na_reason();
Use this method to retrieve the reason if the IPv6 network provisioning is not available. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->cap_if_net_provisioning_ipv6_na_reason();
Use this method to retrieve the flag indicates whether or not modify the VLAN assignement for this interface. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->cap_if_vlan_assignment_ind();
Use this method to retrieve the reason if the VLAN assignment action is not available. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->cap_if_vlan_assignment_na_reason();
Use this method to retrieve the flag indicates whether or not modify the voice VLAN assignement for this interface. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->cap_if_vlan_assignment_ind();
Use this method to retrieve the reason if the voice VLAN assignment action is not available. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->cap_if_voice_vlan_na_reason();
Use this method to retrieve the description of the interface. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->description();
Use this method to retrieve the configured description task information.
None
The method returns the attribute value that can be an Infoblox::Grid::Discovery::Port::Config::Description object.
# Get attribute value my $value = $object->description_task_info();
Use this method to retrieve the device object. This is a read-only attribute.
None
The method returns the attribute value that can be an Infoblox::Grid::Discovery::Device object.
# Get attribute value my $value = $object->device();
Use this method to retrieve the duplex state of the interface. This is a read-only attribute.
None
The method returns the attribute value that can be 'FULL', 'HALF', 'UNKNOWN' or 'UNSUPPORTED'.
# Get attribute value my $value = $object->duplex();
Use this method to retrieve the current discovery status. This attribute is read-only. 'discover_now_status' will not be returned by default, use 'return_methods' to request it if needed.
None.
The method returns the attribute value that can be 'COMPLETE', 'FAILED', 'NONE', 'PENDING' or 'RUNNING'.
#Get discover_now_status my $discover_now_status = $object->discover_now_status();
Use this method to set or retrieve the extensible attributes associated with the DeviceInterface object.
Valid value is a hash reference containing the names of extensible attributes and their associated values ( Infoblox::Grid::Extattr objects ).
If you specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.
If you did not specify a parameter, the method returns the attribute value.
#Get extattrs my $ref_extattrs = $object->extattrs(); #Modify extattrs $object->extattrs({ 'Site' => $extattr1, 'Administrator' => $extattr2 });
Use this method to retrieve a list of IFaddr information associated with the interface. This is a read-only attribute.
None
The method returns the attribute value that can be an array reference that contains Infoblox::Grid::Discovery::IFAddrInfo objects.
# Get attribute value my $value = $object->ifaddr_infos();
Use this method to retrieve the interface index number, as reported by SNMP. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->index();
Use this method to retrieve the timestamp of the last detected interface property change. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->last_change();
Use this method to retrieve the flag that indicates whether this is a link aggregation interface. This is a read-only attribute.
None
The method returns the attribute value that can be 'true' or 'false'.
# Get attribute value my $value = $object->link_aggregation();
Use this method to retrieve the MAC address of the interface. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->mac();
Use this method to retrieve Microsoft Active Directory users related information. This is a read-only attribute.
None
The valid return value is an Infoblox::Grid::MSServer::AdUser::Data object.
#Get ms_ad_user_data my $ms_ad_user_data = $object->ms_ad_user_data();
Use this method to retrieve the interface system name. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->name();
Use this method to retrieve the operating state of the interface. This is a read-only attribute.
None
The method returns the attribute value that can be 'UP' or 'DOWN'.
# Get attribute value my $value = $object->oper_status();
Use this method to retrieve the port fast status of the interface. This is a read-only attribute.
None
The method returns the attribute value that can be 'ENABLED' or 'DISABLED'.
# Get attribute value my $value = $object->port_fast();
Use this method to retrieve the object to which this port is reserved. This is a read-only attribute.
None
The method returns the attribute value that can be Infoblox::DHCP::HostAddr, Infoblox::DHCP::IPv6HostAddr, Infoblox::DHCP::FixedAddr, Infoblox::DHCP::IPv6FixedAddr or Infoblox::Grid::Member object.
# Get attribute value my $value = $object->reserved_object();
Use this method to retrieve the interface speed in bps. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->speed();
Use this method to retrieve the flag that indicates if the interface is tagged as trunk or not. This is a read-only attribute.
None
The method returns the attribute value that can be 'ON' or 'OFF'.
# Get attribute value my $value = $object->trunk_status();
Use this method to retrieve the interface type. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->type();
Use this method to retrieve a list of VLAN Information associated with this interface. This is a read-only attribute.
None
The method returns the attribute value that can be an array reference that contains Infoblox::Grid::Discovery::VLANInfo objects.
# Get attribute value my $value = $object->vlan_infos();
Use this method to retrieve the configured VLAN task information.
None
The method returns the attribute value that can be an Infoblox::Grid::Discovery::Port::Config::VlanInfo object.
# Get attribute value my $value = $object->vlan_info_task_info();
Use this method to retrieve the name of the network view associated with the interface. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->network_view();
Use this method to retrieve the name of the VRF associated with the interface, if any. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->vrf_name();
Use this method to retrieve the VRF description. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->vrf_description();
Use this method to retrieve the route distinguisher associated with the VRF. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->vrf_route_distinguisher();
Infoblox Inc. http://www.infoblox.com/
Infoblox::Grid::Discovery::Device, Infoblox::Grid::Discovery::VLANInfo, Infoblox::Grid::Discovery::IFAddrInfo
Copyright (c) 2017 Infoblox Inc.