Infoblox::CiscoISE::Endpoint - A Cisco ISE endpoint object.
The CiscoISE endpoint object provides configuration for third party Cisco ISE servers integration.
my $ise_endpoint = Infoblox::CiscoISE::Endpoint->new( address => $fqdn | $ipaddr, # Required bulk_download_certificate => $path, # Required client_certificate => $path, # Required subscribe_settings => $subscribe_settings, # Required subscribing_member => $string, # Required version => 'VERSION_1_3' | 'VERSION_1_4' | 'VERSION_2_0', # Required comment => $string, # Optional / Default is undefined connection_timeout => $uint, # Optional / Default is 10 disable => 'true' | 'false', # Optional / Default is 'true' extattrs => { $string => $extattr, ... }, # Optional / Default is undefined extensible_attributes => {$string => $string | $num, $string => [ $string | $num, ... ], ... } # Optional / Default is undefined network_view => $string, # Optional / Default is 'default' publish_settings => $publish_settings, # Optional / Default is undefined secondary_address => $fqdn | $ipaddr, # Optional / Default is undefined type => 'TYPE_CISCO', # Optional / Default is 'TYPE_CISCO', );
You cannot set both extattrs and extensible_attributes attributes at the same time.
This section describes all the methods in an Infoblox::Session module that you can apply to a Cisco ISE endpoint object.
Use this method to add the object to the Infoblox appliance. See Infoblox::Session->add() for parameters and return values.
#Construct an object my $object = Infoblox::CiscoISE::Endpoint->new( address => '10.0.0.1', bulk_download_certificate => '/path/to/bulk_download_cert.pem', client_certificate => '/path/to/client_cert.pem', subscribe_settings => $subscribe_settings, subscribing_member => 'infoblox.com', version => 'VERSION_1_3', );
#Submit for addition my $response = $session->add($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 Cisco ISE endpoint object:
address - Optional. The FQDN or IP address of the Cisco ISE endpoint. comment - Optional. The Cisco ISE endpoint comment in string format extattrs - Optional. A hash reference containing Infoblox::Grid::Extattr object. extensible_attributes - Optional. A hash reference containing extensible attributes. network_view - Optional. The Cisco ISE endpoint network view name. resolved_address - Optional. The resolved IP address of the Cisco ISE endpoint. resolved_secondary_address - Optional. The resolved secondary IP address of the Cisco ISE endpoint. secondary_address - Optional. The secondary FQDN or IP address of the Cisco ISE endpoint. subscribing_member - Optional. The Cisco ISE endpoint subscribing member name. type - Optional. The Cisco ISE endpoint type. version - Optional. The Cisco ISE endpoint version.
my @retrieved_objs = $session->get( object => 'Infoblox::CiscoISE::Endpoint', address => '10.0.0.1', );
my @retrieved_objs = $session->get( object => 'Infoblox::CiscoISE::Endpoint', extensible_attributes => {'Site' => 'Santa Clara'}, );
Use this method to modify the object in the Infoblox appliance. See Infoblox::Session->modify() for parameters and return values.
#Modify comment value $object->comment('this is a modified comment');
#Submit modification my $response = $session->modify($object);
Use this method to remove the object from the Infoblox appliance. See Infoblox::Session->remove() for parameters and return values.
To remove a specific object, first use get() or search() to retrieve the specific DHCP range object, and then submit this object for removal.
#Get the objects my @retrieved_objs = $session->get( object => 'Infoblox::CiscoISE::Endpoint', address => '10.0.0.1', newtork_view => 'default', );
#Find the desired object from the retrieved list my $desired_object = $retrieved_objs[0];
#Submit for removal my $response = $session->remove($desired_object);
Use this method to search for objects in the Infoblox appliance. See Infoblox::Session->search() for parameters and return values.
Apply the following attributes to search for the Cisco ISE endpoint object:
address - Optional. The FQDN or IP address of the Cisco ISE endpoint (regexp). comment - Optional. The Cisco ISE endpoint comment in string format (regexp). extattrs - Optional. A hash reference containing Infoblox::Grid::Extattr object. extensible_attributes - Optional. A hash reference containing extensible attributes. network_view - Optional. The Cisco ISE endpoint network view name (exact). resolved_address - Optional. The resolved IP address of the Cisco ISE endpoint (regexp). resolved_secondary_address - Optional. The resolved secondary IP address of the Cisco ISE endpoint (regexp). secondary_address - Optional. The secondary FQDN or IP address of the Cisco ISE endpoint (regexp). subscribing_member - Optional. The Cisco ISE endpoint subscribing member name (exact). type - Optional. The Cisco ISE endpoint type (exact). version - Optional. The Cisco ISE endpoint version (exact).
For more information about searching extensible attributes, see Infoblox::Grid::ExtensibleAttributeDef/Searching Extensible Attributes.
# search for objects my @retrieved_objs = $session->search( object => 'Infoblox::CiscoISE::Endpoint', network_view => 'default', address => '10.*', comment => '.*comment', );
# search for objects defining 'Santa Clara' for 'Site' extensible attribute my @retrieved_objs = $session->search( object => 'Infoblox::DHCP::Range', extensible_attributes => {'Site' => 'Santa Clara'}, );
This section describes all the methods that you can use to configure and retrieve the attribute values of a Cisco ISE endpoint.
Use this method to set or retrieve the fully-qualified domain name (FQDN) or IP address of the Cisco ISE endpoint.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is a desired IP address or FQDN in 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 address value my $address = $object->address();
#Modify address value $object->address('foo.com');
Use this method to set the path to a bulk download certificate file. This is a write-only attribute.
Include the specified parameter to set the attribute value.
The valid value is a path to a certificate in string format.
If you specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.
#Modify bulk_download_certificate value $object->bulk_download_certificate('/path/to/cert.pem');
Use this method to retrieve the bulk download certificate subject. This is a read-only attrbiute.
Omit the parameter to retrieve the attribute value.
None
The method returns the attribute value.
#Get bulk_download_certificate_subject value my $bulk_download_certificate_subject = $object->bulk_download_certificate_subject();
Use this method to retrieve the time from which the bulk download certificate is valid. This is a read-only attrbiute.
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 bulk_download_certificate_valid_from value my $bulk_download_certificate_valid_from = $object->bulk_download_certificate_valid_from();
Use this method to retrieve the bulk download certificate expiration time. This is a read-only attrbiute.
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 bulk_download_certificate_valid_to value my $bulk_download_certificate_valid_to = $object->bulk_download_certificate_valid_to();
Use this method to set the path to a client certificate file. This is a write-only attribute.
Include the specified parameter to set the attribute value.
The valid value is a path to a certificate in string format.
If you specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.
#Modify client_certificate value $object->client_certificate('/path/to/cert.pem');
Use this method to retrieve the client certificate subject. This is a read-only attrbiute.
Omit the parameter to retrieve the attribute value.
None
The method returns the attribute value.
#Get client_certificate_subject value my $client_certificate_subject = $object->client_certificate_subject();
Use this method to retrieve the time from which the client certificate is valid. This is a read-only attrbiute.
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 client_certificate_valid_from value my $client_certificate_valid_from = $object->client_certificate_valid_from();
Use this method to retrieve the bulk client certificate expiration time. This is a read-only attrbiute.
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 client_certificate_valid_to value my $client_certificate_valid_to = $object->client_certificate_valid_to();
Use this method to set or retrieve the Cisco ISE endpoint 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 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('ise comment');
Use this method to retrieve the Cisco ISE endpoint connection status. This is a read-only attrbiute.
Omit the parameter to retrieve the attribute value.
None
The method returns the attribute value.
#Get connection_status value my $connection_status = $object->connection_status();
Use this method to set or retrieve the timeout value (in seconds) for the Cisco ISE endpoint connections.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is an unsigned integer between 1 and 180. The default value is 10.
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 connection_timeout value my $connection_timeout = $object->connection_timeout();
#Modify connection_timeout value $object->connection_timeout('20');
Use this method to set or retrieve the flag that indicates whether the Cisco ISE endpoint is enabled or disabled.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
Specify 'true' to disable the Cisco ISE endpoint or 'false' to enable 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 disable value my $disable = $object->disable();
#Modify disable value $object->disable('false');
Use this method to set or retrieve the extensible attributes associated with a Cisco ISE endpoint object.
Valid value is a hash reference that contains the names of extensible attributes and their associated values (Infoblox::Grid::Extattr 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 extattrs value my $extattrs = $object->extattrs();
#Modify extattrs value $dhcp_range->extattrs({'Site' => $extattr1, 'Administrator' => $extattr2});
Use this method to set or retrieve the extensible attributes associated with a Cisco ISE endpoint object.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
For valid values for extensible attributes, see Infoblox::Grid::ExtensibleAttributeDef/Extensible Attribute Values.
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 extensible attributes value my $extensible_attributes = $object->extensible_attributes(); #Modify extensible attributes $object->extensible_attributes({'Site' => 'Santa Clara', 'Administrator' => ['Peter', 'Tom']});
Use this method to set or retrieve the Cisco ISE endpoint network view name.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is a desired network view name in string format. The default value is 'default'.
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 network_view value my $network_view = $object->network_view();
#Modify network_view value $object->network_view('internal');
Use this method to set or retrieve the Cisco ISE endpoint publish settings.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is an Infoblox::CiscoISE::PublishSetting 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 publish_settings value my $publish_settings = $object->publish_settings();
#Modify publish_settings value $object->publish_settings($publish_settings);
Use this method to retrieve the resolved IP address of the Cisco ISE endpoint. This is a read-only attribute.
Omit the parameter to retrieve the attribute value.
None
The method returns the attribute value.
#Get resolved_address value my $resolved_address = $object->resolved_address();
Use this method to retrieve the resolved secondary IP address of the Cisco ISE endpoint. This is a read-only attribute.
Omit the parameter to retrieve the attribute value.
None
The method returns the attribute value.
#Get resolved_secondary_address value my $resolved_secondary_address = $object->resolved_secondary_address();
Use this method to set or retrieve the secondary fully-qualified domain name (FQDN) or IP address of the Cisco ISE endpoint.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is a desired IP address or FQDN in 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 secondary_address value my $secondary_address = $object->secondary_address();
#Modify secondary_address value $object->secondary_address('foo.com');
Use this method to set or retrieve the Cisco ISE endpoint subscribe settings.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is an Infoblox::CiscoISE::SubscribeSetting 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 subscribe_settings value my $subscribe_settings = $object->subscribe_settings();
#Modify subscribe_settings value $object->subscribe_settings($subscribe_settings);
Use this method to set or retrieve the Cisco ISE endpoint subscribing member host name.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is a desired subscribing member host name in string format. The default value is 'default'.
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 subscribing_member value my $subscribing_member = $object->subscribing_member();
#Modify subscribing_member value $object->subscribing_member('infoblox.com');
Use this method to set or retrieve the Cisco ISE endpoint type.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is 'TYPE_CISCO'.
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 type value my $type = $object->type();
#Modify type value $object->type('TYPE_CISCO');
Use this method to set or retrieve the Cisco ISE endpoint version.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid values are 'VERSION_1_3', 'VERSION_1_4' and 'VERSION_2_0'.
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 version value my $version = $object->version();
#Modify version value $object->version('VERSION_2_0');
Infoblox Inc. http://www.infoblox.com/
Infoblox::Session, Infoblox::Session->add(), Infoblox::Session->get(), Infoblox::Session->modify(), Infoblox::Session->remove(), Infoblox::Session->search(), Infoblox::Grid::Extattr, Infoblox::Grid::ExtensibleAttributeDef/Searching Extensible Attributes, Infoblox::CiscoISE::PublishSetting, Infoblox::CiscoISE::SubscribeSetting,
Copyright (c) 2017 Infoblox Inc.