This object represents the captive portal configuration.
References to captiveportal are object references. The name part of a captive portal object reference has the following components:
Example: captiveportal/ZG5zLm5ldHdvcmtfdmlldyQxMTk:member.com
The object does not support the following operations:
The object cannot be managed on Cloud Platform members.
These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.
The basic version of the object contains the field(s): name.
The authentication server group assigned to this captive portal.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
The company name that appears in the guest registration page.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
Determines if authentication failures are logged to syslog or not.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Determines if successful authentications are logged to syslog or not.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
The type of user to be enabled for the captive portal.
Type
String.
Create
The default value is AUTHENTICATED.
Search
The field is not available for search.
The encryption the captive portal uses.
Type
String.
Create
The default value is NONE.
Search
The field is not available for search.
The list of files associated with the captive portal.
Type
A/An Captive portal file struct array.
Create
The default value is:
empty
Search
The field is not available for search.
The name of the custom field that you are adding to the guest registration page.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
Determines if the custom field is required or not.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The name of the custom field that you are adding to the guest registration page.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
Determines if the custom field is required or not.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The name of the custom field that you are adding to the guest registration page.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
Determines if the custom field is required or not.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The name of the custom field that you are adding to the guest registration page.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
Determines if the custom field is required or not.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Determines if the email address of the guest is required or not.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
Determines if the first name of the guest is required or not.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
Determines if the last name of the guest is required or not.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
Determines if the middle name of the guest is required or not.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Determines if the phone number of the guest is required or not.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
The helpdesk message that appears in the guest registration page.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
Determines the IP address on which the captive portal listens. Valid if listen address type is ‘IP’.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
Determines the type of the IP address on which the captive portal listens.
Type
String.
Create
The default value is VIP.
Search
The field is not available for search.
The hostname of the Grid member that hosts the captive portal.
Type
String.
Search
The field is available for search via
Notes
The name is part of the base object.
The name cannot be updated.
name cannot be written.
The network view of the captive portal.
Type
String.
Create
The default value is default.
Search
The field is not available for search.
The TCP port used by the Captive Portal service. The port is required when the Captive Portal service is enabled. Valid values are between 1 and 63999. Please note that setting the port number to 80 or 443 might impact performance.
Type
Unsigned integer.
Create
The default value is 4433.
Search
The field is not available for search.
Determines if the captive portal service is enabled or not.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The syslog level at which authentication failures are logged.
Type
String.
Create
The default value is INFO.
Search
The field is not available for search.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| authn_server_group | String | N | N | N | N/A |
| company_name | String | N | N | N | N/A |
| enable_syslog_auth_failure | Bool | N | N | N | N/A |
| enable_syslog_auth_success | Bool | N | N | N | N/A |
| enable_user_type | String | N | N | N | N/A |
| encryption | String | N | N | N | N/A |
| files | [struct] | N | N | N | N/A |
| guest_custom_field1_name | String | N | N | N | N/A |
| guest_custom_field1_required | Bool | N | N | N | N/A |
| guest_custom_field2_name | String | N | N | N | N/A |
| guest_custom_field2_required | Bool | N | N | N | N/A |
| guest_custom_field3_name | String | N | N | N | N/A |
| guest_custom_field3_required | Bool | N | N | N | N/A |
| guest_custom_field4_name | String | N | N | N | N/A |
| guest_custom_field4_required | Bool | N | N | N | N/A |
| guest_email_required | Bool | N | N | N | N/A |
| guest_first_name_required | Bool | N | N | N | N/A |
| guest_last_name_required | Bool | N | N | N | N/A |
| guest_middle_name_required | Bool | N | N | N | N/A |
| guest_phone_required | Bool | N | N | N | N/A |
| helpdesk_message | String | N | N | N | N/A |
| listen_address_ip | String | N | N | N | N/A |
| listen_address_type | String | N | N | N | N/A |
| name | String | N | Y | Y | = |
| network_view | String | N | N | N | N/A |
| port | Unsigned int | N | N | N | N/A |
| service_enabled | Bool | N | N | N | N/A |
| syslog_auth_failure_level | String | N | N | N | N/A |
| syslog_auth_success_level | String | N | N | N | N/A |
| welcome_message | String | N | N | N | N/A |
capacityreport : Grid member capacity report object.
certificate:authservice : Certificate authentication service object.