Infoblox::DTC::Object - An object for all managed objects on DNS traffic control devices.

NAME
DESCRIPTION
CONSTRUCTOR
SESSION METHODS

Infoblox::Session->get( )
Infoblox::Session->search( )

METHODS

abstract_type( )
comment( )
display_type( )
extattrs( )
extensible_attributes( )
ipv4_address_list( )
ipv6_address_list( )
name( )
object( )
status( )
status_time( )

AUTHOR
SEE ALSO
COPYRIGHT

NAME

Infoblox::DTC::Object - An object for all managed objects on DNS traffic control devices.

DESCRIPTION

This is a read-only object for all managed objects on DNS traffic control devices.

CONSTRUCTOR

SESSION METHODS

This section describes all the methods in an Infoblox::Session module that you can apply to an object.

Infoblox::Session->get( )

Use this method to retrieve all the matching objects from the Infoblox appliance. See Infoblox::Session->get() for parameters and return values.

Key References

 Apply the following attributes to get a specific object:

  comment       - Optional. The comment.
  name          - Optional. The object name.
  type          - Optional. The object type. The valid values are 'LBDN', 'POOL' and 'SERVER'.
  status_member - Optional. Optional. The member that provides the health status for the object. The default is Grid.

Example

 my @retrieved_objs = $session->get(
    object => 'Infoblox::DTC::Object',
    name   => 'dtc_device',
 );

Infoblox::Session->search( )

Use this method to search for objects in the Infoblox appliance. See Infoblox::Session->search() for parameters and return values.

Key References

 Apply the following attributes to search a specific object:

  comment       - Optional. The comment.
  name          - Optional. The object name.
  type          - Optional. The object type. The valid values are 'LBDN', 'POOL' and 'SERVER'.
  status_member - Optional. The member that provides the health status for the object. The default is Grid.

Example

 my @retrieved_objs = $session->search(
    object => 'Infoblox::DTC::Object',
    name   => 'dtc_device',
 );

METHODS

This section describes all the methods that you can use to retrieve the attribute values of an object.

abstract_type( )

Use this method to retrieve an abstract object type. This method does not support any argument because the attribute is read-only and is set by the server.

Parameter

None

Returns

The method returns the attribute value.

Example

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

comment( )

Use this method to retrieve a descriptive comment. This method does not support any argument because the attribute is read-only and is set by the server.

Parameter

None

Returns

The method returns the attribute value.

Example

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

display_type( )

Use this method to retrieve an object type. This method does not support any argument because the attribute is read-only and is set by the server.

Parameter

None

Returns

The method returns the attribute value.

Example

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

extattrs( )

Use this method to retrieve the extensible attributes associated with an object object. This attribute is read-only and cannot be set.

Parameter

None.

Returns

The method returns the attribute value.

Example

 #Get extattrs
 my $ref_extattrs = $object->extattrs();

extensible_attributes( )

Use this method to retrieve the extensible attributes associated with an object. This method does not support any argument because the attribute is read-only and is set by the server.

Parameter

None

Returns

The method returns the attribute value.

Example

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

ipv4_address_list( )

Use this method to retrieve the IPv4 addresses for display. This method does not support any argument because the attribute is read-only and is set by the server.

Parameter

None

Returns

The method returns the attribute value.

Example

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

ipv6_address_list( )

Use this method to retrieve the IPv6 addresses for display. This method does not support any argument because the attribute is read-only and is set by the server.

Parameter

None

Returns

The method returns the attribute value.

Example

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

name( )

Use this method to retrieve an object name. This method does not support any argument because the attribute is read-only and is set by the server.

Parameter

None

Returns

The method returns the attribute value.

Example

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

object( )

Use this method to retrieve an object. This method does not support any argument because the attribute is read-only and is set by the server.

Parameter

None

Returns

The valid return value is an Infoblox::DTC::Pool, Infoblox::DTC::Server or Infoblox::DTC::LBDN object.

Example

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

status( )

Use this method to retrieve the current status of an object. This method does not support any argument because the attribute is read-only and is set by the server.

Parameter

None

Returns

The method returns the attribute value that can be 'BLUE', 'GRAY', 'GREEN', 'NONE', 'RED' or 'YELLOW'.

 +---------------+-------------------------------+
 |  GREEN        |  Working, OK                  |
 +---------------+-------------------------------+
 |  YELLOW       |  Warning                      |
 +---------------+-------------------------------+
 |  RED          |  Failed, Error                |
 +---------------+-------------------------------+
 |  BLUE         |  Transitional, Connecting     |
 +---------------+-------------------------------+
 |  GRAY         |  Disabled                     |
 +---------------+-------------------------------+
 |  NONE (BLACK) |  Inactive, Offline, Unknown   |
 +---------------+-------------------------------+

Example

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

status_time( )

Use this method to retrieve the timestamp of the object's current status. This is a read-only attribute.

Parameter

None

Returns

The method returns the attribute value.

Example

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

AUTHOR

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