Infoblox::LDAP::AuthService - An LDAP Authentication Service object.

• NAME
• DESCRIPTION
• CONSTRUCTOR
• SESSION METHODS
• Infoblox::Session->add( )
• Infoblox::Session->get( )
• Infoblox::Session->modify( )
• Infoblox::Session->remove( )
• Infoblox::Session->search( )
• METHODS
• comment( )
• disable( )
• ea_mapping( )
• mode( )
• name( )
• ldap_group_attribute( )
• ldap_group_authentication_type( )
• ldap_user_attribute( )
• recovery_interval( )
• retries( )
• search_scope( )
• servers( )
• timeout( )
• SAMPLE CODE
• AUTHOR
• SEE ALSO
• COPYRIGHT

NAME

Infoblox::LDAP::AuthService - An LDAP Authentication Service object.

DESCRIPTION

The LDAP Authentication Service.

CONSTRUCTOR

 my $service = Infoblox::LDAP::AuthService->new(
     name                           => $string,                           # Required
     servers                        => [$server1, $server2, ...],         # Required, These are Infoblox::LDAP::Server objects
     timeout                        => $uint,                             # Optional, Default is 5
     retries                        => $uint,                             # Optional, Default is 5
     recovery_interval              => $uint,                             # Optional, Default is 30
     mode                           => 'ORDERED_LIST'| 'ROUND_ROBIN',     # Optional, Default is 'ORDERED_LIST'
     ldap_user_attribute            => $string,                           # Required
     ldap_group_attribute           => $string,                           # Optional, Default is 'memberOf'
     search_scope                   => BASE' | 'ONELEVEL' | 'SUBTREE',    # Optional, Default is 'ONELEVEL'
     ea_mapping                     => [$ea_mapping1, $ea_mapping, ...],  # Optional, These are Infoblox::LDAP::EA_Mapping objects
     comment                        => $string,                           # Optional
     disable                        => 'true' | 'false',                  # Optional, Default is 'false'
     ldap_group_authentication_type => 'GROUP_ATTRIBUTE' | 'POSIX_GROUP', # Optional, Default is 'GROUP_ATTRIBUTE'
 );
 

SESSION METHODS

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

Infoblox::Session->add( )

Use this method to add an object to the Infoblox appliance. See Infoblox::Session->add() for parameters and return values.

Example

 #Construct an object
 my $service = Infoblox::LDAP::AuthService->new(
    name                => 'LDAPAuthService',
    servers             => [$server],
    ldap_user_attribute => 'cn',
 );

 #Submit for addition
 my $response = $session->add( $service );

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 LDAP Authentication Service object:

  name         - Optional. The LDAP Authentication Service name.
  comment      - Optional. The comment.
  search_scope - Optional. The starting point of the LDAP search.
  mode         - Optional. The LDAP authentication mode.

Example

 my @retrieved_objs = $session->get(
    object => 'Infoblox::LDAP::AuthService',
    name   => 'LDAPAuthService',
 );

Infoblox::Session->modify( )

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

Example

 # Use this method to modify comment of a LDAP Authentication Service.
 $service->comment("This is modified object");
 # Submit modification
 my $response = $session->modify( $service );

Infoblox::Session->remove( )

Use this method to remove an 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 object, and then submit this object for removal.

Example

 #Get the objects with the same name
 my @retrieved_objs = $session->get(
    object => 'Infoblox::LDAP::AuthService',
    name   => 'LDAPAuthService',
 )
 #Find the desired object from the retrieved list.
 my $desired_device = $retrieved_objs[0];
 # Submit for removal
 my $response = $session->remove( $desired_device );

Infoblox::Session->search( )

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

Key References

 Apply the following attributes to search a specific LDAP Authentication Service object:

  name         - Optional. The LDAP Authentication Service name.
  comment      - Optional. The comment.
  search_scope - Optional. The starting point of the LDAP search.
  mode         - Optional. The LDAP authentication mode.

Example

 my @retrieved_objs = $session->search(
    object => 'Infoblox::LDAP::AuthService',
    name   => 'LDAPAuthService',
 );

METHODS

This section describes all the methods that you can use to configure and retrieve the attribute values of an LDAP Authentication Service object.

comment( )

Use this method to set or retrieve a descriptive comment.

Parameter

A desired comment in string format with a maximum of 256 bytes.

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 attribute value
 my $value = $service->comment();
 #Modify attribute value
 $service->comment('LDAP Authentication Service');

disable( )

Use this method to enable or disable an LDAP Authentication Service.

Parameter

Specify "true" to disable an LDAP Authentication Service or "false" to enable it. The default value is '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 attribute value
 my $value = $service->disable();
 #Modify attribute value
 $service->disable('true');

ea_mapping( )

Use this method to set or retrieve mapping of LDAP fields to extensible attributes.

Parameter

An array of an Infoblox::LDAP::EA_Mapping objects.

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 attribute value
 my $value = $service->ea_mapping();
 #Modify attribute value
 $service->ea_mapping([$ea_mapping1, $ea_mapping2]);

mode( )

Use this method to set or retrieve an LDAP authentication mode.

Parameter

Valid values are 'ORDERED_LIST' and 'ROUND_ROBIN'. The default value is 'ORDERED_LIST'.

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 attribute value
 my $value = $service->mode();
 #Modify attribute value
 $service->mode('ROUND_ROBIN');

name( )

Use this method to set or retrieve an LDAP Authentication Service name.

Parameter

An LDAP Authentication Service name in string format.

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 attribute value
 my $value = $service->name();
 #Modify attribute value
 $service->name('NewLDAPAuthService');

ldap_group_attribute( )

Use this method to set or retrieve the name of the LDAP attribute that defines group membership.

Parameter

A name of the LDAP attribute in string format. The default value is 'memberOf'.

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 attribute value
 my $value = $service->ldap_group_attribute();
 #Modify attribute value
 $service->ldap_group_attribute('memberOf');

ldap_group_authentication_type( )

Use this method to set or retrieve the LDAP group authentication type.

Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.

Parameter

The valid values are 'GROUP_ATTRIBUTE' and 'POSIX_GROUP'.

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 ldap_group_authentication_type value
 my $value = $service->ldap_group_authentication_type();
 #Modify ldap_group_authentication_type value
 $service->ldap_group_authentication_type('POSIX_GROUP');

ldap_user_attribute( )

Use this method to set or retrieve an LDAP userid attribute that is used for search.

Parameter

An LDAP userid attribute in string format.

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 attribute value
 my $value = $service->ldap_user_attribute();
 #Modify attribute value
 $service->ldap_user_attribute('cn');

recovery_interval( )

Use this method to set or retrieve the period of time to wait before trying to contact an LDAP server that has been marked as 'down'.

Parameter

The period of time in seconds. The default value is 30.

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 attribute value
 my $value = $service->recovery_interval();
 #Modify attribute value
 $service->recovery_interval(40);

retries( )

Use this method to set or retrieve maximum number of authentication attempts.

Parameter

Maximum number of authentication attempts. The default value is 5.

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 attribute value
 my $value = $service->retries();
 #Modify attribute value
 $service->retries(4);

search_scope( )

Use this method to set or retrieve the starting point of an LDAP search.

Parameter

Valid values are 'BASE', 'ONELEVEL' and 'SUBTREE'. The default value is 'ONELEVEL'.

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 attribute value
 my $value = $service->search_scope();
 #Modify attribute value
 $service->search_scope('ONELEVEL');

servers( )

Use this method to set or retrieve the list of LDAP servers used for authentication.

Parameter

An array of an Infoblox::LDAP::Server objects.

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 attribute value
 my $value = $service->servers();
 #Modify attribute value
 $service->servers([$server1, $server2]);

timeout( )

Use this method to set or retrieve timeout for authentication.

Parameter

Timout in seconds. The default value is 5.

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 attribute value
 my $value = $service->timeout();
 #Modify attribute value
 $service->timeout(4);

SAMPLE CODE

The following sample code demonstrates the different functions that can be applied to an object such as add, get, modify, search and remove. This sample also includes error handling for the operations.

#Preparation prior to getting and modifying a LDAP Authentication Service object

 use strict;
 use Infoblox;

 #refers to Infoblox Appliance IP address
 my $host_ip = "192.168.1.2";

 #Create a session to the Infoblox appliance

 my $session = Infoblox::Session->new(
     master   => $host_ip,
     username => "admin",
     password => "infoblox"
 );
 unless ($session) {
        die("Construct session failed: ",
                Infoblox::status_code() . ":" . Infoblox::status_detail());
 }
 print "Session created successfully\n";

#Create a LDAP Authentication Service object

 my $server = Infoblox::LDAP::Server->new(
     'address' => '10.0.0.1',
     'base_dn' => 'dc=infoblox,dc=com',
 );

 unless ($server) {
        die("Construct LDAP server object failed: ",
                Infoblox::status_code() . ":" . Infoblox::status_detail());
 }
 print "LDAP server object created successfully\n";

 my $service = Infoblox::LDAP::AuthService->new(
     'name'                => 'papi-ldap-service',
     'servers'             => [$server],
     'ldap_user_attribute' => 'cn',
 );

 unless ($service) {
        die("Construct LDAP Authentication Service object failed: ",
                Infoblox::status_code() . ":" . Infoblox::status_detail());
 }
 print "LDAP Authentication Service object created successfully\n";

 my $response = $session->add($service);

 unless ($response) {
     die("Add LDAP Authentication Service failed: ",
            $session->status_code() . ":" . $session->status_detail());
 }
 print "LDAP Authentication Service added successfully \n";

#Search for a LDAP Authentication Service object

 my @retrieved_objs = $session->search(
    object => 'Infoblox::LDAP::AuthService',
    name   => 'papi-ldap-service',
 );

 $service = $retrieved_objs[0];

 unless ($service) {
         die("Search LDAP Authentication Service object failed: ",
                 $session->status_code() . ":" . $session->status_detail());
 }
 print "Search LDAP Authentication Service object found at least 1 matching entry\n";

#Get and modify the LDAP Authentication Service object

 @retrieved_objs = $session->get(
    object => 'Infoblox::LDAP::AuthService',
    name   => 'papi-ldap-service',
 );

 $service = $retrieved_objs[0];

 unless ($service) {
     die("Get LDAP Authentication Service object failed: ",
            $session->status_code() . ":" . $session->status_detail());
 }
 print"Get LDAP Authentication Service successful \n";

 $service->comment("This is modified object");

 $session->modify($service)
    or die("Modify LDAP Authentication Service failed",
             $session->status_code() . ":" . $session->status_detail());
 print "LDAP Authentication Service modified successfully \n";

#Remove the LDAP Authentication Service object

 @retrieved_objs = $session->get(
    object => 'Infoblox::LDAP::AuthService',
    name   => 'papi-ldap-service',
 );

 $service = $retrieved_objs[0];

 unless ($service) {
     die("Get LDAP Authentication Service object failed: ",
            $session->status_code() . ":" . $session->status_detail());
 }
 print"Get LDAP Authentication Service successful \n";

 $session->remove( $service )
     or die("Remove LDAP Authentication Service failed",
            $session->status_code() . ":" . $session->status_detail());
 print "LDAP Authentication Service removed successfully \n";

 ####PROGRAM ENDS####

AUTHOR

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

SEE ALSO

Infoblox::LDAP::Server, Infoblox::LDAP::EA_Mapping

COPYRIGHT

Copyright (c) 2017 Infoblox Inc.