Infoblox::Grid::Discovery::Properties - Grid discovery properties.
The object provides information about Grid discovery properties.
my $object = Infoblox::Grid::Discovery::Properties->new( 'advanced_polling_settings' => $adv, # Required 'auto_conversion_settings' => [$auto_conversion1, ...], # Optional 'basic_polling_settings' => $basic, # Required 'enable_auto_conversion' => 'true' | 'false' # Optional 'enable_auto_updates' => 'true' | 'false' # Optional 'snmp3_credentials' => [$snmp3_1, ...], # Optional 'snmp_credentials' => [$snmp_1, ...], # Optional 'cli_credentials' => [$cli1, ...], # Optional 'discovery_blackout_setting' => $blackout, # Optional 'port_control_blackout_setting' => $blackout, # Optional 'ports' => [$port1, ...], # Optional 'ignore_conflict_duration' => $uint, # Optional 'same_port_control_discovery_blackout' => 'true' | 'false' # Optional 'unmanaged_ips_limit' => $uint, # Optional 'unmanaged_ips_timeout' => $uint, # Optional 'vrf_mapping_rules' => [$vrf_rule_1, ...], # Optional 'vrf_mapping_policy' => 'NONE' | 'RULE_BASED' | 'RULE_AND_INTERNAL_BASED', # Optional );
This section describes all the methods in Infoblox::Session that you can apply to a object.
Use this method to retrieve the existing object from the Infoblox appliance. See Infoblox::Session->get() for parameters and return values.
my $object = $session->get('object' => 'Infoblox::Grid::Discovery::Properties');
Use this method to modify object in the Infoblox appliance. See Infoblox::Session->modify() for parameters and return values.
my $port = Infoblox::Grid::Discovery::Port->new( 'port' => 40, 'type' => 'UDP', );
# Use method to modify ports $object->ports([$port]); # Submit modification my $response = $session->modify( $object );
This section describes all the methods that you can use to set or retrieve the attribute values of the object.
Use this method to set or retrieve discovery advanced poll settings.
Valid value is an Infoblox::Grid::Discovery::AdvancedPollSettings object.
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 attribute value my $value = $object->advanced_polling_settings(); # Modify attribute value $object->advanced_polling_settings($adv);
Use this method to set or retrieve a list of automatic conversion settings.
Valid value is an array reference that contains Infoblox::Grid::Discovery::AutoConversionSetting 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 attribute value my $value = $object->auto_conversion_settings(); # Modify attribute value $object->auto_conversion_settings([$auto_conversion_settings1, $auto_conversion_settings2]);
Use this method to set or retrieve discovery basic poll settings.
Valid value is an Infoblox::Grid::Discovery::BasicPollSettings object.
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 attribute value my $value = $object->basic_polling_settings(); # Modify attribute value $object->basic_polling_settings($basic);
Use this method to set or retrieve the flag that enables automatic conversion of discovered data.
Specify 'true' to enable automatic conversion of discovery data or 'false' to disable 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 attribute value my $value = $object->enable_auto_conversion(); # Modify attribute value $object->enable_auto_conversion('true');
Use this method to set or retrieve the flag that enables updating discovered data for managed objects.
Specify 'true' to enable updating discovered data for managed objects or 'false' to disable it. The default value is 'true'.
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 attribute value my $value = $object->enable_auto_updates(); # Modify attribute value $object->enable_auto_updates('true');
Use this method to set or retrieve the discovery CLI credentials.
Valid value is an array reference that contains Infoblox::Grid::Discovery::CLICredential 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 attribute value my $value = $object->cli_credentials(); # Modify attribute value $object->cli_credentials([$cli1, $cli2]);
Use this method to set or retrieve the discovery blackout setting.
Valid value is an Infoblox::Grid::Discovery::Properties::BlackoutSetting object.
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 attribute value my $value = $object->discovery_blackout_setting(); # Modify attribute value $object->discovery_blackout_setting($blackout);
Use this method to set or retrieve the ignore discovery conflict duration.
The ignore discovery conflict duration in seconds.
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 attribute value my $value = $object->ignore_conflict_duration(); # Modify attribute value $object->ignore_conflict_duration(3600);
Use this method to set or retrieve ports to scan.
Valid value is an array reference that contains Infoblox::Grid::Discovery::Port 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 attribute value my $value = $object->ports(); # Modify attribute value $object->ports([$port1, $port2]);
Use this method to set or retrieve the port control blackout setting.
Valid value is an Infoblox::Grid::Discovery::Properties::BlackoutSetting object.
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 attribute value my $value = $object->port_control_blackout_setting(); # Modify attribute value $object->port_control_blackout_setting($blackout);
Use this method to set or retrieve the flag that enables using the same discovery blackout for port control blackout.
Specify 'true' to use same discovery blackout for port control blackout or 'false' to disable 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 attribute value my $value = $object->same_port_control_discovery_blackout(); # Modify attribute value $object->same_port_control_discovery_blackout('true');
Use this method to set or retrieve a list of discovery SNMPv3 credentials.
Valid value is an array reference that contains Infoblox::Grid::Discovery::SNMP3Credential 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 attribute value my $value = $object->snmp3_credentials(); # Modify attribute value $object->snmp3_credentials([$snmp3_1, $snmp3_2]);
Use this method to set or retrieve a list of discovery SNMP v1 and v2 credentials>.
Valid value is an array reference that contains Infoblox::Grid::Discovery::SNMPCredential 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 attribute value my $value = $object->snmp_credentials(); # Modify attribute value $object->snmp_credentials([$snmp1, $snmp2]);
Use this method to test credentials.
Note that this method does not perform automatic polling for the operational status. It returns a snapshot of the status at the time when you call the method, which may not be the final status. To get the latest status, the client script needs to provide polling logic for this method until the operation status is 'INPROGRESS' by calling the method with start parameter assigned to the end field in the previous call result. For more details, see the example below.
id - Optional. The test credential ID.
The following members are supported when id is defined:
start - Optional. The start position of the text.
The following members are supported when id is not defined:
view - Optional. The network view name. The default value is the system-defined default network view.
type - Optional if one of the following is defined: cli_credentials, snmp_credential, or snmp3_credential. Otherwise, this member is required. The valid value is 'CLI', 'SNMP' or 'SNMP3'.
device - Required if address is not defined. The Infoblox::Grid::Discovery::Device object.
member - Optional. The discovery member name.
address - Required if device is not defined. The IP address of the device.
cli_credentials - Optional. At least one of the following must be defined: cli_credentials, snmp_credential, or snmp3_credential. The array reference that contains Infoblox::Grid::Discovery::CLICredential objects.
snmp_credential - Optional. At least one of the following must be defined: cli_credentials, snmp_credential, or snmp3_credential. The Infoblox::Grid::Discovery::SNMPCredential object.
snmp3_credential - Optional. At least one of the following must be defined: cli_credentials, snmp_credential, or snmp3_credential. The Infoblox::Grid::Discovery::SNMP3Credential object.
The method returns an Infoblox::Grid::Discovery::TestCredential object when the operation succeeds, and returns false when the operation fails.
# Get a test credential ID my $result = $object->test_credential( 'address' => '10.0.0.1', 'snmp_credential' => $snmp, );
# Get detailed information by id if (ref($result) eq 'Infoblox::Grid::Discovery::TestCredential') { $result = $object->test_credential('id' => $result->id()); }
# check for the 'COMPLETE' or 'FAILED' status of test credential while (ref($result) eq 'Infoblox::Grid::Discovery::TestCredential' && $result->status() eq 'INPROGRESS') { $result = $grid->test_credential('id' => $result->id(), 'start' => $result->end()); }
Use this method to set or retrieve the limit value for discovered unmanaged IP addresses. This value determines how often users are notified when new unmanaged IP addresses are discovered in a particular network.
The valid value is an unsigned integer. The minimun value is 1.
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 attribute value my $value = $object->unmanaged_ips_limit(); # Modify attribute value $object->unmanaged_ips_limit(30);
Use this method to set or retrieve the timeout value (in seconds) between notifications about new unmanaged IP addresses in a particular network.
The valid value is an unsigned integer. The minimum value is 60 (one minute), and the maximum value is the number of seconds from the time you set it until January 2038.
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 attribute value my $value = $object->unmanaged_ips_timeout(); # Modify attribute value $object->unmanaged_ips_timeout(300);
Use this method to set or retrieve a list of VRF mapping rules.
Valid value is an array reference that contains Infoblox::Grid::Discovery::VRFMappingRule 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 attribute value my $value = $object->vrf_mapping_rules(); # Modify attribute value $object->vrf_mapping_rules([$vrf_mapping_rule1, $vrf_mapping_rule2]);
Use this method to set or retrieve the VRF mapping policy.
The policy type used to define the behavior of the VRF mapping. Valid value is one of the following policy types: 'NONE', 'RULE_BASED', 'RULE_AND_INTERNAL_BASED'.
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 attribute value my $value = $object->vrf_mapping_policy(); # Modify attribute value $object->vrf_mapping_policy('RULE_AND_INTERNAL_BASED');
Infoblox Inc. http://www.infoblox.com/
Infoblox::Session, Infoblox::Grid::Discovery::SNMPCredential, Infoblox::Grid::Discovery::SNMP3Credential, Infoblox::Grid::Discovery::Port, Infoblox::Grid::Discovery::CLICredential, Infoblox::Grid::Discovery::Properties::BlackoutSetting, Infoblox::Grid::Discovery::VRFMappingRule, Infoblox::Grid::Discovery::AutoConversionSetting
Copyright (c) 2017 Infoblox Inc.