Infoblox::Grid::HTTPProxyServerSetting - An Infoblox Grid HTTP Proxy Server Setting object.
The Grid HTTP Proxy Server Setting object provides information about HTTP Proxy Server configuration.
my $http_proxy_setting = Infoblox::Grid::HTTPProxyServerSetting->new( address => $fqdn | $ipv4addr | $ipv6addr, # Required port => $uint, # Required enable_username_and_password => 'true' | 'false', # Optional / Default is 'false' enable_proxy => 'true' | 'false', # Optional / Default is 'false' enable_content_inspection => 'true' | 'false', # Optional / Default is 'false' verify_cname => 'true' | 'false', # Optional / Default is 'false' comment => $string, # Optional / Default is undefined username => $string, # Optional / Default is undefined password => $string, # Optional / Default is undefined certificate => $string, # Optional / Default is undefined );
The object does not support any session methods.
The following functions are available to be applied to a HTTP Proxy Server object.
Use this method to set or retreive the Grid HTTP proxy server settings. See Infoblox::Grid->http_proxy_server_setting() for parameters andreturn values.
#Get http_proxy_server_setting value my $http_proxy_server_setting = $grid->http_proxy_server_setting();
#Modify http_proxy_server_setting value $grid->http_proxy_server_setting($http_proxy_setting);
This section describes all the methods that you can use to configure and retrieve the attribute values of a HTTP Proxy Server Setting object.
Use this method to set or retrieve the address of the HTTP Proxy Server.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is a string that contains Fully-Qualified Domain Name (FQDN), IPv4 address or IPv6 address.
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 = $obj->address();
#Modify address value $obj->address('10.0.0.1');
Use this method to set the path to a CA Certificate used in a content inspection by a HTTP Proxy Server. This is a write-only attribute.
Include the specified parameter to set the attribute value.
The valid value is a string which contains a path to certificate.
If you specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.
#Modify certificateibute value $obj->certificate('/path/to/cert.pem');
Use this method to set or retrieve the descriptive comment for HTTP Proxy Server configuration.
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 = $obj->attr();
#Modify comment value $obj->comment('desired comment');
Use this method to set or retrieve the flag that indicates whether the HTTPS packets content inspection by HTTP Proxy Server 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 HTTPS packets content inspection 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 enable_content_inspection value my $enable_content_inspection = $obj->enable_content_inspection();
#Modify enable_content_inspection value $obj->enable_content_inspection('true');
Use this method to set or retrieve the flag that indicates whether the use of username and password for the connectivity of HTTP proxy server is enabled or not.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
Specify 'true' to use username and password for testing the connectivity of HTTP proxy server or 'false' to disallow 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 enable_username_and_password value my $enable_username_and_password = $obj->enable_username_and_password();
#Modify enable_username_and_password value $obj->enable_username_and_password('true');
Use this method to set or retrieve the flag that indicates whether HTTP Proxy Server 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 HTTP Proxy Server 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 enable_proxy value my $enable_proxy = $obj->enable_proxy();
#Modify enable_proxy value $obj->enable_proxy('true');
Use this method to set the HTTP Proxy password. This is a write-only attribute.
Include the specified parameter to set the attribute value.
The valid value is a desired password in a string format.
If you specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.
#Modify password value $obj->password('pass');
Use this method to set or retrieve the HTTP Proxy Server port it listens to.
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 0 and 65535.
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 value my $port = $obj->port();
#Modify port value $obj->port(10000);
Use this method to set or retrieve the HTTP Proxy user name.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
The valid value is a desired user name 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 username value my $username = $obj->username();
#Modify username value $obj->username('user1');
Use this method to set or retrieve the flag which indicates whether the CNAME record query verification is enabled or not.
Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.
Specify 'true' to enable CNAME record query verification 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 verify_cname value my $verify_cname = $obj->verify_cname();
#Modify verify_cname value $obj->verify_cname('true');
Infoblox Inc. http://www.infoblox.com/
Infoblox::Grid, Infoblox::Grid->http_proxy_server_setting()
Copyright (c) 2017 Infoblox Inc.