Hc_aaa_access_options - Управление подсистемой RADIUS авторизации
Hc_aaa_access_options_clean
Команда сброса настроек подсистемы RADIUS авторизации (access).
Аналог команды в CoCon:
domain/<DOMAIN>/aaa/access/clean
Метод HTTP-запроса:
POST
Шаблон HTTP-запроса:
http://host:port/commands/aaa_access_options_clean
Код HTTP-ответа:
- 200 – в случае успеха;
- 404 – в случае ошибки.
XSD-схема XML-запроса/ответа:
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified"
attributeFormDefault="unqualified">
<xs:annotation>
<xs:documentation xml:lang="en">
Clean properties of AAA service.
Usage: http://server:9999/commands/aaa_access_options_clean.
Implementation: hc_aaa_access_options_clean.erl.
Git: git@git.eltex.loc:httpTerminal.git.
Copyright (c) 2016, Eltex. All rights reserved.
</xs:documentation>
</xs:annotation>
<xs:include schemaLocation="error.xsd"/>
<xs:include schemaLocation="ecm_common.xsd"/>
<!-- resultType-->
<xs:complexType name="resultType">
<xs:all>
<xs:element name="domain_options" type="domainCleanOutType" minOccurs="1"/>
</xs:all>
</xs:complexType>
<!-- in-->
<xs:element name="in">
<xs:complexType>
<xs:sequence>
<xs:element name="request">
<xs:complexType>
<xs:all>
<xs:element name="domain_options" type="domainCleanInType"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<!-- out -->
<xs:element name="out">
<xs:complexType>
<xs:choice>
<xs:element name="result" type="resultType"/>
<xs:element name="error" type="errorType"/>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:schema
CODE
Пример:
Запрос:
http://192.168.1.21:9999/commands/aaa_access_options_clean
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_aaa_access_options_clean.xsd">
<request>
<domain_options>
<system/>
<domain name="biysk.local">
<option name="enable"/>
<option name="login"/>
<option name="my_address"/>
<option name="password"/>
<option name="servers"/>
</domain>
</domain_options>
</request>
</in>
CODE
Код ответа:
200
Ответ:
<?xml version="1.0"?>
<out xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_aaa_access_options_clean.xsd">
<result>
<domain_options>
<system/>
<domain name="biysk.local">
<success option="enable"/>
<success option="login"/>
<success option="my_address"/>
<success option="password"/>
<success option="servers"/>
</domain>
</domain_options>
</result>
</out>
CODE
Hc_aaa_access_options_info
Команда просмотра информации о подсистеме RADIUS авторизации (access).
Аналог команды в CoCon:
domain/<DOMAIN>/aaa/access/info
Метод HTTP-запроса:
POST
Шаблон HTTP-запроса:
http://host:port/commands/aaa_access_options_info
Код HTTP-ответа:
- 200 – в случае успеха;
- 404 – в случае ошибки.
XSD-схема XML-запроса/ответа:
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified"
attributeFormDefault="unqualified">
<xs:annotation>
<xs:documentation xml:lang="en">
Show properties of AAA service.
Usage: http://server:9999/commands/aaa_access_options_info.
Implementation: hc_aaa_access_options_info.erl.
Git: git@git.eltex.loc:httpTerminal.git.
Copyright (c) 2016, Eltex. All rights reserved.
</xs:documentation>
</xs:annotation>
<xs:include schemaLocation="error.xsd"/>
<xs:include schemaLocation="ecm_common.xsd"/>
<!-- Types -->
<xs:simpleType name="resendCountType">
<xs:restriction base="integerRangeType">
<xs:minInclusive value="0"/>
<xs:maxInclusive value="50"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="aaaAccessOptionsType">
<xs:complexContent>
<xs:extension base="baseOptionsType">
<xs:attribute name="enable" type="booleanType" use="optional"/>
<xs:attribute name="my_address" type="ipAddressType" use="optional"/>
<xs:attribute name="servers" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation xml:lang="en">
The list of the RADIUS servers' names splitted by comma.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="login" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation xml:lang="en">
Access RADIUS request login.
Available values: default | billing | sip | cgpn | any string.
In case of login = default - login set as the domain name.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="password" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation xml:lang="en">
Access RADIUS request password.
Available values: default | billing | sip | any string.
In case of password = default - password set as the domain name.
In case of strong security restrictions password may be shown as ********
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- resultType-->
<xs:complexType name="resultType">
<xs:all>
<xs:element name="domain_options" type="domainInfoOutType" minOccurs="1"/>
</xs:all>
</xs:complexType>
<!-- in-->
<xs:element name="in">
<xs:complexType>
<xs:sequence>
<xs:element name="request">
<xs:complexType>
<xs:all>
<xs:element name="domain_options" type="domainInfoInType" minOccurs="1"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<!-- out -->
<xs:element name="out">
<xs:complexType>
<xs:choice>
<xs:element name="result" type="resultType"/>
<xs:element name="error" type="errorType"/>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:schema>
XML
Пример:
Запрос:
http://192.168.1.21:9999/commands/aaa_access_options_info
<?xml version="1.0"?>
<in xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="hc_aaa_access_options_info.xsd">
<request>
<domain_options domain="biysk.local"/>
</request>
</in>
CODE
Код ответа:
200
Ответ:
<?xml version="1.0"?>
<out
xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_aaa_access_options_info.xsd">
<result>
<domain_options>
<system>
<options xs:type="aaaAccessOptionsType"/>
</system>
<domain name="biysk.local">
<options xs:type="aaaAccessOptionsType" servers="billing_access" password="********" my_address="192.168.1.21" login="default" enable="false"/>
</domain>
</domain_options>
</result>
</out>
CODE
Hc_aaa_access_options_set
Команда изменения настроек подсистемы RADIUS авторизации (access).
Аналог команды в CoCon:
domain/<DOMAIN>/aaa/access/set
Метод HTTP-запроса:
POST
Шаблон HTTP-запроса:
http://host:port/commands/aaa_access_options_set
Код HTTP-ответа:
- 200 – в случае успеха;
- 404 – в случае ошибки.
XSD-схема XML-запроса/ответа:
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified"
attributeFormDefault="unqualified">
<xs:annotation>
<xs:documentation xml:lang="en">
Set AAA service properties
Usage: http://server:9999/commands/aaa_access_options_set.
Implementation: hc_aaa_access_options_set.erl.
Git: git@git.eltex.loc:httpTerminal.git.
Copyright (c) 2016, Eltex. All rights reserved.
</xs:documentation>
</xs:annotation>
<xs:include schemaLocation="error.xsd"/>
<xs:include schemaLocation="ecm_common.xsd"/>
<!-- Types -->
<xs:simpleType name="resendCountType">
<xs:restriction base="integerRangeType">
<xs:minInclusive value="0"/>
<xs:maxInclusive value="50"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="aaaAccessOptionsType">
<xs:complexContent>
<xs:extension base="baseOptionsType">
<xs:attribute name="enable" type="booleanType" use="optional"/>
<xs:attribute name="my_address" type="ipAddressType" use="optional"/>
<xs:attribute name="servers" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation xml:lang="en">
The list of the RADIUS servers' names splitted by comma.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="login" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation xml:lang="en">
Access RADIUS request login.
Available values: default | billing | sip | cgpn | any string.
In case of login = default - login set as the domain name.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="password" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation xml:lang="en">
Access RADIUS request password.
Available values: default | billing | sip | any string.
In case of password = default - password set as the domain name.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- resultType-->
<xs:complexType name="resultType">
<xs:all>
<xs:element name="domain_options" type="domainSetOutType" minOccurs="1"/>
</xs:all>
</xs:complexType>
<!-- in-->
<xs:element name="in">
<xs:complexType>
<xs:sequence>
<xs:element name="request">
<xs:complexType>
<xs:all>
<xs:element name="domain_options" type="domainSetInType"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<!-- out -->
<xs:element name="out">
<xs:complexType>
<xs:choice>
<xs:element name="result" type="resultType" minOccurs="1" maxOccurs="1"/>
<xs:element name="error" type="errorType" minOccurs="1" maxOccurs="1"/>
</xs:choice>
</xs:complexType>
</xs:element>
</xs:schema
CODE
Пример:
Запрос:
http://192.168.1.21:9999/commands/aaa_access_options_set
<?xml version="1.0"?>
<in
xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_aaa_access_options_set.xsd">
<request>
<domain_options>
<system>
<options xs:type="aaaAccessOptionsType"/>
</system>
<domain name="biysk.local">
<options xs:type="aaaAccessOptionsType" servers="master,192.168.2.21" my_address="192.168.1.21" enable="false"/>
</domain>
</domain_options>
</request>
</in>
CODE
Код ответа:
200
Ответ:
<?xml version="1.0"?>
<out
xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_aaa_access_options_set.xsd">
<result>
<domain_options>
<system/>
<domain name="biysk.local">
<success option="enable"/>
<success option="my_address"/>
<success option="servers"/>
</domain>
</domain_options>
</result>
</out>
CODE