Infoblox::Grid::Discovery::Data - the discovered data.


NAME

Infoblox::Grid::Discovery::Data - the discovered data.


DESCRIPTION

The object provides information about the discovered data.


CONSTRUCTOR

 my $object = Infoblox::Grid::Discovery::Data->new(
    'ap_name'                            => $string,
    'ap_ip_address'                      => $ipaddr,
    'ap_ssid'                            => $string,
    'bridge_domain                       => $string,
    'duid'                               => $string,
    'mac_address'                        => $string,
    'netbios'                            => $string,
    'os'                                 => $string,
    'device_model'                       => $string,
    'device_port_name'                   => $string,
    'device_port_type'                   => $string,
    'device_type'                        => $string,
    'device_vendor'                      => $string,
    'discovered_name'                    => $string,
    'discoverer'                         => $string,
    'endpoint_groups'                    => $string,
    'first_discovered'                   => $datetime,
    'last_discovered'                    => $datetime,
    'mgmt_ip_address'                    => $ipaddr,
    'network_component_description'      => $string,
    'network_component_ip'               => $ipaddr,
    'network_component_model'            => $string,
    'network_component_name'             => $string,
    'network_component_port_description' => $string,
    'network_component_port_name'        => $string,
    'network_component_port_number'      => $uint,
    'network_component_type'             => $string,
    'network_component_vendor'           => $string,
    'open_ports'                         => $string,
    'port_duplex'                        => 'Full' | 'Half',
    'port_link_status'                   => 'Connected' | 'Not Connected' | 'Unknown',
    'port_speed'                         => '100G' | '100M' | '10G' | '10M' | '1G' | 'Unknown',
    'port_status'                        => 'Down' | 'Unknown' | 'Up',
    'port_type'                          => $string,
    'port_vlan_description'              => $string,
    'port_vlan_name'                     => $string,
    'port_vlan_number'                   => $uint,
    'task_name'                          => $string,
    'tenant'                             => $string,
    'network_component_location'         => $string,
    'network_component_contact'          => $string,
    'device_location'                    => $string,
    'device_contact'                     => $string,
    'v_netadapter'                       => $string,
    'v_cluster'                          => $string,
    'v_datacenter'                       => $string,
    'v_name'                             => $string,
    'v_type'                             => 'VirtualCenter' | 'HostSystem' | 'VirtualMachine',
    'v_host'                             => $string,
    'v_os'                               => $string,
    'v_switch'                           => $string,
 );
 


SESSION METHODS

The object does not support any session methods.


METHODS

This section describes all the methods that you can use to set or retrieve the attribute values of the discovered data object.

device_model( )

Use this method to set or retrieve the model name of the device in the vendor terminology.

Parameter

The model name of the device in string format.

Returns

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.

Example
 # Get attribute value
 my $value = $object->device_model();
 # Modify attribute value
 $object->device_model('model');

device_port_name( )

Use this method to set or retrieve the system name of the interface the IP associates with.

Parameter

The system name of the interface in string format.

Returns

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.

Example
 # Get attribute value
 my $value = $object->device_port_name();
 # Modify attribute value
 $object->device_port_name('port');

device_port_type( )

Use this method to set or retrieve the hardware type of the interface the IP associates with.

Parameter

The hardware type of the interface in string format.

Returns

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.

Example
 # Get attribute value
 my $value = $object->device_port_type();
 # Modify attribute value
 $object->device_port_type('type');

device_type( )

Use this method to set or retrieve the type of the device in the vendor terminology.

Parameter

The type of the device in string format.

Returns

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.

Example
 # Get attribute value
 my $value = $object->device_type();
 # Modify attribute value
 $object->device_type('type');

device_vendor( )

Use this method to set or retrieve the vendor name of the device.

Parameter

The vendor name of the device in string format.

Returns

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.

Example
 # Get attribute value
 my $value = $object->device_vendor();
 # Modify attribute value
 $object->device_vendor('vendor');

discovered_name( )

Use this method to set or retrieve the name of the IP as seen by the discovery station.

Parameter

The discovered name in string format.

Returns

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.

Example
 # Get attribute value
 my $value = $object->discovered_name();
 # Modify attribute value
 $object->discovered_name('name');

discoverer( )

Use this method to set or retrieve the name of the discoverer.

Parameter

The name of the discoverer in string format.

Returns

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.

Example
 # Get attribute value
 my $value = $object->discoverer();
 # Modify attribute value
 $object->discoverer('discoverer');

duid( )

Use this method to set or retrieve the discovered DHCPv6 UID (DUID).

Parameter

The discovered DHCPv6 UID (DUID) in string format.

Returns

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.

Example
 # Get attribute value
 my $value = $object->duid();
 # Modify attribute value
 $object->duid('aa:aa');

endpoint_groups( )

Use this method to retrieve comma-separated list of discovered endpoint groups. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->endpoint_groups();

first_discovered( )

Use this method to set or retrieve the date and time when the object was first discovered.

Parameter

The date and time in the ISO 8601 extended format (e.g. 2008-10-21T10:56:33Z or 2008-10-21T10:56:33.001Z).

Returns

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.

Example
 # Get attribute value
 my $value = $object->first_discovered();
 # Modify attribute value
 $object->first_discovered('2008-10-21T10:56:33Z');

iprg_no( )

Use this method to set or retrieve the port redundant group number.

Parameter

Valid value is an unsigned integer which describes port redundant group number.

Returns

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.

Example
 # Get attribute value
 my $value = $object->iprg_no();
 # Modify attribute value
 $object->iprg_no(10);

iprg_state( )

Use this method to set or retrieve the status for the IP address within port redundant group.

Parameter

Valid value is "VIP", "ACTIVE", "NEGOTIATION" or "STANDBY".

Returns

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.

Example
 # Get attribute value
 my $value = $object->iprg_state();
 # Modify attribute value
 $object->iprg_state('ACTIVE');

iprg_type( )

Use this method to set or retrieve the port redundant group type.

Parameter

Valid value is "HSRP" or "VRRP".

Returns

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.

Example
 # Get attribute value
 my $value = $object->iprg_type();
 # Modify attribute value
 $object->iprg_type('HSRP');

last_discovered( )

Use this method to set or retrieve the date and time when the object was last discovered.

Parameter

The date and time in the ISO 8601 extended format (e.g. 2008-10-21T10:56:33Z or 2008-10-21T10:56:33.001Z).

Returns

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.

Example
 # Get attribute value
 my $value = $object->last_discovered();
 # Modify attribute value
 $object->last_discovered('2008-10-21T10:56:33Z');

mac_address( )

Use this method to set or retrieve the MAC address.

Parameter

The MAC address in string format.

Returns

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.

Example
 # Get attribute value
 my $value = $object->mac_address();
 # Modify attribute value
 $object->mac_address('11:11:11:11:11:11');

mgmt_ip_address( )

Use this method to set or retrieve the management IP address of the device if the device has more than one IP.

Parameter

The management IP address of the device.

Returns

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.

Example
 # Get attribute value
 my $value = $object->mgmt_ip_address();
 # Modify attribute value
 $object->mgmt_ip_address('10.0.0.1');

netbios( )

Use this method to set or retrieve the discovered NetBIOS name.

Parameter

The discovered NetBIOS name in string format.

Returns

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.

Example
 # Get attribute value
 my $value = $object->netbios();
 # Modify attribute value
 $object->netbios('netbios');

network_component_description( )

Use this method to set or retrieve the descriptive string for the network component.

Parameter

The descriptive string for the network component.

Returns

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.

Example
 # Get attribute value
 my $value = $object->network_component_description();
 # Modify attribute value
 $object->network_component_description('description');

network_component_ip( )

Use this method to set or retrieve the IP Address the network component.

Parameter

The IP Address the network component.

Returns

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.

Example
 # Get attribute value
 my $value = $object->network_component_ip();
 # Modify attribute value
 $object->network_component_ip('10.0.0.2');

network_component_model( )

Use this method to set or retrieve the model name of the network component.

Parameter

The model name of the network component in string format.

Returns

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.

Example
 # Get attribute value
 my $value = $object->network_component_model();
 # Modify attribute value
 $object->network_component_model('model');

network_component_name( )

Use this method to set or retrieve the name of the network component.

Parameter

The name of the network component in string format.

Returns

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.

Example
 # Get attribute value
 my $value = $object->network_component_name();
 # Modify attribute value
 $object->network_component_name('name');

network_component_port_description( )

Use this method to set or retrieve the description of the port on the network component.

Parameter

The description of the port on the network component in string format.

Returns

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.

Example
 # Get attribute value
 my $value = $object->network_component_port_description();
 # Modify attribute value
 $object->network_component_port_description('description');

network_component_port_name( )

Use this method to set or retrieve the port name on the network component on which the IP was discovered.

Parameter

The port name on the network component in string format.

Returns

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.

Example
 # Get attribute value
 my $value = $object->network_component_port_name();
 # Modify attribute value
 $object->network_component_port_name('port');

network_component_port_number( )

Use this method to set or retrieve the port number on the network component on which the IP was discovered.

Parameter

The port number on the network component.

Returns

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.

Example
 # Get attribute value
 my $value = $object->network_component_port_number();
 # Modify attribute value
 $object->network_component_port_number(10);

network_component_type( )

Use this method to set or retrieve the type of network component.

Parameter

The type of network component in string format.

Returns

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.

Example
 # Get attribute value
 my $value = $object->network_component_type();
 # Modify attribute value
 $object->network_component_type('type');

network_component_vendor( )

Use this method to set or retrieve the vendor name of the network component to which the device is connected.

Parameter

The vendor name of the network component in string format.

Returns

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.

Example
 # Get attribute value
 my $value = $object->network_component_vendor();
 # Modify attribute value
 $object->network_component_vendor('vendor');

open_ports( )

Use this method to set or retrieve the list of opened ports on the IP address, represented as: "TCP: 21,22,23 UDP: 137,139".

Parameter

The list of opened ports in string format.

Returns

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.

Example
 # Get attribute value
 my $value = $object->open_ports();
 # Modify attribute value
 $object->open_ports('TCP: 21,22,23 UDP: 137,139');

os( )

Use this method to set or retrieve the name of the operation system by network discovery.

Parameter

The name of the operation system in string format.

Returns

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.

Example
 # Get attribute value
 my $value = $object->os();
 # Modify attribute value
 $object->os('linux');

port_duplex( )

Use this method to set or retrieve duplex settings on the port on the network component.

Parameter

Valid value is 'Full' or 'Half'.

Returns

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.

Example
 # Get attribute value
 my $value = $object->port_duplex();
 # Modify attribute value
 $object->port_duplex('Full');

port_link_status( )

Use this method to set or retrieve the link status of the port on the network component.

Parameter

Valid value is 'Connected', 'Not Connected' or 'Unknown'.

Returns

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.

Example
 # Get attribute value
 my $value = $object->port_link_status();
 # Modify attribute value
 $object->port_link_status('Connected');

port_speed( )

Use this method to set or retrieve speed settings on the port on the network component.

Parameter

Valid value is '10M', '100M', '1G', '10G', '100G' or 'Unknown'.

Returns

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.

Example
 # Get attribute value
 my $value = $object->port_speed();
 # Modify attribute value
 $object->port_speed('Unknown');

port_status( )

Use this method to set or retrieve the status of the port on the network component.

Parameter

Valid value is 'Up', 'Down' or 'Unknown'.

Returns

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.

Example
 # Get attribute value
 my $value = $object->port_status();
 # Modify attribute value
 $object->port_status('Unknown');

port_type( )

Use this method to set or retrieve the type of the interface on the network component to which the device is connected.

Parameter

The type of the interface on the network component in string format.

Returns

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.

Example
 # Get attribute value
 my $value = $object->port_type();
 # Modify attribute value
 $object->port_type('type');

port_vlan_description( )

Use this method to set or retrieve the description of the VLAN on the port on the network component.

Parameter

The description of the VLAN on the port on the network component in string format.

Returns

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.

Example
 # Get attribute value
 my $value = $object->port_vlan_description();
 # Modify attribute value
 $object->port_vlan_description('description');

port_vlan_name( )

Use this method to set or retrieve the name of the VLAN on the port on the network component.

Parameter

The name of the VLAN on the port on the network component in string format.

Returns

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.

Example
 # Get attribute value
 my $value = $object->port_vlan_name();
 # Modify attribute value
 $object->port_vlan_name('name');

port_vlan_number( )

Use this method to set or retrieve the number VLANs on the port on the network component.

Parameter

The number of VLANs on the port on the network component.

Returns

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.

Example
 # Get attribute value
 my $value = $object->port_vlan_number();
 # Modify attribute value
 $object->port_vlan_number(10);

task_name( )

Use this method to retrieve the name of discovery task. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->task_name();

tenant( )

Use this method to retrieve the discovered tenant. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->tenant();

network_component_location( )

Use this method to retrieve location of the network component on which the IP address was discovered. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->network_component_location();

ap_name( )

Use this method to retrieve discovered name of Wireless Access Point. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->ap_name();

ap_ip_address( )

Use this method to retrieve discovered IP address of Wireless Access Point. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->ap_ip_address();

ap_ssid( )

Use this method to retrieve service set identifier (SSID) associated with Wireless Access Point. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->ap_ssid();

bridge_domain( )

Use this method to retrieve the discovered bridge domain. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->bridge_domain();

network_component_contact( )

Use this method to retrieve contact information from the network component on which the IP address was discovered. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->network_component_contact();

device_location( )

Location of device on which the IP address was discovered. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->device_location();

device_contact( )

Contact information from device on which the IP address was discovered. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->device_contact();

v_cluster( )

Use this method to set or retrieve the VMware cluster in the entity found.

Parameter

The VMware cluster in string format.

Returns

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.

Example
 # Get attribute value
 my $value = $object->v_cluster();
 # Modify attribute value
 $object->v_cluster('cluster');

v_datacenter( )

Use this method to set or retrieve the VMware datacenter in the entity found.

Parameter

The VMware datacenter in string format.

Returns

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.

Example
 # Get attribute value
 my $value = $object->v_datacenter();
 # Modify attribute value
 $object->v_datacenter('datacenter');

v_host( )

Use this method to set or retrieve the VMware host system in the entity found.

Parameter

The VMware host system in string format.

Returns

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.

Example
 # Get attribute value
 my $value = $object->v_host();
 # Modify attribute value
 $object->v_host('host');

v_name( )

Use this method to set or retrieve the VMware entity name in the entity found.

Parameter

The VMware entity name in string format.

Returns

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.

Example
 # Get attribute value
 my $value = $object->v_name();
 # Modify attribute value
 $object->v_name('name');

v_netadapter( )

Use this method to set or retrieve the VMware physical adapter in the entity found.

Parameter

The VMware physical adapter in string format.

Returns

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.

Example
 # Get attribute value
 my $value = $object->v_netadapter();
 # Modify attribute value
 $object->v_netadapter('netadapter');

v_os( )

Use this method to set or retrieve the VMware Operating System in the entity found.

Parameter

The VMware Operating System in string format.

Returns

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.

Example
 # Get attribute value
 my $value = $object->v_os();
 # Modify attribute value
 $object->v_os('linux');

v_switch( )

Use this method to set or retrieve the VMware virtual switch in the entity found.

Parameter

The VMware virtual switch in string format.

Returns

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.

Example
 # Get attribute value
 my $value = $object->v_switch();
 # Modify attribute value
 $object->v_switch('switch');

v_type( )

Use this method to set or retrieve the type of encryption to use.

Parameter

Valid value is 'VirtualCenter', 'HostSystem' or 'VirtualMachine'.

Returns

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.

Example
 # Get attribute value
 my $value = $object->v_type();
 # Modify attribute value
 $object->v_type('VirtualMachine');

vmi_name( )

Use this method to retrieve the name of the virtual machine. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vmi_name();

vmi_id( )

Use this method to retrieve the ID of the virtual machine. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vmi_id();

vmi_tenant_id( )

Use this method to retrieve the Tenant ID to which the virtual machine belongs. This is a read-only attribute

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vmi_tenant_id();

vlan_port_group( )

Use this method to retrieve the port group to which the virtual machine belongs. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vlan_port_group();

vswitch_name( )

Use this method to retrieve the name of the virtual switch. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vswitch_name();

vswitch_id( )

Use this method to retrieve the ID of the virtual switch. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vswitch_id();

vswitch_type( )

Use this method to retrieve the type of the virtual switch: Standard or Distributed. 'Unknown' indicates the value is not avialable. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vswitch_type();

vswitch_ipv6_enabled( )

Use this method to retrieve the flag used to indicate if the virtual swich has IPv6 enabled or not. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vswitch_ipv6_enabled();

vport_name( )

Use this method to retrieve the name of the network adapter on the virtual switch to which the virtual machine is connected. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vport_name();

vport_mac_address( )

Use this method to retrieve the MAC address of the network adapter on the virtual switch to which the the virtual machine is connected. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vport_mac_address();

vport_link_status( )

Use this method to retrieve the status of the link of the network adapter on the virtual switch to which the virtual machine is connected. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vport_link_status();

vport_conf_speed( )

Use this method to retrieve the configured speed (in Kb) of the network adapter on the virtual switch to which the virtual machine is connected. Example: 1500Kb. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vport_conf_speed();

vport_conf_mode( )

Use this method to retrieve the configured mode of the network adapter on the virtual switch to which the virtual machine is connected. Valid value is Full-duplex or Half-duplex. 'Unknown' indicates the value is not available. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vport_conf_mode();

vport_speed( )

Use this method to retrieve the actual speed (in Kb) of the network adapter on the virtual switch to which the virtual machine is connected. Example: 1500Kb. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vport_speed();

vport_mode( )

Use this method to retrieve the actual mode of the network adapter on the virtual switch to which the virtual machine is connected. Valid value is Full-duplex or Half-duplex. 'Unknown' indicates the value is not available. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vport_mode();

vswitch_segment_type( )

Use this method to retrieve the type of the network segment to which the current virtual machine/vport is connected. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vswitch_segment_type();

vswitch_segment_name( )

Use this method to retrieve the name of the network segment to which the current virtual machine/vport is connected. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vswitch_segment_name();

vswitch_segment_id( )

Use this method to retrieve the ID of the network segment to which the current virtual machine/vport is connected. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vswitch_segment_id();

vswitch_segment_port_group( )

Use this method to retrieve the port group of the network segment to which the current virtual machine/vport is connected. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vswitch_segment_port_group();

vswitch_available_ports_count( )

Use this method to retrieve the number of available ports reported by the virtual switch to which the virtual machine/vport is connected. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vswitch_available_ports_count();

vswitch_tep_type( )

Use this method to retrieve the type of virtual tunnel endpoint (VTEP) in the virtual switch. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vswitch_tep_type();

vswitch_tep_ip ( )

Use this method to retrieve the IP address of the virtual tunnel endpoint (VTEP) in the virtual switch. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vswitch_tep_ip ();

vswitch_tep_port_group( )

Use this method to retrieve the port group of the virtual tunnel endpoint (VTEP) in the virtual switch. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vswitch_tep_port_group();

vswitch_tep_vlan( )

Use this method to retrieve the VLAN of the virtual tunnel endpoint (VTEP) in the virtual switch. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vswitch_tep_vlan();

vswitch_tep_dhcp_server( )

Use this method to retrieve the DHCP server of the virtual tunnel endpoint (VTEP) in the virtual switch. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vswitch_tep_dhcp_server();

vswitch_tep_multicast( )

Use this method to retrieve the multicast address of the virtual tunnel endpoint (VTEP) in the virtual swtich. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vswitch_tep_multicast();

vmhost_ip_address( )

Use this method to retrieve the IP address of the physical node on which the virtual machine is hosted. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vmhost_ip_address ();

vmhost_name( )

Use this method to retrieve the name of the physical node on which the virtual machine is hosted. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vmhost_name();

vmhost_mac_address ( )

Use this method to retrieve the MAC address of the physical node on which the virtual machine is hosted. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vmhost_mac_address ();

vmhost_subnet_cidr ( )

Use this method to retrieve the CIDR subnet of the physical node on which the virtual machine is hosted. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vmhost_subnet_cidr ();

vmhost_nic_names( )

Use this method to retrieve the list of all physical port names used by the virtual switch on the physical node on which the virtual machine is hosted. Represented as: "eth1,eth2,eth3". This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vmhost_nic_names();

cisco_ise_endpoint_profile( )

Use this method to retrieve a name of the endpoint profile created in Cisco ISE. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->cisco_ise_endpoint_profile();

cisco_ise_security_group( )

Use this method to retrieve the Cisco ISE security group. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->cisco_ise_security_group();

cisco_ise_session_state( )

Use this method to retrieve the Cisco ISE session state. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->cisco_ise_session_state();

cisco_ise_ssid( )

Use this method to retrieve the Cisco ISE SSID. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->cisco_ise_ssid();

cmp_type( )

Use this method to retrieve the Cloud Management Platform type. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->cmp_type();

vmi_ip_type( )

Use this method to retrieve the discovered IP address type. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vmi_ip_type();

vmi_private_address( )

Use this method to retrieve the private IP address of the virtual machine. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vmi_private_address();

vmi_is_public_address( )

Use this method to retrieve the flag used to indicate whether the IP address is a public address or not. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example
 # Get attribute value
 my $value = $object->vmi_is_public_address();


SAMPLE CODE

The following sample code demonstrates the different functions that can be applied to a discovered data object.

#Preparation

 use strict;
 use Infoblox;
 #Create a session to the Infoblox appliance
 my $host_ip   = "192.168.1.2";
 my $host_name = "infoblox.localdomain";
 my $session = Infoblox::Session->new(
     master   => $host_ip,       #appliance host ip
     username => "admin",        #appliance user login
     password => "infoblox"      #appliance password
 );
 unless ($session) {
    die("Construct session failed: ".
         Infoblox::status_code() . ":" . Infoblox::status_detail());
 }
 print "Session created successfully.\n";

#Get an Infoblox::Grid::Discovery::Data object

 my @retrieved_objs = $session->get('object' => 'Infoblox::DHCP::FixedAddr', 'ipv4addr' => '10.0.0.5');
 my $fa = $retrieved_objs[0];
 unless ($fa) {
    die("Get FixedAddr object failed: ".
        $session->status_code() . ":" . $session->status_detail());
 }
 my $data = $fa->discovered_data();
 unless ($data) {
    die("FixedAddr object doesn't contain the discovered data");
 }

#Search by discovered data

 $data = Infoblox::Grid::Discovery::Data->new(
    'netbios' => 'Fixed*',
    'v_type'  => 'VirtualCenter',
 );
 unless ($data) {
    die("Construct Infoblox::Grid::Discovery::Data object failed: ".
         Infoblox::status_code() . ":" . Infoblox::status_detail());
 }
 @retrieved_objs = $session->get('object' => 'Infoblox::DHCP::FixedAddr', 'discovered_data' => $data);
 $fa = $retrieved_objs[0];
 unless ($fa) {
    die("Get FixedAddr object failed: ".
        $session->status_code() . ":" . $session->status_detail());
 }
 ####PROGRAM ENDS####


AUTHOR

Infoblox Inc. http://www.infoblox.com/


COPYRIGHT

Copyright (c) 2017 Infoblox Inc.