Hc_aaa_options - Управление службой RADIUS AAA
Hc_aaa_options_clean
Команда сброса настроек подсистемы аккаунтинга.
Аналог команды в CoCon:
domain/<DOMAIN>/aaa/accounting/clean
Метод HTTP-запроса:
POST
Шаблон HTTP-запроса:
http://host:port/commands/aaa_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_options_clean.
Implementation: hc_aaa_options_clean.erl.
Git: git@git.eltex.loc:httpTerminal.git.
Copyright (c) 2015, 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>
XML
Список всех возможных атрибутов аналогичен Hc_aaa_options_info и Hc_aaa_options_set.
Пример:
Запрос:
http://192.168.1.21:9999/commands/aaa_options_clean
<?xml version="1.0"?>
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_aaa_options_clean.xsd">
<request>
<domain_options>
<system />
<domain name="biysk.local">
<option name="send_ss_notification" />
<option name="my_address" />
<option name="enable" />
<option name="interim_interval" />
<option name="unsuccessful_call_info" />
<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_options_clean.xsd">
<result>
<domain_options>
<system/>
<domain name="biysk.local">
<success option="enable"/>
<success option="interim_interval"/>
<success option="my_address"/>
<success option="send_ss_notification"/>
<success option="servers"/>
<success option="unsuccessful_call_info"/>
</domain>
</domain_options>
</result>
</out>
CODE
Hc_aaa_options_info
Команда просмотра информации о подсистеме аккаунтинга.
Аналог команды в CoCon:
domain/<DOMAIN>/aaa/accounting/info
Метод HTTP-запроса:
POST
Шаблон HTTP-запроса:
http://host:port/commands/aaa_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_options_info.
Implementation: hc_aaa_options_info.erl.
Git: git@git.eltex.loc:httpTerminal.git.
Copyright (c) 2015, 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="aaaOptionsType">
<xs:complexContent>
<xs:extension base="baseOptionsType">
<xs:attribute name="send_ss_notification" type="booleanType" use="optional"/>
<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="interim_interval" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation xml:lang="en">
Acct-Interim-Interval value. Available values:
server_configured - Acct-Interim-Interval value get from RADIUS accept message;
disabled - account update messages doesn't send;
[60, 86400] - Acct-Interim-Interval value in seconds.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="unsuccessful_call_info" type="booleanType" use="optional"/>
</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_options_info
<?xml version="1.0"?>
<in
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="hc_aaa_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_options_info.xsd">
<result>
<domain_options>
<system>
<options xs:type="aaaOptionsType"/>
</system>
<domain name="biysk.local">
<options xs:type="aaaOptionsType" unsuccessful_call_info="false" servers="billing_account,billing_access" send_ss_notification="false" my_address="192.168.1.21" interim_interval="server_configured" enable="false"/>
</domain>
</domain_options>
</result>
</out>
CODE
Hc_aaa_options_set
Команда изменения настроек подсистемы аккаунтинга.
Аналог команды в CoCon:
domain/<DOMAIN>/aaa/accounting/set
Метод HTTP-запроса:
POST
Шаблон HTTP-запроса:
http://host:port/commands/aaa_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_options_set.
Implementation: hc_aaa_options_set.erl.
Git: git@git.eltex.loc:httpTerminal.git.
Copyright (c) 2015, 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="aaaOptionsType">
<xs:complexContent>
<xs:extension base="baseOptionsType">
<xs:attribute name="send_ss_notification" type="booleanType" use="optional"/>
<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="interim_interval" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation xml:lang="en">
Acct-Interim-Interval value. Available values:
server_configured - Acct-Interim-Interval value get from RADIUS accept message;
disabled - account update messages doesn't send;
[60, 86400] - Acct-Interim-Interval value in seconds.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="unsuccessful_call_info" type="booleanType" use="optional"/>
</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_options_set
<?xml version="1.0"?>
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_aaa_options_set.xsd">
<request>
<domain_options>
<system>
<options xs:type="aaaOptionsType"/>
</system>
<domain name="biysk.local">
<options xs:type="aaaOptionsType" servers="master,naomi2" my_address="127.0.0.1" unsuccessful_call_info="false" send_ss_notification="false" enable="false" interim_interval="server_configured" />
</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_options_set.xsd">
<result>
<domain_options>
<system/>
<domain name="biysk.local">
<success option="enable"/>
<success option="interim_interval"/>
<success option="my_address"/>
<success option="send_ss_notification"/>
<success option="servers"/>
<success option="unsuccessful_call_info"/>
</domain>
</domain_options>
</result>
</out>
CODE