Infoblox::Grid::DataCollection::Cluster - A data collection cluster object.
The data collection cluster object provides information and configuration for data collection feature.
This section describes all the methods in the Infoblox::Session module that you can apply to a data collection cluster object.
Use this method to retrieve all the matching objects from the Infoblox appliance. See Infoblox::Session->get() for parameters and return values.
Apply the following attributes to get a specific data collection cluster object:
comment - Optional. The data collection cluster comment.
name - Optional. The data collection cluster name.
unique_id - Optional. The data collection cluster unique hexadecimal identifier.
#Get cluster with name 'cluster1' my $object = $session->get( object => 'Infoblox::Grid::DataCollection::Cluster', name => 'cluster1', );
Use this method to modify an object in the Infoblox appliance. See Infoblox::Session->modify() for parameters and return values.
#Modify disable value $object->disable('true');
#Submit modification my $response = $session->modify($object);
Use this method to retrieve all the matching objects from the Infoblox appliance. See Infoblox::Session->search() for parameters and return values.
Apply the following attributes to search for a data collection cluster object:
comment - Optional. The data collection cluster comment (regexp);
name - Optional. The data collection cluster name (regexp);
unique_id - Optional. The data collection cluster unique hexadecimal identifier (regexp).
#Search for cluster that matches /cluster.*/ pattern my @objects = $session->search( object => 'Infoblox::Grid::DataCollection::Cluster', name => 'cluster.*', );
This section describes all the methods that can be used to configure and retrieve the attribute values of a data collection cluster object.
Use this method to set or retrieve the list of clusters that are prevented from activation.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is an array of Infoblox::Grid::DataCollection::BlacklistedCluster 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 blacklisted_clusters value my $blacklisted_clusters = $object->blacklisted_clusters();
#Modify blacklisted_clusters value $object->blacklisted_clusters([$cluster1, $cluster2]);
Use this method to set or retrieve the data collection cluster comment.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is a desired comment in a string format.
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 comment value my $comment = $object->comment();
#Modify comment value $object->comment('cluster comment');
Use this method to retrieve the list of data collector virtual machines. This is a read-only attribute.
Omit the parameter to retrieve the attribute value.
None
The valid return value is an array of Infoblox::Grid::DataCollection::IPInfo objects.
#Get datacollector_vms value my $datacollector_vms = $object->datacollector_vms();
Use this method to set or retrieve the flag that indicates whether the data collection cluster is enabled or disabled.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
Specify 'true' to enable the data collection cluster or 'false' to disable/deactivate it. The default value is 'false'.
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 disable value my $disable = $object->disable();
#Modify disable value $object->disable('true');
Use this method to set or retrieve the flag that indicates whether the data collection cluster registration is enabled or disabled.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
Specify 'true' to enable the data collection cluster registration or 'false' to prevent it from registration. The default value is 'false'.
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 enable_registration value my $enable_registration = $object->enable_registration();
#Modify enable_registration value $object->enable_registration('true');
Use this method to retrieve the last activation time for the data collection cluster.
Omit the parameter to retrieve the attribute value.
None
The method returns the attribute value, the number of seconds that have elapsed since January 1st, 1970 UTC.
#Get last_activation_time value my $last_activation_time = $object->last_activation_time();
Use this method to set or retrieve the name of the data collection cluster. This is a read-only attribute.
Omit the parameter to retrieve the attribute value.
None
The method returns the attribute value.
#Get name value my $name = $object->name();
Use this method to retrieve the time the data collection cluster was registered. This is a read-only attribute.
Omit the parameter to retrieve the attribute value.
None
The method returns the attribute value, the number of seconds that have elapsed since January 1st, 1970 UTC.
#Get registration_time value my $registration_time = $object->registration_time();
Use this method to set or retrieve the unique identifier for the data collection cluster.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is a desired hexadecimal identifier in a string format.
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 unique_id value my $unique_id = $object->unique_id();
#Modify unique_id value $object->unique_id('ABCD');
Infoblox Inc. http://www.infoblox.com/
Infoblox::Grid::DataCollection::BlacklistedCluster, Infoblox::Grid::DataCollection::IPInfo,
Copyright (c) 2017 Infoblox Inc.