Hc_aaa_general_options_clean

Команда сброса общих настроек подсистемы аккаунтинга.

Аналог команды в CoCon:

domain/<DOMAIN>/aaa/general/clean

Метод HTTP-запроса:

POST

Шаблон HTTP-запроса:

http://host:port/commands/aaa_general_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_general_options_clean.
      Implementation: hc_aaa_general_options_clean.erl.
      Git: git@git.eltex.loc:httpTerminal.git.
      Copyright (c) 2020, 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_general_options_info и Hc_aaa_general_options_set.

Пример:

Запрос:
http://192.168.1.21:9999/commands/aaa_general_options_clean


<?xml version="1.0"?>
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_aaa_general_options_clean.xsd">
    <request>
        <domain_options>
            <system />
            <domain name="biysk.local">
                <option name="adaptation" />
                <option name="call_origin_mode" />
                <option name="if_radius_unavailable" />
                <option name="modificate_station_id" />
                <option name="profile" />
            </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_general_options_clean.xsd">
	<result>
		<domain_options>
			<system/>
			<domain name="biysk.local">
				<success option="adaptation"/>
				<success option="call_origin_mode"/>
				<success option="if_radius_unavailable"/>
				<success option="modificate_station_id"/>
				<success option="profile"/>
			</domain>
		</domain_options>
	</result>
</out>

CODE

Hc_aaa_general_options_info

Команда просмотра информации об общих настройках подсистемы аккаунтинга.

Аналог команды в CoCon:

domain/<DOMAIN>/aaa/general/info

Метод HTTP-запроса:

POST

Шаблон HTTP-запроса:

http://host:port/commands/aaa_general_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_general_options_info.
            Implementation: hc_aaa_general_options_info.erl.
            Git: git@git.eltex.loc:httpTerminal.git.
            Copyright (c) 2020, 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>

    <!-- callOriginModeType -->
    <xs:simpleType name="callOriginModeType">
        <xs:restriction base="unionType">
            <xs:enumeration value="default"/>
            <xs:enumeration value="cisco"/>
        </xs:restriction>
    </xs:simpleType>

    <xs:complexType name="aaaGeneralOptionsType">
        <xs:complexContent>
            <xs:extension base="baseOptionsType">
                <xs:attribute name="adaptation" type="atomType" use="optional"/>
                <xs:attribute name="if_radius_unavailable" type="xs:string" use="optional"/>
                <xs:attribute name="profile" type="xs:string" use="optional"/>
                <xs:attribute name="call_origin_mode" type="callOriginModeType" use="optional"/>
                <xs:attribute name="modificate_station_id" 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_general_options_info


<?xml version="1.0"?>
<in xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="hc_aaa_general_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_general_options_info.xsd">
	<result>
		<domain_options>
			<system>
				<options xs:type="aaaGeneralOptionsType"/>
			</system>
			<domain name="biysk.local">
				<options xs:type="aaaGeneralOptionsType" profile="cisco_vsa" modificate_station_id="true" if_radius_unavailable="private,local" call_origin_mode="cisco" adaptation="default_adaptation"/>
			</domain>
		</domain_options>
	</result>
</out>

CODE

Hc_aaa_general_options_set

Команда изменения общих настроек подсистемы аккаунтинга.

Аналог команды в CoCon:

domain/<DOMAIN>/aaa/general/set

Метод HTTP-запроса:

POST

Шаблон HTTP-запроса:

http://host:port/commands/aaa_general_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_general_options_set.
            Implementation: hc_aaa_general_options_set.erl.
            Git: git@git.eltex.loc:httpTerminal.git.
            Copyright (c) 2020, 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>

    <!-- callOriginModeType -->
    <xs:simpleType name="callOriginModeType">
        <xs:restriction base="unionType">
            <xs:enumeration value="default"/>
            <xs:enumeration value="cisco"/>
        </xs:restriction>
    </xs:simpleType>

    <xs:complexType name="aaaGeneralOptionsType">
        <xs:complexContent>
            <xs:extension base="baseOptionsType">
                <xs:attribute name="adaptation" type="atomType" use="optional"/>
                <xs:attribute name="if_radius_unavailable" type="xs:string" use="optional"/>
                <xs:attribute name="profile" type="xs:string" use="optional"/>
                <xs:attribute name="call_origin_mode" type="callOriginModeType" use="optional"/>
                <xs:attribute name="modificate_station_id" 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_general_options_set


<?xml version="1.0"?>
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="hc_aaa_general_options_set.xsd">
    <request>
        <domain_options>
            <system>
                <options xs:type="aaaGeneralOptionsType"/>
            </system>
            <domain name="biysk.local">
                <options xs:type="aaaGeneralOptionsType" adaptation="default_adaptation" call_origin_mode="cisco" if_radius_unavailable="private, local" modificate_station_id="true" profile="cisco_vsa" />
            </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_general_options_set.xsd">
	<result>
		<domain_options>
			<system/>
			<domain name="biysk.local">
				<success option="adaptation"/>
				<success option="call_origin_mode"/>
				<success option="if_radius_unavailable"/>
				<success option="modificate_station_id"/>
				<success option="profile"/>
			</domain>
		</domain_options>
	</result>
</out>

CODE