Infoblox::MasterGrid::Grid - Manages the Master Grid settings.

• NAME
• DESCRIPTION
• CONSTRUCTOR
• SESSION METHODS
• Infoblox::Session->get( )
• Infoblox::Session->search( )
• Infoblox::Session->modify( )
• METHODS
• address( )
• connection_timestamp( )
• detached( )
• enabled( )
• joined( )
• last_event( )
• last_event_details( )
• last_sync_timestamp( )
• port( )
• status( )
• AUTHOR
• SEE ALSO
• COPYRIGHT

NAME

Infoblox::MasterGrid::Grid - Manages the Master Grid settings.

DESCRIPTION

This class manages the Master Grid.

CONSTRUCTOR

The Infoblox::MasterGrid::Grid object is automatically generated when a Grid successfully joins the Master Grid. It does not require manual construction.

SESSION METHODS

This section describes all the methods in Infoblox::Session that you can apply to a Master Grid object.

Infoblox::Session->get( )

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

Key References

 Apply the following attributes to get a specific Master Grid object:

 name    - Optional. The Master Grid name in string format.
 port    - Optional. The Master Grid port number.

Example

 my $grid = $session->get(
     object => "Infoblox::MasterGrid::Grid");

Infoblox::Session->search( )

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

Key References

 Apply the following attributes to get a specificMaster Grid object:

 name    - Optional. The Master Grid name in string format. Regular expression is supported.
 port    - Optional. The Master Grid port number.

Example

 my $grid = $session->search(
     object => "Infoblox::MasterGrid::Grid");

Infoblox::Session->modify( )

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

Example

 # Use this method to modify the enabled status
 $grid->enabled("false");
 # Submit modification
 my $response = $session->modify( $grid );

METHODS

This section describes all the methods that you can use to configure and retrieve the attribute values of a Master Grid.

address( )

Use this method to set or retrieve the domain name or IP address for the Master Grid.

Parameter

Valid values are a domain name in FQDN format or an IP address.

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 address
 my $address = $grid->address();
 #Modify address
 $grid->address("10.0.0.1");

connection_timestamp( )

Use this method to retrieve the timestamp that indicates when the connection to the Master Grid was established.

Parameter

none

Returns

The method returns the timestamp.

Example

 #Get the Master Grid connection_timestamp
 my $connection_timestamp = $mg->connection_timestamp();

detached( )

Use this method to retrieve the detached flag for the Master Grid.

Parameter

none

Returns

The method returns "true" or "false".

Example

 #Get detached flag
 my $detached = $grid->detached();

enabled( )

Use this method to set or retrieve the enabled flag for the Master Grid.

Parameter

Valid values are "true" or "false".

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 enabled flag
 my $enabled = $grid->enabled();
 #Modify enabled flag
 $grid->enabled("false");

joined( )

Use this method to retrieve the status of the Grid's join operation to the Master Grid.

Parameter

none

Returns

The method returns "true" or "false".

Example

 #Get the join status of the Grid to the Master Grid
 my $joined = $mg->joined();

last_event( )

Use this method to retrieve the Master Grid's last event.

Parameter

none

Returns

The method returns the Master Grid's last event.

Example

 #Get the Master Grid last_event
 my $last_event = $mg->last_event();

last_event_details( )

Use this method to retrieve the details of the Master Grid's last event.

Parameter

none

Returns

The method returns details on the Master Grid's last event.

Example

 #Get the Master Grid last_event_details
 my $last_event_details = $mg->last_event_details();

last_sync_timestamp( )

Use this method to retrieve the timestamp for the last synchronization operation with the Master Grid.

Parameter

none

Returns

The method returns the timestamp.

Example

 #Get the Master Grid last_sync_timestamp
 my $last_sync_timestamp = $mg->last_sync_timestamp();

port( )

Use this method to set or retrieve the Master Grid port to which the Grid connects.

Parameter

Valid value is a port number from 0 to 65535.

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 port
 my $port = $grid->port();
 #Modify port
 $grid->port(1234);

status( )

Use this method to retrieve the Master Grid's status.

Parameter

none

Returns

The method returns the Master Grid's status in string format.

Example

 #Get the Master Grid status
 my $status = $mg->status();

AUTHOR

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

SEE ALSO

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

COPYRIGHT

Copyright (c) 2017 Infoblox Inc.