Infoblox::Grid::Admin::AdAuthServer - Active Directory Authentication Server object
Represents an AD authentication server (i.e., domain controller) that is used to authenticate administrators.
my $ad_auth_server = Infoblox::Grid::Admin::AdAuthServer->new( name => $fqdn | $ipv4addr, # Required port => $num, # Required comment => $string, # Optional / Default is empty disabled => "true" | "false", # Optional / Default is "false" encryption => "SSL" | "None", # Optional / Default is "None" mgmt_port => "true" | "false", # Optional / Default is "false" );
This section describes all the methods in an Infoblox::Session module that you can apply to an object.
ad_auth_server_list()Use this method to specify AD authentication servers that are used to authenticate administrators.
# Construct an object my $ad_auth_server1 = Infoblox::Grid::Admin::AdAuthServer->new( name => "1.2.3.4", port => 636, comment => "domain controller in room 1" disabled => "false", encryption => "SSL", mgmt_port => "false", );
# Construct another object my $ad_auth_server2 = Infoblox::Grid::Admin::AdAuthServer->new( name => "foo.com", port => 389, comment => "domain controller in room 2" disabled => "false", encryption => "None", mgmt_port => "false", );
# Configure AdAuthServer my $response = $ad_auth_service->ad_auth_server_list([$ad_auth_server1, $ad_auth_server2]);
Use the following methods to access the attributes of an Infoblox::Grid::Admin::AdAuthServer object. Specify a parameter to set the attribute's value, or omit the parameter to get the attribute's value.
Use this method to set or retrieve comments about the server.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
Comments in string format with a maximum of 256 bytes.
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 my $val = $obj->comment(); #Modify comment $obj->comment("head office");
Use this method to disable the Active Directory authentication service.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
Set the parameter to "true" to disable the service. Set the parameter to "false" to enable the service. 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 disabled my $val = $obj->disabled(); #Modify disabled $obj->disabled("true");
Use this method to set or retrieve the encryption flag.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
Specify "SSL" to use SSL encryption or "None" to use no encryption.
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 encryption my $val = $obj->encryption(); #Modify encryption $obj->encryption("SSL");
Use this method to set or retrieve the FQDN or IPv4 address of the AD authentication server.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The FQDN or IPv4 address of the AD authentication server 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 name my $val = $obj->name(); #Modify name $obj->name("1.2.3.5");
Use this method to set or retrieve the port number on the AD server to which the appliance sends authentication requests.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
TCP port of the AD authentication server
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 port my $val = $obj->port(); #Modify port $obj->port(389);
Use this method to set or retrieve the MGMT port flag of the AD server. Set this flag to "true" to restrict the appliance to connecting to the AD server through the management port only.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
Specify "true" to set the mgmt_port flag or "false" to deactivate/unset 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 mgmt_port my $val = $obj->mgmt_port(); #Modify mgmt_port $obj->mgmt_port('false');
Infoblox Inc. http://www.infoblox.com
Infoblox::Grid::Admin::AdAuthService, Infoblox::Session, Infoblox::Session->add(), Infoblox::Session->get(), Infoblox::Session->modify(), Infoblox::Session->remove()
Copyright (c) 2017 Infoblox Inc.