Infoblox::Grid::Discovery::Device - the discovery device.
The object provides information about the discovery device.
This section describes all the methods in Infoblox::Session that you can apply to the object.
Use this method to retrieve all the matching objects from the Infoblox appliance. See Infoblox::Session->get() for parameters and return values.
Note that you should use 'return_methods' attribute to retrieve 'networks', 'interfaces', 'cap_admin_status_ind', 'cap_admin_status_na_reason', 'cap_description_ind', 'cap_description_na_reason', 'cap_net_deprovisioning_ind', 'cap_net_deprovisioning_na_reason', 'cap_net_provisioning_ind', 'cap_net_provisioning_na_reason', 'cap_net_vlan_provisioning_ind', 'cap_net_vlan_provisioning_na_reason', 'cap_vlan_assignment_ind', 'cap_vlan_assignment_na_reason', 'cap_voice_vlan_ind', 'cap_voice_vlan_na_reason' and 'neighbors' members of the device.
Apply the following attributes to get a specific object:
address - Optional. The IP address of the device. chassis_serial_number - Optional. The device chassis serial number. name - Optional. The device name. model - Optional. The device model. class - Optional. The device class. location - Optional. The device location. description - Optional. The device description. discovery_member - Optional. The name of the discovery member.
# without networks', 'interfaces' and 'neighbors' members my @retrieved_objs = $session->get( 'object' => 'Infoblox::Grid::Discovery::Device', 'name' => 'device', );
# with networks', 'interfaces' and 'neighbors' members my @retrieved_objs = $session->get( 'object' => 'Infoblox::Grid::Discovery::Device', 'return_methods' => ['+networks', '+interfaces', '+neighbors'], 'name' => 'device', );
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 );
Use this method to search for objects in the Infoblox appliance. See Infoblox::Session->search() for parameters and return values.
Note that you should use 'return_methods' attribute to retrieve 'networks', 'interfaces', 'cap_admin_status_ind', 'cap_admin_status_na_reason', 'cap_description_ind', 'cap_description_na_reason', 'cap_net_deprovisioning_ind', 'cap_net_deprovisioning_na_reason', 'cap_net_provisioning_ind', 'cap_net_provisioning_na_reason', 'cap_net_vlan_provisioning_ind', 'cap_net_vlan_provisioning_na_reason', 'cap_vlan_assignment_ind', 'cap_vlan_assignment_na_reason', 'cap_voice_vlan_ind', 'cap_voice_vlan_na_reason' and 'neighbors' members of the device.
Apply the following attributes to search for a object:
address - Optional. The IP address of the device (regular expression). chassis_serial_number - Optional. The device chassis serial number (regular expression). name - Optional. The device name (regular expression). model - Optional. The device model (regular expression). class - Optional. The device class (regular expression). location - Optional. The device location (regular expression). description - Optional. The device description (regular expression). discovery_member - Optional. The host name of the discovery member.
# without networks', 'interfaces' and 'neighbors' members my @retrieved_objs = $session->search( 'object' => 'Infoblox::Grid::Discovery::Device', 'name' => 'device', );
# with networks', 'interfaces' and 'neighbors' members my @retrieved_objs = $session->session( 'object' => 'Infoblox::Grid::Discovery::Device', 'return_methods' => ['+networks', '+interfaces', '+neighbors'], 'name' => 'device', );
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 IP address of the device. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->address();
Use this method to retrieve the IP address object of the device. This is a read-only attribute.
None
The method returns the attribute value that can be an Infoblox::IPAM::Address object.
# Get attribute value my $value = $object->address_object();
Use this method to retrieve the flag indicates whether or not modify the admin status of an interface in this device. This is a read-only attribute.
None
The method returns the attribute value. Note that this method has to be explicitly requested via Infoblox::Session's return_methods member.
# Get attribute value my $value = $object->cap_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. Note that this method has to be explicitly requested via Infoblox::Session's return_methods member.
# Get attribute value my $value = $object->cap_admin_status_na_reason();
Use this method to retrieve the flag indicates whether or not modify the description of an interface in this device. This is a read-only attribute.
None
The method returns the attribute value. Note that this method has to be explicitly requested via Infoblox::Session's return_methods member.
# Get attribute value my $value = $object->cap_description_ind();
Use this method to retrieve the reason if the description edit action is not available. This is a read-only attribute.
None
The method returns the attribute value. Note that this method has to be explicitly requested via Infoblox::Session's return_methods member.
# Get attribute value my $value = $object->cap_description_na_reason();
Use this method to retrieve the flag indicates whether or not deprovision a network from interfaces of this device. This is a read-only attribute.
None
The method returns the attribute value. Note that this method has to be explicitly requested via Infoblox::Session's return_methods member.
# Get attribute value my $value = $object->cap_net_deprovisioning_ind();
Use this method to retrieve the reason if the deprovision a network from interfaces of this device is not available. This is a read-only attribute.
None
The method returns the attribute value. Note that this method has to be explicitly requested via Infoblox::Session's return_methods member.
# Get attribute value my $value = $object->cap_net_deprovisioning_na_reason();
Use this method to retrieve the flag indicates whether or not modify the network associated to an interface of this device. This is a read-only attribute.
None
The method returns the attribute value. Note that this method has to be explicitly requested via Infoblox::Session's return_methods member.
# Get attribute value my $value = $object->cap_net_provisioning_ind();
Use this method to retrieve the reason if the network provisioning is not available. This is a read-only attribute.
None
The method returns the attribute value. Note that this method has to be explicitly requested via Infoblox::Session's return_methods member.
# Get attribute value my $value = $object->cap_net_provisioning_na_reason();
Use this method to retrieve the flag indicates whether or not create a VLAN and then provision a network in to this interface. This is a read-only attribute.
None
The method returns the attribute value. Note that this method has to be explicitly requested via Infoblox::Session's return_methods member.
# Get attribute value my $value = $object->cap_net_vlan_provisioning_ind();
Use this method to retrieve the reason if the network provisioning on VLAN is not available. This is a read-only attribute.
None
The method returns the attribute value. Note that this method has to be explicitly requested via Infoblox::Session's return_methods member.
# Get attribute value my $value = $object->cap_net_vlan_provisioning_na_reason();
Use this method to retrieve the flag indicates whether or not modify the VLAN assignement of an interface in this device. This is a read-only attribute.
None
The method returns the attribute value. Note that this method has to be explicitly requested via Infoblox::Session's return_methods member.
# Get attribute value my $value = $object->cap_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. Note that this method has to be explicitly requested via Infoblox::Session's return_methods member.
# Get attribute value my $value = $object->cap_vlan_assignment_na_reason();
Use this method to retrieve the flag indicates whether or not modify the voice vlan assignement of an interface in this device. This is a read-only attribute.
None
The method returns the attribute value. Note that this method has to be explicitly requested via Infoblox::Session's return_methods member.
# Get attribute value my $value = $object->cap_voice_vlan_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. Note that this method has to be explicitly requested via Infoblox::Session's return_methods member.
# Get attribute value my $value = $object->cap_voice_vlan_na_reason();
Use this method to retrieve the device chassis serial number. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->chassis_serial_number();
Use this method to retrieve the device class. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->class();
Use this method to retrieve the device description. 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 current discovery status. This attribute is read-only.
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 Device 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 the device interfaces. This is a read-only attribute.
None
The method returns the attribute value that can be an array reference that contains Infoblox::Grid::Discovery::DeviceInterface objects. Note that this method has to be explicitly requested via Infoblox::Session's return_methods member.
# Get attribute value my $value = $object->interfaces();
Use this method to retrieve the device location. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->location();
Use this method to retrieve the device model name. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->model();
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 device 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 a list of the device neighbors. This is a read-only attribute.
None
The method returns the attribute value that can be an array reference that contains Infoblox::Grid::Discovery::DeviceNeighbor objects. Note that this method has to be explicitly requested via Infoblox::Session's return_methods member.
# Get attribute value my $value = $object->neighbors();
Use this method to retrieve the network object. This is a read-only attribute.
None
The method returns the attribute value that can be an Infoblox::DHCP::Network or Infoblox::DHCP::IPv6Network object.
# Get attribute value my $value = $object->network();
Use this method to retrieve the network view name. 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 a list of network objects. This is a read-only attribute.
None
The method returns the attribute value that can be an array reference that contains Infoblox::DHCP::Network and Infoblox::DHCP::IPv6Network objects. Note that this method has to be explicitly requested via Infoblox::Session's return_methods member.
# Get attribute value my $value = $object->networks();
Use this method to retrieve the Operating System version running on the device. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->os_version();
Use this method to retrieve a list of device port statistics. This is a read-only attribute.
None
The method returns the attribute value that can be an arrary reference that contains Infoblox::Grid::Discovery::Device::PortStatistics objects.
# Get attribute value my $value = $object->port_stats();
Use this method to retrieve the device vendor name. This is a read-only attribute.
None
The method returns the attribute value.
# Get attribute value my $value = $object->vendor();
Use this method to retrieve a list of VLAN information. This is a read-only attribute.
None
The method returns the attribute value that can be an arrary reference that contains Infoblox::Grid::Discovery::VLANInfo objects.
# Get attribute value my $value = $object->vlan_infos();
Infoblox Inc. http://www.infoblox.com/
Infoblox::Session, Infoblox::DHCP::Network, Infoblox::DHCP::IPv6Network, Infoblox::Grid::Discovery::DeviceNeighbor, Infoblox::Grid::Discovery::DeviceInterface, Infoblox::IPAM::Address, Infoblox::Grid::MSServer::AdUser::Data
Copyright (c) 2017 Infoblox Inc.