< Home

Data Model

The configuration model file matching Portal server template is huawei-aaa-portal.yang.

Table 1 Data model

Object

Description

Value

Remarks

/huawei-aaa-portal/portal

Indicates that the request operation (creation or modification) object is a Portal server template. This object is the root object. It is only used to contain sub-objects, but does not have any data meaning.

N/A

N/A

/huawei-aaa-portal/portal/portal-server/name

Indicates the name of the created Portal server template.

The value is a string of 1 to 31 case-sensitive characters. It cannot be - or -- and cannot contain spaces or the following symbols: / \ : * ? " < > | @ ' %.

N/A

/huawei-aaa-portal/portal/portal-server/portal-server-ip

Indicates that the IP address for the Portal server is configured.

  • IPv4: The value is in dotted decimal notation.
  • IPv6: The value is a 32-digit hexadecimal number, in the format X:X:X:X:X:X:X:X.

N/A

/huawei-aaa-portal/portal/portal-server/destination-port

Indicates that the destination port number for the switch to send packets to the Portal server is configured.

The value is an integer that ranges from 1 to 65535.

N/A

/huawei-aaa-portal/portal/portal-server/shared-key

Indicates that the shared key for the switch to exchange information with the Portal server is configured.

The value is a string of case-sensitive characters without spaces. It can be a string of 48 characters in cipher text, or a string of 1 to 16 characters in plain text. If the string is enclosed in double quotation marks (" "), the string can contain spaces.

N/A

/huawei-aaa-portal:portal/portal-server/vpn-instance

Indicates that the VPN instance for the switch to communicate with the Portal server is configured.

The value must be an existing VPN instance.

N/A

/huawei-aaa-portal/portal/portal-server/server-url

Indicates that the URL for the Portal server is configured.

The value is a string of 1 to 200 case-sensitive characters without spaces and question marks (?). If the string is enclosed in double quotation marks (" "), the string can contain spaces.

N/A

/huawei-aaa-portal/portal/portal-server/url-template/name

Indicates the name of the URL template bound to the Portal server template.

The value must be the name of an existing URL template.

N/A

/huawei-aaa-portal/portal/portal-server/protocol

Indicates that the protocol used in Portal authentication is configured.

Enumerated type:

  • http
  • haca
  • portal
  • http-uam

N/A

/huawei-aaa-portal/portal/portal-server/web-redirection-disable

Indicates that the Portal authentication redirection function is disabled. By default, the Portal authentication redirection function is enabled.

Boolean type:

  • true: enabled
  • false: disabled

N/A

/huawei-aaa-portal/portal/portal-server/server-detect-function/server-detect-enable

Indicates that the Portal server detection function is enabled.

Boolean type:

  • true: enabled
  • false: disabled

N/A

/huawei-aaa-portal/portal/portal-server/user-sync-function

Indicates that the user information synchronization function is enabled for Portal authentication.

Boolean type:

  • true: enabled
  • false: disabled

N/A

/huawei-aaa-portal/portal/portal-server/source-ip-address/ip/ip-address

Indicates that the source IP address for the switch to communicate with the Portal server is configured.

The value is in dotted decimal notation.

N/A

/huawei-aaa-portal/portal/listening-port

Indicates that the number of the port through which the switch listens to Portal packets is configured.

The value is an integer that ranges from 1024 to 55535.

N/A

/huawei-aaa-portal/portal/url-template/name

Indicates the name of a created URL template.

The value is a string of 1 to 31 case-sensitive characters. It cannot be - or -- and cannot contain spaces or the following symbols: / \ : * ? " < > | @ ' %.

N/A

/huawei-aaa-portal/portal/url-template/url/url

Indicates that the redirect URL or pushed URL for the Portal server is configured.

The value is a string of 1 to 200 case-sensitive characters without spaces. If the string is enclosed in double quotation marks (" "), the string can contain spaces.

N/A

/huawei-aaa-portal/portal/url-template/url-parameter

Indicates that parameters carried in the URL are configured.

The value is a string of 1 to 16 case-sensitive characters without spaces. If the string is enclosed in double quotation marks (" "), the string can contain spaces.

N/A

/huawei-aaa-portal/portal/url-template/url-parameter/mac-address-format

Indicates that the MAC address format in the URL is configured.

  • normal: The MAC address format is set to XX-XX-XX-XX-XX-XX.
  • compact: The MAC address format is set to XXXX-XXXX-XXXX.
  • delimiter: The value is one case-sensitive character without spaces.

N/A

/huawei-aaa-portal:portal/url-template/mark-parameter/start-mark

Configuring the start character in the URL.

The value is one case-sensitive character without spaces.

N/A

/huawei-aaa-portal:portal/url-template/mark-parameter/assignment-mark

Configuring the assignment character in the URL.

The value is one case-sensitive character without spaces.

N/A

/huawei-aaa-portal:portal/url-template/mark-parameter/isolate-mark

Configuring the delimiter in the URL.

The value is one case-sensitive character without spaces.

N/A

/huawei-aaa-portal:portal/url-template/url-ssid

Indicates the SSID that users associate with in the redirect URL or pushed URL of the Portal server.

The value must be an existing SSID.

N/A

/huawei-aaa-portal:portal/reply-message-enable

Indicates whether to enable the device to transparently transmit user authentication responses sent by the authentication server to the Portal server.

The value is of the Boolean type:

  • true: enables the function.
  • false: disables the function.

N/A

/huawei-aaa-portal:portal/logout-resend-function/interval

Indicates the re-transmission interval of Portal authentication user logout packets.

The value is an integer in the range from 1 to 300, in seconds.

N/A

/huawei-aaa-portal:portal/logout-resend-function/times

Indicates the number of re-transmission times for Portal authentication user logout packets.

The value is an integer in the range from 0 to 15.

The value 0 indicates that the re-transmission function is disabled.

N/A

/huawei-aaa-portal:portal/version

Indicates the Portal protocol version supported by the device.

The value is of the enumerated type:

  • v2
  • v1v2

N/A

/huawei-aaa-portal:portal/logout-different-server-enable

Indicates whether to enable a device to process user logout requests sent by a Portal server other than the one from which users log in.

The value is of the Boolean type:

  • true: enables the function.
  • false: disables the function.

N/A

/huawei-aaa-portal:portal/global-source-ip/ip/ip-address

Indicates the source IP address used by the device to communicate with the Portal server in the system view.

The value is in dotted decimal notation.

N/A

/huawei-aaa-portal:portal/url-template/url-parameter/login-url/key

/huawei-aaa-portal:portal/url-template/url-parameter/login-url/value

Indicates the login URL of the access device.

  • key: indicates the identification keyword for the login URL sent to the Portal server during redirection.
  • value: indicates a specified URL of the access device.
  • key: The value is a string of 1 to 16 case-sensitive characters without spaces, question marks (?), ampersands (&), and equal signs (=).
  • value: The value is a string of 1 to 200 case-sensitive characters without spaces.

N/A

/huawei-aaa-portal:portal/portal-server/url-template/ciphered-parameter-name

Indicates the name of the encrypted URL template parameter.

The value is a string of 1 to 16 characters.

N/A

/huawei-aaa-portal:portal/portal-server/url-template/iv-parameter-name

Indicates the encryption vector name of the URL template parameter.

The value is a string of 1 to 16 characters.

N/A

/huawei-aaa-portal:portal/portal-server/url-template/key

Indicates the encryption key for encrypting the URL template parameter.

The value is either a plain-text string of 1-16 characters or a cipher-text string of 48 characters.

N/A

/huawei-aaa-portal:portal/portal-server/source-ip-address/interface/loopback-interface

Configures the IP address of a specified interface as the source IP address used by the device to communicate with the Portal server.

The value must be an existing interface number.

N/A

/huawei-aaa-portal:portal/portal-server/http-method-parameters/get-method-enable

Indicates whether to enable users to submit the user name and password to the device in GET mode during Portal authentication.

The value is of the Boolean type:

  • true: enables the function.
  • false: disables the function.

N/A

/huawei-aaa-portal:portal/portal-server/http-method-parameters/post-parameters/cmd-key/cmd-key

Indicates the command identification keyword.

The value is a string of 1 to 16 case-sensitive characters without spaces, question marks (?), ampersands (&), and equal signs (=).

N/A

/huawei-aaa-portal:portal/portal-server/http-method-parameters/post-parameters/cmd-key/login-key

Indicates the user login identification keyword.

The value is a string of 1 to 15 case-sensitive characters without spaces, question marks (?), ampersands (&), and equal signs (=).

N/A

/huawei-aaa-portal:portal/portal-server/http-method-parameters/post-parameters/cmd-key/logout-key

Indicates the user logout identification keyword.

The value is a string of 1 to 15 case-sensitive characters without spaces, question marks (?), ampersands (&), and equal signs (=).

N/A

/huawei-aaa-portal:portal/portal-server/http-method-parameters/post-parameters/password-key/password-key

Indicates the password identification keyword.

The value is a string of 1 to 16 case-sensitive characters without spaces, question marks (?), ampersands (&), and equal signs (=).

N/A

/huawei-aaa-portal:portal/portal-server/http-method-parameters/post-parameters/initial-url-key/init-url-key

Indicates the identification keyword for the user initial login URL.

The value is a string of 1 to 16 case-sensitive characters without spaces, question marks (?), ampersands (&), and equal signs (=).

N/A

/huawei-aaa-portal:portal/portal-server/http-method-parameters/post-parameters/user-ip-key/user-ip-key

Indicates the identification keyword for the user IP address.

The value is a string of 1 to 16 case-sensitive characters without spaces, question marks (?), ampersands (&), and equal signs (=).

N/A

/huawei-aaa-portal:portal/portal-server/http-method-parameters/post-parameters/user-mac-key/user-mac-key

Indicates the identification keyword for the user MAC address.

The value is a string of 1 to 16 case-sensitive characters without spaces, question marks (?), ampersands (&), and equal signs (=).

N/A

/huawei-aaa-portal:portal/portal-server/http-method-parameters/post-parameters/user-name-key/user-name-key

Indicates the user name identification keyword.

The value is a string of 1 to 16 case-sensitive characters without spaces, question marks (?), ampersands (&), and equal signs (=).

N/A

/huawei-aaa-portal:portal/portal-server/http-method-parameters/post-parameters/response-parameters/login-fail

Indicates the response message upon a user login failure.

N/A

N/A

/huawei-aaa-portal:portal/portal-server/http-method-parameters/post-parameters/response-parameters/login-success

Indicates the response message upon a user login success.

N/A

N/A

/huawei-aaa-portal:portal/portal-server/http-method-parameters/post-parameters/response-parameters/logout-fail

Indicates the response message upon a user logout failure.

N/A

N/A

/huawei-aaa-portal:portal/portal-server/http-method-parameters/post-parameters/response-parameters/logout-success

Indicates the response message upon a user logout success.

N/A

N/A

/huawei-aaa-portal:portal/url-template/url-parameter/set-parameter-value/set-device-ip/ip-address

Indicates the device IP address carried in the URL.

The value is in dotted decimal notation.

N/A

/huawei-aaa-portal:portal/portal-server/detect-type

Indicates the mode in which a device detects Portal server status.

Enumerated type:

  • http
  • portal

N/A

Copyright © Huawei Technologies Co., Ltd.
Copyright © Huawei Technologies Co., Ltd.
Next topic >