diff --git a/EfficientIP/SOLIDserver/OpenAPIs/efficientip_solidserver-2.0.json b/EfficientIP/SOLIDserver/OpenAPIs/efficientip_solidserver-2.0.json new file mode 100644 index 0000000..1f1ffdd --- /dev/null +++ b/EfficientIP/SOLIDserver/OpenAPIs/efficientip_solidserver-2.0.json @@ -0,0 +1,47021 @@ +{ + "openapi": "3.0.2", + "info": { + "contact": { + "email": "support-api@efficientip.com", + "name": "Support", + "url": "https://www.efficientip.com/services/support/" + }, + "description": "OpenAPI 3.0.2 API definition for SOLIDserver service from EfficientIP.

Copyright \u00a9 2000-2024 EfficientIP

All specifications and information regarding the products in this document are subject to change without notice and should not be construed as a commitment by EfficientIP. EfficientIP assumes no responsibility or liability for any mistakes or inaccuracies that may appear in this document. All statements and recommendations in this document are believed to be accurate but are presented without warranty. Users must take full responsibility for their application of any product.

This document aims at detailing EfficientIP proprietary solutions. As our solutions rely on several third-party products, created by other companies or organizations, it may redirect readers to third-party websites and documentation for further information. In such a case, EfficientIP cannot be liable or expected to provide said information on products they do maintain or created.

Generated (Friday 4th of October 2024 03:41:11 PM)

", + "license": { + "name": "EfficientIP" + }, + "title": "SOLIDserver API", + "version": "2.0" + }, + "servers": [ + { + "url": "https://{host}:{port}/api/v2.0", + "variables": { + "host": { + "default": "sds-ip-or-name", + "description": "server ip or server fqdn" + }, + "port": { + "default": "443", + "enum": [ + "443" + ] + } + } + } + ], + "security": [ + { + "HttpHeaderLoginKey": [], + "HttpHeaderPasswordKey": [] + }, + { + "BasicAuth": [] + }, + { + "EipApiTokenAuth": [], + "EipApiTokenTime": [] + } + ], + "paths": { + "/ipam/space/list": { + "get": { + "description": "This service allows you to list the objects.
To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_space_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
.The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_space_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the spaces", + "tags": [ + "ipam" + ] + } + }, + "/ipam/space/count": { + "get": { + "description": "This service allows you to return the number of objects.
To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_space_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of spaces", + "tags": [ + "ipam" + ] + } + }, + "/ipam/space/info": { + "get": { + "description": "This service allows you to display the properties of an object.
To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_space_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "explode": true, + "in": "query", + "name": "space_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_space_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a space", + "tags": [ + "ipam" + ] + } + }, + "/ipam/space/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
  • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

    Mandatory Parameters: space_name", + "operationId": "ipam_space_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_space_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_space_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_space_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a space", + "tags": [ + "ipam" + ] + } + }, + "/ipam/space/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
    • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

      Mandatory Parameters: (space_id || space_name)", + "operationId": "ipam_space_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_space_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_space_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_space_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a space", + "tags": [ + "ipam" + ] + } + }, + "/ipam/space/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

      Mandatory Parameters: (space_id || space_name)", + "operationId": "ipam_space_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "explode": true, + "in": "query", + "name": "space_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the space.", + "explode": true, + "in": "query", + "name": "space_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_space_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_space_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a space", + "tags": [ + "ipam" + ] + } + }, + "/ipam/network/list": { + "get": { + "description": "This service allows you to list the objects.
      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_network_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
      .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the IPv4 block/subnet-type networks", + "tags": [ + "ipam" + ] + } + }, + "/ipam/network/count": { + "get": { + "description": "This service allows you to return the number of objects.
      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_network_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of IPv4 block/subnet-type networks", + "tags": [ + "ipam" + ] + } + }, + "/ipam/network/info": { + "get": { + "description": "This service allows you to display the properties of an object.
      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_network_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv4 network, a unique numeric key value automatically incremented when you add an IPv4 network. Use the ID to specify the IPv4 network of your choice.", + "explode": true, + "in": "query", + "name": "network_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of an IPv4 block/subnet-type network", + "tags": [ + "ipam" + ] + } + }, + "/ipam/network/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
      • If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.Note that to add a block-type network, setting the input parameter subnet_level to 0 is mandatory.
        To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

        Mandatory Parameters: (network_addr && (network_end_addr || network_size || network_mask || network_prefix) && (space_id || space_name || parent_network_id))", + "operationId": "ipam_network_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add an IPv4 block/subnet-type network", + "tags": [ + "ipam" + ] + } + }, + "/ipam/network/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
        • If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.Note that to add a block-type network, setting the input parameter subnet_level to 0 is mandatory.
          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

          Mandatory Parameters: (network_id || (network_addr && (network_end_addr || network_size || network_mask || network_prefix) && (space_id || space_name || parent_network_id)))", + "operationId": "ipam_network_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit an IPv4 block/subnet-type network", + "tags": [ + "ipam" + ] + } + }, + "/ipam/network/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

          Mandatory Parameters: (network_id || (network_addr && (network_end_addr || network_size || network_mask || network_prefix) && (space_id || space_name || parent_network_id)))", + "operationId": "ipam_network_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the parent IPv4 network. Use the ID to specify the parent IPv4 network of your choice.", + "explode": true, + "in": "query", + "name": "parent_network_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "explode": true, + "in": "query", + "name": "space_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the space.", + "explode": true, + "in": "query", + "name": "space_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The start IP address of the IPv4 network, its first IP address.", + "explode": true, + "in": "query", + "name": "network_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The end IP address of the IPv4 network, its last IP address.", + "explode": true, + "in": "query", + "name": "network_end_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv4 network, a unique numeric key value automatically incremented when you add an IPv4 network. Use the ID to specify the IPv4 network of your choice.", + "explode": true, + "in": "query", + "name": "network_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The netmask of the IPv4 network. It is expressed in dot-decimal notation and defines the number of addresses the network contains.", + "explode": true, + "in": "query", + "name": "network_mask", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The prefix of the IPv4 network, an integer that defines the number of addresses the network contains.", + "explode": true, + "in": "query", + "name": "network_prefix", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The size of the IPv4 network, the number of IP addresses it contains.", + "explode": true, + "in": "query", + "name": "network_size", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The position of the network within the hierarchy of networks of a VLSM organization. It calculates between 0 and n all the levels of the organization, its behavior depends on the value of the parameter use_reversed_relative_position:
          • use_reversed_relative_position=0 where 0 indicates a block-type network at the highest level possible, in a space-based organization, it belongs to the top space. The levels increment from 0 down to n, the lowest level you set up, within networks or spaces.
          • use_reversed_relative_position=1 where 1 indicates a network located at the lowest level of the organization, within networks or spaces. The levels increment from 0 up to n, the network at the highest level of the organization.
          ", + "explode": true, + "in": "query", + "name": "relative_position", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The level of the network within the space:
          • Set it to 0 for a block-type network.
          • Set it to a value between 1 and n for a subnet-type network.
          If you set a value between 2 and n, you are setting a network-based VLSM organization where non terminal subnet-type networks can contain other subnet-type networks.", + "explode": true, + "in": "query", + "name": "network_level", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the IPv4 network.", + "explode": true, + "in": "query", + "name": "network_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to determine if the calculation of the parameter relative_position should start from the top (0) or the bottom (1) of the VLSM organization.", + "explode": true, + "in": "query", + "name": "use_reversed_relative_position", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete an IPv4 block/subnet-type network", + "tags": [ + "ipam" + ] + } + }, + "/ipam/pool/list": { + "get": { + "description": "This service allows you to list the objects.
          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_pool_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
          .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the IPv4 pools", + "tags": [ + "ipam" + ] + } + }, + "/ipam/pool/count": { + "get": { + "description": "This service allows you to return the number of objects.
          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_pool_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of IPv4 pools", + "tags": [ + "ipam" + ] + } + }, + "/ipam/pool/info": { + "get": { + "description": "This service allows you to display the properties of an object.
          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_pool_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv4 pool, a unique numeric key value automatically incremented when you add an IPv4 pool. Use the ID to specify the IPv4 pool of your choice.", + "explode": true, + "in": "query", + "name": "pool_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of an IPv4 pool", + "tags": [ + "ipam" + ] + } + }, + "/ipam/pool/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
          • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

            Mandatory Parameters: (pool_start_ip_addr && (pool_end_ip_addr || pool_size) && (network_id || space_id || space_name))", + "operationId": "ipam_pool_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add an IPv4 pool", + "tags": [ + "ipam" + ] + } + }, + "/ipam/pool/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
            • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

              Mandatory Parameters: (pool_id || (pool_start_ip_addr && (pool_end_ip_addr || pool_size) && (network_id || space_id || space_name)))", + "operationId": "ipam_pool_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit an IPv4 pool", + "tags": [ + "ipam" + ] + } + }, + "/ipam/pool/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

              Mandatory Parameters: (pool_id || (pool_start_ip_addr && (pool_end_ip_addr || pool_size) && (network_id || space_id || space_name)))", + "operationId": "ipam_pool_delete", + "parameters": [ + { + "description": "The last IP address of the pool.", + "explode": true, + "in": "query", + "name": "pool_end_ip_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv4 pool, a unique numeric key value automatically incremented when you add an IPv4 pool. Use the ID to specify the IPv4 pool of your choice.", + "explode": true, + "in": "query", + "name": "pool_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The size of the pool, the number of IP addresses it contains.", + "explode": true, + "in": "query", + "name": "pool_size", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "explode": true, + "in": "query", + "name": "space_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the space.", + "explode": true, + "in": "query", + "name": "space_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The first IP address of the pool.", + "explode": true, + "in": "query", + "name": "pool_start_ip_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv4 network, a unique numeric key value automatically incremented when you add an IPv4 network. Use the ID to specify the IPv4 network of your choice.", + "explode": true, + "in": "query", + "name": "network_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete an IPv4 pool", + "tags": [ + "ipam" + ] + } + }, + "/ipam/address/list": { + "get": { + "description": "This service allows you to list the objects.
              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_address_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
              .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the IPv4 addresses", + "tags": [ + "ipam" + ] + } + }, + "/ipam/address/count": { + "get": { + "description": "This service allows you to return the number of objects.
              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_address_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of IPv4 addresses", + "tags": [ + "ipam" + ] + } + }, + "/ipam/address/info": { + "get": { + "description": "This service allows you to display the properties of an object.
              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_address_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv4 address, a unique numeric key value automatically incremented when you add an IPv4 address. Use the ID to specify the IPv4 address of your choice.", + "explode": true, + "in": "query", + "name": "address_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of an IPv4 address", + "tags": [ + "ipam" + ] + } + }, + "/ipam/address/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
              • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                Mandatory Parameters: (address_hostaddr && (space_id || space_name))", + "operationId": "ipam_address_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add an IPv4 address", + "tags": [ + "ipam" + ] + } + }, + "/ipam/address/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                  Mandatory Parameters: (address_id || (address_hostaddr && (space_id || space_name)))", + "operationId": "ipam_address_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit an IPv4 address", + "tags": [ + "ipam" + ] + } + }, + "/ipam/address/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                  Mandatory Parameters: (address_id || (address_hostaddr && (space_id || space_name)))", + "operationId": "ipam_address_delete", + "parameters": [ + { + "description": "The IP address.", + "explode": true, + "in": "query", + "name": "address_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv4 address, a unique numeric key value automatically incremented when you add an IPv4 address. Use the ID to specify the IPv4 address of your choice.", + "explode": true, + "in": "query", + "name": "address_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "explode": true, + "in": "query", + "name": "space_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the space.", + "explode": true, + "in": "query", + "name": "space_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The name of the IPv4 address.", + "explode": true, + "in": "query", + "name": "address_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete an IPv4 address", + "tags": [ + "ipam" + ] + } + }, + "/ipam/alias/list": { + "get": { + "description": "This service allows you to list the objects.
                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_alias_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                  .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv4 address, a unique numeric key value automatically incremented when you add an IPv4 address. Use the ID to specify the IPv4 address of your choice.", + "explode": true, + "in": "query", + "name": "address_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the aliases of an IPv4 address", + "tags": [ + "ipam" + ] + } + }, + "/ipam/alias/count": { + "get": { + "description": "This service allows you to return the number of objects.
                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_alias_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv4 address, a unique numeric key value automatically incremented when you add an IPv4 address. Use the ID to specify the IPv4 address of your choice.", + "explode": true, + "in": "query", + "name": "address_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of aliases of an IPv4 address", + "tags": [ + "ipam" + ] + } + }, + "/ipam/alias/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                  • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                    Mandatory Parameters: (alias_name && (address_id || (address_hostaddr && (space_id || space_name))))", + "operationId": "ipam_alias_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add an IPv4 address alias", + "tags": [ + "ipam" + ] + } + }, + "/ipam/alias/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                    • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                      Mandatory Parameters: (alias_id || (alias_name && (address_id || (address_hostaddr && (space_id || space_name)))))", + "operationId": "ipam_alias_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit an IPv4 address alias", + "tags": [ + "ipam" + ] + } + }, + "/ipam/alias/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                      Mandatory Parameters: (alias_id || (alias_name && (address_id || (address_hostaddr && (space_id || space_name)))))", + "operationId": "ipam_alias_delete", + "parameters": [ + { + "description": "The IP address.", + "explode": true, + "in": "query", + "name": "address_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv4 address, a unique numeric key value automatically incremented when you add an IPv4 address. Use the ID to specify the IPv4 address of your choice.", + "explode": true, + "in": "query", + "name": "address_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the IPv4 alias.", + "explode": true, + "in": "query", + "name": "alias_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv4 alias, a unique numeric key value automatically incremented when you add an IPv4 alias. Use the ID to specify the IPv4 alias to of your choice.", + "explode": true, + "in": "query", + "name": "alias_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "explode": true, + "in": "query", + "name": "space_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the space.", + "explode": true, + "in": "query", + "name": "space_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The type of the alias.", + "explode": true, + "in": "query", + "name": "alias_type", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete an IPv4 address alias", + "tags": [ + "ipam" + ] + } + }, + "/ipam/network6/list": { + "get": { + "description": "This service allows you to list the objects.
                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_network6_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                      .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the IPv6 block/subnet-type networks", + "tags": [ + "ipam" + ] + } + }, + "/ipam/network6/count": { + "get": { + "description": "This service allows you to return the number of objects.
                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_network6_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of IPv6 block/subnet-type networks", + "tags": [ + "ipam" + ] + } + }, + "/ipam/network6/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_network6_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv6 network, a unique numeric key value automatically incremented when you add an IPv6 network. Use the ID to specify the IPv6 network of your choice.", + "explode": true, + "in": "query", + "name": "network6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of an IPv6 block/subnet-type network", + "tags": [ + "ipam" + ] + } + }, + "/ipam/network6/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                      • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                        Mandatory Parameters: (network6_addr && (network6_end_addr || network6_prefix) && (space_id || space_name || parent_network6_id))", + "operationId": "ipam_network6_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network6_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network6_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network6_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add an IPv6 block/subnet-type network", + "tags": [ + "ipam" + ] + } + }, + "/ipam/network6/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                        • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                          Mandatory Parameters: (network6_id || (network6_addr && (network6_end_addr || network6_prefix) && (space_id || space_name || parent_network6_id)))", + "operationId": "ipam_network6_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network6_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network6_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network6_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit an IPv6 block/subnet-type network", + "tags": [ + "ipam" + ] + } + }, + "/ipam/network6/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                          Mandatory Parameters: (network6_id || (network6_addr && (network6_end_addr || network6_prefix) && (space_id || space_name || parent_network6_id)))", + "operationId": "ipam_network6_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the parent IPv6 network. Use the ID to specify the parent IPv6 network of your choice.", + "explode": true, + "in": "query", + "name": "parent_network6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "explode": true, + "in": "query", + "name": "space_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the space.", + "explode": true, + "in": "query", + "name": "space_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The start IP address of the IPv6 network, its first IP address.", + "explode": true, + "in": "query", + "name": "network6_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The end IP address of the IPv6 network, its last IP address.", + "explode": true, + "in": "query", + "name": "network6_end_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv6 network, a unique numeric key value automatically incremented when you add an IPv6 network. Use the ID to specify the IPv6 network of your choice.", + "explode": true, + "in": "query", + "name": "network6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The prefix of the IPv6 network, an integer that defines the number of address the network contains.", + "explode": true, + "in": "query", + "name": "network6_prefix", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The position of the network within the hierarchy of networks of a VLSM organization. It calculates between 0 and n all the levels of the organization, its behavior depends on the value of the parameter use_reversed_relative_position:
                          • use_reversed_relative_position=0 where 0 indicates a block-type network at the highest level possible, in a space-based organization, it belongs to the top space. The levels increment from 0 down to n, the lowest level you set up, within networks or spaces.
                          • use_reversed_relative_position=1 where 1 indicates a network located at the lowest level of the organization, within networks or spaces. The levels increment from 0 up to n, the network at the highest level of the organization.
                          ", + "explode": true, + "in": "query", + "name": "relative_position", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the IPv6 network.", + "explode": true, + "in": "query", + "name": "network6_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The level of the network within the space:
                          • Set it to 0 for a block-type network.
                          • Set it to a value between 1 and n for a subnet-type network.
                          If you set a value between 2 and n, you are setting a network-based VLSM organization where non terminal subnet-type networks can contain other subnet-type networks.", + "explode": true, + "in": "query", + "name": "network_level", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to determine if the calculation of the parameter relative_position should start from the top (0) or the bottom (1) of the VLSM organization.", + "explode": true, + "in": "query", + "name": "use_reversed_relative_position", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network6_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network6_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete an IPv6 block/subnet-type network", + "tags": [ + "ipam" + ] + } + }, + "/ipam/pool6/list": { + "get": { + "description": "This service allows you to list the objects.
                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_pool6_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                          .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the IPv6 pools", + "tags": [ + "ipam" + ] + } + }, + "/ipam/pool6/count": { + "get": { + "description": "This service allows you to return the number of objects.
                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_pool6_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of IPv6 pools", + "tags": [ + "ipam" + ] + } + }, + "/ipam/pool6/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_pool6_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv6 pool, a unique numeric key value automatically incremented when you add an IPv6 pool. Use the ID to specify the IPv6 pool of your choice.", + "explode": true, + "in": "query", + "name": "pool6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of an IPv6 pool", + "tags": [ + "ipam" + ] + } + }, + "/ipam/pool6/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                          • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                            Mandatory Parameters: (pool6_start_ip_addr && pool6_end_ip_addr && (network6_id || space_id || space_name))", + "operationId": "ipam_pool6_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool6_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool6_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool6_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add an IPv6 pool", + "tags": [ + "ipam" + ] + } + }, + "/ipam/pool6/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                            • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                              Mandatory Parameters: (pool6_id || (pool6_start_ip_addr && pool6_end_ip_addr && (network6_id || space_id || space_name)))", + "operationId": "ipam_pool6_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool6_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool6_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool6_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit an IPv6 pool", + "tags": [ + "ipam" + ] + } + }, + "/ipam/pool6/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                              Mandatory Parameters: (pool6_id || (pool6_start_ip_addr && pool6_end_ip_addr && (network6_id || space_id || space_name)))", + "operationId": "ipam_pool6_delete", + "parameters": [ + { + "description": "The last IP address of the pool.", + "explode": true, + "in": "query", + "name": "pool6_end_ip_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv6 pool, a unique numeric key value automatically incremented when you add an IPv6 pool. Use the ID to specify the IPv6 pool of your choice.", + "explode": true, + "in": "query", + "name": "pool6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "explode": true, + "in": "query", + "name": "space_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the space.", + "explode": true, + "in": "query", + "name": "space_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The first IP address of the pool.", + "explode": true, + "in": "query", + "name": "pool6_start_ip_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv6 network, a unique numeric key value automatically incremented when you add an IPv6 network. Use the ID to specify the IPv6 network of your choice.", + "explode": true, + "in": "query", + "name": "network6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool6_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool6_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete an IPv6 pool", + "tags": [ + "ipam" + ] + } + }, + "/ipam/address6/list": { + "get": { + "description": "This service allows you to list the objects.
                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_address6_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                              .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the IPv6 addresses", + "tags": [ + "ipam" + ] + } + }, + "/ipam/address6/count": { + "get": { + "description": "This service allows you to return the number of objects.
                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_address6_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of IPv6 addresses", + "tags": [ + "ipam" + ] + } + }, + "/ipam/address6/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_address6_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv6 address, a unique numeric key value automatically incremented when you add an IPv6 address. Use the ID to specify the IPv6 address of your choice.", + "explode": true, + "in": "query", + "name": "address6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of an IPv6 address", + "tags": [ + "ipam" + ] + } + }, + "/ipam/address6/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                              • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                Mandatory Parameters: (address6_hostaddr && (space_id || space_name))", + "operationId": "ipam_address6_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address6_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address6_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address6_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add an IPv6 address", + "tags": [ + "ipam" + ] + } + }, + "/ipam/address6/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                  Mandatory Parameters: (address6_id || (address6_hostaddr && (space_id || space_name)))", + "operationId": "ipam_address6_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address6_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address6_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address6_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit an IPv6 address", + "tags": [ + "ipam" + ] + } + }, + "/ipam/address6/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                  Mandatory Parameters: (address6_id || (address6_hostaddr && (space_id || space_name)))", + "operationId": "ipam_address6_delete", + "parameters": [ + { + "description": "The IP address.", + "explode": true, + "in": "query", + "name": "address6_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv6 address, a unique numeric key value automatically incremented when you add an IPv6 address. Use the ID to specify the IPv6 address of your choice.", + "explode": true, + "in": "query", + "name": "address6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "explode": true, + "in": "query", + "name": "space_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the space.", + "explode": true, + "in": "query", + "name": "space_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The name of the IPv6 address.", + "explode": true, + "in": "query", + "name": "address6_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address6_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address6_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete an IPv6 address", + "tags": [ + "ipam" + ] + } + }, + "/ipam/alias6/list": { + "get": { + "description": "This service allows you to list the objects.
                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_alias6_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                  .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv6 address, a unique numeric key value automatically incremented when you add an IPv6 address. Use the ID to specify the IPv6 address of your choice.", + "explode": true, + "in": "query", + "name": "address6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the aliases of an IPv6 address", + "tags": [ + "ipam" + ] + } + }, + "/ipam/alias6/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_alias6_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv6 address, a unique numeric key value automatically incremented when you add an IPv6 address. Use the ID to specify the IPv6 address of your choice.", + "explode": true, + "in": "query", + "name": "address6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of aliases of an IPv6 address", + "tags": [ + "ipam" + ] + } + }, + "/ipam/alias6/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                  • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                    Mandatory Parameters: (alias6_name && (address6_id || (address6_hostaddr && (space_id || space_name))))", + "operationId": "ipam_alias6_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias6_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias6_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias6_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add an IPv6 address alias", + "tags": [ + "ipam" + ] + } + }, + "/ipam/alias6/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                    • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                      Mandatory Parameters: (alias6_id || (alias6_name && (address6_id || (address6_hostaddr && (space_id || space_name)))))", + "operationId": "ipam_alias6_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias6_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias6_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias6_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit an IPv6 address alias", + "tags": [ + "ipam" + ] + } + }, + "/ipam/alias6/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                      Mandatory Parameters: (alias6_id || (alias6_name && (address6_id || (address6_hostaddr && (space_id || space_name)))))", + "operationId": "ipam_alias6_delete", + "parameters": [ + { + "description": "The IP address.", + "explode": true, + "in": "query", + "name": "address6_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv6 address, a unique numeric key value automatically incremented when you add an IPv6 address. Use the ID to specify the IPv6 address of your choice.", + "explode": true, + "in": "query", + "name": "address6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the IPv6 address.", + "explode": true, + "in": "query", + "name": "alias6_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv6 alias, a unique numeric key value automatically incremented when you add an IPv6 alias. Use the ID to specify the IPv6 alias to of your choice.", + "explode": true, + "in": "query", + "name": "alias6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "explode": true, + "in": "query", + "name": "space_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the space.", + "explode": true, + "in": "query", + "name": "space_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The type of the alias.", + "explode": true, + "in": "query", + "name": "alias6_type", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias6_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias6_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete an IPv6 address alias", + "tags": [ + "ipam" + ] + } + }, + "/dhcp/server/list": { + "get": { + "description": "This service allows you to list the objects.
                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_server_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                      .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_server_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv4 servers", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/server/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_server_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of DHCPv4 servers", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/server/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_server_info", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "explode": true, + "in": "query", + "name": "server_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_server_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCPv4 server", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/failover/list": { + "get": { + "description": "This service allows you to list the objects.
                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_failover_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                      .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_failover_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv4 failover channels", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/failover/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_failover_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of DHCPv4 failover channels", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/failover/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_failover_info", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv4 failover channel, a unique numeric key value automatically incremented when you add a DHCPv4 failover channel. Use the ID to specify the DHCPv4 failover channel of your choice.", + "explode": true, + "in": "query", + "name": "failover_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_failover_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCPv4 failover channel", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/group/list": { + "get": { + "description": "This service allows you to list the objects.
                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_group_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                      .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_group_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv4 groups", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/group/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_group_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of DHCPv4 groups", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/group/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_group_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv4 group, a unique numeric key value automatically incremented when you add a DHCPv4 group. Use the ID to specify the DHCPv4 group of your choice.", + "explode": true, + "in": "query", + "name": "group_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_group_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCPv4 group", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/group/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                      • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                        Mandatory Parameters: (group_name && (server_id || server_name || server_hostaddr))", + "operationId": "dhcp_group_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_group_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_group_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_group_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a DHCPv4 group", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/group/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                        • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                          Mandatory Parameters: (group_id || (group_name && (server_id || server_name || server_hostaddr)))", + "operationId": "dhcp_group_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_group_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_group_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_group_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a DHCPv4 group", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/group/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                          Mandatory Parameters: (group_id || (group_name && (server_id || server_name || server_hostaddr)))", + "operationId": "dhcp_group_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "explode": true, + "in": "query", + "name": "server_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DHCPv4 server.", + "explode": true, + "in": "query", + "name": "server_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv4 group, a unique numeric key value automatically incremented when you add a DHCPv4 group. Use the ID to specify the DHCPv4 group of your choice.", + "explode": true, + "in": "query", + "name": "group_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DHCPv4 group.", + "explode": true, + "in": "query", + "name": "group_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The IP address of the DHCP server.", + "explode": true, + "in": "query", + "name": "server_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_group_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_group_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a DHCPv4 group", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/sharednetwork/list": { + "get": { + "description": "This service allows you to list the objects.
                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_sharednetwork_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                          .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv4 shared networks", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/sharednetwork/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_sharednetwork_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of DHCPv4 shared networks", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/sharednetwork/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_sharednetwork_info", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv4 shared network, a unique numeric key value automatically incremented when you add a DHCPv4 shared network. Use the ID to specify the DHCPv4 shared network of your choice.", + "explode": true, + "in": "query", + "name": "sharednetwork_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCPv4 shared network", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/sharednetwork/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                          • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                            Mandatory Parameters: (sharednetwork_name && (server_id || server_name || server_hostaddr))", + "operationId": "dhcp_sharednetwork_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a DHCPv4 shared network", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/sharednetwork/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                            • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                              Mandatory Parameters: ((sharednetwork_id || sharednetwork_name) && (server_id || server_name || server_hostaddr))", + "operationId": "dhcp_sharednetwork_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a DHCPv4 shared network", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/sharednetwork/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                              Mandatory Parameters: ((sharednetwork_id || sharednetwork_name) && (server_id || server_name || server_hostaddr))", + "operationId": "dhcp_sharednetwork_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "explode": true, + "in": "query", + "name": "server_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DHCPv4 server.", + "explode": true, + "in": "query", + "name": "server_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv4 shared network, a unique numeric key value automatically incremented when you add a DHCPv4 shared network. Use the ID to specify the DHCPv4 shared network of your choice.", + "explode": true, + "in": "query", + "name": "sharednetwork_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DHCPv4 shared network.", + "explode": true, + "in": "query", + "name": "sharednetwork_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The IP address of the DHCP server.", + "explode": true, + "in": "query", + "name": "server_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a DHCPv4 Shared Network", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/scope/list": { + "get": { + "description": "This service allows you to list the objects.
                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_scope_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                              .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv4 scopes", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/scope/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_scope_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of DHCPv4 scopes", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/scope/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_scope_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv4 scope, a unique numeric key value automatically incremented when you add a DHCPv4 scope. Use the ID to specify the DHCPv4 scope of your choice.", + "explode": true, + "in": "query", + "name": "scope_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCPv4 scope", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/scope/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                              • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                Mandatory Parameters: (scope_net_addr && scope_net_mask && (server_id || server_name || server_hostaddr))", + "operationId": "dhcp_scope_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a DHCPv4 scope", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/scope/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                  Mandatory Parameters: (scope_id || (scope_net_addr && scope_net_mask && (server_id || server_name || server_hostaddr)))", + "operationId": "dhcp_scope_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a DHCPv4 scope", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/scope/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                  Mandatory Parameters: (scope_id || (scope_net_addr && (server_id || server_name || server_hostaddr)))", + "operationId": "dhcp_scope_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "explode": true, + "in": "query", + "name": "server_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DHCPv4 server.", + "explode": true, + "in": "query", + "name": "server_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv4 scope, a unique numeric key value automatically incremented when you add a DHCPv4 scope. Use the ID to specify the DHCPv4 scope of your choice.", + "explode": true, + "in": "query", + "name": "scope_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The first IP address of the DHCPv4 scope.", + "explode": true, + "in": "query", + "name": "scope_net_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The IP address of the DHCP server.", + "explode": true, + "in": "query", + "name": "server_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a DHCPv4 scope", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/range/list": { + "get": { + "description": "This service allows you to list the objects.
                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_range_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                  .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv4 ranges", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/range/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_range_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of DHCPv4 ranges", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/range/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_range_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv4 range, a unique numeric key value automatically incremented when you add a DHCPv4 range. Use the ID to specify the DHCPv4 range of your choice.", + "explode": true, + "in": "query", + "name": "range_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCPv4 range", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/range/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                  • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                    Mandatory Parameters: (range_start_addr && range_end_addr && (scope_id || server_id || server_name || server_hostaddr))", + "operationId": "dhcp_range_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a DHCPv4 range", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/range/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                    • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                      Mandatory Parameters: (range_id || (range_start_addr && range_end_addr && (scope_id || server_id || server_name || server_hostaddr)))", + "operationId": "dhcp_range_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a DHCPv4 range", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/range/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                      Mandatory Parameters: (range_id || ((range_name || range_start_addr || range_end_addr) && (server_id || server_name || server_hostaddr || scope_id)))", + "operationId": "dhcp_range_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "explode": true, + "in": "query", + "name": "server_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DHCPv4 server.", + "explode": true, + "in": "query", + "name": "server_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The last IP address of the DHCPv4 range.", + "explode": true, + "in": "query", + "name": "range_end_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv4 range, a unique numeric key value automatically incremented when you add a DHCPv4 range. Use the ID to specify the DHCPv4 range of your choice.", + "explode": true, + "in": "query", + "name": "range_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The start and end IP address of the DHCPv4 range, as follows: <start-ip>-<end-ip>.", + "explode": true, + "in": "query", + "name": "range_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The first IP address of the DHCPv4 range.", + "explode": true, + "in": "query", + "name": "range_start_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv4 scope, a unique numeric key value automatically incremented when you add a DHCPv4 scope. Use the ID to specify the DHCPv4 scope of your choice.", + "explode": true, + "in": "query", + "name": "scope_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The IP address of the DHCP server.", + "explode": true, + "in": "query", + "name": "server_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a DHCPv4 range", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/lease/list": { + "get": { + "description": "This service allows you to list the objects.
                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_lease_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                      .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_lease_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv4 leases", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/lease/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_lease_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of DHCPv4 leases", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/lease/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_lease_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv4 lease, a unique numeric key value automatically incremented when you add a DHCPv4 lease. Use the ID to specify the DHCPv4 lease of your choice.", + "explode": true, + "in": "query", + "name": "lease_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_lease_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCPv4 lease", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/static/list": { + "get": { + "description": "This service allows you to list the objects.
                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_static_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                      .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv4 statics", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/static/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_static_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of DHCPv4 statics", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/static/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_static_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCP static, a unique numeric key value automatically incremented when you add a DHCP sttestatic. Use the ID to specify the DHCP static of your choice.", + "explode": true, + "in": "query", + "name": "static_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCPv4 static", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/static/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                      • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                        Mandatory Parameters: (server_id || server_name || server_hostaddr) && (static_addr || static_mac_addr || static_identifier)", + "operationId": "dhcp_static_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a DHCPv4 static", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/static/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                        • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                          Mandatory Parameters: (static_id || (server_id || server_name || server_hostaddr) && (static_addr || static_mac_addr || static_identifier))", + "operationId": "dhcp_static_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a DHCPv4 static", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/static/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                          Mandatory Parameters: (static_id || (static_addr && (static_mac_addr || static_identifier) && (server_id || server_name || server_hostaddr || scope_id)))", + "operationId": "dhcp_static_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "explode": true, + "in": "query", + "name": "server_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DHCPv4 server.", + "explode": true, + "in": "query", + "name": "server_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The IP address associated with the DHCPv4 static.", + "explode": true, + "in": "query", + "name": "static_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv4 static, a unique numeric key value automatically incremented when you add a DHCPv4 static. Use the ID to specify the DHCPv4 static of your choice.", + "explode": true, + "in": "query", + "name": "static_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The host identifier associated with the IPv4 static. An option and value to look for to identify clients and assign them the static, specified as follows: option <option-name> expected value.", + "explode": true, + "in": "query", + "name": "static_identifier", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The MAC address associated with the IPv4 static, it must include the MAC address type. The address has 7 sections, 00:11:22:33:44:55:66 , where 00 indicates the type. For Ethernet, type in 01.", + "explode": true, + "in": "query", + "name": "static_mac_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv4 scope, a unique numeric key value automatically incremented when you add a DHCPv4 scope. Use the ID to specify the DHCPv4 scope of your choice.", + "explode": true, + "in": "query", + "name": "scope_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The IP address of the DHCP server.", + "explode": true, + "in": "query", + "name": "server_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The name of the DHCPv4 static.", + "explode": true, + "in": "query", + "name": "static_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a DHCPv4 static", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/acl/list": { + "get": { + "description": "This service allows you to list the objects.
                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_acl_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                          .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_acl_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCP ACLs", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/acl/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_acl_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of DHCP ACLs", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/acl/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_acl_info", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv4 ACL, a unique numeric key value automatically incremented when you add a DHCPv4 ACL. Use the ID to specify the DHCPv4 ACL of your choice.", + "explode": true, + "in": "query", + "name": "acl_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_acl_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCP ACL", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/aclentry/list": { + "get": { + "description": "This service allows you to list the objects.
                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_aclentry_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                          .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_aclentry_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCP ACL entries", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/aclentry/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_aclentry_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of DHCP ACL entries", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/aclentry/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_aclentry_info", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv4 ACL entry, a unique numeric key value automatically incremented when you add a DHCPv4 ACL entry. Use the ID to specify the DHCPv4 ACL entry of your choice.", + "explode": true, + "in": "query", + "name": "aclentry_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_aclentry_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCP ACL entry", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/server6/list": { + "get": { + "description": "This service allows you to list the objects.
                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_server6_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                          .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_server6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv6 servers", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/server6/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_server6_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of DHCPv6 servers", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/server6/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_server6_info", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "explode": true, + "in": "query", + "name": "server6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_server6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCPv6 server", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/group6/list": { + "get": { + "description": "This service allows you to list the objects.
                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_group6_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                          .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_group6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv6 groups", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/sharednetwork6/list": { + "get": { + "description": "This service allows you to list the objects.
                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_sharednetwork6_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                          .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv6 shared networks", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/sharednetwork6/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_sharednetwork6_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of DHCPv6 shared networks", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/sharednetwork6/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_sharednetwork6_info", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv6 shared network, a unique numeric key value automatically incremented when you add a DHCPv6 shared network. Use the ID to specify the DHCPv6 shared network of your choice.", + "explode": true, + "in": "query", + "name": "sharednetwork6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCPv6 shared network", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/sharednetwork6/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                          • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                            Mandatory Parameters: (sharednetwork6_name && (server6_id || server6_name || server6_hostaddr))", + "operationId": "dhcp_sharednetwork6_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork6_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork6_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork6_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a DHCPv6 shared network", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/sharednetwork6/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                            • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                              Mandatory Parameters: ((sharednetwork6_id || sharednetwork6_name) && (server6_id || server6_name || server6_hostaddr))", + "operationId": "dhcp_sharednetwork6_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork6_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork6_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork6_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a DHCPv6 shared network", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/sharednetwork6/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                              Mandatory Parameters: ((sharednetwork6_id || sharednetwork6_name) && (server6_id || server6_name || server6_hostaddr))", + "operationId": "dhcp_sharednetwork6_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "explode": true, + "in": "query", + "name": "server6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DHCPv6 server.", + "explode": true, + "in": "query", + "name": "server6_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv6 shared network, a unique numeric key value automatically incremented when you add a DHCPv6 shared network. Use the ID to specify the DHCPv6 shared network of your choice.", + "explode": true, + "in": "query", + "name": "sharednetwork6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DHCPv6 shared network.", + "explode": true, + "in": "query", + "name": "sharednetwork6_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The IP address of the DHCP server.", + "explode": true, + "in": "query", + "name": "server6_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork6_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork6_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a DHCPv6 Shared Network", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/scope6/list": { + "get": { + "description": "This service allows you to list the objects.
                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_scope6_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                              .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv6 scopes", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/scope6/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_scope6_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of DHCPv6 scopes", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/scope6/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_scope6_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv6 scope, a unique numeric key value automatically incremented when you add a DHCPv6 scope. Use the ID to specify the DHCPv6 scope of your choice.", + "explode": true, + "in": "query", + "name": "scope6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCPv6 scope", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/scope6/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                              • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                Mandatory Parameters: (scope6_start_addr && (scope6_end_addr || scope6_prefix) && (server6_id || server6_name || server6_hostaddr))", + "operationId": "dhcp_scope6_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope6_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope6_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope6_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a DHCPv6 scope", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/scope6/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                  Mandatory Parameters: (scope6_id || (scope6_start_addr && (scope6_end_addr || scope6_prefix) && (server6_id || server6_name || server6_hostaddr)))", + "operationId": "dhcp_scope6_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope6_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope6_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope6_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a DHCPv6 scope", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/scope6/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                  Mandatory Parameters: (scope6_id || (scope6_start_addr && (server6_id || server6_name || server6_hostaddr)))", + "operationId": "dhcp_scope6_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "explode": true, + "in": "query", + "name": "server6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DHCPv6 server.", + "explode": true, + "in": "query", + "name": "server6_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv6 scope, a unique numeric key value automatically incremented when you add a DHCPv6 scope. Use the ID to specify the DHCPv6 scope of your choice.", + "explode": true, + "in": "query", + "name": "scope6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The first IP address of the DHCPv6 scope.", + "explode": true, + "in": "query", + "name": "scope6_start_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The IP address of the DHCP server.", + "explode": true, + "in": "query", + "name": "server6_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope6_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope6_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a DHCPv6 scope", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/range6/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_range6_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                  .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv6 ranges", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/range6/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_range6_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of DHCPv6 ranges", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/range6/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_range6_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv6 range, a unique numeric key value automatically incremented when you add a DHCPv6 range. Use the ID to specify the DHCPv6 of your choice.", + "explode": true, + "in": "query", + "name": "range6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCPv6 range", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/range6/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                  • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                    Mandatory Parameters: (range6_start_addr && range6_end_addr && (scope6_id || server6_id || server6_name || server6_hostaddr))", + "operationId": "dhcp_range6_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range6_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range6_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range6_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a DHCPv6 range", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/range6/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                    • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                      Mandatory Parameters: (range6_id || (range6_start_addr && range6_end_addr && (scope6_id || server6_id || server6_name || server6_hostaddr)))", + "operationId": "dhcp_range6_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range6_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range6_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range6_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a DHCPv6 range", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/range6/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                      Mandatory Parameters: (range6_id || ((range6_start_addr || range6_end_addr) && (server6_id || server6_name || server6_hostaddr || scope6_id)))", + "operationId": "dhcp_range6_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "explode": true, + "in": "query", + "name": "server6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DHCPv6 server.", + "explode": true, + "in": "query", + "name": "server6_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The last IP address of the DHCPv6 range.", + "explode": true, + "in": "query", + "name": "range6_end_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv6 range, a unique numeric key value automatically incremented when you add a DHCPv6 range. Use the ID to specify the DHCPv6 of your choice.", + "explode": true, + "in": "query", + "name": "range6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The first IP address of the DHCPv6 range.", + "explode": true, + "in": "query", + "name": "range6_start_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv6 scope, a unique numeric key value automatically incremented when you add a DHCPv6 scope. Use the ID to specify the DHCPv6 scope of your choice.", + "explode": true, + "in": "query", + "name": "scope6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The IP address of the DHCP server.", + "explode": true, + "in": "query", + "name": "server6_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range6_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range6_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a DHCPv6 range", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/lease6/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_lease6_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                      .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_lease6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv6 leases", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/lease6/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_lease6_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of DHCPv6 leases", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/static6/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_static6_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                      .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv6 statics", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/static6/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_static6_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of DHCPv6 statics", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/static6/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_static6_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCP static, a unique numeric key value automatically incremented when you add a DHCP static. Use the ID to specify the DHCP static of your choice.", + "explode": true, + "in": "query", + "name": "static6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCPv6 static", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/static6/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                      • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                        Mandatory Parameters: (static6_name && (static6_mac_addr || static6_client_duid) && (server6_id || server6_name || server6_hostaddr))", + "operationId": "dhcp_static6_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static6_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static6_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static6_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a DHCPv6 static", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/static6/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                        • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                          Mandatory Parameters: (static6_id || (static6_name && (static6_mac_addr || static6_client_duid) && (server6_id || server6_name || server6_hostaddr)))", + "operationId": "dhcp_static6_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static6_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static6_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static6_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a DHCPv6 static", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/static6/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                          Mandatory Parameters: (static6_id || ((static6_name || static6_addr) && (server6_id || server6_name || server6_hostaddr || scope6_id)))", + "operationId": "dhcp_static6_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "explode": true, + "in": "query", + "name": "server6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DHCPv6 server.", + "explode": true, + "in": "query", + "name": "server6_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The IP address associated with the DHCPv6 static.", + "explode": true, + "in": "query", + "name": "static6_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv6 static, a unique numeric key value automatically incremented when you add a DHCPv6 static. Use the ID to specify the DHCPv6 static of your choice.", + "explode": true, + "in": "query", + "name": "static6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DHCPv6 static.", + "explode": true, + "in": "query", + "name": "static6_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv6 scope, a unique numeric key value automatically incremented when you add a DHCPv6 scope. Use the ID to specify the DHCPv6 scope of your choice.", + "explode": true, + "in": "query", + "name": "scope6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The IP address of the DHCP server.", + "explode": true, + "in": "query", + "name": "server6_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static6_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static6_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a DHCPv6 static", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/acl6/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_acl6_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                          .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_acl6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv6 ACLs", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/aclentry6/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_aclentry6_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                          .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_aclentry6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv6 ACL entries", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/acl6/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_acl6_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of DHCPv6 ACLs", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/aclentry6/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_aclentry6_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of DHCPv6 ACL entries", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/acl6/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_acl6_info", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv6 ACL, a unique numeric key value automatically incremented when you add a DHCPv6 ACL. Use the ID to specify the DHCPv6 ACL of your choice.", + "explode": true, + "in": "query", + "name": "acl6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_acl6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCPv6 ACL", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/aclentry6/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_aclentry6_info", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv6 ACL entry, a unique numeric key value automatically incremented when you add a DHCPv6 ACL entry. Use the ID to specify the DHCPv6 ACL entry of your choice.", + "explode": true, + "in": "query", + "name": "aclentry6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_aclentry6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCPv6 ACL entry", + "tags": [ + "dhcp" + ] + } + }, + "/dns/server/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dns_server_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                          .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_server_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DNS servers", + "tags": [ + "dns" + ] + } + }, + "/dns/server/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dns_server_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of DNS servers", + "tags": [ + "dns" + ] + } + }, + "/dns/server/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dns_server_info", + "parameters": [ + { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "explode": true, + "in": "query", + "name": "server_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_server_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DNS server", + "tags": [ + "dns" + ] + } + }, + "/dns/view/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dns_view_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                          .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_view_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the views", + "tags": [ + "dns" + ] + } + }, + "/dns/view/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dns_view_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of views", + "tags": [ + "dns" + ] + } + }, + "/dns/view/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dns_view_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DNS view. Use the ID to specify the DNS view of your choice.", + "explode": true, + "in": "query", + "name": "view_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_view_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a view", + "tags": [ + "dns" + ] + } + }, + "/dns/view/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                          • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                            Mandatory Parameters: (view_name && (server_id || server_name || server_hostaddr))", + "operationId": "dns_view_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_view_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_view_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_view_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a view", + "tags": [ + "dns" + ] + } + }, + "/dns/view/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                            • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                              Mandatory Parameters: (view_id || (view_name && (server_id || server_name || server_hostaddr)))", + "operationId": "dns_view_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_view_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_view_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_view_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a view", + "tags": [ + "dns" + ] + } + }, + "/dns/view/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                              Mandatory Parameters: (view_id || (view_name && (server_id || server_name || server_hostaddr)))", + "operationId": "dns_view_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "explode": true, + "in": "query", + "name": "server_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DNS server.", + "explode": true, + "in": "query", + "name": "server_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DNS view. Use the ID to specify the DNS view of your choice.", + "explode": true, + "in": "query", + "name": "view_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DNS view.", + "explode": true, + "in": "query", + "name": "view_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The IP address of the DNS server.", + "explode": true, + "in": "query", + "name": "server_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_view_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_view_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a view", + "tags": [ + "dns" + ] + } + }, + "/dns/zone/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dns_zone_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                              .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zone_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DNS options of a zone", + "tags": [ + "dns" + ] + } + }, + "/dns/zone/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dns_zone_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of zones", + "tags": [ + "dns" + ] + } + }, + "/dns/zone/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dns_zone_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DNS zone, a unique numeric key value automatically incremented when you add a DNS zone. Use the ID to specify the DNS zone of your choice.", + "explode": true, + "in": "query", + "name": "zone_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zone_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a zone", + "tags": [ + "dns" + ] + } + }, + "/dns/zone/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                              • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                Mandatory Parameters: (zone_name && zone_type && (view_id || view_name) && (server_id || server_name || server_hostaddr))", + "operationId": "dns_zone_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zone_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zone_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zone_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a zone", + "tags": [ + "dns" + ] + } + }, + "/dns/zone/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                  Mandatory Parameters: (zone_id || (zone_name && (view_id || view_name) && (server_id || server_name || server_hostaddr)))", + "operationId": "dns_zone_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zone_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zone_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zone_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a zone", + "tags": [ + "dns" + ] + } + }, + "/dns/zone/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                  Mandatory Parameters: (zone_id || (zone_name && (view_id || (view_name && (server_id || server_name || server_hostaddr)))))", + "operationId": "dns_zone_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "explode": true, + "in": "query", + "name": "server_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DNS server.", + "explode": true, + "in": "query", + "name": "server_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DNS view the object belongs to.", + "explode": true, + "in": "query", + "name": "view_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DNS view the object belongs to.", + "explode": true, + "in": "query", + "name": "view_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DNS zone, a unique numeric key value automatically incremented when you add a DNS zone. Use the ID to specify the DNS zone of your choice.", + "explode": true, + "in": "query", + "name": "zone_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DNS zone the object belongs to.", + "explode": true, + "in": "query", + "name": "zone_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The IP address of the DNS server.", + "explode": true, + "in": "query", + "name": "server_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zone_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zone_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a zone", + "tags": [ + "dns" + ] + } + }, + "/dns/rr/list": { + "get": { + "description": "This service allows you to list the resource records.
                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.
                                                                                  Adding some resource records requires to specify one or more values:


                                                                                  Expected values for the DNS records
                                                                                  TypeValuenumberRelated field(s)Description
                                                                                  SOA1Name serverThe FQDN of the primary Master name server for the zone the record belongs to. Has a special meaning when used with Dynamic DNS (DDNS): called MNAME, it allows the DNS client to know on which DNS server it has to update itself with DDNS.
                                                                                  2ResponsibleThe administrator email address for the zone the record belongs to.
                                                                                  3Serial numberThe serial number for the zone the record belongs to. The serial number is automatically incremented for each zone change.
                                                                                  4RefreshThe refresh delay for the zone the record belongs to, in seconds. When reached, it forces the slave name server(s) to read the SOA record. If this record is higher than the slave's one, a zone transfer will be triggered by the slave to get the latest version of the zone. Typical values are 3 to 24 hours.
                                                                                  5RetryThe retry delay for the zone the record belongs to, in seconds. When reached, it forces the slave server to retry the request if it fails to reach the master server during a refresh cycle. Typical values are from 10 to 60 minutes.
                                                                                  6ExpirationThe expiration time for the zone the record belongs to, in seconds. When reached, the zone records are considered to be no longer valid/authoritative. The DNS server then stops responding to queries for the zone. To avoid a major outage, the typical value is pretty high, between 1 to 3 weeks.
                                                                                  7MinimumThe minimum time for the zone the record belongs to, in seconds. It defines the period of time that negative responses can be cached from the slave. For instance, if a request cannot be resolved, the server will answer with a NXDOMAIN result (No such domain). The server will continue returning this value until the Minimum value expires, then it will retry the resolution. This value has to be between 0 and 3 hours.
                                                                                  NS1DNS serverThe DNS server hostname.
                                                                                  MX1PreferenceA number, between 0 and 65535, to define which server has priority if there are several RRs in the zone. The lowest the value has the priority over the other server(s).
                                                                                  2Mail serverThe SMTP (mail) server hostname.
                                                                                  A1IP addressThe IPv4 Address of the host.
                                                                                  AAAA1IPv6 addressThe IPv6 Address of the host.
                                                                                  PTR1LocalizationThe hostname that should be returned when the IP address is queried.
                                                                                  CNAME1HostnameThe hostname.
                                                                                  TXT1TextThe description of your choice (max. 255 characters including spaces).
                                                                                  SRV1PriorityA number, between 0 and 65535, to define which server has priority if there are several SRV RRs in the zone. The lowest the value has the priority over the other server(s).
                                                                                  2WeightA number, between 0 and 65535, that defines the server weight. If two SRV RRs have the same priority, the weight defines which server is more used. The field gives priority to the SRV RR with the greatest weight value: the greater the value is, the more the server is solicited. If you type in , there is no weighting.
                                                                                  3PortsThe port number that delivers the service to the target.
                                                                                  4TargetThe hostname of the server delivering the service.
                                                                                  HINFO1CPUThe name of the CPU, either , , , , , , , or .
                                                                                  2OSThe name of the operating system, either , , , , , , , , , , , or .
                                                                                  MINFO1ResponsibleemailThe email address of the administrator of the mail list.
                                                                                  2Error emailThe email address that should receive the error messages regarding the mail list.
                                                                                  DNAME1DomainThe domain name of a subdomain of the zone.
                                                                                  AFSDB1PreferenceType the version of AFS service used: (AFS version 3.0) or (OSF DCE/NCA version).
                                                                                  2AFS serverThe AFS hostname.
                                                                                  NAPTR1OrderA number, between 0 and 65535, to define which RR has priority if there are several NAPTR RRs in the zone. The lowest the value has the priority over the other record(s).
                                                                                  2PreferenceA number, between 0 and 65535, to define which RR has priority if there are several NAPTR RRs have the same order in the zone. The lowest the value has the priority over the other record(s).
                                                                                  2FlagsThe string that corresponds to the action you want your client application to perform. The flag specified impacts the data expected in the field , and/or .
                                                                                  3ServicesThe services parameters to which applies the action specified in the field . You must respect your client application syntax.
                                                                                  4RegexThe string that contains a substitution expression matching the format to which applies the action specified the field .
                                                                                  5ReplaceAn FQDN domain name to which applies the action specified the field . You can specify no domain name if you type in (dot) in the field.
                                                                                  For more details, refer to available on IETF website at .
                                                                                  NSAP1NameThe NSAP address of the end system. It should start with and not exceed 255 hexadecimal characters separated by dots.
                                                                                  DS1Key TagThe parent zone DS key tag.
                                                                                  2Key AlgorithmThe parent zone DS algorithm key.
                                                                                  3Digest TypeThe parent zone DS digest type.
                                                                                  4DigestThe parent zone DS digest.
                                                                                  DNSKEY1FlagsThe zone key flag.
                                                                                  2ProtocolThe protocol value.
                                                                                  3AlgorithmThe public key's cryptographic algorithm.
                                                                                  4KeyThe public key material.
                                                                                  WKS1IP addressThe IPv4 Address of the host that contains the services listed in the Services field.
                                                                                  2ProtocolThe communication protocol, either or .
                                                                                  3ServicesThe list of needed services.


                                                                                  ", + "operationId": "dns_rr_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                  .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_rr_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the resource records", + "tags": [ + "dns" + ] + } + }, + "/dns/rr/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dns_rr_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of resource records", + "tags": [ + "dns" + ] + } + }, + "/dns/rr/info": { + "get": { + "description": "This service allows to display the properties of a resource record.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.Adding some resource records requires to specify one or more values:
                                                                                  Expected values for the DNS records







                                                                                  Type
                                                                                  Value number
                                                                                  Related field(s)
                                                                                  Syntax




                                                                                  SOA
                                                                                  1
                                                                                  Name server
                                                                                  Type in the FQDN of the primary Master name server for the zone the record belongs to. Has a special meaning when used with Dynamic DNS (DDNS): called MNAME, it allows the DNS client to know on which DNS server it has to update itself with DDNS.


                                                                                  2
                                                                                  Responsible
                                                                                  Type in the administrator email address for the zone the record belongs to.


                                                                                  3
                                                                                  Serial number
                                                                                  Type in the serial number for the zone the record belongs to. The serial number is automatically incremented for each zone change.


                                                                                  4
                                                                                  Refresh
                                                                                  Type in the refresh delay for the zone the record belongs to, in seconds. When reached, it forces the slave name server(s) to read the SOA record. If this record is higher than the slave's one, a zone transfer will be triggered by the slave to get the latest version of the zone. Typical values are 3 to 24 hours.


                                                                                  5
                                                                                  Retry
                                                                                  Type in the retry delay for the zone the record belongs to, in seconds. When reached, it forces the slave server to retry the request if it fails to reach the master server during a refresh cycle. Typical values are from 10 to 60 minutes.


                                                                                  6
                                                                                  Expiration
                                                                                  Type in the expiration time for the zone the record belongs to, in seconds. When reached, the zone records are considered to be no longer valid/authoritative. The DNS server then stops responding to queries for the zone. To avoid a major outage, the typical value is pretty high, between 1 to 3 weeks.


                                                                                  7
                                                                                  Minimum
                                                                                  Type in the minimum time for the zone the record belongs to, in seconds. It defines the period of time that negative responses can be cached from the slave. For instance, if a request cannot be resolved, the server will answer with a NXDOMAIN result (No such domain). The server will continue returning this value until the Minimum value expires, then it will retry the resolution. This value has to be between 0 and 3 hours.


                                                                                  NS
                                                                                  1
                                                                                  DNS server
                                                                                  Type in the DNS server hostname.


                                                                                  MX
                                                                                  1
                                                                                  Preference
                                                                                  Type a number, between 0 and 65535, to define which server has priority if there are several RRs in the zone. The lowest the value has the priority over the other server(s).


                                                                                  2
                                                                                  Mail server
                                                                                  Type in the SMTP (mail) server hostname.


                                                                                  A
                                                                                  1
                                                                                  IP address
                                                                                  Type in the IPv4 Address of the host.


                                                                                  AAAA
                                                                                  1
                                                                                  IPv6 address
                                                                                  Type in the IPv6 Address of the host.


                                                                                  PTR
                                                                                  1
                                                                                  Localization
                                                                                  Type in the hostname that should be returned when the IP address is queried.


                                                                                  CNAME
                                                                                  1
                                                                                  Hostname
                                                                                  Type in the hostname.


                                                                                  TXT
                                                                                  1
                                                                                  Text
                                                                                  Type in the description of your choice (max. 255 characters including spaces).


                                                                                  SRV
                                                                                  1
                                                                                  Priority
                                                                                  Type a number, between 0 and 65535, to define which server has priority if there are several SRV RRs in the zone. The lowest the value has the priority over the other server(s).


                                                                                  2
                                                                                  Weight
                                                                                  Type a number, between 0 and 65535, that defines the server weight. If two SRV RRs have the same priority, the weight defines which server is more used. The field gives priority to the SRV RR with the greatest weight value: the greater the value is, the more the server is solicited. If you type in 0, there is no weighting.


                                                                                  3
                                                                                  Ports
                                                                                  Type in the port number that delivers the service to the target.


                                                                                  4
                                                                                  Target
                                                                                  Type in the hostname of the server delivering the service.


                                                                                  HINFO
                                                                                  1
                                                                                  CPU
                                                                                  Type in the name of the CPU, either INTEL, AMD, SPARC, ALPHA, HPPA, POWERPC, MIPS, MOTOROLA or Other.


                                                                                  2
                                                                                  OS
                                                                                  The name of the operating system, either AIX, FREEBSD, HPUX, IRIX, LINUX, OSF, OS/2, SOLARIS, SUNOS, VMS, WINDOWS, or Other.


                                                                                  MINFO
                                                                                  1
                                                                                  Responsible email
                                                                                  Type in the email address of the administrator of the mail list.


                                                                                  2
                                                                                  Error email
                                                                                  Type in the email address that should receive the error messages regarding the mail list.


                                                                                  DNAME
                                                                                  1
                                                                                  Domain
                                                                                  Type in the domain name of a subdomain of the zone.


                                                                                  AFSDB
                                                                                  1
                                                                                  Preference
                                                                                  Type the version of AFS service used: 1 (AFS version 3.0) or 2 (OSF DCE/NCA version).


                                                                                  2
                                                                                  AFS server
                                                                                  Type in the AFS hostname.


                                                                                  NAPTR
                                                                                  The record NAPTR is described in the RFC 3403, available on IETF website: http://tools.ietf.org/html/rfc3403.

                                                                                  1
                                                                                  Order
                                                                                  Type a number, between 0 and 65535, to define which RR has priority if there are several NAPTR RRs in the zone. The lowest the value has the priority over the other record(s).


                                                                                  2
                                                                                  Preference
                                                                                  Type a number, between 0 and 65535, to define which RR has priority if there are several NAPTR RRs have the same order in the zone. The lowest the value has the priority over the other record(s).


                                                                                  2
                                                                                  Flags
                                                                                  Type in the string that corresponds to the action you want your client application to perform. The flag specified impacts the data expected in the field Services, Regex and/or Replace.


                                                                                  3
                                                                                  Services
                                                                                  Type in the services parameters to which applies the action specified in the field Flags. You must respect your client application syntax.


                                                                                  4
                                                                                  Regex
                                                                                  Type in the string that contains a substitution expression matching the format to which applies the action specified the field Flags.


                                                                                  5
                                                                                  Replace
                                                                                  Type in an FQDN domain name to which applies the action specified the field Flags. You can specify no domain name if you type in . (dot) in the field.


                                                                                  NSAP
                                                                                  1
                                                                                  Name
                                                                                  Type in the NSAP address of the end system. It should start with 0x and not exceed 255 hexadecimal characters separated by dots.


                                                                                  DS
                                                                                  1
                                                                                  Key Tag
                                                                                  Type in the parent zone DS key tag.


                                                                                  2
                                                                                  Key Algorithm
                                                                                  Type in the parent zone DS algorithm key.


                                                                                  3
                                                                                  Digest Type
                                                                                  Type in the parent zone DS digest type.


                                                                                  4
                                                                                  Digest
                                                                                  Type in the parent zone DS digest.


                                                                                  DNSKEY
                                                                                  1
                                                                                  Flags
                                                                                  Type in or paste the zone key flag.


                                                                                  2
                                                                                  Protocol
                                                                                  Type in or paste the protocol value.


                                                                                  3
                                                                                  Algorithm
                                                                                  Type in or paste the public key's cryptographic algorithm.


                                                                                  4
                                                                                  Key
                                                                                  Type in or paste the public key material.


                                                                                  WKS
                                                                                  1
                                                                                  IP address
                                                                                  Type in the IPv4 Address of the host that contains the services listed in the Services field.


                                                                                  2
                                                                                  Protocol
                                                                                  Type in TCP or UDP.


                                                                                  3
                                                                                  Services
                                                                                  Type in the list of needed services.



                                                                                  ", + "operationId": "dns_rr_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DNS resource record, a unique numeric key value automatically incremented when you add a DNS RR. Use the ID to specify the DNS RR of your choice.", + "explode": true, + "in": "query", + "name": "rr_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_rr_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a resource record", + "tags": [ + "dns" + ] + } + }, + "/dns/rr/add": { + "post": { + "description": "This service allows you to add a resource record or edit an existing one.
                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.
                                                                                  Adding some resource records requires to specify one or more values:


                                                                                  Expected values for the DNS records
                                                                                  TypeValuenumberRelated field(s)Description
                                                                                  SOA1Name serverThe FQDN of the primary Master name server for the zone the record belongs to. Has a special meaning when used with Dynamic DNS (DDNS): called MNAME, it allows the DNS client to know on which DNS server it has to update itself with DDNS.
                                                                                  2ResponsibleThe administrator email address for the zone the record belongs to.
                                                                                  3Serial numberThe serial number for the zone the record belongs to. The serial number is automatically incremented for each zone change.
                                                                                  4RefreshThe refresh delay for the zone the record belongs to, in seconds. When reached, it forces the slave name server(s) to read the SOA record. If this record is higher than the slave's one, a zone transfer will be triggered by the slave to get the latest version of the zone. Typical values are 3 to 24 hours.
                                                                                  5RetryThe retry delay for the zone the record belongs to, in seconds. When reached, it forces the slave server to retry the request if it fails to reach the master server during a refresh cycle. Typical values are from 10 to 60 minutes.
                                                                                  6ExpirationThe expiration time for the zone the record belongs to, in seconds. When reached, the zone records are considered to be no longer valid/authoritative. The DNS server then stops responding to queries for the zone. To avoid a major outage, the typical value is pretty high, between 1 to 3 weeks.
                                                                                  7MinimumThe minimum time for the zone the record belongs to, in seconds. It defines the period of time that negative responses can be cached from the slave. For instance, if a request cannot be resolved, the server will answer with a NXDOMAIN result (No such domain). The server will continue returning this value until the Minimum value expires, then it will retry the resolution. This value has to be between 0 and 3 hours.
                                                                                  NS1DNS serverThe DNS server hostname.
                                                                                  MX1PreferenceA number, between 0 and 65535, to define which server has priority if there are several RRs in the zone. The lowest the value has the priority over the other server(s).
                                                                                  2Mail serverThe SMTP (mail) server hostname.
                                                                                  A1IP addressThe IPv4 Address of the host.
                                                                                  AAAA1IPv6 addressThe IPv6 Address of the host.
                                                                                  PTR1LocalizationThe hostname that should be returned when the IP address is queried.
                                                                                  CNAME1HostnameThe hostname.
                                                                                  TXT1TextThe description of your choice (max. 255 characters including spaces).
                                                                                  SRV1PriorityA number, between 0 and 65535, to define which server has priority if there are several SRV RRs in the zone. The lowest the value has the priority over the other server(s).
                                                                                  2WeightA number, between 0 and 65535, that defines the server weight. If two SRV RRs have the same priority, the weight defines which server is more used. The field gives priority to the SRV RR with the greatest weight value: the greater the value is, the more the server is solicited. If you type in , there is no weighting.
                                                                                  3PortsThe port number that delivers the service to the target.
                                                                                  4TargetThe hostname of the server delivering the service.
                                                                                  HINFO1CPUThe name of the CPU, either , , , , , , , or .
                                                                                  2OSThe name of the operating system, either , , , , , , , , , , , or .
                                                                                  MINFO1ResponsibleemailThe email address of the administrator of the mail list.
                                                                                  2Error emailThe email address that should receive the error messages regarding the mail list.
                                                                                  DNAME1DomainThe domain name of a subdomain of the zone.
                                                                                  AFSDB1PreferenceType the version of AFS service used: (AFS version 3.0) or (OSF DCE/NCA version).
                                                                                  2AFS serverThe AFS hostname.
                                                                                  NAPTR1OrderA number, between 0 and 65535, to define which RR has priority if there are several NAPTR RRs in the zone. The lowest the value has the priority over the other record(s).
                                                                                  2PreferenceA number, between 0 and 65535, to define which RR has priority if there are several NAPTR RRs have the same order in the zone. The lowest the value has the priority over the other record(s).
                                                                                  2FlagsThe string that corresponds to the action you want your client application to perform. The flag specified impacts the data expected in the field , and/or .
                                                                                  3ServicesThe services parameters to which applies the action specified in the field . You must respect your client application syntax.
                                                                                  4RegexThe string that contains a substitution expression matching the format to which applies the action specified the field .
                                                                                  5ReplaceAn FQDN domain name to which applies the action specified the field . You can specify no domain name if you type in (dot) in the field.
                                                                                  For more details, refer to available on IETF website at .
                                                                                  NSAP1NameThe NSAP address of the end system. It should start with and not exceed 255 hexadecimal characters separated by dots.
                                                                                  DS1Key TagThe parent zone DS key tag.
                                                                                  2Key AlgorithmThe parent zone DS algorithm key.
                                                                                  3Digest TypeThe parent zone DS digest type.
                                                                                  4DigestThe parent zone DS digest.
                                                                                  DNSKEY1FlagsThe zone key flag.
                                                                                  2ProtocolThe protocol value.
                                                                                  3AlgorithmThe public key's cryptographic algorithm.
                                                                                  4KeyThe public key material.
                                                                                  WKS1IP addressThe IPv4 Address of the host that contains the services listed in the Services field.
                                                                                  2ProtocolThe communication protocol, either or .
                                                                                  3ServicesThe list of needed services.




                                                                                  Mandatory Parameters: (rr_name && rr_type && rr_value1 && (server_id || server_name || server_hostaddr))", + "operationId": "dns_rr_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_rr_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_rr_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_rr_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a resource record", + "tags": [ + "dns" + ] + } + }, + "/dns/rr/edit": { + "put": { + "description": "This service allows you to add a resource record or edit an existing one.
                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.
                                                                                  Adding some resource records requires to specify one or more values:


                                                                                  Expected values for the DNS records
                                                                                  TypeValuenumberRelated field(s)Description
                                                                                  SOA1Name serverThe FQDN of the primary Master name server for the zone the record belongs to. Has a special meaning when used with Dynamic DNS (DDNS): called MNAME, it allows the DNS client to know on which DNS server it has to update itself with DDNS.
                                                                                  2ResponsibleThe administrator email address for the zone the record belongs to.
                                                                                  3Serial numberThe serial number for the zone the record belongs to. The serial number is automatically incremented for each zone change.
                                                                                  4RefreshThe refresh delay for the zone the record belongs to, in seconds. When reached, it forces the slave name server(s) to read the SOA record. If this record is higher than the slave's one, a zone transfer will be triggered by the slave to get the latest version of the zone. Typical values are 3 to 24 hours.
                                                                                  5RetryThe retry delay for the zone the record belongs to, in seconds. When reached, it forces the slave server to retry the request if it fails to reach the master server during a refresh cycle. Typical values are from 10 to 60 minutes.
                                                                                  6ExpirationThe expiration time for the zone the record belongs to, in seconds. When reached, the zone records are considered to be no longer valid/authoritative. The DNS server then stops responding to queries for the zone. To avoid a major outage, the typical value is pretty high, between 1 to 3 weeks.
                                                                                  7MinimumThe minimum time for the zone the record belongs to, in seconds. It defines the period of time that negative responses can be cached from the slave. For instance, if a request cannot be resolved, the server will answer with a NXDOMAIN result (No such domain). The server will continue returning this value until the Minimum value expires, then it will retry the resolution. This value has to be between 0 and 3 hours.
                                                                                  NS1DNS serverThe DNS server hostname.
                                                                                  MX1PreferenceA number, between 0 and 65535, to define which server has priority if there are several RRs in the zone. The lowest the value has the priority over the other server(s).
                                                                                  2Mail serverThe SMTP (mail) server hostname.
                                                                                  A1IP addressThe IPv4 Address of the host.
                                                                                  AAAA1IPv6 addressThe IPv6 Address of the host.
                                                                                  PTR1LocalizationThe hostname that should be returned when the IP address is queried.
                                                                                  CNAME1HostnameThe hostname.
                                                                                  TXT1TextThe description of your choice (max. 255 characters including spaces).
                                                                                  SRV1PriorityA number, between 0 and 65535, to define which server has priority if there are several SRV RRs in the zone. The lowest the value has the priority over the other server(s).
                                                                                  2WeightA number, between 0 and 65535, that defines the server weight. If two SRV RRs have the same priority, the weight defines which server is more used. The field gives priority to the SRV RR with the greatest weight value: the greater the value is, the more the server is solicited. If you type in , there is no weighting.
                                                                                  3PortsThe port number that delivers the service to the target.
                                                                                  4TargetThe hostname of the server delivering the service.
                                                                                  HINFO1CPUThe name of the CPU, either , , , , , , , or .
                                                                                  2OSThe name of the operating system, either , , , , , , , , , , , or .
                                                                                  MINFO1ResponsibleemailThe email address of the administrator of the mail list.
                                                                                  2Error emailThe email address that should receive the error messages regarding the mail list.
                                                                                  DNAME1DomainThe domain name of a subdomain of the zone.
                                                                                  AFSDB1PreferenceType the version of AFS service used: (AFS version 3.0) or (OSF DCE/NCA version).
                                                                                  2AFS serverThe AFS hostname.
                                                                                  NAPTR1OrderA number, between 0 and 65535, to define which RR has priority if there are several NAPTR RRs in the zone. The lowest the value has the priority over the other record(s).
                                                                                  2PreferenceA number, between 0 and 65535, to define which RR has priority if there are several NAPTR RRs have the same order in the zone. The lowest the value has the priority over the other record(s).
                                                                                  2FlagsThe string that corresponds to the action you want your client application to perform. The flag specified impacts the data expected in the field , and/or .
                                                                                  3ServicesThe services parameters to which applies the action specified in the field . You must respect your client application syntax.
                                                                                  4RegexThe string that contains a substitution expression matching the format to which applies the action specified the field .
                                                                                  5ReplaceAn FQDN domain name to which applies the action specified the field . You can specify no domain name if you type in (dot) in the field.
                                                                                  For more details, refer to available on IETF website at .
                                                                                  NSAP1NameThe NSAP address of the end system. It should start with and not exceed 255 hexadecimal characters separated by dots.
                                                                                  DS1Key TagThe parent zone DS key tag.
                                                                                  2Key AlgorithmThe parent zone DS algorithm key.
                                                                                  3Digest TypeThe parent zone DS digest type.
                                                                                  4DigestThe parent zone DS digest.
                                                                                  DNSKEY1FlagsThe zone key flag.
                                                                                  2ProtocolThe protocol value.
                                                                                  3AlgorithmThe public key's cryptographic algorithm.
                                                                                  4KeyThe public key material.
                                                                                  WKS1IP addressThe IPv4 Address of the host that contains the services listed in the Services field.
                                                                                  2ProtocolThe communication protocol, either or .
                                                                                  3ServicesThe list of needed services.




                                                                                  Mandatory Parameters: (rr_id || (rr_name && rr_type && rr_value1 && (server_id || server_name || server_hostaddr)))", + "operationId": "dns_rr_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_rr_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_rr_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_rr_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a resource record", + "tags": [ + "dns" + ] + } + }, + "/dns/rr/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                  Mandatory Parameters: (rr_id || (rr_name && (server_id || server_name || server_hostaddr)))", + "operationId": "dns_rr_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "explode": true, + "in": "query", + "name": "server_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DNS server.", + "explode": true, + "in": "query", + "name": "server_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The IP address of the DNS server.", + "explode": true, + "in": "query", + "name": "server_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DNS resource record, a unique numeric key value automatically incremented when you add a DNS RR. Use the ID to specify the DNS RR of your choice.", + "explode": true, + "in": "query", + "name": "rr_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DNS resource record.", + "explode": true, + "in": "query", + "name": "rr_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DNS view, a unique numeric key value automatically incremented when you add a DNS view. Use the ID to specify the DNS view of your choice.", + "explode": true, + "in": "query", + "name": "view_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DNS view.", + "explode": true, + "in": "query", + "name": "view_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DNS zone, a unique numeric key value automatically incremented when you add a DNS zone. Use the ID to specify the DNS zone of your choice.", + "explode": true, + "in": "query", + "name": "zone_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DNS zone the object belongs to.", + "explode": true, + "in": "query", + "name": "zone_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the space associated with the DNS zone the record belongs to.", + "explode": true, + "in": "query", + "name": "zone_space_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The type of the DNS resource record.


                                                                                  rr_type possible values
                                                                                  ValueRecord type description
                                                                                  SOAStart of Authority. Defines the zone name, an email contact and various time and refresh values applicable to the zone. It is automatically generated upon creation of a zone and cannot be added manually.
                                                                                  NSName Server. Defines the authoritative name server(s) for the domain (defined by the SOA record) or the subdomain. The NS record that indicates which server has authority over a zone is automatically generated upon the creation of a zone, once the server has been synchronized.
                                                                                  AIPv4 Address. An IPv4 address for a host.
                                                                                  PTRPointer Record. Address Resolution, from an IP address (IPv4 or IPv6) to a host. Used in reverse mapping.
                                                                                  AAAAIPv6 Address. An IPv6 address for a host.
                                                                                  CNAMECanonical Name. An alias name for a host.
                                                                                  MXMail Exchange. The mail server/exchanger that services this zone.
                                                                                  SRVServices record. Defines services available in the zone, for example, LDAP, HTTP, etc...
                                                                                  DNAMEDelegation of Reverse Names. Delegation of reverse addresses primarily in IPv6. (Deprecated, use the CNAME RR instead)
                                                                                  TXTText. Information associated with a name.
                                                                                  DSDelegation Signer, a DNSSEC related RR used to verify the validity of the ZSK of a subdomain.
                                                                                  DNSKEYDNS Key. It contains the public cryptographic key used to sign the zone with DNSSEC.
                                                                                  65534A private type record automatically added to the zone once it is signed with DNSSEC.
                                                                                  HINFOSystem Information. Information about a host: hardware type and operating system description.
                                                                                  MINFOMailbox mail list Information. Defines the mail administrator for a mail list and optionally a mailbox to receive error messages relating to the mail list.
                                                                                  AFSDBAFS Database. Location of the AFS servers.
                                                                                  WKSWell-Known Service. Defines the services and protocols supported by a host. (Deprecated, use the SRV RR instead)
                                                                                  NAPTRNaming Authority Pointer Record. General purpose definition of rule set to be used by applications e.g. VoIP.
                                                                                  NSAPNetwork Service Access Point. Defines record (equivalent of an A record) maps a host name to an endpoint address.


                                                                                  Note that the parameter is not case sensitive, you could type in A or a.", + "explode": true, + "in": "query", + "name": "rr_type", + "required": false, + "schema": { + "enum": [ + "A", + "NS", + "MD", + "MF", + "CNAME", + "SOA", + "MB", + "MG", + "MR", + "NULL", + "WKS", + "PTR", + "HINFO", + "MINFO", + "MX", + "TXT", + "SPF", + "RP", + "AFSDB", + "X25", + "ISDN", + "RT", + "NSAP", + "NSAP_PTR", + "SIG", + "KEY", + "PX", + "GPOS", + "AAAA", + "LOC", + "NXT", + "EID", + "NIMLOC", + "SRV", + "ATMA", + "NAPTR", + "KX", + "CERT", + "A6", + "DNAME", + "OPT", + "DS", + "DNSSIG", + "NSEC", + "DNSKEY", + "NSEC3", + "NSEC3PARAM", + "CDS", + "CDNSKEY", + "CAA", + "TLSA", + "SSHFP", + "OPENPGPKEY", + "URI", + "AVC", + "NINFO", + "DLV", + "DHCID", + "EUI48", + "EUI64", + "NID", + "L32", + "L64", + "HTTPS", + "SVCB" + ], + "type": "string" + }, + "style": "form" + }, + { + "description": "The first or only value required for the DNS resource record, as detailed in the service description", + "explode": true, + "in": "query", + "name": "rr_value1", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The second value of the DNS resource record, depending on its type, as detailed in the service description", + "explode": true, + "in": "query", + "name": "rr_value2", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The third value of the DNS resource record, depending on its type, as detailed in the service description", + "explode": true, + "in": "query", + "name": "rr_value3", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The fourth value of the DNS resource record, depending on its type, as detailed in the service description", + "explode": true, + "in": "query", + "name": "rr_value4", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The fifth value of the DNS resource record, depending on its type, as detailed in the service description", + "explode": true, + "in": "query", + "name": "rr_value5", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The sixth value of the DNS resource record, depending on its type, as detailed in the service description", + "explode": true, + "in": "query", + "name": "rr_value6", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The seventh value of the DNS resource record, depending on its type, as detailed in the service description", + "explode": true, + "in": "query", + "name": "rr_value7", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_rr_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_rr_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a resource record", + "tags": [ + "dns" + ] + } + }, + "/dns/acl/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dns_acl_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                  .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_acl_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DNS ACLs", + "tags": [ + "dns" + ] + } + }, + "/dns/acl/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dns_acl_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of DNS ACLs", + "tags": [ + "dns" + ] + } + }, + "/dns/acl/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dns_acl_info", + "parameters": [ + { + "description": "The database identifier (ID) of the DNS ACL, a unique numeric key value automatically incremented when you add a DNS ACL. Use the ID to specify the DNS ACL of your choice.", + "explode": true, + "in": "query", + "name": "acl_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_acl_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DNS ACL", + "tags": [ + "dns" + ] + } + }, + "/dns/acl/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                  • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                    Mandatory Parameters: ((acl_name && (server_id || server_name || server_hostaddr)) && acl_value)", + "operationId": "dns_acl_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_acl_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_acl_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_acl_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a DNS ACL", + "tags": [ + "dns" + ] + } + }, + "/dns/acl/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                    • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                      Mandatory Parameters: ((acl_id || (acl_name && (server_id || server_name || server_hostaddr))) && acl_value)", + "operationId": "dns_acl_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_acl_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_acl_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_acl_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a DNS ACL", + "tags": [ + "dns" + ] + } + }, + "/dns/acl/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                      Mandatory Parameters: acl_id", + "operationId": "dns_acl_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the DNS ACL, a unique numeric key value automatically incremented when you add a DNS ACL. Use the ID to specify the DNS ACL of your choice.", + "explode": true, + "in": "query", + "name": "acl_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "explode": true, + "in": "query", + "name": "server_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DNS server.", + "explode": true, + "in": "query", + "name": "server_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The name of the DNS ACL.", + "explode": true, + "in": "query", + "name": "acl_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The IP address of the DNS server.", + "explode": true, + "in": "query", + "name": "server_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_acl_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_acl_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a DNS ACL", + "tags": [ + "dns" + ] + } + }, + "/dns/viewparam/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dns_viewparam_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                      .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_viewparam_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DNS options of a view", + "tags": [ + "dns" + ] + } + }, + "/dns/viewparam/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dns_viewparam_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of DNS options of a view", + "tags": [ + "dns" + ] + } + }, + "/dns/viewparam/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dns_viewparam_info", + "parameters": [ + { + "description": "The database identifier (ID) of the DNS view. Use the ID to specify the DNS view of your choice.", + "explode": true, + "in": "query", + "name": "view_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_viewparam_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DNS option set on a view", + "tags": [ + "dns" + ] + } + }, + "/dns/viewparam/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                      • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                        Mandatory Parameters: (view_id && viewparam_key)", + "operationId": "dns_viewparam_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_viewparam_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_viewparam_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_viewparam_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a DNS option on a view", + "tags": [ + "dns" + ] + } + }, + "/dns/viewparam/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                        • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                          Mandatory Parameters: (view_id && viewparam_key)", + "operationId": "dns_viewparam_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_viewparam_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_viewparam_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_viewparam_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a DNS option on a view", + "tags": [ + "dns" + ] + } + }, + "/dns/viewparam/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                          Mandatory Parameters: (view_id && viewparam_key)", + "operationId": "dns_viewparam_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the DNS view. Use the ID to specify the DNS view of your choice.", + "explode": true, + "in": "query", + "name": "view_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DNS option that you want to remove from the view: param_key=<option-name>.", + "explode": true, + "in": "query", + "name": "viewparam_key", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_viewparam_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_viewparam_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a DNS option from a view", + "tags": [ + "dns" + ] + } + }, + "/dns/zoneparam/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dns_zoneparam_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                          .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zoneparam_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DNS options of a zone", + "tags": [ + "dns" + ] + } + }, + "/dns/zoneparam/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dns_zoneparam_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of DNS options of a zone", + "tags": [ + "dns" + ] + } + }, + "/dns/zoneparam/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dns_zoneparam_info", + "parameters": [ + { + "description": "The database identifier (ID) of the DNS zone, a unique numeric key value automatically incremented when you add a DNS zone. Use the ID to specify the DNS zone of your choice.", + "explode": true, + "in": "query", + "name": "zone_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zoneparam_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DNS option set on a zone", + "tags": [ + "dns" + ] + } + }, + "/dns/zoneparam/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                          • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                            Mandatory Parameters: (zone_id && zoneparam_key)", + "operationId": "dns_zoneparam_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zoneparam_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zoneparam_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zoneparam_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a DNS option on a zone", + "tags": [ + "dns" + ] + } + }, + "/dns/zoneparam/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                            • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                              Mandatory Parameters: (zone_id && zoneparam_key)", + "operationId": "dns_zoneparam_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zoneparam_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zoneparam_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zoneparam_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a DNS option on a zone", + "tags": [ + "dns" + ] + } + }, + "/dns/zoneparam/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                              Mandatory Parameters: (zone_id && zoneparam_key)", + "operationId": "dns_zoneparam_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the DNS zone, a unique numeric key value automatically incremented when you add a DNS zone. Use the ID to specify the DNS zone of your choice.", + "explode": true, + "in": "query", + "name": "zone_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DNS option that you want to remove from the zone: param_key=<option-name>.", + "explode": true, + "in": "query", + "name": "zoneparam_key", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "explode": true, + "in": "query", + "name": "server_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zoneparam_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zoneparam_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a DNS option from a zone", + "tags": [ + "dns" + ] + } + }, + "/app/application/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "app_application_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                              .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/app_application_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the applications", + "tags": [ + "app" + ] + } + }, + "/app/application/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "app_application_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of applications", + "tags": [ + "app" + ] + } + }, + "/app/application/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "app_application_info", + "parameters": [ + { + "description": "The database identifier (ID) of the application, a unique numeric key value automatically incremented when you add an application. Use the ID to specify the application of your choice.", + "explode": true, + "in": "query", + "name": "application_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/app_application_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of an application", + "tags": [ + "app" + ] + } + }, + "/app/application/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                              • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                Mandatory Parameters: (application_name && application_fqdn)", + "operationId": "app_application_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/app_application_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/app_application_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/app_application_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add an application", + "tags": [ + "app" + ] + } + }, + "/app/application/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                  Mandatory Parameters: (application_id || (application_name && application_fqdn))", + "operationId": "app_application_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/app_application_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/app_application_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/app_application_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit an application", + "tags": [ + "app" + ] + } + }, + "/app/application/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                  Mandatory Parameters: (application_id || (application_name && application_fqdn))", + "operationId": "app_application_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the application, a unique numeric key value automatically incremented when you add an application. Use the ID to specify the application of your choice.", + "explode": true, + "in": "query", + "name": "application_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The Fully Qualified Domain Name (FQDN) of the application.", + "explode": true, + "in": "query", + "name": "application_fqdn", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The name of the application.", + "explode": true, + "in": "query", + "name": "application_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the GSLB server associated with the application, a unique numeric key value automatically incremented when you add the server. Use it to identify the GSLB server of your choice.", + "explode": true, + "in": "query", + "name": "gslbserver_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the GSLB server associated with the application.", + "explode": true, + "in": "query", + "name": "gslbserver_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/app_application_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/app_application_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete an application", + "tags": [ + "app" + ] + } + }, + "/app/pool/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "app_pool_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                  .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/app_pool_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the pools", + "tags": [ + "app" + ] + } + }, + "/app/pool/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "app_pool_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of pools", + "tags": [ + "app" + ] + } + }, + "/app/pool/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "app_pool_info", + "parameters": [ + { + "description": "The database identifier (ID) of the pool, a unique numeric key value automatically incremented when you add a pool. Use the ID to specify the pool of your choice.", + "explode": true, + "in": "query", + "name": "pool_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/app_pool_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a pool", + "tags": [ + "app" + ] + } + }, + "/app/pool/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                  • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                    Mandatory Parameters: (pool_name && pool_type && pool_lb_mode && (application_id || (appapplication_pool_name && application_fqdn)))", + "operationId": "app_pool_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/app_pool_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/app_pool_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/app_pool_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a pool", + "tags": [ + "app" + ] + } + }, + "/app/pool/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                    • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                      Mandatory Parameters: (pool_id || (pool_name && (application_id || (appapplication_pool_name && application_fqdn))))", + "operationId": "app_pool_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/app_pool_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/app_pool_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/app_pool_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a pool", + "tags": [ + "app" + ] + } + }, + "/app/pool/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                      Mandatory Parameters: (pool_id || (pool_name && (application_id || (appapplication_pool_name && application_fqdn))))", + "operationId": "app_pool_delete", + "parameters": [ + { + "description": "The Fully Qualified Domain Name (FQDN) of the application the object belongs to.", + "explode": true, + "in": "query", + "name": "application_fqdn", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the application the object belongs to.", + "explode": true, + "in": "query", + "name": "application_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the application the object belongs to.", + "explode": true, + "in": "query", + "name": "application_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the pool, a unique numeric key value automatically incremented when you add a pool. Use the ID to specify the pool of your choice.", + "explode": true, + "in": "query", + "name": "pool_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the pool.", + "explode": true, + "in": "query", + "name": "pool_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the GSLB server associated with the application, a unique numeric key value automatically incremented when you add the server. Use it to identify the GSLB server of your choice.", + "explode": true, + "in": "query", + "name": "gslbserver_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/app_pool_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/app_pool_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a pool", + "tags": [ + "app" + ] + } + }, + "/app/node/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "app_node_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                      .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/app_node_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the nodes", + "tags": [ + "app" + ] + } + }, + "/app/node/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "app_node_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of nodes", + "tags": [ + "app" + ] + } + }, + "/app/node/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "app_node_info", + "parameters": [ + { + "description": "The database identifier (ID) of the node, a unique numeric key value automatically incremented when you add a node. Use the ID to specify the node of your choice.", + "explode": true, + "in": "query", + "name": "node_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/app_node_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a node", + "tags": [ + "app" + ] + } + }, + "/app/node/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                      • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                        Mandatory Parameters: (node_name && node_hostaddr && (pool_id || (apppool_node_name && (application_id || (appapplication_node_name && application_fqdn)))))", + "operationId": "app_node_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/app_node_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/app_node_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/app_node_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a node", + "tags": [ + "app" + ] + } + }, + "/app/node/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                        • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                          Mandatory Parameters: (node_id || (node_name && (pool_id || (apppool_node_name && (application_id || (appapplication_node_name && application_fqdn))))))", + "operationId": "app_node_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/app_node_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/app_node_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/app_node_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a node", + "tags": [ + "app" + ] + } + }, + "/app/node/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                          Mandatory Parameters: (node_id || (node_name && (pool_id || (apppool_node_name && (application_id || (appapplication_node_name && application_fqdn))))))", + "operationId": "app_node_delete", + "parameters": [ + { + "description": "The Fully Qualified Domain Name (FQDN) of the application the object belongs to.", + "explode": true, + "in": "query", + "name": "application_fqdn", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the application the object belongs to.", + "explode": true, + "in": "query", + "name": "application_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the application the object belongs to.", + "explode": true, + "in": "query", + "name": "application_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the node, a unique numeric key value automatically incremented when you add a node. Use the ID to specify the node of your choice.", + "explode": true, + "in": "query", + "name": "node_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the pool, a unique numeric key value automatically incremented when you add a pool. Use the ID to specify the pool of your choice.", + "explode": true, + "in": "query", + "name": "pool_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the pool.", + "explode": true, + "in": "query", + "name": "pool_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The name of the node.", + "explode": true, + "in": "query", + "name": "node_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the GSLB server associated with the application, a unique numeric key value automatically incremented when you add the server. Use it to identify the GSLB server of your choice.", + "explode": true, + "in": "query", + "name": "gslbserver_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/app_node_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/app_node_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a node", + "tags": [ + "app" + ] + } + }, + "/guardian/policy/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "guardian_policy_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                          .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/guardian_policy_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the policies", + "tags": [ + "guardian" + ] + } + }, + "/guardian/policy/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "guardian_policy_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of policies", + "tags": [ + "guardian" + ] + } + }, + "/guardian/policy/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "guardian_policy_info", + "parameters": [ + { + "description": "The database identifier (ID) of the policy, a unique numeric key value automatically incremented when you add the policy. Use it to identify the policy of your choice.", + "explode": true, + "in": "query", + "name": "policy_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/guardian_policy_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a policy", + "tags": [ + "guardian" + ] + } + }, + "/guardian/policy/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                          • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                            Mandatory Parameters: (policy_name)", + "operationId": "guardian_policy_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/guardian_policy_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/guardian_policy_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/guardian_policy_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a policy", + "tags": [ + "guardian" + ] + } + }, + "/guardian/policy/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                            • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                              Mandatory Parameters: (policy_id || (policy_name))", + "operationId": "guardian_policy_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/guardian_policy_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/guardian_policy_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/guardian_policy_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a policy", + "tags": [ + "guardian" + ] + } + }, + "/guardian/policy/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                              Mandatory Parameters: (policy_id || (policy_name && (dns_policy_name || server_id))", + "operationId": "guardian_policy_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the Guardian server associated with the policy, a unique numeric key value automatically incremented when you add the server. Use it to identify the Guardian server of your choice.", + "explode": true, + "in": "query", + "name": "server_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the Guardian server associated with the policy.", + "explode": true, + "in": "query", + "name": "server_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the policy, a unique numeric key value automatically incremented when you add the policy. Use it to identify the policy of your choice.", + "explode": true, + "in": "query", + "name": "policy_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the policy.", + "explode": true, + "in": "query", + "name": "policy_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/guardian_policy_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/guardian_policy_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a policy", + "tags": [ + "guardian" + ] + } + }, + "/device/device/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "device_device_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                              .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/device_device_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the Device Manager devices", + "tags": [ + "device" + ] + } + }, + "/device/device/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "device_device_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of Device Manager devices", + "tags": [ + "device" + ] + } + }, + "/device/device/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "device_device_info", + "parameters": [ + { + "description": "The database identifier (ID) of the Device Manager device, a unique numeric key value automatically incremented when you add a device. Use the ID to specify the device of your choice.", + "explode": true, + "in": "query", + "name": "device_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/device_device_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a Device Manager device", + "tags": [ + "device" + ] + } + }, + "/device/device/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                              • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                Mandatory Parameters: (device_name)", + "operationId": "device_device_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/device_device_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/device_device_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/device_device_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a Device Manager device", + "tags": [ + "device" + ] + } + }, + "/device/device/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                                • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                  Mandatory Parameters: (device_id || device_name)", + "operationId": "device_device_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/device_device_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/device_device_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/device_device_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a Device Manager device", + "tags": [ + "device" + ] + } + }, + "/device/device/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                  Mandatory Parameters: (device_id || device_name)", + "operationId": "device_device_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the Device Manager device, a unique numeric key value automatically incremented when you add a device. Use the ID to specify the device of your choice.", + "explode": true, + "in": "query", + "name": "device_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the Device Manager device.", + "explode": true, + "in": "query", + "name": "device_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/device_device_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/device_device_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a Device Manager device", + "tags": [ + "device" + ] + } + }, + "/device/interface/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "device_interface_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                  .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/device_interface_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the Device Manager ports & interfaces", + "tags": [ + "device" + ] + } + }, + "/device/interface/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "device_interface_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number Device Manager ports & interfaces", + "tags": [ + "device" + ] + } + }, + "/device/interface/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "device_interface_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the Device Manager port or interface, a unique numeric key value automatically incremented when you add a port or interface. Use the ID to specify the port or interface of your choice.", + "explode": true, + "in": "query", + "name": "interface_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/device_interface_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a Device Manager port or interface", + "tags": [ + "device" + ] + } + }, + "/device/interface/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                                  • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                    Mandatory Parameters: (interface_name && (device_id || device_name) && interface_type", + "operationId": "device_interface_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/device_interface_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/device_interface_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/device_interface_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a Device Manager port or interface", + "tags": [ + "device" + ] + } + }, + "/device/interface/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                                    • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                      Mandatory Parameters: (interface_id || (interface_name && (device_id || device_name))", + "operationId": "device_interface_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/device_interface_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/device_interface_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/device_interface_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a Device Manager port or interface", + "tags": [ + "device" + ] + } + }, + "/device/interface/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                      Mandatory Parameters: (interface_id || (interface_name && (device_id || device_name))", + "operationId": "device_interface_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the Device Manager device, a unique numeric key value automatically incremented when you add a device. Use the ID to specify the device of your choice.", + "explode": true, + "in": "query", + "name": "device_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the Device Manager device.", + "explode": true, + "in": "query", + "name": "device_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the Device Manager port or interface, a unique numeric key value automatically incremented when you add a port or interface. Use the ID to specify the port or interface of your choice.", + "explode": true, + "in": "query", + "name": "interface_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the Device Manager port or interface.", + "explode": true, + "in": "query", + "name": "interface_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/device_interface_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/device_interface_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a Device Manager port or interface", + "tags": [ + "device" + ] + } + }, + "/device/link/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "device_link_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                      .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the Device Manager port or interface, a unique numeric key value automatically incremented when you add a port or interface. Use the ID to specify the port or interface of your choice.", + "explode": true, + "in": "query", + "name": "interface_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/device_link_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List Device Manager ports & interfaces", + "tags": [ + "device" + ] + } + }, + "/device/link/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "device_link_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the Device Manager port or interface, a unique numeric key value automatically incremented when you add a port or interface. Use the ID to specify the port or interface of your choice.", + "explode": true, + "in": "query", + "name": "interface_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of links between Device Manager devices", + "tags": [ + "device" + ] + } + }, + "/device/link/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                                      • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                        Mandatory Parameters: ( (interface1_id || (interface1_name && device1_name)) && (interface2_id || (interface2_name && device2_name)) )", + "operationId": "device_link_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/device_link_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/device_link_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/device_link_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Link two Device Manager devices using their ports and/or interfaces", + "tags": [ + "device" + ] + } + }, + "/device/link/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                                        • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                          Mandatory Parameters: (link_id || ( (interface1_id || (interface1_name && device1_name)) && (interface2_id || (interface2_name && device2_name)) ))", + "operationId": "device_link_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/device_link_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/device_link_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/device_link_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Link two Device Manager devices using their ports and/or interfaces", + "tags": [ + "device" + ] + } + }, + "/device/link/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                          Mandatory Parameters: (link_id || ( (interface1_id || (interface1_name && device1_name)) && (interface2_id || (interface2_name && device2_name)) ))", + "operationId": "device_link_delete", + "parameters": [ + { + "description": "The name of the device to which belongs the DM port or interface you want to unlink from interface2_id.", + "explode": true, + "in": "query", + "name": "device1_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The name of the device to which belongs the DM port or interface you want to unlink from interface1_id.", + "explode": true, + "in": "query", + "name": "device2_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DM port or interface you want to unlink from interface2_id.", + "explode": true, + "in": "query", + "name": "interface1_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DM port or interface you want to unlink from interface2_id.", + "explode": true, + "in": "query", + "name": "interface1_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DM port or interface you want to unlink from interface1_id.", + "explode": true, + "in": "query", + "name": "interface2_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DM port or interface you want to unlink from interface1_id.", + "explode": true, + "in": "query", + "name": "interface2_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the Device Manager port or interface link, a unique numeric key value automatically incremented when you add a link between a device and a port or interface. Use the ID to specify the port or interface link of your choice.", + "explode": true, + "in": "query", + "name": "link_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to determine if the link between two Device Manager devices is set automatically (1) or manually (0).", + "explode": true, + "in": "query", + "name": "link_auto_link", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/device_link_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/device_link_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a link between two Device Manager devices", + "tags": [ + "device" + ] + } + }, + "/vlan/domain/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "vlan_domain_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                          .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_domain_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the VLAN domains", + "tags": [ + "vlan" + ] + } + }, + "/vlan/domain/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "vlan_domain_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of VLAN domains", + "tags": [ + "vlan" + ] + } + }, + "/vlan/domain/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "vlan_domain_info", + "parameters": [ + { + "description": "The database identifier (ID) of the VLAN domain, a unique numeric key value automatically incremented when you add a VLAN domain. Use the ID to specify the VLAN domain of your choice.", + "explode": true, + "in": "query", + "name": "domain_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_domain_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a VLAN domain", + "tags": [ + "vlan" + ] + } + }, + "/vlan/domain/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                                          • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                            Mandatory Parameters: domain_name", + "operationId": "vlan_domain_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_domain_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_domain_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_domain_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a VLAN domain", + "tags": [ + "vlan" + ] + } + }, + "/vlan/domain/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                                            • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                              Mandatory Parameters: (domain_id || domain_name)", + "operationId": "vlan_domain_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_domain_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_domain_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_domain_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a VLAN domain", + "tags": [ + "vlan" + ] + } + }, + "/vlan/domain/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                              Mandatory Parameters: (domain_id || domain_name)", + "operationId": "vlan_domain_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the VLAN domain, a unique numeric key value automatically incremented when you add a VLAN domain. Use the ID to specify the VLAN domain of your choice.", + "explode": true, + "in": "query", + "name": "domain_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the VLAN domain.", + "explode": true, + "in": "query", + "name": "domain_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_domain_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_domain_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a VLAN domain", + "tags": [ + "vlan" + ] + } + }, + "/vlan/range/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "vlan_range_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                              .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_range_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the VLAN ranges", + "tags": [ + "vlan" + ] + } + }, + "/vlan/range/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                                                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "vlan_range_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of VLAN ranges", + "tags": [ + "vlan" + ] + } + }, + "/vlan/range/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "vlan_range_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the VLAN range, a unique numeric key value automatically incremented when you add a VLAN range. Use the ID to specify the VLAN range of your choice.", + "explode": true, + "in": "query", + "name": "range_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_range_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a VLAN range", + "tags": [ + "vlan" + ] + } + }, + "/vlan/range/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                                              • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                Mandatory Parameters: (range_name && (domain_id || domain_name))", + "operationId": "vlan_range_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_range_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_range_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_range_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a VLAN range", + "tags": [ + "vlan" + ] + } + }, + "/vlan/range/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                                                • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                  Mandatory Parameters: (range_id || (range_name && (domain_id || domain_name)))", + "operationId": "vlan_range_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_range_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_range_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_range_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a VLAN range", + "tags": [ + "vlan" + ] + } + }, + "/vlan/range/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                  Mandatory Parameters: (range_id || (range_name && (domain_id || domain_name)))", + "operationId": "vlan_range_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the VLAN domain, a unique numeric key value automatically incremented when you add a VLAN domain. Use the ID to specify the VLAN domain of your choice.", + "explode": true, + "in": "query", + "name": "domain_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the VLAN domain.", + "explode": true, + "in": "query", + "name": "domain_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the VLAN range, a unique numeric key value automatically incremented when you add a VLAN range. Use the ID to specify the VLAN range of your choice.", + "explode": true, + "in": "query", + "name": "range_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the VLAN range.", + "explode": true, + "in": "query", + "name": "range_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_range_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_range_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a VLAN range", + "tags": [ + "vlan" + ] + } + }, + "/vlan/vlan/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "vlan_vlan_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                  .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_vlan_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the VLANs", + "tags": [ + "vlan" + ] + } + }, + "/vlan/vlan/count": { + "get": { + "description": "This service allows you to return the number of objects.
                                                                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "vlan_vlan_count", + "parameters": [ + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service /list of the object in this clause.To filter the result using class parameters, you must tag them first.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Count the number of VLANs", + "tags": [ + "vlan" + ] + } + }, + "/vlan/vlan/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "vlan_vlan_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the VLAN, a unique numeric key value automatically incremented when you add a VLAN. Use the ID to specify the VLAN of your choice.", + "explode": true, + "in": "query", + "name": "vlan_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_vlan_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a VLAN", + "tags": [ + "vlan" + ] + } + }, + "/vlan/vlan/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                                                  • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                    Mandatory Parameters: (vlan_vlan_id && (domain_id || domain_name))", + "operationId": "vlan_vlan_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_vlan_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_vlan_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_vlan_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a VLAN", + "tags": [ + "vlan" + ] + } + }, + "/vlan/vlan/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                                                    • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                      Mandatory Parameters: (vlan_id || (vlan_vlan_id && (domain_id || domain_name)))", + "operationId": "vlan_vlan_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_vlan_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_vlan_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_vlan_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a VLAN", + "tags": [ + "vlan" + ] + } + }, + "/vlan/vlan/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                      Mandatory Parameters: (vlan_id || (vlan_vlan_id && (domain_id || domain_name)))", + "operationId": "vlan_vlan_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the VLAN domain, a unique numeric key value automatically incremented when you add a VLAN domain. Use the ID to specify the VLAN domain of your choice.", + "explode": true, + "in": "query", + "name": "domain_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the VLAN domain.", + "explode": true, + "in": "query", + "name": "domain_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the VLAN, a unique numeric key value automatically incremented when you add a VLAN. Use the ID to specify the VLAN of your choice.", + "explode": true, + "in": "query", + "name": "vlan_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The VLAN identifier (ID) of the VLAN, a unique numeric key value within a VLAN domain. Use the ID to specify the VLAN of your choice.", + "explode": true, + "in": "query", + "name": "vlan_vlan_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the VLAN range, a unique numeric key value automatically incremented when you add a VLAN range. Use the ID to specify the VLAN range of your choice.", + "explode": true, + "in": "query", + "name": "range_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the VLAN range.", + "explode": true, + "in": "query", + "name": "range_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The name of the VLAN.", + "explode": true, + "in": "query", + "name": "vlan_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_vlan_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_vlan_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a VLAN", + "tags": [ + "vlan" + ] + } + } + }, + "components": { + "responses": { + "SuccessObjectChanges": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "operation succeed" + }, + "ErrorObjectChanges": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "The specified resource was not found" + }, + "EmptyObjectChanges": { + "description": "no result" + }, + "SuccessObjectCount": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiCountResponseSuccess" + } + } + }, + "description": "result operation count" + } + }, + "schemas": { + "ApiResponse": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ApiCountResponseSuccess": { + "example": { + "data": [ + { + "count": 0 + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/ApiCountResponseSuccess_data_inner" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ApiMessageEntry": { + "example": { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + "properties": { + "code": { + "format": "int32", + "type": "integer" + }, + "msg": { + "type": "string" + }, + "type": { + "enum": [ + "error", + "warning", + "notice" + ], + "type": "string" + }, + "extras": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "type": "object" + }, + "ApiClassParameterOutputEntry": { + "example": { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + }, + "source": { + "type": "string" + } + }, + "type": "object" + }, + "ApiClassParameterInputEntry": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "app_application_data": { + "example": { + "data": [ + { + "application_fqdn": "application_fqdn", + "application_inactive_nodes": "application_inactive_nodes", + "application_delayed_time": "application_delayed_time", + "application_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "application_total_nodes": "application_total_nodes", + "application_class_name": "application_class_name", + "parent_application_id": "parent_application_id", + "application_multistatus": "application_multistatus", + "gslbserver_id": "gslbserver_id", + "application_id": "application_id", + "gslbserver_list": "gslbserver_list", + "gslbserver_type": "gslbserver_type", + "gslbserver_name": "gslbserver_name", + "gslbserver_status": "gslbserver_status", + "application_name": "application_name", + "parent_application_name": "parent_application_name" + }, + { + "application_fqdn": "application_fqdn", + "application_inactive_nodes": "application_inactive_nodes", + "application_delayed_time": "application_delayed_time", + "application_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "application_total_nodes": "application_total_nodes", + "application_class_name": "application_class_name", + "parent_application_id": "parent_application_id", + "application_multistatus": "application_multistatus", + "gslbserver_id": "gslbserver_id", + "application_id": "application_id", + "gslbserver_list": "gslbserver_list", + "gslbserver_type": "gslbserver_type", + "gslbserver_name": "gslbserver_name", + "gslbserver_status": "gslbserver_status", + "application_name": "application_name", + "parent_application_name": "parent_application_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_app_application_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "app_application_add_input": { + "properties": { + "application_fqdn": { + "description": "The Fully Qualified Domain Name (FQDN) of the application.", + "type": "string" + }, + "application_name": { + "description": "The name of the application.", + "type": "string" + }, + "gslbserver_list": { + "description": "The name of all the GSLB servers associated with the application. You can specify one or more names.", + "type": "string" + }, + "application_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "application_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "app_application_edit_input": { + "properties": { + "application_id": { + "description": "The database identifier (ID) of the application, a unique numeric key value automatically incremented when you add an application. Use the ID to specify the application of your choice.", + "type": "integer" + }, + "application_fqdn": { + "description": "The Fully Qualified Domain Name (FQDN) of the application.", + "type": "string" + }, + "application_name": { + "description": "The name of the application.", + "type": "string" + }, + "gslbserver_list": { + "description": "The name of all the GSLB servers associated with the application. You can specify one or more names.", + "type": "string" + }, + "application_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "application_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "app_application_add_success": { + "example": { + "data": [ + { + "application_id": "application_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_app_application_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "app_application_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_app_application_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "app_application_edit_success": { + "example": { + "data": [ + { + "application_id": "application_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_app_application_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "app_application_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_app_application_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "app_application_delete_success": { + "example": { + "data": [ + { + "application_id": "application_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_app_application_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "app_application_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_app_application_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "app_node_data": { + "example": { + "data": [ + { + "healthcheck_timeout": "healthcheck_timeout", + "healthcheck_id": "healthcheck_id", + "gslbserver_name": "gslbserver_name", + "application_name": "application_name", + "node_delayed_time": "node_delayed_time", + "admin_status": "admin_status", + "pool_lb_mode": "pool_lb_mode", + "healthcheck_name": "healthcheck_name", + "translated_healthcheck_name": "translated_healthcheck_name", + "application_fqdn": "application_fqdn", + "node_status": "node_status", + "healthcheck_params": "healthcheck_params", + "node_weight": "node_weight", + "translated_pool_lb_mode": "translated_pool_lb_mode", + "node_name": "node_name", + "parent_application_id": "parent_application_id", + "healthcheck_failover": "healthcheck_failover", + "pool_id": "pool_id", + "gslbserver_id": "gslbserver_id", + "application_id": "application_id", + "pool_name": "pool_name", + "gslbserver_type": "gslbserver_type", + "node_address_addr": "node_address_addr", + "healthcheck_freq": "healthcheck_freq", + "node_address6_addr": "node_address6_addr", + "healthcheck_failback": "healthcheck_failback", + "node_id": "node_id" + }, + { + "healthcheck_timeout": "healthcheck_timeout", + "healthcheck_id": "healthcheck_id", + "gslbserver_name": "gslbserver_name", + "application_name": "application_name", + "node_delayed_time": "node_delayed_time", + "admin_status": "admin_status", + "pool_lb_mode": "pool_lb_mode", + "healthcheck_name": "healthcheck_name", + "translated_healthcheck_name": "translated_healthcheck_name", + "application_fqdn": "application_fqdn", + "node_status": "node_status", + "healthcheck_params": "healthcheck_params", + "node_weight": "node_weight", + "translated_pool_lb_mode": "translated_pool_lb_mode", + "node_name": "node_name", + "parent_application_id": "parent_application_id", + "healthcheck_failover": "healthcheck_failover", + "pool_id": "pool_id", + "gslbserver_id": "gslbserver_id", + "application_id": "application_id", + "pool_name": "pool_name", + "gslbserver_type": "gslbserver_type", + "node_address_addr": "node_address_addr", + "healthcheck_freq": "healthcheck_freq", + "node_address6_addr": "node_address6_addr", + "healthcheck_failback": "healthcheck_failback", + "node_id": "node_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_app_node_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "app_node_add_input": { + "properties": { + "application_fqdn": { + "description": "The Fully Qualified Domain Name (FQDN) of the application the object belongs to.", + "type": "string" + }, + "application_id": { + "description": "The database identifier (ID) of the application the object belongs to.", + "type": "integer" + }, + "application_name": { + "description": "The name of the application the object belongs to.", + "type": "string" + }, + "pool_id": { + "description": "The database identifier (ID) of the pool, a unique numeric key value automatically incremented when you add a pool. Use the ID to specify the pool of your choice.", + "type": "integer" + }, + "pool_name": { + "description": "The name of the pool.", + "type": "string" + }, + "node_hostaddr": { + "description": "The IPv4 or IPv6 address of the node.", + "type": "string" + }, + "node_name": { + "description": "The name of the node.", + "type": "string" + }, + "admin_status": { + "description": "The administrative status of the node, managed (1) or unmanaged (0).", + "type": "integer" + }, + "gslbserver_id": { + "description": "The database identifier (ID) of the GSLB server associated with the application, a unique numeric key value automatically incremented when you add the server. Use it to identify the GSLB server of your choice.", + "type": "integer" + }, + "healthcheck_name": { + "description": "The type of health check of the node.", + "enum": [ + "ok", + "ping", + "tcp", + "http", + "custom" + ], + "type": "string" + }, + "node_status": { + "description": "Internal use. Not documented.", + "enum": [ + "0", + "1", + "2" + ], + "type": "string" + }, + "node_weight": { + "description": "The weight of the node, it sets which node is used first within the pool. It must be an integer between 0 and 255, where 0 sets a node as backup.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "app_node_edit_input": { + "properties": { + "application_fqdn": { + "description": "The Fully Qualified Domain Name (FQDN) of the application the object belongs to.", + "type": "string" + }, + "application_id": { + "description": "The database identifier (ID) of the application the object belongs to.", + "type": "integer" + }, + "application_name": { + "description": "The name of the application the object belongs to.", + "type": "string" + }, + "node_id": { + "description": "The database identifier (ID) of the node, a unique numeric key value automatically incremented when you add a node. Use the ID to specify the node of your choice.", + "type": "integer" + }, + "pool_id": { + "description": "The database identifier (ID) of the pool, a unique numeric key value automatically incremented when you add a pool. Use the ID to specify the pool of your choice.", + "type": "integer" + }, + "pool_name": { + "description": "The name of the pool.", + "type": "string" + }, + "node_hostaddr": { + "description": "The IPv4 or IPv6 address of the node.", + "type": "string" + }, + "node_name": { + "description": "The name of the node.", + "type": "string" + }, + "admin_status": { + "description": "The administrative status of the node, managed (1) or unmanaged (0).", + "type": "integer" + }, + "gslbserver_id": { + "description": "The database identifier (ID) of the GSLB server associated with the application, a unique numeric key value automatically incremented when you add the server. Use it to identify the GSLB server of your choice.", + "type": "integer" + }, + "healthcheck_name": { + "description": "The type of health check of the node.", + "enum": [ + "ok", + "ping", + "tcp", + "http", + "custom" + ], + "type": "string" + }, + "node_status": { + "description": "Internal use. Not documented.", + "enum": [ + "0", + "1", + "2" + ], + "type": "string" + }, + "node_weight": { + "description": "The weight of the node, it sets which node is used first within the pool. It must be an integer between 0 and 255, where 0 sets a node as backup.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "app_node_add_success": { + "example": { + "data": [ + { + "node_id": "node_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_app_node_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "app_node_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_app_node_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "app_node_edit_success": { + "example": { + "data": [ + { + "node_id": "node_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_app_node_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "app_node_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_app_node_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "app_node_delete_success": { + "example": { + "data": [ + { + "node_id": "node_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_app_node_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "app_node_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_app_node_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "app_pool_data": { + "example": { + "data": [ + { + "pool_affinity_state": "pool_affinity_state", + "application_fqdn": "application_fqdn", + "pool_inactive_nodes": "pool_inactive_nodes", + "translated_pool_lb_mode": "translated_pool_lb_mode", + "pool_weight": "pool_weight", + "parent_application_id": "parent_application_id", + "pool_delayed_time": "pool_delayed_time", + "pool_id": "pool_id", + "gslbserver_id": "gslbserver_id", + "application_id": "application_id", + "pool_total_nodes": "pool_total_nodes", + "pool_multistatus": "pool_multistatus", + "pool_name": "pool_name", + "gslbserver_type": "gslbserver_type", + "pool_best_active_nodes": "pool_best_active_nodes", + "gslbserver_name": "gslbserver_name", + "application_name": "application_name", + "pool_affinity_session_time": "pool_affinity_session_time", + "pool_lb_mode": "pool_lb_mode", + "pool_type": "pool_type" + }, + { + "pool_affinity_state": "pool_affinity_state", + "application_fqdn": "application_fqdn", + "pool_inactive_nodes": "pool_inactive_nodes", + "translated_pool_lb_mode": "translated_pool_lb_mode", + "pool_weight": "pool_weight", + "parent_application_id": "parent_application_id", + "pool_delayed_time": "pool_delayed_time", + "pool_id": "pool_id", + "gslbserver_id": "gslbserver_id", + "application_id": "application_id", + "pool_total_nodes": "pool_total_nodes", + "pool_multistatus": "pool_multistatus", + "pool_name": "pool_name", + "gslbserver_type": "gslbserver_type", + "pool_best_active_nodes": "pool_best_active_nodes", + "gslbserver_name": "gslbserver_name", + "application_name": "application_name", + "pool_affinity_session_time": "pool_affinity_session_time", + "pool_lb_mode": "pool_lb_mode", + "pool_type": "pool_type" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_app_pool_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "app_pool_add_input": { + "properties": { + "application_fqdn": { + "description": "The Fully Qualified Domain Name (FQDN) of the application the object belongs to.", + "type": "string" + }, + "application_id": { + "description": "The database identifier (ID) of the application the object belongs to.", + "type": "integer" + }, + "application_name": { + "description": "The name of the application the object belongs to.", + "type": "string" + }, + "pool_lb_mode": { + "description": "The load-balancing mode of the pool.", + "enum": [ + "weighted", + "round-robin", + "latency" + ], + "type": "string" + }, + "pool_name": { + "description": "The name of the pool.", + "type": "string" + }, + "pool_type": { + "description": "The type of the pool.", + "enum": [ + "ipv4", + "ipv6" + ], + "type": "string" + }, + "pool_affinity_session_time": { + "description": "The session duration, in seconds. You only need to set it if the parameter pool_affinity_state is set to 1.", + "type": "integer" + }, + "pool_affinity_state": { + "description": "The session affinity activation status.", + "type": "integer" + }, + "gslbserver_id": { + "description": "The database identifier (ID) of the GSLB server associated with the application, a unique numeric key value automatically incremented when you add the server. Use it to identify the GSLB server of your choice.", + "type": "integer" + }, + "pool_best_active_nodes": { + "description": "The maximum number of active nodes with the lowest latency that must answer the queries made to the application FQDN. You only need to set it if you set the pool_lb_mode to latency.", + "type": "integer" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "app_pool_edit_input": { + "properties": { + "application_fqdn": { + "description": "The Fully Qualified Domain Name (FQDN) of the application the object belongs to.", + "type": "string" + }, + "application_id": { + "description": "The database identifier (ID) of the application the object belongs to.", + "type": "integer" + }, + "application_name": { + "description": "The name of the application the object belongs to.", + "type": "string" + }, + "pool_id": { + "description": "The database identifier (ID) of the pool, a unique numeric key value automatically incremented when you add a pool. Use the ID to specify the pool of your choice.", + "type": "integer" + }, + "pool_lb_mode": { + "description": "The load-balancing mode of the pool.", + "enum": [ + "weighted", + "round-robin", + "latency" + ], + "type": "string" + }, + "pool_name": { + "description": "The name of the pool.", + "type": "string" + }, + "pool_type": { + "description": "The type of the pool.", + "enum": [ + "ipv4", + "ipv6" + ], + "type": "string" + }, + "pool_affinity_session_time": { + "description": "The session duration, in seconds. You only need to set it if the parameter pool_affinity_state is set to 1.", + "type": "integer" + }, + "pool_affinity_state": { + "description": "The session affinity activation status.", + "type": "integer" + }, + "gslbserver_id": { + "description": "The database identifier (ID) of the GSLB server associated with the application, a unique numeric key value automatically incremented when you add the server. Use it to identify the GSLB server of your choice.", + "type": "integer" + }, + "pool_best_active_nodes": { + "description": "The maximum number of active nodes with the lowest latency that must answer the queries made to the application FQDN. You only need to set it if you set the pool_lb_mode to latency.", + "type": "integer" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "app_pool_add_success": { + "example": { + "data": [ + { + "pool_id": "pool_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_app_pool_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "app_pool_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_app_pool_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "app_pool_edit_success": { + "example": { + "data": [ + { + "pool_id": "pool_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_app_pool_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "app_pool_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_app_pool_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "app_pool_delete_success": { + "example": { + "data": [ + { + "pool_id": "pool_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_app_pool_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "app_pool_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_app_pool_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "device_device_data": { + "example": { + "data": [ + { + "dev_name": "dev_name", + "device_id": "device_id", + "row_state": "row_state", + "device_port_used_percent": "device_port_used_percent", + "device_address_formated": "device_address_formated", + "interface_free": "interface_free", + "device_port_free": "device_port_free", + "device_class_name": "device_class_name", + "device_address_addr": "device_address_addr", + "device_space_id": "device_space_id", + "dev_id": "dev_id", + "device_name": "device_name", + "device_port_total": "device_port_total", + "interface_used_percent": "interface_used_percent", + "device_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "interface_total": "interface_total", + "device_port_used": "device_port_used", + "device_space_name": "device_space_name", + "interface_used": "interface_used" + }, + { + "dev_name": "dev_name", + "device_id": "device_id", + "row_state": "row_state", + "device_port_used_percent": "device_port_used_percent", + "device_address_formated": "device_address_formated", + "interface_free": "interface_free", + "device_port_free": "device_port_free", + "device_class_name": "device_class_name", + "device_address_addr": "device_address_addr", + "device_space_id": "device_space_id", + "dev_id": "dev_id", + "device_name": "device_name", + "device_port_total": "device_port_total", + "interface_used_percent": "interface_used_percent", + "device_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "interface_total": "interface_total", + "device_port_used": "device_port_used", + "device_space_name": "device_space_name", + "interface_used": "interface_used" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_device_device_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "device_device_add_input": { + "properties": { + "device_name": { + "description": "The name of the Device Manager device, each device must have a unique name.", + "type": "string" + }, + "device_addr": { + "description": "The IP address you want to associate with the Device Manager device, in decimal format.", + "type": "string" + }, + "device_address_addr": { + "description": "The IP address you want to associate with the Device Manager device, in hexadecimal format.", + "type": "string" + }, + "device_space_id": { + "description": "The database identifier (ID) of a space you want to associate with the Device Manager device.", + "type": "integer" + }, + "dev_id": { + "description": "The database identifier (ID) of a NetChange network device you want to associate with the Device Manager device.", + "type": "integer" + }, + "row_state": { + "description": "The object activation status.
                                                                                                                                      • If set to 0, the object is present in the database but ignored, i.e. it cannot be managed, counted or listed. This status is applied on objects deleted from the GUI.
                                                                                                                                      • If set to 1, the object is enabled and managed.
                                                                                                                                      • If set to 2, the object is unmanaged, disabled or both depending on the context.
                                                                                                                                      By default, row_state is set to 1 when an object is created.", + "enum": [ + "1", + "2", + "3" + ], + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "device_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "device_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "device_device_edit_input": { + "properties": { + "device_id": { + "description": "The database identifier (ID) of the Device Manager device, a unique numeric key value automatically incremented when you add a device. Use the ID to specify the device of your choice.", + "type": "integer" + }, + "device_name": { + "description": "The name of the Device Manager device, each device must have a unique name.", + "type": "string" + }, + "device_addr": { + "description": "The IP address you want to associate with the Device Manager device, in decimal format.", + "type": "string" + }, + "device_address_addr": { + "description": "The IP address you want to associate with the Device Manager device, in hexadecimal format.", + "type": "string" + }, + "device_space_id": { + "description": "The database identifier (ID) of a space you want to associate with the Device Manager device.", + "type": "integer" + }, + "dev_id": { + "description": "The database identifier (ID) of a NetChange network device you want to associate with the Device Manager device.", + "type": "integer" + }, + "row_state": { + "description": "The object activation status.
                                                                                                                                      • If set to 0, the object is present in the database but ignored, i.e. it cannot be managed, counted or listed. This status is applied on objects deleted from the GUI.
                                                                                                                                      • If set to 1, the object is enabled and managed.
                                                                                                                                      • If set to 2, the object is unmanaged, disabled or both depending on the context.
                                                                                                                                      By default, row_state is set to 1 when an object is created.", + "enum": [ + "1", + "2", + "3" + ], + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "device_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "device_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "device_device_add_success": { + "example": { + "data": [ + { + "device_id": "device_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_device_device_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "device_device_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_device_device_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "device_device_edit_success": { + "example": { + "data": [ + { + "device_id": "device_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_device_device_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "device_device_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_device_device_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "device_device_delete_success": { + "example": { + "data": [ + { + "device_id": "device_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_device_device_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "device_device_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_device_device_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "device_interface_data": { + "example": { + "data": [ + { + "interface_manual_link": "interface_manual_link", + "pear_iface_id": "pear_iface_id", + "interface_vendor_key": "interface_vendor_key", + "interface_nb_ip": "interface_nb_ip", + "interface_class_name": "interface_class_name", + "interface_name": "interface_name", + "interface_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "interface_mac": "interface_mac", + "device_name": "device_name", + "data_id": "data_id", + "interface_add_time": "interface_add_time", + "interface_type": "interface_type", + "interface_address_addr": "interface_address_addr", + "dev_name": "dev_name", + "interface_address_formated": "interface_address_formated", + "device_id": "device_id", + "interface_space_id": "interface_space_id", + "interface_modify_time": "interface_modify_time", + "row_state": "row_state", + "pear_ipl_iface_id": "pear_ipl_iface_id", + "device_class_name": "device_class_name", + "dev_enabled": "dev_enabled", + "dev_id": "dev_id", + "port_name": "port_name", + "interface_id": "interface_id", + "port_enabled": "port_enabled", + "interface_vendor_mac": "interface_vendor_mac", + "device_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "port_id": "port_id", + "interface_auto_link": "interface_auto_link", + "interface_space_name": "interface_space_name" + }, + { + "interface_manual_link": "interface_manual_link", + "pear_iface_id": "pear_iface_id", + "interface_vendor_key": "interface_vendor_key", + "interface_nb_ip": "interface_nb_ip", + "interface_class_name": "interface_class_name", + "interface_name": "interface_name", + "interface_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "interface_mac": "interface_mac", + "device_name": "device_name", + "data_id": "data_id", + "interface_add_time": "interface_add_time", + "interface_type": "interface_type", + "interface_address_addr": "interface_address_addr", + "dev_name": "dev_name", + "interface_address_formated": "interface_address_formated", + "device_id": "device_id", + "interface_space_id": "interface_space_id", + "interface_modify_time": "interface_modify_time", + "row_state": "row_state", + "pear_ipl_iface_id": "pear_ipl_iface_id", + "device_class_name": "device_class_name", + "dev_enabled": "dev_enabled", + "dev_id": "dev_id", + "port_name": "port_name", + "interface_id": "interface_id", + "port_enabled": "port_enabled", + "interface_vendor_mac": "interface_vendor_mac", + "device_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "port_id": "port_id", + "interface_auto_link": "interface_auto_link", + "interface_space_name": "interface_space_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_device_interface_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "device_interface_add_input": { + "properties": { + "device_id": { + "description": "The database identifier (ID) of the Device Manager device, a unique numeric key value automatically incremented when you add a device. Use the ID to specify the device of your choice.", + "type": "integer" + }, + "device_name": { + "description": "The name of the Device Manager device.", + "type": "string" + }, + "interface_addr": { + "description": "The IP addresses you want to associate with the Device Manager port or interface, as follows <ip4_list>,<ip6_list>.", + "type": "string" + }, + "interface_mac": { + "description": "The MAC address you want to associate with the Device Manager port or interface.", + "type": "string" + }, + "interface_name": { + "description": "The name of the Device Manager port or interface, each port or interface must have a unique name.", + "type": "string" + }, + "interface_type": { + "description": "A way to indicate if the object is either a port or an interface.", + "enum": [ + "interface", + "port" + ], + "type": "string" + }, + "interface_ip4_list": { + "description": "The list of IPv4 addresses you want to associate to the Device Manager port or interface, in hexadecimal format, as follows: <ip_address>, <ip_address>,...", + "type": "string" + }, + "interface_ip6_list": { + "description": "The list of IPv6 addresses you want to associate to the Device Manager port or interface, in hexadecimal format, as follows: <ip_address>, <ip_address>,...", + "type": "string" + }, + "port_id": { + "description": "The database identifier (ID) of a NetChange port you want to associate with the Device Manager port or interface.", + "type": "integer" + }, + "row_state": { + "description": "The object activation status.
                                                                                                                                      • If set to 0, the object is present in the database but ignored, i.e. it cannot be managed, counted or listed. This status is applied on objects deleted from the GUI.
                                                                                                                                      • If set to 1, the object is enabled and managed.
                                                                                                                                      • If set to 2, the object is unmanaged, disabled or both depending on the context.
                                                                                                                                      By default, row_state is set to 1 when an object is created.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of a space you want to associate with the Device Manager port or interface.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "interface_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "interface_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "device_interface_edit_input": { + "properties": { + "device_id": { + "description": "The database identifier (ID) of the Device Manager device, a unique numeric key value automatically incremented when you add a device. Use the ID to specify the device of your choice.", + "type": "integer" + }, + "device_name": { + "description": "The name of the Device Manager device.", + "type": "string" + }, + "interface_addr": { + "description": "The IP addresses you want to associate with the Device Manager port or interface, as follows <ip4_list>,<ip6_list>.", + "type": "string" + }, + "interface_id": { + "description": "The database identifier (ID) of the Device Manager port or interface, a unique numeric key value automatically incremented when you add a port or interface. Use the ID to specify the port or interface of your choice.", + "type": "integer" + }, + "interface_mac": { + "description": "The MAC address you want to associate with the Device Manager port or interface.", + "type": "string" + }, + "interface_name": { + "description": "The name of the Device Manager port or interface, each port or interface must have a unique name.", + "type": "string" + }, + "interface_type": { + "description": "A way to indicate if the object is either a port or an interface.", + "enum": [ + "interface", + "port" + ], + "type": "string" + }, + "interface_ip4_list": { + "description": "The list of IPv4 addresses you want to associate to the Device Manager port or interface, in hexadecimal format, as follows: <ip_address>, <ip_address>,...", + "type": "string" + }, + "interface_ip6_list": { + "description": "The list of IPv6 addresses you want to associate to the Device Manager port or interface, in hexadecimal format, as follows: <ip_address>, <ip_address>,...", + "type": "string" + }, + "port_id": { + "description": "The database identifier (ID) of a NetChange port you want to associate with the Device Manager port or interface.", + "type": "integer" + }, + "row_state": { + "description": "The object activation status.
                                                                                                                                      • If set to 0, the object is present in the database but ignored, i.e. it cannot be managed, counted or listed. This status is applied on objects deleted from the GUI.
                                                                                                                                      • If set to 1, the object is enabled and managed.
                                                                                                                                      • If set to 2, the object is unmanaged, disabled or both depending on the context.
                                                                                                                                      By default, row_state is set to 1 when an object is created.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of a space you want to associate with the Device Manager port or interface.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "interface_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "interface_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "device_interface_add_success": { + "example": { + "data": [ + { + "interface_id": "interface_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_device_interface_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "device_interface_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_device_interface_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "device_interface_edit_success": { + "example": { + "data": [ + { + "interface_id": "interface_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_device_interface_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "device_interface_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_device_interface_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "device_interface_delete_success": { + "example": { + "data": [ + { + "interface_id": "interface_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_device_interface_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "device_interface_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_device_interface_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "device_link_data": { + "example": { + "data": [ + { + "device_name": "device_name", + "interface_id": "interface_id", + "device_id": "device_id", + "link_add_time": "link_add_time", + "link_auto_link": "link_auto_link", + "interface_name": "interface_name", + "interface_type": "interface_type", + "link_id": "link_id", + "interface_mac": "interface_mac" + }, + { + "device_name": "device_name", + "interface_id": "interface_id", + "device_id": "device_id", + "link_add_time": "link_add_time", + "link_auto_link": "link_auto_link", + "interface_name": "interface_name", + "interface_type": "interface_type", + "link_id": "link_id", + "interface_mac": "interface_mac" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_device_link_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "device_link_add_input": { + "properties": { + "device1_name": { + "description": "The name of the device to which belongs the DM port or interface you want to link with interface2_id.", + "type": "string" + }, + "device2_name": { + "description": "The name of the device to which belongs the DM port or interface you want to link with interface1_id.", + "type": "string" + }, + "interface1_id": { + "description": "The database identifier (ID) of the DM port or interface you want to link with interface2_id.", + "type": "integer" + }, + "interface1_name": { + "description": "The name of the DM port or interface you want to link with interface2_id.", + "type": "string" + }, + "interface2_id": { + "description": "The database identifier (ID) of the DM port or interface you want to link with interface1_id.", + "type": "integer" + }, + "interface2_name": { + "description": "The name of the DM port or interface you want to link with interface1_id.", + "type": "string" + }, + "link_id": { + "description": "The database identifier (ID) of the Device Manager port or interface link, a unique numeric key value automatically incremented when you add a link between a device and a port or interface. Use the ID to specify the port or interface link of your choice.", + "type": "integer" + }, + "link_auto_link": { + "description": "A way to determine if the link between two Device Manager devices is set automatically (1) or manually (0).", + "type": "integer" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "device_link_edit_input": { + "properties": { + "device1_name": { + "description": "The name of the device to which belongs the DM port or interface you want to link with interface2_id.", + "type": "string" + }, + "device2_name": { + "description": "The name of the device to which belongs the DM port or interface you want to link with interface1_id.", + "type": "string" + }, + "interface1_id": { + "description": "The database identifier (ID) of the DM port or interface you want to link with interface2_id.", + "type": "integer" + }, + "interface1_name": { + "description": "The name of the DM port or interface you want to link with interface2_id.", + "type": "string" + }, + "interface2_id": { + "description": "The database identifier (ID) of the DM port or interface you want to link with interface1_id.", + "type": "integer" + }, + "interface2_name": { + "description": "The name of the DM port or interface you want to link with interface1_id.", + "type": "string" + }, + "link_id": { + "description": "The database identifier (ID) of the Device Manager port or interface link, a unique numeric key value automatically incremented when you add a link between a device and a port or interface. Use the ID to specify the port or interface link of your choice.", + "type": "integer" + }, + "link_auto_link": { + "description": "A way to determine if the link between two Device Manager devices is set automatically (1) or manually (0).", + "type": "integer" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "device_link_add_success": { + "example": { + "data": [ + { + "link_id": "link_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_device_link_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "device_link_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_device_link_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "device_link_edit_success": { + "example": { + "data": [ + { + "link_id": "link_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_device_link_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "device_link_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_device_link_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "device_link_delete_success": { + "example": { + "data": [ + { + "link_id": "link_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_device_link_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "device_link_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_device_link_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_acl_data": { + "example": { + "data": [ + { + "server_name": "server_name", + "acl_spawnwith": "acl_spawnwith", + "server_id": "server_id", + "acl_leaselimit": "acl_leaselimit", + "acl_statement": "acl_statement", + "smart_parent_id": "smart_parent_id", + "acl_name": "acl_name", + "acl_delayed_create_time": "acl_delayed_create_time", + "server_cluster_role": "server_cluster_role", + "acl_delayed_delete_time": "acl_delayed_delete_time", + "acl_id": "acl_id", + "acl_match": "acl_match", + "server_type": "server_type" + }, + { + "server_name": "server_name", + "acl_spawnwith": "acl_spawnwith", + "server_id": "server_id", + "acl_leaselimit": "acl_leaselimit", + "acl_statement": "acl_statement", + "smart_parent_id": "smart_parent_id", + "acl_name": "acl_name", + "acl_delayed_create_time": "acl_delayed_create_time", + "server_cluster_role": "server_cluster_role", + "acl_delayed_delete_time": "acl_delayed_delete_time", + "acl_id": "acl_id", + "acl_match": "acl_match", + "server_type": "server_type" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_acl_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_acl6_data": { + "example": { + "data": [ + { + "acl6_statement": "acl6_statement", + "smart_parent_id": "smart_parent_id", + "acl6_id": "acl6_id", + "acl6_match": "acl6_match", + "server_cluster_role": "server_cluster_role", + "acl6_spawnwith": "acl6_spawnwith", + "acl6_name": "acl6_name", + "server6_id": "server6_id", + "acl6_delayed_time": "acl6_delayed_time", + "server6_type": "server6_type", + "server6_name": "server6_name" + }, + { + "acl6_statement": "acl6_statement", + "smart_parent_id": "smart_parent_id", + "acl6_id": "acl6_id", + "acl6_match": "acl6_match", + "server_cluster_role": "server_cluster_role", + "acl6_spawnwith": "acl6_spawnwith", + "acl6_name": "acl6_name", + "server6_id": "server6_id", + "acl6_delayed_time": "acl6_delayed_time", + "server6_type": "server6_type", + "server6_name": "server6_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_acl6_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_aclentry_data": { + "example": { + "data": [ + { + "aclentry_id": "aclentry_id", + "server_name": "server_name", + "aclentry_leaselimit": "aclentry_leaselimit", + "smart_parent_id": "smart_parent_id", + "acl_name": "acl_name", + "server_cluster_role": "server_cluster_role", + "aclentry_delayed_delete_time": "aclentry_delayed_delete_time", + "aclentry_value": "aclentry_value", + "aclentry_delayed_create_time": "aclentry_delayed_create_time", + "acl_id": "acl_id", + "server_id": "server_id", + "server_type": "server_type" + }, + { + "aclentry_id": "aclentry_id", + "server_name": "server_name", + "aclentry_leaselimit": "aclentry_leaselimit", + "smart_parent_id": "smart_parent_id", + "acl_name": "acl_name", + "server_cluster_role": "server_cluster_role", + "aclentry_delayed_delete_time": "aclentry_delayed_delete_time", + "aclentry_value": "aclentry_value", + "aclentry_delayed_create_time": "aclentry_delayed_create_time", + "acl_id": "acl_id", + "server_id": "server_id", + "server_type": "server_type" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_aclentry_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_aclentry6_data": { + "example": { + "data": [ + { + "aclentry6_value": "aclentry6_value", + "smart_parent_id": "smart_parent_id", + "aclentry6_delayed_time": "aclentry6_delayed_time", + "acl6_id": "acl6_id", + "server_cluster_role": "server_cluster_role", + "aclentry6_id": "aclentry6_id", + "acl6_name": "acl6_name", + "server6_id": "server6_id", + "server6_type": "server6_type", + "server6_name": "server6_name" + }, + { + "aclentry6_value": "aclentry6_value", + "smart_parent_id": "smart_parent_id", + "aclentry6_delayed_time": "aclentry6_delayed_time", + "acl6_id": "acl6_id", + "server_cluster_role": "server_cluster_role", + "aclentry6_id": "aclentry6_id", + "acl6_name": "acl6_name", + "server6_id": "server6_id", + "server6_type": "server6_type", + "server6_name": "server6_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_aclentry6_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_failover_data": { + "example": { + "data": [ + { + "server_name": "server_name", + "failover_mclt": "failover_mclt", + "failover_peer_port": "failover_peer_port", + "failover_state": "failover_state", + "failover_name": "failover_name", + "failover_delayed_create_time": "failover_delayed_create_time", + "server_id": "server_id", + "failover_peer_addr": "failover_peer_addr", + "failover_split": "failover_split", + "failover_delayed_delete_time": "failover_delayed_delete_time", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "smart_parent_id": "smart_parent_id", + "failover_addr": "failover_addr", + "failover_type": "failover_type", + "failover_auto_partner_down": "failover_auto_partner_down", + "server_cluster_role": "server_cluster_role", + "peer_server_id": "peer_server_id", + "failover_multistatus": "failover_multistatus", + "server_state": "server_state", + "server_type": "server_type", + "failover_id": "failover_id", + "failover_port": "failover_port" + }, + { + "server_name": "server_name", + "failover_mclt": "failover_mclt", + "failover_peer_port": "failover_peer_port", + "failover_state": "failover_state", + "failover_name": "failover_name", + "failover_delayed_create_time": "failover_delayed_create_time", + "server_id": "server_id", + "failover_peer_addr": "failover_peer_addr", + "failover_split": "failover_split", + "failover_delayed_delete_time": "failover_delayed_delete_time", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "smart_parent_id": "smart_parent_id", + "failover_addr": "failover_addr", + "failover_type": "failover_type", + "failover_auto_partner_down": "failover_auto_partner_down", + "server_cluster_role": "server_cluster_role", + "peer_server_id": "peer_server_id", + "failover_multistatus": "failover_multistatus", + "server_state": "server_state", + "server_type": "server_type", + "failover_id": "failover_id", + "failover_port": "failover_port" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_failover_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_group_data": { + "example": { + "data": [ + { + "server_name": "server_name", + "group_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "group_name": "group_name", + "server_class_name": "server_class_name", + "group_class_name": "group_class_name", + "group_multistatus": "group_multistatus", + "server_id": "server_id", + "server_version": "server_version", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "smart_parent_id": "smart_parent_id", + "group_id": "group_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "smart_parent_name": "smart_parent_name", + "group_delayed_create_time": "group_delayed_create_time", + "group_delayed_delete_time": "group_delayed_delete_time", + "server_type": "server_type" + }, + { + "server_name": "server_name", + "group_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "group_name": "group_name", + "server_class_name": "server_class_name", + "group_class_name": "group_class_name", + "group_multistatus": "group_multistatus", + "server_id": "server_id", + "server_version": "server_version", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "smart_parent_id": "smart_parent_id", + "group_id": "group_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "smart_parent_name": "smart_parent_name", + "group_delayed_create_time": "group_delayed_create_time", + "group_delayed_delete_time": "group_delayed_delete_time", + "server_type": "server_type" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_group_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_group_add_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "group_name": { + "description": "The name of the DHCPv4 group, each DHCPv4 group must have a unique name.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "group_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "group_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dhcp_group_edit_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "group_id": { + "description": "The database identifier (ID) of the DHCPv4 group, a unique numeric key value automatically incremented when you add a DHCPv4 group. Use the ID to specify the DHCPv4 group of your choice.", + "type": "integer" + }, + "group_name": { + "description": "The name of the DHCPv4 group, each DHCPv4 group must have a unique name.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "group_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "group_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dhcp_group_add_success": { + "example": { + "data": [ + { + "group_id": "group_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_group_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_group_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_group_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_group_edit_success": { + "example": { + "data": [ + { + "group_id": "group_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_group_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_group_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_group_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_group_delete_success": { + "example": { + "data": [ + { + "group_id": "group_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_group_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_group_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_group_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_group6_data": { + "example": { + "data": [ + { + "server6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server6_version": "server6_version", + "server6_addr6": "server6_addr6", + "group6_name": "group6_name", + "server6_hostaddr": "server6_hostaddr", + "group6_multistatus": "group6_multistatus", + "group6_delayed_time": "group6_delayed_time", + "group6_id": "group6_id", + "server6_name": "server6_name", + "server6_addr": "server6_addr", + "smart_parent_id": "smart_parent_id", + "smart_parent_name": "smart_parent_name", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "server6_type": "server6_type", + "group6_class_name": "group6_class_name", + "group6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ] + }, + { + "server6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server6_version": "server6_version", + "server6_addr6": "server6_addr6", + "group6_name": "group6_name", + "server6_hostaddr": "server6_hostaddr", + "group6_multistatus": "group6_multistatus", + "group6_delayed_time": "group6_delayed_time", + "group6_id": "group6_id", + "server6_name": "server6_name", + "server6_addr": "server6_addr", + "smart_parent_id": "smart_parent_id", + "smart_parent_name": "smart_parent_name", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "server6_type": "server6_type", + "group6_class_name": "group6_class_name", + "group6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ] + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_group6_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_lease_data": { + "example": { + "data": [ + { + "range_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_name": "range_name", + "server_name": "server_name", + "lease_mac_addr": "lease_mac_addr", + "sharednetwork_id": "sharednetwork_id", + "server_class_name": "server_class_name", + "lease_vendor_id": "lease_vendor_id", + "server_version": "server_version", + "lease_addr": "lease_addr", + "percent": "percent", + "scope_name": "scope_name", + "range_id": "range_id", + "lease_name": "lease_name", + "smart_parent_id": "smart_parent_id", + "parameter_request_list": "parameter_request_list", + "scope_id": "scope_id", + "lease_circuit_id": "lease_circuit_id", + "lease_time": "lease_time", + "smart_parent_name": "smart_parent_name", + "server_cluster_role": "server_cluster_role", + "scope_size": "scope_size", + "lease_fingerbank_os": "lease_fingerbank_os", + "lease_address_addr": "lease_address_addr", + "lease_remote_id": "lease_remote_id", + "lease_first_time": "lease_first_time", + "lease_giaddr": "lease_giaddr", + "range_end_addr": "range_end_addr", + "time_to_expire": "time_to_expire", + "sharednetwork_name": "sharednetwork_name", + "lease_multistatus": "lease_multistatus", + "server_id": "server_id", + "server_addr": "server_addr", + "lease_clientname": "lease_clientname", + "lease_period": "lease_period", + "server_hostaddr": "server_hostaddr", + "scope_net_addr": "scope_net_addr", + "server_addr6": "server_addr6", + "lease_domain": "lease_domain", + "lease_end_time": "lease_end_time", + "range_start_addr": "range_start_addr", + "range_class_name": "range_class_name", + "range_failover_name": "range_failover_name", + "lease_mac_vendor": "lease_mac_vendor", + "lease_client_ident": "lease_client_ident", + "lease_id": "lease_id", + "server_type": "server_type", + "scope_class_name": "scope_class_name" + }, + { + "range_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_name": "range_name", + "server_name": "server_name", + "lease_mac_addr": "lease_mac_addr", + "sharednetwork_id": "sharednetwork_id", + "server_class_name": "server_class_name", + "lease_vendor_id": "lease_vendor_id", + "server_version": "server_version", + "lease_addr": "lease_addr", + "percent": "percent", + "scope_name": "scope_name", + "range_id": "range_id", + "lease_name": "lease_name", + "smart_parent_id": "smart_parent_id", + "parameter_request_list": "parameter_request_list", + "scope_id": "scope_id", + "lease_circuit_id": "lease_circuit_id", + "lease_time": "lease_time", + "smart_parent_name": "smart_parent_name", + "server_cluster_role": "server_cluster_role", + "scope_size": "scope_size", + "lease_fingerbank_os": "lease_fingerbank_os", + "lease_address_addr": "lease_address_addr", + "lease_remote_id": "lease_remote_id", + "lease_first_time": "lease_first_time", + "lease_giaddr": "lease_giaddr", + "range_end_addr": "range_end_addr", + "time_to_expire": "time_to_expire", + "sharednetwork_name": "sharednetwork_name", + "lease_multistatus": "lease_multistatus", + "server_id": "server_id", + "server_addr": "server_addr", + "lease_clientname": "lease_clientname", + "lease_period": "lease_period", + "server_hostaddr": "server_hostaddr", + "scope_net_addr": "scope_net_addr", + "server_addr6": "server_addr6", + "lease_domain": "lease_domain", + "lease_end_time": "lease_end_time", + "range_start_addr": "range_start_addr", + "range_class_name": "range_class_name", + "range_failover_name": "range_failover_name", + "lease_mac_vendor": "lease_mac_vendor", + "lease_client_ident": "lease_client_ident", + "lease_id": "lease_id", + "server_type": "server_type", + "scope_class_name": "scope_class_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_lease_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_lease6_data": { + "example": { + "data": [ + { + "scope6_size": "scope6_size", + "lease6_multistatus": "lease6_multistatus", + "server6_version": "server6_version", + "lease6_id": "lease6_id", + "lease6_address6_addr": "lease6_address6_addr", + "range6_failover_name": "range6_failover_name", + "server6_name": "server6_name", + "lease6_end_time": "lease6_end_time", + "lease6_first_time": "lease6_first_time", + "lease6_period": "lease6_period", + "range6_end_address6_addr": "range6_end_address6_addr", + "scope6_prefix": "scope6_prefix", + "smart_parent_id": "smart_parent_id", + "smart_parent_name": "smart_parent_name", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "lease6_clientname": "lease6_clientname", + "server6_type": "server6_type", + "lease6_mac_vendor": "lease6_mac_vendor", + "lease6_domain": "lease6_domain", + "range6_id": "range6_id", + "range6_start_address6_addr": "range6_start_address6_addr", + "server6_addr6": "server6_addr6", + "lease6_time": "lease6_time", + "sharednetwork6_name": "sharednetwork6_name", + "lease6_client_duid": "lease6_client_duid", + "server6_hostaddr": "server6_hostaddr", + "lease6_percent": "lease6_percent", + "server6_addr": "server6_addr", + "lease6_mac_addr": "lease6_mac_addr", + "scope6_class_name": "scope6_class_name", + "scope6_name": "scope6_name", + "range6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_id": "scope6_id", + "sharednetwork6_id": "sharednetwork6_id", + "lease6_giaddr": "lease6_giaddr", + "lease6_time_to_expire": "lease6_time_to_expire", + "lease6_name": "lease6_name", + "scope6_start_address6_addr": "scope6_start_address6_addr", + "range6_class_name": "range6_class_name" + }, + { + "scope6_size": "scope6_size", + "lease6_multistatus": "lease6_multistatus", + "server6_version": "server6_version", + "lease6_id": "lease6_id", + "lease6_address6_addr": "lease6_address6_addr", + "range6_failover_name": "range6_failover_name", + "server6_name": "server6_name", + "lease6_end_time": "lease6_end_time", + "lease6_first_time": "lease6_first_time", + "lease6_period": "lease6_period", + "range6_end_address6_addr": "range6_end_address6_addr", + "scope6_prefix": "scope6_prefix", + "smart_parent_id": "smart_parent_id", + "smart_parent_name": "smart_parent_name", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "lease6_clientname": "lease6_clientname", + "server6_type": "server6_type", + "lease6_mac_vendor": "lease6_mac_vendor", + "lease6_domain": "lease6_domain", + "range6_id": "range6_id", + "range6_start_address6_addr": "range6_start_address6_addr", + "server6_addr6": "server6_addr6", + "lease6_time": "lease6_time", + "sharednetwork6_name": "sharednetwork6_name", + "lease6_client_duid": "lease6_client_duid", + "server6_hostaddr": "server6_hostaddr", + "lease6_percent": "lease6_percent", + "server6_addr": "server6_addr", + "lease6_mac_addr": "lease6_mac_addr", + "scope6_class_name": "scope6_class_name", + "scope6_name": "scope6_name", + "range6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_id": "scope6_id", + "sharednetwork6_id": "sharednetwork6_id", + "lease6_giaddr": "lease6_giaddr", + "lease6_time_to_expire": "lease6_time_to_expire", + "lease6_name": "lease6_name", + "scope6_start_address6_addr": "scope6_start_address6_addr", + "range6_class_name": "range6_class_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_lease6_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_range_data": { + "example": { + "data": [ + { + "range_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_name": "range_name", + "server_name": "server_name", + "range_lease_count": "range_lease_count", + "sharednetwork_id": "sharednetwork_id", + "server_class_name": "server_class_name", + "scope_start_address_addr": "scope_start_address_addr", + "server_version": "server_version", + "range_size": "range_size", + "scope_name": "scope_name", + "range_id": "range_id", + "range_lease_percent": "range_lease_percent", + "smart_parent_id": "smart_parent_id", + "scope_id": "scope_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope_if_name": "scope_if_name", + "smart_parent_name": "smart_parent_name", + "scope_size": "scope_size", + "range_delayed_create_time": "range_delayed_create_time", + "range_delayed_delete_time": "range_delayed_delete_time", + "server_comment": "server_comment", + "range_end_addr": "range_end_addr", + "scope_if_addr": "scope_if_addr", + "range_state": "range_state", + "sharednetwork_name": "sharednetwork_name", + "server_id": "server_id", + "server_addr": "server_addr", + "scope_net_mask": "scope_net_mask", + "server_hostaddr": "server_hostaddr", + "scope_net_addr": "scope_net_addr", + "server_addr6": "server_addr6", + "range_start_addr": "range_start_addr", + "range_class_name": "range_class_name", + "range_failover_name": "range_failover_name", + "scope_space_id": "scope_space_id", + "scope_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_multistatus": "range_multistatus", + "range_start_address_addr": "range_start_address_addr", + "range_end_address_addr": "range_end_address_addr", + "server_type": "server_type", + "range_acl": "range_acl", + "scope_class_name": "scope_class_name" + }, + { + "range_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_name": "range_name", + "server_name": "server_name", + "range_lease_count": "range_lease_count", + "sharednetwork_id": "sharednetwork_id", + "server_class_name": "server_class_name", + "scope_start_address_addr": "scope_start_address_addr", + "server_version": "server_version", + "range_size": "range_size", + "scope_name": "scope_name", + "range_id": "range_id", + "range_lease_percent": "range_lease_percent", + "smart_parent_id": "smart_parent_id", + "scope_id": "scope_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope_if_name": "scope_if_name", + "smart_parent_name": "smart_parent_name", + "scope_size": "scope_size", + "range_delayed_create_time": "range_delayed_create_time", + "range_delayed_delete_time": "range_delayed_delete_time", + "server_comment": "server_comment", + "range_end_addr": "range_end_addr", + "scope_if_addr": "scope_if_addr", + "range_state": "range_state", + "sharednetwork_name": "sharednetwork_name", + "server_id": "server_id", + "server_addr": "server_addr", + "scope_net_mask": "scope_net_mask", + "server_hostaddr": "server_hostaddr", + "scope_net_addr": "scope_net_addr", + "server_addr6": "server_addr6", + "range_start_addr": "range_start_addr", + "range_class_name": "range_class_name", + "range_failover_name": "range_failover_name", + "scope_space_id": "scope_space_id", + "scope_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_multistatus": "range_multistatus", + "range_start_address_addr": "range_start_address_addr", + "range_end_address_addr": "range_end_address_addr", + "server_type": "server_type", + "range_acl": "range_acl", + "scope_class_name": "scope_class_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_range_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_range_add_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "range_end_addr": { + "description": "The last IP address of the DHCPv4 range.", + "type": "string" + }, + "range_start_addr": { + "description": "The first IP address of the DHCPv4 range.", + "type": "string" + }, + "scope_id": { + "description": "The database identifier (ID) of the DHCPv4 scope, a unique numeric key value automatically incremented when you add a DHCPv4 scope. Use the ID to specify the DHCPv4 scope of your choice.", + "type": "integer" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "range_acl": { + "description": "The list of ACLs associated with the DHCPv4 range, as follows: <ACL_name>;<ACL_name>;... .", + "type": "string" + }, + "range_name": { + "description": "The start and end IP address of the DHCPv4 range, as follows: <start-ip>-<end-ip>.", + "type": "string" + }, + "scope_name": { + "description": "The name of the DHCPv4 scope.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "range_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "range_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dhcp_range_edit_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "range_end_addr": { + "description": "The last IP address of the DHCPv4 range.", + "type": "string" + }, + "range_id": { + "description": "The database identifier (ID) of the DHCPv4 range, a unique numeric key value automatically incremented when you add a DHCPv4 range. Use the ID to specify the DHCPv4 range of your choice.", + "type": "integer" + }, + "range_start_addr": { + "description": "The first IP address of the DHCPv4 range.", + "type": "string" + }, + "scope_id": { + "description": "The database identifier (ID) of the DHCPv4 scope, a unique numeric key value automatically incremented when you add a DHCPv4 scope. Use the ID to specify the DHCPv4 scope of your choice.", + "type": "integer" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "range_acl": { + "description": "The list of ACLs associated with the DHCPv4 range, as follows: <ACL_name>;<ACL_name>;... .", + "type": "string" + }, + "range_name": { + "description": "The start and end IP address of the DHCPv4 range, as follows: <start-ip>-<end-ip>.", + "type": "string" + }, + "scope_name": { + "description": "The name of the DHCPv4 scope.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "range_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "range_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dhcp_range_add_success": { + "example": { + "data": [ + { + "range_id": "range_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_range_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_range_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_range_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_range_edit_success": { + "example": { + "data": [ + { + "range_id": "range_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_range_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_range_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_range_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_range_delete_success": { + "example": { + "data": [ + { + "range_id": "range_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_range_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_range_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_range_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_range6_data": { + "example": { + "data": [ + { + "server6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_size": "scope6_size", + "server6_version": "server6_version", + "range6_state": "range6_state", + "scope6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range6_failover_name": "range6_failover_name", + "server6_name": "server6_name", + "range6_end_address6_addr": "range6_end_address6_addr", + "scope6_prefix": "scope6_prefix", + "server6_comment": "server6_comment", + "smart_parent_id": "smart_parent_id", + "smart_parent_name": "smart_parent_name", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "server6_type": "server6_type", + "range6_delayed_time": "range6_delayed_time", + "range6_acl": "range6_acl", + "range6_id": "range6_id", + "range6_name": "range6_name", + "range6_start_address6_addr": "range6_start_address6_addr", + "server6_addr6": "server6_addr6", + "sharednetwork6_name": "sharednetwork6_name", + "range6_multistatus": "range6_multistatus", + "server6_hostaddr": "server6_hostaddr", + "scope6_end_address6_addr": "scope6_end_address6_addr", + "server6_addr": "server6_addr", + "range6_size": "range6_size", + "scope6_class_name": "scope6_class_name", + "scope6_name": "scope6_name", + "scope6_space_id": "scope6_space_id", + "range6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_id": "scope6_id", + "range6_lease_count": "range6_lease_count", + "sharednetwork6_id": "sharednetwork6_id", + "scope6_start_address6_addr": "scope6_start_address6_addr", + "range6_class_name": "range6_class_name" + }, + { + "server6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_size": "scope6_size", + "server6_version": "server6_version", + "range6_state": "range6_state", + "scope6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range6_failover_name": "range6_failover_name", + "server6_name": "server6_name", + "range6_end_address6_addr": "range6_end_address6_addr", + "scope6_prefix": "scope6_prefix", + "server6_comment": "server6_comment", + "smart_parent_id": "smart_parent_id", + "smart_parent_name": "smart_parent_name", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "server6_type": "server6_type", + "range6_delayed_time": "range6_delayed_time", + "range6_acl": "range6_acl", + "range6_id": "range6_id", + "range6_name": "range6_name", + "range6_start_address6_addr": "range6_start_address6_addr", + "server6_addr6": "server6_addr6", + "sharednetwork6_name": "sharednetwork6_name", + "range6_multistatus": "range6_multistatus", + "server6_hostaddr": "server6_hostaddr", + "scope6_end_address6_addr": "scope6_end_address6_addr", + "server6_addr": "server6_addr", + "range6_size": "range6_size", + "scope6_class_name": "scope6_class_name", + "scope6_name": "scope6_name", + "scope6_space_id": "scope6_space_id", + "range6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_id": "scope6_id", + "range6_lease_count": "range6_lease_count", + "sharednetwork6_id": "sharednetwork6_id", + "scope6_start_address6_addr": "scope6_start_address6_addr", + "range6_class_name": "range6_class_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_range6_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_range6_add_input": { + "properties": { + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "type": "integer" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "range6_end_addr": { + "description": "The last IP address of the DHCPv6 range.", + "type": "string" + }, + "range6_start_addr": { + "description": "The first IP address of the DHCPv6 range.", + "type": "string" + }, + "scope6_id": { + "description": "The database identifier (ID) of the DHCPv6 scope, a unique numeric key value automatically incremented when you add a DHCPv6 scope. Use the ID to specify the DHCPv6 scope of your choice.", + "type": "integer" + }, + "server6_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "range6_acl": { + "description": "The list of ACLs associated with the DHCPv6 range, as follows: <ACL_name>;<ACL_name>;... .", + "type": "string" + }, + "scope6_name": { + "description": "The name of the DHCPv6 scope.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "range6_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "range6_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dhcp_range6_edit_input": { + "properties": { + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "type": "integer" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "range6_end_addr": { + "description": "The last IP address of the DHCPv6 range.", + "type": "string" + }, + "range6_id": { + "description": "The database identifier (ID) of the DHCPv6 range, a unique numeric key value automatically incremented when you add a DHCPv6 range. Use the ID to specify the DHCPv6 range of your choice.", + "type": "integer" + }, + "range6_start_addr": { + "description": "The first IP address of the DHCPv6 range.", + "type": "string" + }, + "scope6_id": { + "description": "The database identifier (ID) of the DHCPv6 scope, a unique numeric key value automatically incremented when you add a DHCPv6 scope. Use the ID to specify the DHCPv6 scope of your choice.", + "type": "integer" + }, + "server6_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "range6_acl": { + "description": "The list of ACLs associated with the DHCPv6 range, as follows: <ACL_name>;<ACL_name>;... .", + "type": "string" + }, + "scope6_name": { + "description": "The name of the DHCPv6 scope.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "range6_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "range6_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dhcp_range6_add_success": { + "example": { + "data": [ + { + "range6_id": "range6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_range6_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_range6_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_range6_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_range6_edit_success": { + "example": { + "data": [ + { + "range6_id": "range6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_range6_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_range6_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_range6_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_range6_delete_success": { + "example": { + "data": [ + { + "range6_id": "range6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_range6_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_range6_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_range6_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_scope_data": { + "example": { + "data": [ + { + "server_name": "server_name", + "sharednetwork_id": "sharednetwork_id", + "server_class_name": "server_class_name", + "scope_start_address_addr": "scope_start_address_addr", + "server_version": "server_version", + "scope_space_name": "scope_space_name", + "scope_name": "scope_name", + "scope_delayed_create_time": "scope_delayed_create_time", + "smart_parent_id": "smart_parent_id", + "scope_multistatus": "scope_multistatus", + "scope_id": "scope_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "smart_parent_name": "smart_parent_name", + "scope_size": "scope_size", + "smart_arch": "smart_arch", + "scope_end_address_addr": "scope_end_address_addr", + "failover_name": "failover_name", + "sharednetwork_name": "sharednetwork_name", + "scope_delayed_delete_time": "scope_delayed_delete_time", + "server_id": "server_id", + "server_addr": "server_addr", + "scope_net_mask": "scope_net_mask", + "server_hostaddr": "server_hostaddr", + "scope_net_addr": "scope_net_addr", + "server_addr6": "server_addr6", + "scope_space_id": "scope_space_id", + "scope_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_type": "server_type", + "failover_id": "failover_id", + "scope_class_name": "scope_class_name" + }, + { + "server_name": "server_name", + "sharednetwork_id": "sharednetwork_id", + "server_class_name": "server_class_name", + "scope_start_address_addr": "scope_start_address_addr", + "server_version": "server_version", + "scope_space_name": "scope_space_name", + "scope_name": "scope_name", + "scope_delayed_create_time": "scope_delayed_create_time", + "smart_parent_id": "smart_parent_id", + "scope_multistatus": "scope_multistatus", + "scope_id": "scope_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "smart_parent_name": "smart_parent_name", + "scope_size": "scope_size", + "smart_arch": "smart_arch", + "scope_end_address_addr": "scope_end_address_addr", + "failover_name": "failover_name", + "sharednetwork_name": "sharednetwork_name", + "scope_delayed_delete_time": "scope_delayed_delete_time", + "server_id": "server_id", + "server_addr": "server_addr", + "scope_net_mask": "scope_net_mask", + "server_hostaddr": "server_hostaddr", + "scope_net_addr": "scope_net_addr", + "server_addr6": "server_addr6", + "scope_space_id": "scope_space_id", + "scope_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_type": "server_type", + "failover_id": "failover_id", + "scope_class_name": "scope_class_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_scope_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_scope_add_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "scope_net_addr": { + "description": "The first IP address of the DHCPv4 scope.", + "type": "string" + }, + "scope_net_mask": { + "description": "The netmask of the DHCPv4 scope. It is expressed in dot-decimal notation and defines the number of addresses the scope contains.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "failover_id": { + "description": "The database identifier (ID) of the DHCPv4 failover channel, a unique numeric key value automatically incremented when you add a DHCPv4 failover channel. Use the ID to specify the DHCPv4 failover channel of your choice.", + "type": "integer" + }, + "failover_name": { + "description": "The name of the DHCPv4 failover channel.", + "type": "string" + }, + "scope_name": { + "description": "The name of the DHCPv4 scope, each DHCPv4 scope must have a unique name.", + "type": "string" + }, + "scope_space_id": { + "description": "The database identifier (ID) of an existing space you want to associate with the DHCPv4 scope.", + "type": "integer" + }, + "scope_space_name": { + "description": "The name of an existing space you want to associate with the DHCPv4 scope.", + "type": "string" + }, + "sharednetwork_id": { + "description": "The database identifier (ID) of the DHCPv4 shared network, a unique numeric key value automatically incremented when you add a DHCPv4 shared network. Use the ID to specify the DHCPv4 shared network of your choice.", + "type": "integer" + }, + "sharednetwork_name": { + "description": "The name of the DHCPv4 shared network.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "scope_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "scope_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dhcp_scope_edit_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "scope_id": { + "description": "The database identifier (ID) of the DHCPv4 scope, a unique numeric key value automatically incremented when you add a DHCPv4 scope. Use the ID to specify the DHCPv4 scope of your choice.", + "type": "integer" + }, + "scope_net_addr": { + "description": "The first IP address of the DHCPv4 scope.", + "type": "string" + }, + "scope_net_mask": { + "description": "The netmask of the DHCPv4 scope. It is expressed in dot-decimal notation and defines the number of addresses the scope contains.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "failover_id": { + "description": "The database identifier (ID) of the DHCPv4 failover channel, a unique numeric key value automatically incremented when you add a DHCPv4 failover channel. Use the ID to specify the DHCPv4 failover channel of your choice.", + "type": "integer" + }, + "failover_name": { + "description": "The name of the DHCPv4 failover channel.", + "type": "string" + }, + "scope_name": { + "description": "The name of the DHCPv4 scope, each DHCPv4 scope must have a unique name.", + "type": "string" + }, + "scope_space_id": { + "description": "The database identifier (ID) of an existing space you want to associate with the DHCPv4 scope.", + "type": "integer" + }, + "scope_space_name": { + "description": "The name of an existing space you want to associate with the DHCPv4 scope.", + "type": "string" + }, + "sharednetwork_id": { + "description": "The database identifier (ID) of the DHCPv4 shared network, a unique numeric key value automatically incremented when you add a DHCPv4 shared network. Use the ID to specify the DHCPv4 shared network of your choice.", + "type": "integer" + }, + "sharednetwork_name": { + "description": "The name of the DHCPv4 shared network.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "scope_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "scope_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dhcp_scope_add_success": { + "example": { + "data": [ + { + "scope_id": "scope_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_scope_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_scope_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_scope_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_scope_edit_success": { + "example": { + "data": [ + { + "scope_id": "scope_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_scope_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_scope_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_scope_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_scope_delete_success": { + "example": { + "data": [ + { + "scope_id": "scope_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_scope_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_scope_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_scope_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_scope6_data": { + "example": { + "data": [ + { + "scope6_delayed_time": "scope6_delayed_time", + "server6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_size": "scope6_size", + "server6_version": "server6_version", + "scope6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server6_name": "server6_name", + "scope6_prefix": "scope6_prefix", + "smart_parent_id": "smart_parent_id", + "scope6_sort_name": "scope6_sort_name", + "scope6_multistatus": "scope6_multistatus", + "failover6_name": "failover6_name", + "smart_parent_name": "smart_parent_name", + "smart_arch": "smart_arch", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "server6_type": "server6_type", + "scope6_space_name": "scope6_space_name", + "failover6_id": "failover6_id", + "server6_addr6": "server6_addr6", + "sharednetwork6_name": "sharednetwork6_name", + "server6_hostaddr": "server6_hostaddr", + "scope6_end_address6_addr": "scope6_end_address6_addr", + "server6_addr": "server6_addr", + "scope6_class_name": "scope6_class_name", + "scope6_name": "scope6_name", + "scope6_space_id": "scope6_space_id", + "scope6_id": "scope6_id", + "sharednetwork6_id": "sharednetwork6_id", + "scope6_start_address6_addr": "scope6_start_address6_addr" + }, + { + "scope6_delayed_time": "scope6_delayed_time", + "server6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_size": "scope6_size", + "server6_version": "server6_version", + "scope6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server6_name": "server6_name", + "scope6_prefix": "scope6_prefix", + "smart_parent_id": "smart_parent_id", + "scope6_sort_name": "scope6_sort_name", + "scope6_multistatus": "scope6_multistatus", + "failover6_name": "failover6_name", + "smart_parent_name": "smart_parent_name", + "smart_arch": "smart_arch", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "server6_type": "server6_type", + "scope6_space_name": "scope6_space_name", + "failover6_id": "failover6_id", + "server6_addr6": "server6_addr6", + "sharednetwork6_name": "sharednetwork6_name", + "server6_hostaddr": "server6_hostaddr", + "scope6_end_address6_addr": "scope6_end_address6_addr", + "server6_addr": "server6_addr", + "scope6_class_name": "scope6_class_name", + "scope6_name": "scope6_name", + "scope6_space_id": "scope6_space_id", + "scope6_id": "scope6_id", + "sharednetwork6_id": "sharednetwork6_id", + "scope6_start_address6_addr": "scope6_start_address6_addr" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_scope6_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_scope6_add_input": { + "properties": { + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "type": "integer" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "scope6_end_addr": { + "description": "The last IP address of the DHCPv6 scope.", + "type": "string" + }, + "scope6_prefix": { + "description": "The prefix of the DHCPv6 scope, an integer that defines the number of address the scope contains.", + "type": "string" + }, + "scope6_start_addr": { + "description": "The first IP address of the DHCPv6 scope.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "failover6_id": { + "description": "The database identifier (ID) of the DHCPv6 failover channel, a unique numeric key value automatically incremented when you add a DHCPv6 failover channel. Use the ID to specify the DHCPv6 failover channel of your choice.", + "type": "integer" + }, + "failover6_name": { + "description": "The name of the DHCPv6 failover channel.", + "type": "string" + }, + "scope6_name": { + "description": "The name of the DHCPv6 scope, each DHCPv6 scope must have a unique name.", + "type": "string" + }, + "scope6_space_id": { + "description": "The database identifier (ID) of an existing space you want to associate with the DHCPv6 scope.", + "type": "integer" + }, + "scope6_space_name": { + "description": "The name of an existing space you want to associate with the DHCPv6 scope.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "scope6_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "scope6_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dhcp_scope6_edit_input": { + "properties": { + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "type": "integer" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "scope6_end_addr": { + "description": "The last IP address of the DHCPv6 scope.", + "type": "string" + }, + "scope6_id": { + "description": "The database identifier (ID) of the DHCPv6 scope, a unique numeric key value automatically incremented when you add a DHCPv6 scope. Use the ID to specify the DHCPv6 scope of your choice.", + "type": "integer" + }, + "scope6_prefix": { + "description": "The prefix of the DHCPv6 scope, an integer that defines the number of address the scope contains.", + "type": "string" + }, + "scope6_start_addr": { + "description": "The first IP address of the DHCPv6 scope.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "failover6_id": { + "description": "The database identifier (ID) of the DHCPv6 failover channel, a unique numeric key value automatically incremented when you add a DHCPv6 failover channel. Use the ID to specify the DHCPv6 failover channel of your choice.", + "type": "integer" + }, + "failover6_name": { + "description": "The name of the DHCPv6 failover channel.", + "type": "string" + }, + "scope6_name": { + "description": "The name of the DHCPv6 scope, each DHCPv6 scope must have a unique name.", + "type": "string" + }, + "scope6_space_id": { + "description": "The database identifier (ID) of an existing space you want to associate with the DHCPv6 scope.", + "type": "integer" + }, + "scope6_space_name": { + "description": "The name of an existing space you want to associate with the DHCPv6 scope.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "scope6_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "scope6_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dhcp_scope6_add_success": { + "example": { + "data": [ + { + "scope6_id": "scope6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_scope6_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_scope6_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_scope6_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_scope6_edit_success": { + "example": { + "data": [ + { + "scope6_id": "scope6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_scope6_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_scope6_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_scope6_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_scope6_delete_success": { + "example": { + "data": [ + { + "scope6_id": "scope6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_scope6_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_scope6_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_scope6_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_server_data": { + "example": { + "data": [ + { + "server_stat_enabled": "server_stat_enabled", + "server_cisco_password": "server_cisco_password", + "server_uboottime": "server_uboottime", + "server_stat_time": "server_stat_time", + "server_ms_use_ssl": "server_ms_use_ssl", + "server_version": "server_version", + "server_stat_niceness": "server_stat_niceness", + "server_multistatus": "server_multistatus", + "service_address_addr": "service_address_addr", + "smart_parent_name": "smart_parent_name", + "server_localtime": "server_localtime", + "smart_ref2_server_id": "smart_ref2_server_id", + "cluster_ssh_keyring_id": "cluster_ssh_keyring_id", + "server_tcp_port": "server_tcp_port", + "server_snmp_timeout": "server_snmp_timeout", + "server_stat_period": "server_stat_period", + "server_windhcp_protocol": "server_windhcp_protocol", + "cluster_hb_hostaddr": "cluster_hb_hostaddr", + "server_ipmdhcp_protocol": "server_ipmdhcp_protocol", + "server_id": "server_id", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "connectionprofile_name": "connectionprofile_name", + "reverse_proxy_conf": "reverse_proxy_conf", + "cluster_peer_server_id": "cluster_peer_server_id", + "server_msrpc_login": "server_msrpc_login", + "cluster_vip_phys_hostaddr": "cluster_vip_phys_hostaddr", + "server_name": "server_name", + "smart_parent_arch": "smart_parent_arch", + "server_cisco_login": "server_cisco_login", + "server_class_name": "server_class_name", + "server_snmp_profile_id": "server_snmp_profile_id", + "smart_ref2_server_name": "smart_ref2_server_name", + "smart_ref1_server_name": "smart_ref1_server_name", + "server_snmp_use_tcp": "server_snmp_use_tcp", + "smart_parent_id": "smart_parent_id", + "server_cisco_use_ssh": "server_cisco_use_ssh", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_https_login": "server_https_login", + "server_cluster_role": "server_cluster_role", + "smart_arch": "smart_arch", + "server_cisco_root_password": "server_cisco_root_password", + "server_state": "server_state", + "server_comment": "server_comment", + "server_synching": "server_synching", + "smart_ref1_server_id": "smart_ref1_server_id", + "server_is_package": "server_is_package", + "server_snmp_port": "server_snmp_port", + "total_smart_members": "total_smart_members", + "server_isolated": "server_isolated", + "smart_param1": "smart_param1", + "server_msrpc_domain": "server_msrpc_domain", + "ref2_server_name": "ref2_server_name", + "server_snmp_retry": "server_snmp_retry", + "ref1_server_name": "ref1_server_name", + "server_snmp_id": "server_snmp_id", + "smart_members_name": "smart_members_name", + "server_type": "server_type" + }, + { + "server_stat_enabled": "server_stat_enabled", + "server_cisco_password": "server_cisco_password", + "server_uboottime": "server_uboottime", + "server_stat_time": "server_stat_time", + "server_ms_use_ssl": "server_ms_use_ssl", + "server_version": "server_version", + "server_stat_niceness": "server_stat_niceness", + "server_multistatus": "server_multistatus", + "service_address_addr": "service_address_addr", + "smart_parent_name": "smart_parent_name", + "server_localtime": "server_localtime", + "smart_ref2_server_id": "smart_ref2_server_id", + "cluster_ssh_keyring_id": "cluster_ssh_keyring_id", + "server_tcp_port": "server_tcp_port", + "server_snmp_timeout": "server_snmp_timeout", + "server_stat_period": "server_stat_period", + "server_windhcp_protocol": "server_windhcp_protocol", + "cluster_hb_hostaddr": "cluster_hb_hostaddr", + "server_ipmdhcp_protocol": "server_ipmdhcp_protocol", + "server_id": "server_id", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "connectionprofile_name": "connectionprofile_name", + "reverse_proxy_conf": "reverse_proxy_conf", + "cluster_peer_server_id": "cluster_peer_server_id", + "server_msrpc_login": "server_msrpc_login", + "cluster_vip_phys_hostaddr": "cluster_vip_phys_hostaddr", + "server_name": "server_name", + "smart_parent_arch": "smart_parent_arch", + "server_cisco_login": "server_cisco_login", + "server_class_name": "server_class_name", + "server_snmp_profile_id": "server_snmp_profile_id", + "smart_ref2_server_name": "smart_ref2_server_name", + "smart_ref1_server_name": "smart_ref1_server_name", + "server_snmp_use_tcp": "server_snmp_use_tcp", + "smart_parent_id": "smart_parent_id", + "server_cisco_use_ssh": "server_cisco_use_ssh", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_https_login": "server_https_login", + "server_cluster_role": "server_cluster_role", + "smart_arch": "smart_arch", + "server_cisco_root_password": "server_cisco_root_password", + "server_state": "server_state", + "server_comment": "server_comment", + "server_synching": "server_synching", + "smart_ref1_server_id": "smart_ref1_server_id", + "server_is_package": "server_is_package", + "server_snmp_port": "server_snmp_port", + "total_smart_members": "total_smart_members", + "server_isolated": "server_isolated", + "smart_param1": "smart_param1", + "server_msrpc_domain": "server_msrpc_domain", + "ref2_server_name": "ref2_server_name", + "server_snmp_retry": "server_snmp_retry", + "ref1_server_name": "ref1_server_name", + "server_snmp_id": "server_snmp_id", + "smart_members_name": "smart_members_name", + "server_type": "server_type" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_server_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_server6_data": { + "example": { + "data": [ + { + "server6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server6_snmp_id": "server6_snmp_id", + "server6_version": "server6_version", + "smart_parent_arch": "smart_parent_arch", + "server6_state": "server6_state", + "smart_ref2_server6_id": "smart_ref2_server6_id", + "server6_stat_period": "server6_stat_period", + "server6_snmp_profile_id": "server6_snmp_profile_id", + "server6_multistatus": "server6_multistatus", + "server6_name": "server6_name", + "server6_stat_time": "server6_stat_time", + "server6_comment": "server6_comment", + "server6_snmp_timeout": "server6_snmp_timeout", + "smart_parent_id": "smart_parent_id", + "smart_parent_name": "smart_parent_name", + "smart_ref1_server6_id": "smart_ref1_server6_id", + "smart_arch": "smart_arch", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "server6_type": "server6_type", + "server6_snmp_port": "server6_snmp_port", + "server6_stat_niceness": "server6_stat_niceness", + "smart_ref1_server6_name": "smart_ref1_server6_name", + "smart_ref2_server6_name": "smart_ref2_server6_name", + "server6_synching": "server6_synching", + "server6_addr6": "server6_addr6", + "total_smart_members": "total_smart_members", + "server6_isolated": "server6_isolated", + "smart_param1": "smart_param1", + "server6_hostaddr": "server6_hostaddr", + "server6_last_refresh_time": "server6_last_refresh_time", + "server6_https_login": "server6_https_login", + "server6_uboottime": "server6_uboottime", + "server6_addr": "server6_addr", + "server6_snmp_retry": "server6_snmp_retry", + "smart_members_name": "smart_members_name", + "server6_snmp_use_tcp": "server6_snmp_use_tcp", + "connectionprofile_name": "connectionprofile_name", + "server6_is_package": "server6_is_package", + "reverse_proxy_conf": "reverse_proxy_conf", + "server6_stat_enabled": "server6_stat_enabled" + }, + { + "server6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server6_snmp_id": "server6_snmp_id", + "server6_version": "server6_version", + "smart_parent_arch": "smart_parent_arch", + "server6_state": "server6_state", + "smart_ref2_server6_id": "smart_ref2_server6_id", + "server6_stat_period": "server6_stat_period", + "server6_snmp_profile_id": "server6_snmp_profile_id", + "server6_multistatus": "server6_multistatus", + "server6_name": "server6_name", + "server6_stat_time": "server6_stat_time", + "server6_comment": "server6_comment", + "server6_snmp_timeout": "server6_snmp_timeout", + "smart_parent_id": "smart_parent_id", + "smart_parent_name": "smart_parent_name", + "smart_ref1_server6_id": "smart_ref1_server6_id", + "smart_arch": "smart_arch", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "server6_type": "server6_type", + "server6_snmp_port": "server6_snmp_port", + "server6_stat_niceness": "server6_stat_niceness", + "smart_ref1_server6_name": "smart_ref1_server6_name", + "smart_ref2_server6_name": "smart_ref2_server6_name", + "server6_synching": "server6_synching", + "server6_addr6": "server6_addr6", + "total_smart_members": "total_smart_members", + "server6_isolated": "server6_isolated", + "smart_param1": "smart_param1", + "server6_hostaddr": "server6_hostaddr", + "server6_last_refresh_time": "server6_last_refresh_time", + "server6_https_login": "server6_https_login", + "server6_uboottime": "server6_uboottime", + "server6_addr": "server6_addr", + "server6_snmp_retry": "server6_snmp_retry", + "smart_members_name": "smart_members_name", + "server6_snmp_use_tcp": "server6_snmp_use_tcp", + "connectionprofile_name": "connectionprofile_name", + "server6_is_package": "server6_is_package", + "reverse_proxy_conf": "reverse_proxy_conf", + "server6_stat_enabled": "server6_stat_enabled" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_server6_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_sharednetwork_data": { + "example": { + "data": [ + { + "server_name": "server_name", + "smart_parent_id": "smart_parent_id", + "sharednetwork_multistatus": "sharednetwork_multistatus", + "sharednetwork_id": "sharednetwork_id", + "sharednetwork_name": "sharednetwork_name", + "server_id": "server_id", + "sharednetwork_delayed_create_time": "sharednetwork_delayed_create_time", + "sharednetwork_delayed_delete_time": "sharednetwork_delayed_delete_time", + "server_type": "server_type" + }, + { + "server_name": "server_name", + "smart_parent_id": "smart_parent_id", + "sharednetwork_multistatus": "sharednetwork_multistatus", + "sharednetwork_id": "sharednetwork_id", + "sharednetwork_name": "sharednetwork_name", + "server_id": "server_id", + "sharednetwork_delayed_create_time": "sharednetwork_delayed_create_time", + "sharednetwork_delayed_delete_time": "sharednetwork_delayed_delete_time", + "server_type": "server_type" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_sharednetwork_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_sharednetwork_add_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "sharednetwork_name": { + "description": "The name of the DHCPv4 shared network, each DHCPv4 shared network must have a unique name.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dhcp_sharednetwork_edit_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "sharednetwork_id": { + "description": "The database identifier (ID) of the DHCPv4 shared network, a unique numeric key value automatically incremented when you add a DHCPv4 shared network. Use the ID to specify the DHCPv4 shared network of your choice.", + "type": "integer" + }, + "sharednetwork_name": { + "description": "The name of the DHCPv4 shared network, each DHCPv4 shared network must have a unique name.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dhcp_sharednetwork_add_success": { + "example": { + "data": [ + { + "sharednetwork_id": "sharednetwork_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_sharednetwork_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_sharednetwork_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_sharednetwork_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_sharednetwork_edit_success": { + "example": { + "data": [ + { + "sharednetwork_id": "sharednetwork_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_sharednetwork_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_sharednetwork_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_sharednetwork_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_sharednetwork_delete_success": { + "example": { + "data": [ + { + "sharednetwork_id": "sharednetwork_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_sharednetwork_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_sharednetwork_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_sharednetwork_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_sharednetwork6_data": { + "example": { + "data": [ + { + "smart_parent_id": "smart_parent_id", + "sharednetwork6_name": "sharednetwork6_name", + "sharednetwork6_multistatus": "sharednetwork6_multistatus", + "sharednetwork6_delayed_time": "sharednetwork6_delayed_time", + "smart_arch": "smart_arch", + "sharednetwork6_id": "sharednetwork6_id", + "server6_id": "server6_id", + "server6_type": "server6_type", + "server6_name": "server6_name" + }, + { + "smart_parent_id": "smart_parent_id", + "sharednetwork6_name": "sharednetwork6_name", + "sharednetwork6_multistatus": "sharednetwork6_multistatus", + "sharednetwork6_delayed_time": "sharednetwork6_delayed_time", + "smart_arch": "smart_arch", + "sharednetwork6_id": "sharednetwork6_id", + "server6_id": "server6_id", + "server6_type": "server6_type", + "server6_name": "server6_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_sharednetwork6_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_sharednetwork6_add_input": { + "properties": { + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "type": "integer" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "sharednetwork6_name": { + "description": "The name of the DHCPv6 shared network.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dhcp_sharednetwork6_edit_input": { + "properties": { + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "type": "integer" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "sharednetwork6_id": { + "description": "The database identifier (ID) of the DHCPv6 shared network, a unique numeric key value automatically incremented when you add a DHCPv6 shared network. Use the ID to specify the DHCPv6 shared network of your choice.", + "type": "integer" + }, + "sharednetwork6_name": { + "description": "The name of the DHCPv6 shared network.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dhcp_sharednetwork6_add_success": { + "example": { + "data": [ + { + "sharednetwork6_id": "sharednetwork6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_sharednetwork6_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_sharednetwork6_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_sharednetwork6_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_sharednetwork6_edit_success": { + "example": { + "data": [ + { + "sharednetwork6_id": "sharednetwork6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_sharednetwork6_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_sharednetwork6_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_sharednetwork6_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_sharednetwork6_delete_success": { + "example": { + "data": [ + { + "sharednetwork6_id": "sharednetwork6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_sharednetwork6_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_sharednetwork6_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_sharednetwork6_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_static_data": { + "example": { + "data": [ + { + "server_name": "server_name", + "static_mac_vendor": "static_mac_vendor", + "sharednetwork_id": "sharednetwork_id", + "server_class_name": "server_class_name", + "group_class_name": "group_class_name", + "scope_start_address_addr": "scope_start_address_addr", + "server_version": "server_version", + "static_multistatus": "static_multistatus", + "scope_name": "scope_name", + "static_mac_addr": "static_mac_addr", + "static_delayed_create_time": "static_delayed_create_time", + "static_delayed_delete_time": "static_delayed_delete_time", + "smart_parent_id": "smart_parent_id", + "scope_id": "scope_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "smart_parent_name": "smart_parent_name", + "scope_size": "scope_size", + "static_last_seen": "static_last_seen", + "static_expire_time": "static_expire_time", + "scope_end_address_addr": "scope_end_address_addr", + "static_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "static_addr": "static_addr", + "group_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "group_name": "group_name", + "static_domain": "static_domain", + "static_id": "static_id", + "sharednetwork_name": "sharednetwork_name", + "static_class_name": "static_class_name", + "server_id": "server_id", + "scope_net_mask": "scope_net_mask", + "scope_net_addr": "scope_net_addr", + "group_id": "group_id", + "scope_space_id": "scope_space_id", + "scope_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "static_address_addr": "static_address_addr", + "static_name": "static_name", + "static_identifier": "static_identifier", + "server_type": "server_type", + "scope_class_name": "scope_class_name" + }, + { + "server_name": "server_name", + "static_mac_vendor": "static_mac_vendor", + "sharednetwork_id": "sharednetwork_id", + "server_class_name": "server_class_name", + "group_class_name": "group_class_name", + "scope_start_address_addr": "scope_start_address_addr", + "server_version": "server_version", + "static_multistatus": "static_multistatus", + "scope_name": "scope_name", + "static_mac_addr": "static_mac_addr", + "static_delayed_create_time": "static_delayed_create_time", + "static_delayed_delete_time": "static_delayed_delete_time", + "smart_parent_id": "smart_parent_id", + "scope_id": "scope_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "smart_parent_name": "smart_parent_name", + "scope_size": "scope_size", + "static_last_seen": "static_last_seen", + "static_expire_time": "static_expire_time", + "scope_end_address_addr": "scope_end_address_addr", + "static_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "static_addr": "static_addr", + "group_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "group_name": "group_name", + "static_domain": "static_domain", + "static_id": "static_id", + "sharednetwork_name": "sharednetwork_name", + "static_class_name": "static_class_name", + "server_id": "server_id", + "scope_net_mask": "scope_net_mask", + "scope_net_addr": "scope_net_addr", + "group_id": "group_id", + "scope_space_id": "scope_space_id", + "scope_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "static_address_addr": "static_address_addr", + "static_name": "static_name", + "static_identifier": "static_identifier", + "server_type": "server_type", + "scope_class_name": "scope_class_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_static_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_static_add_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "static_addr": { + "description": "The IP address associated with the DHCPv4 static.", + "type": "string" + }, + "static_identifier": { + "description": "The host identifier you want to associate with the IPv4 static. An option and value to look for to identify clients and assign them the static, specified as follows: option <option-name> expected value.", + "type": "string" + }, + "static_mac_addr": { + "description": "The MAC address you want to associate with the IPv4 static, it must include the MAC address type. The address has 7 sections, 00:11:22:33:44:55:66 , where 00 indicates the type. For Ethernet, type in 01.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "group_id": { + "description": "The database identifier (ID) of the DHCPv4 group, a unique numeric key value automatically incremented when you add a DHCPv4 group. Use the ID to specify the DHCPv4 group of your choice.", + "type": "integer" + }, + "group_name": { + "description": "The name of the DHCPv4 group.", + "type": "string" + }, + "static_name": { + "description": "The name of the DHCPv4 static, each DHCPv4 static must have a unique name.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "static_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "static_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dhcp_static_edit_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "static_addr": { + "description": "The IP address associated with the DHCPv4 static.", + "type": "string" + }, + "static_id": { + "description": "The database identifier (ID) of the DHCPv4 static, a unique numeric key value automatically incremented when you add a DHCPv4 static. Use the ID to specify the DHCPv4 static of your choice.", + "type": "integer" + }, + "static_identifier": { + "description": "The host identifier you want to associate with the IPv4 static. An option and value to look for to identify clients and assign them the static, specified as follows: option <option-name> expected value.", + "type": "string" + }, + "static_mac_addr": { + "description": "The MAC address you want to associate with the IPv4 static, it must include the MAC address type. The address has 7 sections, 00:11:22:33:44:55:66 , where 00 indicates the type. For Ethernet, type in 01.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "group_id": { + "description": "The database identifier (ID) of the DHCPv4 group, a unique numeric key value automatically incremented when you add a DHCPv4 group. Use the ID to specify the DHCPv4 group of your choice.", + "type": "integer" + }, + "group_name": { + "description": "The name of the DHCPv4 group.", + "type": "string" + }, + "static_name": { + "description": "The name of the DHCPv4 static, each DHCPv4 static must have a unique name.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "static_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "static_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dhcp_static_add_success": { + "example": { + "data": [ + { + "static_id": "static_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_static_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_static_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_static_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_static_edit_success": { + "example": { + "data": [ + { + "static_id": "static_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_static_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_static_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_static_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_static_delete_success": { + "example": { + "data": [ + { + "static_id": "static_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_static_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_static_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_static_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_static6_data": { + "example": { + "data": [ + { + "server6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_size": "scope6_size", + "static6_address6_addr": "static6_address6_addr", + "server6_version": "server6_version", + "static6_prefix6": "static6_prefix6", + "scope6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "static6_prefix6_prefix": "static6_prefix6_prefix", + "static6_mac_vendor": "static6_mac_vendor", + "group6_id": "group6_id", + "server6_name": "server6_name", + "smart_parent_id": "smart_parent_id", + "static6_class_name": "static6_class_name", + "smart_parent_name": "smart_parent_name", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "static6_time": "static6_time", + "static6_prefix6_addr": "static6_prefix6_addr", + "server6_type": "server6_type", + "static6_name": "static6_name", + "static6_client_duid": "static6_client_duid", + "sharednetwork6_name": "sharednetwork6_name", + "group6_name": "group6_name", + "static6_id": "static6_id", + "static6_end_time": "static6_end_time", + "scope6_end_address6_addr": "scope6_end_address6_addr", + "static6_domain": "static6_domain", + "scope6_class_name": "scope6_class_name", + "scope6_name": "scope6_name", + "scope6_space_id": "scope6_space_id", + "static6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_id": "scope6_id", + "static6_multistatus": "static6_multistatus", + "static6_mac_addr": "static6_mac_addr", + "sharednetwork6_id": "sharednetwork6_id", + "group6_class_name": "group6_class_name", + "static6_state": "static6_state", + "scope6_start_address6_addr": "scope6_start_address6_addr", + "static6_delayed_time": "static6_delayed_time", + "group6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ] + }, + { + "server6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_size": "scope6_size", + "static6_address6_addr": "static6_address6_addr", + "server6_version": "server6_version", + "static6_prefix6": "static6_prefix6", + "scope6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "static6_prefix6_prefix": "static6_prefix6_prefix", + "static6_mac_vendor": "static6_mac_vendor", + "group6_id": "group6_id", + "server6_name": "server6_name", + "smart_parent_id": "smart_parent_id", + "static6_class_name": "static6_class_name", + "smart_parent_name": "smart_parent_name", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "static6_time": "static6_time", + "static6_prefix6_addr": "static6_prefix6_addr", + "server6_type": "server6_type", + "static6_name": "static6_name", + "static6_client_duid": "static6_client_duid", + "sharednetwork6_name": "sharednetwork6_name", + "group6_name": "group6_name", + "static6_id": "static6_id", + "static6_end_time": "static6_end_time", + "scope6_end_address6_addr": "scope6_end_address6_addr", + "static6_domain": "static6_domain", + "scope6_class_name": "scope6_class_name", + "scope6_name": "scope6_name", + "scope6_space_id": "scope6_space_id", + "static6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_id": "scope6_id", + "static6_multistatus": "static6_multistatus", + "static6_mac_addr": "static6_mac_addr", + "sharednetwork6_id": "sharednetwork6_id", + "group6_class_name": "group6_class_name", + "static6_state": "static6_state", + "scope6_start_address6_addr": "scope6_start_address6_addr", + "static6_delayed_time": "static6_delayed_time", + "group6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ] + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_static6_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_static6_add_input": { + "properties": { + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "type": "integer" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "static6_client_duid": { + "description": "The client DHCP Unique Identifier (DUID) associated with the DHCPv6 static.", + "type": "string" + }, + "static6_mac_addr": { + "description": "The MAC address you want to associate with the IPv6 static.", + "type": "string" + }, + "static6_name": { + "description": "The name of the DHCPv6 static, each DHCPv6 static must have a unique name.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "group6_id": { + "description": "The database identifier (ID) of the DHCPv6 group, a unique numeric key value automatically incremented when you add a DHCPv6 group. Use the ID to specify the DHCPv6 group of your choice.", + "type": "integer" + }, + "group6_name": { + "description": "The name of the DHCPv6 group.", + "type": "string" + }, + "static6_addr": { + "description": "The IP address associated with the DHCPv6 static.", + "type": "string" + }, + "static6_prefix6": { + "description": "The IP address of the delegated prefix of the DHCPv6 static.", + "type": "string" + }, + "static6_prefix6_addr": { + "description": "The prefix of the delegated prefix of the DHCPv6 static.", + "type": "string" + }, + "static6_prefix6_prefix": { + "description": "The IP address and prefix of the delegated prefix of the DHCPv6 static. You must specify them as follows: <IPv6-address>/<prefix>.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "static6_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "static6_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dhcp_static6_edit_input": { + "properties": { + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "type": "integer" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "static6_client_duid": { + "description": "The client DHCP Unique Identifier (DUID) associated with the DHCPv6 static.", + "type": "string" + }, + "static6_id": { + "description": "The database identifier (ID) of the DHCPv6 static, a unique numeric key value automatically incremented when you add a DHCPv6 static. Use the ID to specify the DHCPv6 static of your choice.", + "type": "integer" + }, + "static6_mac_addr": { + "description": "The MAC address you want to associate with the IPv6 static.", + "type": "string" + }, + "static6_name": { + "description": "The name of the DHCPv6 static, each DHCPv6 static must have a unique name.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "group6_id": { + "description": "The database identifier (ID) of the DHCPv6 group, a unique numeric key value automatically incremented when you add a DHCPv6 group. Use the ID to specify the DHCPv6 group of your choice.", + "type": "integer" + }, + "group6_name": { + "description": "The name of the DHCPv6 group.", + "type": "string" + }, + "static6_addr": { + "description": "The IP address associated with the DHCPv6 static.", + "type": "string" + }, + "static6_prefix6": { + "description": "The IP address of the delegated prefix of the DHCPv6 static.", + "type": "string" + }, + "static6_prefix6_addr": { + "description": "The prefix of the delegated prefix of the DHCPv6 static.", + "type": "string" + }, + "static6_prefix6_prefix": { + "description": "The IP address and prefix of the delegated prefix of the DHCPv6 static. You must specify them as follows: <IPv6-address>/<prefix>.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "static6_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "static6_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dhcp_static6_add_success": { + "example": { + "data": [ + { + "static6_id": "static6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_static6_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_static6_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_static6_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_static6_edit_success": { + "example": { + "data": [ + { + "static6_id": "static6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_static6_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_static6_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_static6_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_static6_delete_success": { + "example": { + "data": [ + { + "static6_id": "static6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_static6_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_static6_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_static6_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_acl_data": { + "example": { + "data": [ + { + "acl_value": "acl_value", + "acl_name": "acl_name", + "acl_id": "acl_id", + "server_id": "server_id" + }, + { + "acl_value": "acl_value", + "acl_name": "acl_name", + "acl_id": "acl_id", + "server_id": "server_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_acl_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_acl_add_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "acl_name": { + "description": "The name of the DNS ACL, each DNS ACL must have a unique name.", + "type": "string" + }, + "acl_value": { + "description": "The values of the DNS ACL in order of priority, as follows: <value_1>;<value_2>... .", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DNS server.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dns_acl_edit_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "acl_id": { + "description": "The database identifier (ID) of the DNS ACL, a unique numeric key value automatically incremented when you add a DNS ACL. Use the ID to specify the DNS ACL of your choice.", + "type": "integer" + }, + "acl_name": { + "description": "The name of the DNS ACL, each DNS ACL must have a unique name.", + "type": "string" + }, + "acl_value": { + "description": "The values of the DNS ACL in order of priority, as follows: <value_1>;<value_2>... .", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DNS server.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dns_acl_add_success": { + "example": { + "data": [ + { + "acl_id": "acl_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_acl_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dns_acl_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_acl_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_acl_edit_success": { + "example": { + "data": [ + { + "acl_id": "acl_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_acl_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dns_acl_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_acl_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_acl_delete_success": { + "example": { + "data": [ + { + "acl_id": "acl_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_acl_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dns_acl_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_acl_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_rr_data": { + "example": { + "data": [ + { + "rr_id": "rr_id", + "rr_value_ip4_addr": "rr_value_ip4_addr", + "server_version": "server_version", + "rr_auth_gsstsig": "rr_auth_gsstsig", + "rr_ttl": "rr_ttl", + "smart_parent_name": "smart_parent_name", + "rr_full_name_utf": "rr_full_name_utf", + "zone_space_name": "zone_space_name", + "zone_type": "zone_type", + "rr_all_value": "rr_all_value", + "view_class_name": "view_class_name", + "rr_type_id": "rr_type_id", + "rr_value1": "rr_value1", + "rr_value_id": "rr_value_id", + "server_id": "server_id", + "rr_glue_id": "rr_glue_id", + "rr_glue": "rr_glue", + "rr_name_id": "rr_name_id", + "rr_delayed_delete_time": "rr_delayed_delete_time", + "rr_last_update_time": "rr_last_update_time", + "zone_masters": "zone_masters", + "zone_is_reverse": "zone_is_reverse", + "view_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "rr_full_name": "rr_full_name", + "rr_last_update_days": "rr_last_update_days", + "server_name": "server_name", + "zone_sort_zone": "zone_sort_zone", + "zone_forwarders": "zone_forwarders", + "server_class_name": "server_class_name", + "zone_class_name": "zone_class_name", + "zone_name": "zone_name", + "rr_name_address_addr": "rr_name_address_addr", + "rr_value7": "rr_value7", + "zone_id": "zone_id", + "rr_value6": "rr_value6", + "rr_delayed_time": "rr_delayed_time", + "rr_class_name": "rr_class_name", + "smart_parent_id": "smart_parent_id", + "rr_value3": "rr_value3", + "rr_value2": "rr_value2", + "rr_value5": "rr_value5", + "rr_value4": "rr_value4", + "rr_type": "rr_type", + "server_cloud": "server_cloud", + "view_name": "view_name", + "server_comment": "server_comment", + "rr_value_address_addr": "rr_value_address_addr", + "view_id": "view_id", + "zone_is_rpz": "zone_is_rpz", + "rr_multistatus": "rr_multistatus", + "rr_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "zone_name_utf": "zone_name_utf", + "rr_name_ip4_addr": "rr_name_ip4_addr", + "rr_delayed_create_time": "rr_delayed_create_time", + "server_type": "server_type" + }, + { + "rr_id": "rr_id", + "rr_value_ip4_addr": "rr_value_ip4_addr", + "server_version": "server_version", + "rr_auth_gsstsig": "rr_auth_gsstsig", + "rr_ttl": "rr_ttl", + "smart_parent_name": "smart_parent_name", + "rr_full_name_utf": "rr_full_name_utf", + "zone_space_name": "zone_space_name", + "zone_type": "zone_type", + "rr_all_value": "rr_all_value", + "view_class_name": "view_class_name", + "rr_type_id": "rr_type_id", + "rr_value1": "rr_value1", + "rr_value_id": "rr_value_id", + "server_id": "server_id", + "rr_glue_id": "rr_glue_id", + "rr_glue": "rr_glue", + "rr_name_id": "rr_name_id", + "rr_delayed_delete_time": "rr_delayed_delete_time", + "rr_last_update_time": "rr_last_update_time", + "zone_masters": "zone_masters", + "zone_is_reverse": "zone_is_reverse", + "view_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "rr_full_name": "rr_full_name", + "rr_last_update_days": "rr_last_update_days", + "server_name": "server_name", + "zone_sort_zone": "zone_sort_zone", + "zone_forwarders": "zone_forwarders", + "server_class_name": "server_class_name", + "zone_class_name": "zone_class_name", + "zone_name": "zone_name", + "rr_name_address_addr": "rr_name_address_addr", + "rr_value7": "rr_value7", + "zone_id": "zone_id", + "rr_value6": "rr_value6", + "rr_delayed_time": "rr_delayed_time", + "rr_class_name": "rr_class_name", + "smart_parent_id": "smart_parent_id", + "rr_value3": "rr_value3", + "rr_value2": "rr_value2", + "rr_value5": "rr_value5", + "rr_value4": "rr_value4", + "rr_type": "rr_type", + "server_cloud": "server_cloud", + "view_name": "view_name", + "server_comment": "server_comment", + "rr_value_address_addr": "rr_value_address_addr", + "view_id": "view_id", + "zone_is_rpz": "zone_is_rpz", + "rr_multistatus": "rr_multistatus", + "rr_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "zone_name_utf": "zone_name_utf", + "rr_name_ip4_addr": "rr_name_ip4_addr", + "rr_delayed_create_time": "rr_delayed_create_time", + "server_type": "server_type" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_rr_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_rr_add_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DNS server.", + "type": "string" + }, + "rr_name": { + "description": "The full name of the DNS resource record. Specify it as value, it can either follow the format <rr-name>.<existing-zone-name>.<extension> or be . (a dot).", + "type": "string" + }, + "rr_type": { + "description": "The type of the DNS resource record.


                                                                                                                                      rr_type possible values
                                                                                                                                      ValueRecord type description
                                                                                                                                      SOAStart of Authority. Defines the zone name, an email contact and various time and refresh values applicable to the zone. It is automatically generated upon creation of a zone and cannot be added manually.
                                                                                                                                      NSName Server. Defines the authoritative name server(s) for the domain (defined by the SOA record) or the subdomain. The NS record that indicates which server has authority over a zone is automatically generated upon the creation of a zone, once the server has been synchronized.
                                                                                                                                      AIPv4 Address. An IPv4 address for a host.
                                                                                                                                      PTRPointer Record. Address Resolution, from an IP address (IPv4 or IPv6) to a host. Used in reverse mapping.
                                                                                                                                      AAAAIPv6 Address. An IPv6 address for a host.
                                                                                                                                      CNAMECanonical Name. An alias name for a host.
                                                                                                                                      MXMail Exchange. The mail server/exchanger that services this zone.
                                                                                                                                      SRVServices record. Defines services available in the zone, for example, LDAP, HTTP, etc...
                                                                                                                                      DNAMEDelegation of Reverse Names. Delegation of reverse addresses primarily in IPv6. (Deprecated, use the CNAME RR instead)
                                                                                                                                      TXTText. Information associated with a name.
                                                                                                                                      DSDelegation Signer, a DNSSEC related RR used to verify the validity of the ZSK of a subdomain.
                                                                                                                                      DNSKEYDNS Key. It contains the public cryptographic key used to sign the zone with DNSSEC.
                                                                                                                                      65534A private type record automatically added to the zone once it is signed with DNSSEC.
                                                                                                                                      HINFOSystem Information. Information about a host: hardware type and operating system description.
                                                                                                                                      MINFOMailbox mail list Information. Defines the mail administrator for a mail list and optionally a mailbox to receive error messages relating to the mail list.
                                                                                                                                      AFSDBAFS Database. Location of the AFS servers.
                                                                                                                                      WKSWell-Known Service. Defines the services and protocols supported by a host. (Deprecated, use the SRV RR instead)
                                                                                                                                      NAPTRNaming Authority Pointer Record. General purpose definition of rule set to be used by applications e.g. VoIP.
                                                                                                                                      NSAPNetwork Service Access Point. Defines record (equivalent of an A record) maps a host name to an endpoint address.


                                                                                                                                      Note that the parameter is not case sensitive, you could type in A or a.", + "enum": [ + "A", + "NS", + "MD", + "MF", + "CNAME", + "SOA", + "MB", + "MG", + "MR", + "NULL", + "WKS", + "PTR", + "HINFO", + "MINFO", + "MX", + "TXT", + "SPF", + "RP", + "AFSDB", + "X25", + "ISDN", + "RT", + "NSAP", + "NSAP_PTR", + "SIG", + "KEY", + "PX", + "GPOS", + "AAAA", + "LOC", + "NXT", + "EID", + "NIMLOC", + "SRV", + "ATMA", + "NAPTR", + "KX", + "CERT", + "A6", + "DNAME", + "OPT", + "DS", + "DNSSIG", + "NSEC", + "DNSKEY", + "NSEC3", + "NSEC3PARAM", + "CDS", + "CDNSKEY", + "CAA", + "TLSA", + "SSHFP", + "OPENPGPKEY", + "URI", + "AVC", + "NINFO", + "DLV", + "DHCID", + "EUI48", + "EUI64", + "NID", + "L32", + "L64", + "HTTPS", + "SVCB" + ], + "type": "string" + }, + "rr_value1": { + "description": "The first or only value required for the DNS resource record, as detailed in the service description.", + "type": "string" + }, + "check_value": { + "description": "A way to check the values of the DNS resource record before upon addition (1) in order to create a record with the same name but with different values.", + "enum": [ + "yes", + "no" + ], + "type": "string" + }, + "view_id": { + "description": "The database identifier (ID) of the DNS view, a unique numeric key value automatically incremented when you add a DNS view. Use the ID to specify the DNS view of your choice.", + "type": "integer" + }, + "view_name": { + "description": "The name of the DNS view.", + "type": "string" + }, + "zone_id": { + "description": "The database identifier (ID) of the DNS zone, a unique numeric key value automatically incremented when you add a DNS zone. Use the ID to specify the DNS zone of your choice.", + "type": "integer" + }, + "zone_name": { + "description": "The name of the DNS zone the object belongs to.", + "type": "string" + }, + "zone_space_id": { + "description": "The database identifier (ID) of the space associated with the DNS zone the record belongs to.", + "type": "integer" + }, + "rr_glue": { + "description": "The shortname of the DNS resource record.", + "type": "string" + }, + "rr_ttl": { + "description": "The time to live of the DNS resource record, in seconds.", + "type": "integer" + }, + "rr_value2": { + "description": "The second value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value3": { + "description": "The third value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value4": { + "description": "The fourth value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value5": { + "description": "The fifth value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value6": { + "description": "The sixth value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value7": { + "description": "The seventh value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "rr_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "rr_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dns_rr_edit_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DNS server.", + "type": "string" + }, + "rr_id": { + "description": "The database identifier (ID) of the DNS resource record, a unique numeric key value automatically incremented when you add a DNS RR. Use the ID to specify the record of your choice.", + "type": "integer" + }, + "rr_name": { + "description": "The full name of the DNS resource record. Specify it as value, it can either follow the format <rr-name>.<existing-zone-name>.<extension> or be . (a dot).", + "type": "string" + }, + "rr_type": { + "description": "The type of the DNS resource record.


                                                                                                                                      rr_type possible values
                                                                                                                                      ValueRecord type description
                                                                                                                                      SOAStart of Authority. Defines the zone name, an email contact and various time and refresh values applicable to the zone. It is automatically generated upon creation of a zone and cannot be added manually.
                                                                                                                                      NSName Server. Defines the authoritative name server(s) for the domain (defined by the SOA record) or the subdomain. The NS record that indicates which server has authority over a zone is automatically generated upon the creation of a zone, once the server has been synchronized.
                                                                                                                                      AIPv4 Address. An IPv4 address for a host.
                                                                                                                                      PTRPointer Record. Address Resolution, from an IP address (IPv4 or IPv6) to a host. Used in reverse mapping.
                                                                                                                                      AAAAIPv6 Address. An IPv6 address for a host.
                                                                                                                                      CNAMECanonical Name. An alias name for a host.
                                                                                                                                      MXMail Exchange. The mail server/exchanger that services this zone.
                                                                                                                                      SRVServices record. Defines services available in the zone, for example, LDAP, HTTP, etc...
                                                                                                                                      DNAMEDelegation of Reverse Names. Delegation of reverse addresses primarily in IPv6. (Deprecated, use the CNAME RR instead)
                                                                                                                                      TXTText. Information associated with a name.
                                                                                                                                      DSDelegation Signer, a DNSSEC related RR used to verify the validity of the ZSK of a subdomain.
                                                                                                                                      DNSKEYDNS Key. It contains the public cryptographic key used to sign the zone with DNSSEC.
                                                                                                                                      65534A private type record automatically added to the zone once it is signed with DNSSEC.
                                                                                                                                      HINFOSystem Information. Information about a host: hardware type and operating system description.
                                                                                                                                      MINFOMailbox mail list Information. Defines the mail administrator for a mail list and optionally a mailbox to receive error messages relating to the mail list.
                                                                                                                                      AFSDBAFS Database. Location of the AFS servers.
                                                                                                                                      WKSWell-Known Service. Defines the services and protocols supported by a host. (Deprecated, use the SRV RR instead)
                                                                                                                                      NAPTRNaming Authority Pointer Record. General purpose definition of rule set to be used by applications e.g. VoIP.
                                                                                                                                      NSAPNetwork Service Access Point. Defines record (equivalent of an A record) maps a host name to an endpoint address.


                                                                                                                                      Note that the parameter is not case sensitive, you could type in A or a.", + "enum": [ + "A", + "NS", + "MD", + "MF", + "CNAME", + "SOA", + "MB", + "MG", + "MR", + "NULL", + "WKS", + "PTR", + "HINFO", + "MINFO", + "MX", + "TXT", + "SPF", + "RP", + "AFSDB", + "X25", + "ISDN", + "RT", + "NSAP", + "NSAP_PTR", + "SIG", + "KEY", + "PX", + "GPOS", + "AAAA", + "LOC", + "NXT", + "EID", + "NIMLOC", + "SRV", + "ATMA", + "NAPTR", + "KX", + "CERT", + "A6", + "DNAME", + "OPT", + "DS", + "DNSSIG", + "NSEC", + "DNSKEY", + "NSEC3", + "NSEC3PARAM", + "CDS", + "CDNSKEY", + "CAA", + "TLSA", + "SSHFP", + "OPENPGPKEY", + "URI", + "AVC", + "NINFO", + "DLV", + "DHCID", + "EUI48", + "EUI64", + "NID", + "L32", + "L64", + "HTTPS", + "SVCB" + ], + "type": "string" + }, + "rr_value1": { + "description": "The first or only value required for the DNS resource record, as detailed in the service description.", + "type": "string" + }, + "check_value": { + "description": "A way to check the values of the DNS resource record before upon addition (1) in order to create a record with the same name but with different values.", + "enum": [ + "yes", + "no" + ], + "type": "string" + }, + "view_id": { + "description": "The database identifier (ID) of the DNS view, a unique numeric key value automatically incremented when you add a DNS view. Use the ID to specify the DNS view of your choice.", + "type": "integer" + }, + "view_name": { + "description": "The name of the DNS view.", + "type": "string" + }, + "zone_id": { + "description": "The database identifier (ID) of the DNS zone, a unique numeric key value automatically incremented when you add a DNS zone. Use the ID to specify the DNS zone of your choice.", + "type": "integer" + }, + "zone_name": { + "description": "The name of the DNS zone the object belongs to.", + "type": "string" + }, + "zone_space_id": { + "description": "The database identifier (ID) of the space associated with the DNS zone the record belongs to.", + "type": "integer" + }, + "rr_glue": { + "description": "The shortname of the DNS resource record.", + "type": "string" + }, + "rr_ttl": { + "description": "The time to live of the DNS resource record, in seconds.", + "type": "integer" + }, + "rr_value2": { + "description": "The second value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value3": { + "description": "The third value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value4": { + "description": "The fourth value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value5": { + "description": "The fifth value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value6": { + "description": "The sixth value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value7": { + "description": "The seventh value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "rr_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "rr_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dns_rr_add_success": { + "example": { + "data": [ + { + "rr_id": "rr_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_rr_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dns_rr_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_rr_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_rr_edit_success": { + "example": { + "data": [ + { + "rr_id": "rr_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_rr_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dns_rr_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_rr_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_rr_delete_success": { + "example": { + "data": [ + { + "rr_id": "rr_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_rr_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dns_rr_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_rr_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_server_data": { + "example": { + "data": [ + { + "server_ipm_protocol": "server_ipm_protocol", + "server_aws_role_arn": "server_aws_role_arn", + "server_stat_enabled": "server_stat_enabled", + "server_dnssec_validation": "server_dnssec_validation", + "server_ipm_type": "server_ipm_type", + "server_stat_time": "server_stat_time", + "server_gss_keytab_id": "server_gss_keytab_id", + "server_ldap_domain": "server_ldap_domain", + "server_version": "server_version", + "server_stat_niceness": "server_stat_niceness", + "server_recursion": "server_recursion", + "server_multistatus": "server_multistatus", + "smart_parent_name": "smart_parent_name", + "server_allow_recursion": "server_allow_recursion", + "server_az_tenantid": "server_az_tenantid", + "server_key_name": "server_key_name", + "server_aws_use_role": "server_aws_use_role", + "server_key_proto": "server_key_proto", + "server_also_notify": "server_also_notify", + "server_allow_query_cache": "server_allow_query_cache", + "server_notify": "server_notify", + "server_rpz_max_policy_ttl": "server_rpz_max_policy_ttl", + "server_stat_period": "server_stat_period", + "server_aws_role_external_id": "server_aws_role_external_id", + "server_id": "server_id", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "server_rpz_qname_wait_recurse": "server_rpz_qname_wait_recurse", + "server_gslb_supported": "server_gslb_supported", + "server_vpc_list": "server_vpc_list", + "server_forward": "server_forward", + "server_aws_role_session_name": "server_aws_role_session_name", + "connectionprofile_name": "connectionprofile_name", + "server_role": "server_role", + "reverse_proxy_conf": "reverse_proxy_conf", + "server_aws_delegation_set": "server_aws_delegation_set", + "server_querylog_state": "server_querylog_state", + "server_name": "server_name", + "smart_parent_arch": "smart_parent_arch", + "server_gss_enabled": "server_gss_enabled", + "server_class_name": "server_class_name", + "server_guardian_stats_only_supported": "server_guardian_stats_only_supported", + "server_forwarders": "server_forwarders", + "server_hybrid": "server_hybrid", + "server_guardian_gui_management_supported": "server_guardian_gui_management_supported", + "server_rpz_break_dnssec": "server_rpz_break_dnssec", + "smart_parent_id": "smart_parent_id", + "server_blast_status": "server_blast_status", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_ipm_is_package": "server_ipm_is_package", + "smart_arch": "smart_arch", + "server_aws_keyid": "server_aws_keyid", + "server_rpz_min_ns_dots": "server_rpz_min_ns_dots", + "server_ipm_login": "server_ipm_login", + "server_az_group": "server_az_group", + "server_state": "server_state", + "server_cloud": "server_cloud", + "server_cloud_private": "server_cloud_private", + "server_blast_enabled": "server_blast_enabled", + "server_az_subscriptionid": "server_az_subscriptionid", + "server_comment": "server_comment", + "server_synching": "server_synching", + "total_smart_members": "total_smart_members", + "server_isolated": "server_isolated", + "server_windns_port": "server_windns_port", + "server_az_keyid": "server_az_keyid", + "server_force_hybrid": "server_force_hybrid", + "smart_public_ns_list": "smart_public_ns_list", + "server_key_value": "server_key_value", + "server_snmp_id": "server_snmp_id", + "server_rpz_recursive_only": "server_rpz_recursive_only", + "smart_members_name": "smart_members_name", + "server_allow_query": "server_allow_query", + "server_ldap_user": "server_ldap_user", + "server_guardian_push_status": "server_guardian_push_status", + "server_guardian_supported": "server_guardian_supported", + "server_windns_protocol": "server_windns_protocol", + "server_allow_transfer": "server_allow_transfer", + "server_windns_use_ssl": "server_windns_use_ssl", + "server_type": "server_type" + }, + { + "server_ipm_protocol": "server_ipm_protocol", + "server_aws_role_arn": "server_aws_role_arn", + "server_stat_enabled": "server_stat_enabled", + "server_dnssec_validation": "server_dnssec_validation", + "server_ipm_type": "server_ipm_type", + "server_stat_time": "server_stat_time", + "server_gss_keytab_id": "server_gss_keytab_id", + "server_ldap_domain": "server_ldap_domain", + "server_version": "server_version", + "server_stat_niceness": "server_stat_niceness", + "server_recursion": "server_recursion", + "server_multistatus": "server_multistatus", + "smart_parent_name": "smart_parent_name", + "server_allow_recursion": "server_allow_recursion", + "server_az_tenantid": "server_az_tenantid", + "server_key_name": "server_key_name", + "server_aws_use_role": "server_aws_use_role", + "server_key_proto": "server_key_proto", + "server_also_notify": "server_also_notify", + "server_allow_query_cache": "server_allow_query_cache", + "server_notify": "server_notify", + "server_rpz_max_policy_ttl": "server_rpz_max_policy_ttl", + "server_stat_period": "server_stat_period", + "server_aws_role_external_id": "server_aws_role_external_id", + "server_id": "server_id", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "server_rpz_qname_wait_recurse": "server_rpz_qname_wait_recurse", + "server_gslb_supported": "server_gslb_supported", + "server_vpc_list": "server_vpc_list", + "server_forward": "server_forward", + "server_aws_role_session_name": "server_aws_role_session_name", + "connectionprofile_name": "connectionprofile_name", + "server_role": "server_role", + "reverse_proxy_conf": "reverse_proxy_conf", + "server_aws_delegation_set": "server_aws_delegation_set", + "server_querylog_state": "server_querylog_state", + "server_name": "server_name", + "smart_parent_arch": "smart_parent_arch", + "server_gss_enabled": "server_gss_enabled", + "server_class_name": "server_class_name", + "server_guardian_stats_only_supported": "server_guardian_stats_only_supported", + "server_forwarders": "server_forwarders", + "server_hybrid": "server_hybrid", + "server_guardian_gui_management_supported": "server_guardian_gui_management_supported", + "server_rpz_break_dnssec": "server_rpz_break_dnssec", + "smart_parent_id": "smart_parent_id", + "server_blast_status": "server_blast_status", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_ipm_is_package": "server_ipm_is_package", + "smart_arch": "smart_arch", + "server_aws_keyid": "server_aws_keyid", + "server_rpz_min_ns_dots": "server_rpz_min_ns_dots", + "server_ipm_login": "server_ipm_login", + "server_az_group": "server_az_group", + "server_state": "server_state", + "server_cloud": "server_cloud", + "server_cloud_private": "server_cloud_private", + "server_blast_enabled": "server_blast_enabled", + "server_az_subscriptionid": "server_az_subscriptionid", + "server_comment": "server_comment", + "server_synching": "server_synching", + "total_smart_members": "total_smart_members", + "server_isolated": "server_isolated", + "server_windns_port": "server_windns_port", + "server_az_keyid": "server_az_keyid", + "server_force_hybrid": "server_force_hybrid", + "smart_public_ns_list": "smart_public_ns_list", + "server_key_value": "server_key_value", + "server_snmp_id": "server_snmp_id", + "server_rpz_recursive_only": "server_rpz_recursive_only", + "smart_members_name": "smart_members_name", + "server_allow_query": "server_allow_query", + "server_ldap_user": "server_ldap_user", + "server_guardian_push_status": "server_guardian_push_status", + "server_guardian_supported": "server_guardian_supported", + "server_windns_protocol": "server_windns_protocol", + "server_allow_transfer": "server_allow_transfer", + "server_windns_use_ssl": "server_windns_use_ssl", + "server_type": "server_type" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_server_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_view_data": { + "example": { + "data": [ + { + "server_name": "server_name", + "view_order": "view_order", + "server_class_name": "server_class_name", + "server_gss_keytab_id": "server_gss_keytab_id", + "server_version": "server_version", + "view_allow_transfer": "view_allow_transfer", + "view_delayed_create_time": "view_delayed_create_time", + "view_delayed_delete_time": "view_delayed_delete_time", + "view_recursion": "view_recursion", + "smart_parent_id": "smart_parent_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "smart_parent_name": "smart_parent_name", + "server_cloud": "server_cloud", + "view_name": "view_name", + "server_comment": "server_comment", + "view_class_name": "view_class_name", + "view_key_name": "view_key_name", + "view_id": "view_id", + "server_id": "server_id", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "view_multistatus": "view_multistatus", + "view_match_clients": "view_match_clients", + "view_match_to": "view_match_to", + "view_allow_recursion": "view_allow_recursion", + "view_allow_query": "view_allow_query", + "view_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_type": "server_type" + }, + { + "server_name": "server_name", + "view_order": "view_order", + "server_class_name": "server_class_name", + "server_gss_keytab_id": "server_gss_keytab_id", + "server_version": "server_version", + "view_allow_transfer": "view_allow_transfer", + "view_delayed_create_time": "view_delayed_create_time", + "view_delayed_delete_time": "view_delayed_delete_time", + "view_recursion": "view_recursion", + "smart_parent_id": "smart_parent_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "smart_parent_name": "smart_parent_name", + "server_cloud": "server_cloud", + "view_name": "view_name", + "server_comment": "server_comment", + "view_class_name": "view_class_name", + "view_key_name": "view_key_name", + "view_id": "view_id", + "server_id": "server_id", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "view_multistatus": "view_multistatus", + "view_match_clients": "view_match_clients", + "view_match_to": "view_match_to", + "view_allow_recursion": "view_allow_recursion", + "view_allow_query": "view_allow_query", + "view_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_type": "server_type" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_view_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_view_add_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "view_name": { + "description": "The name of the DNS view, each DNS view must have a unique name.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DNS server.", + "type": "string" + }, + "view_allow_query": { + "description": "The ACL values associated with the allow-query configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_allow_recursion": { + "description": "The ACL values associated with the allow-recursion configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_allow_transfer": { + "description": "The ACL values associated with the allow-transfer configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_match_clients": { + "description": "The ACL values associated with the match clients configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_match_to": { + "description": "The ACL values associated with the match destination configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_order": { + "description": "The level of the DNS view, where 0 represents the highest level in the views hierarchy. The parameters dnsview_match_client and view_match_to of each view in a server are reviewed following this order.", + "type": "integer" + }, + "view_recursion": { + "description": "The recursion status of the DNS view:


                                                                                                                                      view_recursion possible values
                                                                                                                                      StatusDescription
                                                                                                                                      noThe view only provides iterative query behavior - normally resulting in a referral. If the answer to the query already exists in the cache it will be returned whatever the value of this statement.
                                                                                                                                      yesThe view always provides recursive query behavior if requested by the client.


                                                                                                                                      ", + "enum": [ + "yes", + "no" + ], + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "view_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "view_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dns_view_edit_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "view_id": { + "description": "The database identifier (ID) of the DNS view, a unique numeric key value automatically incremented when you add a DNS view. Use the ID to specify the DNS view of your choice.", + "type": "integer" + }, + "view_name": { + "description": "The name of the DNS view, each DNS view must have a unique name.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DNS server.", + "type": "string" + }, + "view_allow_query": { + "description": "The ACL values associated with the allow-query configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_allow_recursion": { + "description": "The ACL values associated with the allow-recursion configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_allow_transfer": { + "description": "The ACL values associated with the allow-transfer configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_match_clients": { + "description": "The ACL values associated with the match clients configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_match_to": { + "description": "The ACL values associated with the match destination configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_order": { + "description": "The level of the DNS view, where 0 represents the highest level in the views hierarchy. The parameters dnsview_match_client and view_match_to of each view in a server are reviewed following this order.", + "type": "integer" + }, + "view_recursion": { + "description": "The recursion status of the DNS view:


                                                                                                                                      view_recursion possible values
                                                                                                                                      StatusDescription
                                                                                                                                      noThe view only provides iterative query behavior - normally resulting in a referral. If the answer to the query already exists in the cache it will be returned whatever the value of this statement.
                                                                                                                                      yesThe view always provides recursive query behavior if requested by the client.


                                                                                                                                      ", + "enum": [ + "yes", + "no" + ], + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "view_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "view_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dns_view_add_success": { + "example": { + "data": [ + { + "view_id": "view_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_view_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dns_view_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_view_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_view_edit_success": { + "example": { + "data": [ + { + "view_id": "view_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_view_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dns_view_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_view_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_view_delete_success": { + "example": { + "data": [ + { + "view_id": "view_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_view_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dns_view_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_view_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_viewparam_data": { + "example": { + "data": [ + { + "server_name": "server_name", + "viewparam_key": "viewparam_key", + "viewparam_delayed_delete_time": "viewparam_delayed_delete_time", + "viewparam_delayed_create_time": "viewparam_delayed_create_time", + "viewparam_value": "viewparam_value", + "view_id": "view_id", + "oid": "oid", + "server_id": "server_id", + "view_name": "view_name" + }, + { + "server_name": "server_name", + "viewparam_key": "viewparam_key", + "viewparam_delayed_delete_time": "viewparam_delayed_delete_time", + "viewparam_delayed_create_time": "viewparam_delayed_create_time", + "viewparam_value": "viewparam_value", + "view_id": "view_id", + "oid": "oid", + "server_id": "server_id", + "view_name": "view_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_viewparam_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_viewparam_add_input": { + "properties": { + "view_id": { + "description": "The database identifier (ID) of the DNS view. Use the ID to specify the DNS view of your choice.", + "type": "integer" + }, + "viewparam_key": { + "description": "The name of the DNS option you want to add, edit or remove from the view. You can only set one option at a time.
                                                                                                                                      • To add or edit an option: specify its name in the parameter viewparam_key, as follows viewparam_key=<option-name>, and then specify its value in the parameter viewparam_value.
                                                                                                                                      • To remove an option, specify its name in the parameter viewparam_key and leave the parameter viewparam_value empty.
                                                                                                                                      To set several options, specify as many parameters (viewparam_key and viewparam_value) as you need.", + "type": "string" + }, + "viewparam_is_array": { + "description": "A way to determine is the DNS view option is an array (1).", + "type": "integer" + }, + "viewparam_value": { + "description": "The value of the DNS option specified in the input viewparam_key.
                                                                                                                                      • To add or edit an option value, specify its name in the parameter viewparam_key and set its value as follows: viewparam_value=<option-value> .
                                                                                                                                      • To remove an option value, specify its name in the parameter viewparam_key and leave viewparam_value empty: viewparam_value= .
                                                                                                                                      ", + "type": "string" + } + }, + "type": "object" + }, + "dns_viewparam_edit_input": { + "properties": { + "view_id": { + "description": "The database identifier (ID) of the DNS view. Use the ID to specify the DNS view of your choice.", + "type": "integer" + }, + "viewparam_key": { + "description": "The name of the DNS option you want to add, edit or remove from the view. You can only set one option at a time.
                                                                                                                                      • To add or edit an option: specify its name in the parameter viewparam_key, as follows viewparam_key=<option-name>, and then specify its value in the parameter viewparam_value.
                                                                                                                                      • To remove an option, specify its name in the parameter viewparam_key and leave the parameter viewparam_value empty.
                                                                                                                                      To set several options, specify as many parameters (viewparam_key and viewparam_value) as you need.", + "type": "string" + }, + "viewparam_is_array": { + "description": "A way to determine is the DNS view option is an array (1).", + "type": "integer" + }, + "viewparam_value": { + "description": "The value of the DNS option specified in the input viewparam_key.
                                                                                                                                      • To add or edit an option value, specify its name in the parameter viewparam_key and set its value as follows: viewparam_value=<option-value> .
                                                                                                                                      • To remove an option value, specify its name in the parameter viewparam_key and leave viewparam_value empty: viewparam_value= .
                                                                                                                                      ", + "type": "string" + } + }, + "type": "object" + }, + "dns_viewparam_add_success": { + "example": { + "data": [ + { + "viewparam_id": "viewparam_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_viewparam_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dns_viewparam_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_viewparam_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_viewparam_edit_success": { + "example": { + "data": [ + { + "viewparam_id": "viewparam_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_viewparam_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dns_viewparam_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_viewparam_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_viewparam_delete_success": { + "example": { + "data": [ + { + "viewparam_id": "viewparam_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_viewparam_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dns_viewparam_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_viewparam_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_zone_data": { + "example": { + "data": [ + { + "server_ipm_protocol": "server_ipm_protocol", + "zone_space_id": "zone_space_id", + "zone_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_ipm_type": "server_ipm_type", + "server_gss_keytab_id": "server_gss_keytab_id", + "server_version": "server_version", + "smart_parent_name": "smart_parent_name", + "zone_response_policy": "zone_response_policy", + "zone_rpz_log": "zone_rpz_log", + "zone_space_name": "zone_space_name", + "zone_type": "zone_type", + "zone_allow_update": "zone_allow_update", + "zone_rev_sort_zone": "zone_rev_sort_zone", + "zone_ad_integrated": "zone_ad_integrated", + "zone_forward": "zone_forward", + "view_class_name": "view_class_name", + "zone_allow_transfer": "zone_allow_transfer", + "zone_also_notify": "zone_also_notify", + "zone_synching": "zone_synching", + "zone_rpz_recursive_only": "zone_rpz_recursive_only", + "zone_use_update_policy": "zone_use_update_policy", + "server_id": "server_id", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "server_vpc_list": "server_vpc_list", + "zone_xfer_done": "zone_xfer_done", + "zone_masters": "zone_masters", + "zone_is_reverse": "zone_is_reverse", + "zone_notify": "zone_notify", + "server_aws_delegation_set": "server_aws_delegation_set", + "view_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_name": "server_name", + "zone_num_keys": "zone_num_keys", + "server_gss_enabled": "server_gss_enabled", + "zone_sort_zone": "zone_sort_zone", + "zone_forwarders": "zone_forwarders", + "server_class_name": "server_class_name", + "zone_class_name": "zone_class_name", + "zone_name": "zone_name", + "zone_order": "zone_order", + "zone_delayed_create_time": "zone_delayed_create_time", + "zone_id": "zone_id", + "smart_parent_id": "smart_parent_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "zone_ds": "zone_ds", + "server_state": "server_state", + "server_cloud": "server_cloud", + "view_name": "view_name", + "server_comment": "server_comment", + "view_id": "view_id", + "zone_delayed_delete_time": "zone_delayed_delete_time", + "zone_is_rpz": "zone_is_rpz", + "server_force_hybrid": "server_force_hybrid", + "zone_rpz_max_policy_ttl": "zone_rpz_max_policy_ttl", + "server_ddns_scavenging": "server_ddns_scavenging", + "zone_name_utf": "zone_name_utf", + "zone_allow_query": "zone_allow_query", + "zone_multistatus": "zone_multistatus", + "server_type": "server_type" + }, + { + "server_ipm_protocol": "server_ipm_protocol", + "zone_space_id": "zone_space_id", + "zone_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_ipm_type": "server_ipm_type", + "server_gss_keytab_id": "server_gss_keytab_id", + "server_version": "server_version", + "smart_parent_name": "smart_parent_name", + "zone_response_policy": "zone_response_policy", + "zone_rpz_log": "zone_rpz_log", + "zone_space_name": "zone_space_name", + "zone_type": "zone_type", + "zone_allow_update": "zone_allow_update", + "zone_rev_sort_zone": "zone_rev_sort_zone", + "zone_ad_integrated": "zone_ad_integrated", + "zone_forward": "zone_forward", + "view_class_name": "view_class_name", + "zone_allow_transfer": "zone_allow_transfer", + "zone_also_notify": "zone_also_notify", + "zone_synching": "zone_synching", + "zone_rpz_recursive_only": "zone_rpz_recursive_only", + "zone_use_update_policy": "zone_use_update_policy", + "server_id": "server_id", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "server_vpc_list": "server_vpc_list", + "zone_xfer_done": "zone_xfer_done", + "zone_masters": "zone_masters", + "zone_is_reverse": "zone_is_reverse", + "zone_notify": "zone_notify", + "server_aws_delegation_set": "server_aws_delegation_set", + "view_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_name": "server_name", + "zone_num_keys": "zone_num_keys", + "server_gss_enabled": "server_gss_enabled", + "zone_sort_zone": "zone_sort_zone", + "zone_forwarders": "zone_forwarders", + "server_class_name": "server_class_name", + "zone_class_name": "zone_class_name", + "zone_name": "zone_name", + "zone_order": "zone_order", + "zone_delayed_create_time": "zone_delayed_create_time", + "zone_id": "zone_id", + "smart_parent_id": "smart_parent_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "zone_ds": "zone_ds", + "server_state": "server_state", + "server_cloud": "server_cloud", + "view_name": "view_name", + "server_comment": "server_comment", + "view_id": "view_id", + "zone_delayed_delete_time": "zone_delayed_delete_time", + "zone_is_rpz": "zone_is_rpz", + "server_force_hybrid": "server_force_hybrid", + "zone_rpz_max_policy_ttl": "zone_rpz_max_policy_ttl", + "server_ddns_scavenging": "server_ddns_scavenging", + "zone_name_utf": "zone_name_utf", + "zone_allow_query": "zone_allow_query", + "zone_multistatus": "zone_multistatus", + "server_type": "server_type" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_zone_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_zone_add_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "view_id": { + "description": "The database identifier (ID) of the DNS view the object belongs to.", + "type": "integer" + }, + "view_name": { + "description": "The name of the DNS view the object belongs to.", + "type": "string" + }, + "zone_name": { + "description": "The name of the DNS zone, each DNS zone must have a unique name. For hint zones (zone_type: hint), you must type in . (dot) as zone_name.", + "type": "string" + }, + "zone_type": { + "description": "The type of the DNS zone, either master, slave, forward, stub, hint or delegation-only.", + "enum": [ + "master", + "slave", + "hint", + "stub", + "forward", + "delegation-only" + ], + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DNS server.", + "type": "string" + }, + "server_ddns_scavenging": { + "description": "The DDNS scavenging status of the zone. Set it to 1 to enable the scavenging and automatically delete the stale resource records dynamically added via GSS-TSIG. DDNS scavenging is only effective if the parameters zone_use_update_policy and gss_enabled are set to 1, and the rule 416 is enabled in the GUI.", + "type": "integer" + }, + "zone_ad_integrated": { + "description": "The AD integrated status of the DNS zone. Set it to 1 to indicate that the DNS zone belongs to an Active Directory integrated Microsoft Windows DNS server.", + "type": "integer" + }, + "zone_allow_query": { + "description": "The ACL values associated with the allow-query configuration of the DNS zone, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "zone_allow_transfer": { + "description": "The ACL values associated with the allow-transfer configuration of the DNS zone, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "zone_allow_update": { + "description": "The ACL values associated with the allow-update configuration of the DNS zone, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "zone_also_notify": { + "description": "The IP address and port of the DNS server managing the smart architecture the DNS zone belongs to. If the parameter zone_notify is set to yes or explicit, the server specified is instantly notified of any slave zones updates.", + "type": "string" + }, + "zone_forward": { + "description": "The forwarding mode of the DNS zone.


                                                                                                                                      zone_forward possible values
                                                                                                                                      StatusDescription
                                                                                                                                      firstThe zone sends the queries to the forwarder(s). If no answer is returned, it attempts to answer the queries on its own.
                                                                                                                                      onlyThe zone only forwards the queries to the forwarder(s). Required by some reverse forward zones (e.g., in the case of private addresses).


                                                                                                                                      If the parameter has no value, it indicates that the forwarding is disabled.", + "enum": [ + "none", + "first", + "only", + "default" + ], + "type": "string" + }, + "zone_forwarders": { + "description": "The IP address(es) of the forwarder(s) associated with the DNS zone. It lists the DNS servers to which any unknown query on this zone should be sent, as follows: <ip_address1>;<ip_address2>;... .", + "type": "string" + }, + "zone_is_rpz": { + "description": "The RPZ status of the DNS zone. Set it to 1 to indicate that the DNS zone is a Response Policy Zone.", + "type": "integer" + }, + "zone_masters": { + "description": "For slave DNS zones, the IP address of the DNS server and, if relevant, the name of the DNS view that contain the master DNS zone, as follows: <ip_addr>; or <ip_addr> key <dnsview_name>; .", + "type": "string" + }, + "zone_notify": { + "description": "The notify status of the DNS zone.


                                                                                                                                      zone_notify possible values
                                                                                                                                      StatusDescription
                                                                                                                                      noNo notify message is sent.
                                                                                                                                      yesA notify message is sent to the name servers defined in the NS records of the zone and to the IP address(es) specified in the parameter .
                                                                                                                                      explicitA notify message is sent only to the IP address(es) specified in the parameter .


                                                                                                                                      The notify message is not sent to the server itself or to the primary server defined in the SOA record of the zone.", + "enum": [ + "yes", + "no", + "explicit" + ], + "type": "string" + }, + "zone_order": { + "description": "The level of the RPZ zone, where 0 represents the highest level in the views hierarchy. The RPZ rules of each zone are reviewed following this order. For non-RPZ zones, that have their parameter zone_is_rpz set to 0, you do not need to set this parameter.", + "type": "integer" + }, + "zone_response_policy": { + "description": "The response policy of the DNS zone. All the zones can be set with the policy given, only RPZ zones can be set with other policies.


                                                                                                                                      zone_response_policy possible values
                                                                                                                                      PolicyDescription
                                                                                                                                      givenAll the rules specified in the RPZ zone are applied normally.
                                                                                                                                      disabledThe RPZ zone rules configuration is not applied. All the rules it contains are ignored.
                                                                                                                                      passthruThe rules specified in the RPZ matching the listed RR names are ignored, no matter the RPZ zone they belong to.
                                                                                                                                      nxdomainThe rules specified in the RPZ return an NXDOMAIN response.
                                                                                                                                      nodataThe rules specified in the RPZ return a NODATA response.
                                                                                                                                      cname All the rules specified in the RPZ are redirected toward the specified domain name.


                                                                                                                                      You can only add RPZ zones on EfficientIP or BIND DNS servers.", + "type": "string" + }, + "zone_rpz_log": { + "description": "The RPZ logging status, if zone_is_rpz is set to 1 or yes. It allows you to log all the operations triggered by the RPZ rules of the zone.", + "type": "integer" + }, + "zone_rpz_max_policy_ttl": { + "description": "A way to set the number of seconds of the max policy Time To Live of the zone. By default, the parameter is empty, and the Server max policy TTL of the zone is of 5 seconds. It overrides the same option set at server level.", + "type": "integer" + }, + "zone_rpz_recursive_only": { + "description": "A way to Enable recursive-only on the server for the zone. By default it is enabled (1) and, for this zone, the server only processes policies on recursive queries. It overrides the same option set at server level.", + "type": "integer" + }, + "zone_space_id": { + "description": "The database identifier (ID) of the space associated with the DNS zone the record belongs to.", + "type": "integer" + }, + "zone_space_name": { + "description": "The name of the space associated with the DNS zone the record belongs to.", + "type": "string" + }, + "row_state": { + "description": "The object activation status.
                                                                                                                                      • If set to 0, the object is present in the database but ignored, i.e. it cannot be managed, counted or listed. This status is applied on objects deleted from the GUI.
                                                                                                                                      • If set to 1, the object is enabled and managed.
                                                                                                                                      • If set to 2, the object is unmanaged, disabled or both depending on the context.
                                                                                                                                      By default, row_state is set to 1 when an object is created.", + "type": "integer" + }, + "zone_use_update_policy": { + "description": "The update policy status of the DNS zone. Set it to 1 to indicate that the DNS zone uses a specific GSS-TSIG/update-policy. You can only configure the zone update policy if the parameter gss_enabled is set to 1.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "zone_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "zone_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dns_zone_edit_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "view_id": { + "description": "The database identifier (ID) of the DNS view the object belongs to.", + "type": "integer" + }, + "view_name": { + "description": "The name of the DNS view the object belongs to.", + "type": "string" + }, + "zone_id": { + "description": "The database identifier (ID) of the DNS zone, a unique numeric key value automatically incremented when you add a DNS zone. Use the ID to specify the DNS zone of your choice.", + "type": "integer" + }, + "zone_name": { + "description": "The name of the DNS zone, each DNS zone must have a unique name. For hint zones (zone_type: hint), you must type in . (dot) as zone_name.", + "type": "string" + }, + "zone_type": { + "description": "The type of the DNS zone, either master, slave, forward, stub, hint or delegation-only.", + "enum": [ + "master", + "slave", + "hint", + "stub", + "forward", + "delegation-only" + ], + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DNS server.", + "type": "string" + }, + "server_ddns_scavenging": { + "description": "The DDNS scavenging status of the zone. Set it to 1 to enable the scavenging and automatically delete the stale resource records dynamically added via GSS-TSIG. DDNS scavenging is only effective if the parameters zone_use_update_policy and gss_enabled are set to 1, and the rule 416 is enabled in the GUI.", + "type": "integer" + }, + "zone_ad_integrated": { + "description": "The AD integrated status of the DNS zone. Set it to 1 to indicate that the DNS zone belongs to an Active Directory integrated Microsoft Windows DNS server.", + "type": "integer" + }, + "zone_allow_query": { + "description": "The ACL values associated with the allow-query configuration of the DNS zone, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "zone_allow_transfer": { + "description": "The ACL values associated with the allow-transfer configuration of the DNS zone, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "zone_allow_update": { + "description": "The ACL values associated with the allow-update configuration of the DNS zone, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "zone_also_notify": { + "description": "The IP address and port of the DNS server managing the smart architecture the DNS zone belongs to. If the parameter zone_notify is set to yes or explicit, the server specified is instantly notified of any slave zones updates.", + "type": "string" + }, + "zone_forward": { + "description": "The forwarding mode of the DNS zone.


                                                                                                                                      zone_forward possible values
                                                                                                                                      StatusDescription
                                                                                                                                      firstThe zone sends the queries to the forwarder(s). If no answer is returned, it attempts to answer the queries on its own.
                                                                                                                                      onlyThe zone only forwards the queries to the forwarder(s). Required by some reverse forward zones (e.g., in the case of private addresses).


                                                                                                                                      If the parameter has no value, it indicates that the forwarding is disabled.", + "enum": [ + "none", + "first", + "only", + "default" + ], + "type": "string" + }, + "zone_forwarders": { + "description": "The IP address(es) of the forwarder(s) associated with the DNS zone. It lists the DNS servers to which any unknown query on this zone should be sent, as follows: <ip_address1>;<ip_address2>;... .", + "type": "string" + }, + "zone_is_rpz": { + "description": "The RPZ status of the DNS zone. Set it to 1 to indicate that the DNS zone is a Response Policy Zone.", + "type": "integer" + }, + "zone_masters": { + "description": "For slave DNS zones, the IP address of the DNS server and, if relevant, the name of the DNS view that contain the master DNS zone, as follows: <ip_addr>; or <ip_addr> key <dnsview_name>; .", + "type": "string" + }, + "zone_notify": { + "description": "The notify status of the DNS zone.


                                                                                                                                      zone_notify possible values
                                                                                                                                      StatusDescription
                                                                                                                                      noNo notify message is sent.
                                                                                                                                      yesA notify message is sent to the name servers defined in the NS records of the zone and to the IP address(es) specified in the parameter .
                                                                                                                                      explicitA notify message is sent only to the IP address(es) specified in the parameter .


                                                                                                                                      The notify message is not sent to the server itself or to the primary server defined in the SOA record of the zone.", + "enum": [ + "yes", + "no", + "explicit" + ], + "type": "string" + }, + "zone_order": { + "description": "The level of the RPZ zone, where 0 represents the highest level in the views hierarchy. The RPZ rules of each zone are reviewed following this order. For non-RPZ zones, that have their parameter zone_is_rpz set to 0, you do not need to set this parameter.", + "type": "integer" + }, + "zone_response_policy": { + "description": "The response policy of the DNS zone. All the zones can be set with the policy given, only RPZ zones can be set with other policies.


                                                                                                                                      zone_response_policy possible values
                                                                                                                                      PolicyDescription
                                                                                                                                      givenAll the rules specified in the RPZ zone are applied normally.
                                                                                                                                      disabledThe RPZ zone rules configuration is not applied. All the rules it contains are ignored.
                                                                                                                                      passthruThe rules specified in the RPZ matching the listed RR names are ignored, no matter the RPZ zone they belong to.
                                                                                                                                      nxdomainThe rules specified in the RPZ return an NXDOMAIN response.
                                                                                                                                      nodataThe rules specified in the RPZ return a NODATA response.
                                                                                                                                      cname All the rules specified in the RPZ are redirected toward the specified domain name.


                                                                                                                                      You can only add RPZ zones on EfficientIP or BIND DNS servers.", + "type": "string" + }, + "zone_rpz_log": { + "description": "The RPZ logging status, if zone_is_rpz is set to 1 or yes. It allows you to log all the operations triggered by the RPZ rules of the zone.", + "type": "integer" + }, + "zone_rpz_max_policy_ttl": { + "description": "A way to set the number of seconds of the max policy Time To Live of the zone. By default, the parameter is empty, and the Server max policy TTL of the zone is of 5 seconds. It overrides the same option set at server level.", + "type": "integer" + }, + "zone_rpz_recursive_only": { + "description": "A way to Enable recursive-only on the server for the zone. By default it is enabled (1) and, for this zone, the server only processes policies on recursive queries. It overrides the same option set at server level.", + "type": "integer" + }, + "zone_space_id": { + "description": "The database identifier (ID) of the space associated with the DNS zone the record belongs to.", + "type": "integer" + }, + "zone_space_name": { + "description": "The name of the space associated with the DNS zone the record belongs to.", + "type": "string" + }, + "row_state": { + "description": "The object activation status.
                                                                                                                                      • If set to 0, the object is present in the database but ignored, i.e. it cannot be managed, counted or listed. This status is applied on objects deleted from the GUI.
                                                                                                                                      • If set to 1, the object is enabled and managed.
                                                                                                                                      • If set to 2, the object is unmanaged, disabled or both depending on the context.
                                                                                                                                      By default, row_state is set to 1 when an object is created.", + "type": "integer" + }, + "zone_use_update_policy": { + "description": "The update policy status of the DNS zone. Set it to 1 to indicate that the DNS zone uses a specific GSS-TSIG/update-policy. You can only configure the zone update policy if the parameter gss_enabled is set to 1.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "zone_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "zone_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dns_zone_add_success": { + "example": { + "data": [ + { + "zone_id": "zone_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_zone_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dns_zone_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_zone_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_zone_edit_success": { + "example": { + "data": [ + { + "zone_id": "zone_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_zone_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dns_zone_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_zone_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_zone_delete_success": { + "example": { + "data": [ + { + "zone_id": "zone_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_zone_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dns_zone_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_zone_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_zoneparam_data": { + "example": { + "data": [ + { + "server_name": "server_name", + "zone_id": "zone_id", + "zoneparam_key": "zoneparam_key", + "zoneparam_delayed_delete_time": "zoneparam_delayed_delete_time", + "zoneparam_delayed_create_time": "zoneparam_delayed_create_time", + "zoneparam_value": "zoneparam_value", + "zone_name": "zone_name", + "oid": "oid", + "server_id": "server_id" + }, + { + "server_name": "server_name", + "zone_id": "zone_id", + "zoneparam_key": "zoneparam_key", + "zoneparam_delayed_delete_time": "zoneparam_delayed_delete_time", + "zoneparam_delayed_create_time": "zoneparam_delayed_create_time", + "zoneparam_value": "zoneparam_value", + "zone_name": "zone_name", + "oid": "oid", + "server_id": "server_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_zoneparam_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_zoneparam_add_input": { + "properties": { + "zone_id": { + "description": "The database identifier (ID) of the DNS zone, a unique numeric key value automatically incremented when you add a DNS zone. Use the ID to specify the DNS zone of your choice.", + "type": "integer" + }, + "zoneparam_key": { + "description": "The name of the DNS option you want to add, edit or remove from the zone. You can only set one option at a time.
                                                                                                                                      • To add or edit an option: specify its name in the parameter zoneparam_key, as follows zoneparam_key=<option-name>, and then specify its value in the parameter zoneparam_value.
                                                                                                                                      • To remove an option, specify its name in the parameter zoneparam_key and leave the parameter zoneparam_value empty.
                                                                                                                                      To set several options, specify as many parameters (zoneparam_key and zoneparam_value) as you need.", + "type": "string" + }, + "zoneparam_is_array": { + "description": "A way to determine is the DNS zone option is an array (1).", + "type": "integer" + }, + "zoneparam_value": { + "description": "The value of the DNS option specified in the input zoneparam_key.
                                                                                                                                      • To add or edit an option value, specify its name in the parameter zoneparam_key and set its value as follows: zoneparam_value=<option-value> .
                                                                                                                                      • To remove an option value, specify its name in the parameter zoneparam_key and leave zoneparam_value empty: zoneparam_value= .
                                                                                                                                      ", + "type": "string" + } + }, + "type": "object" + }, + "dns_zoneparam_edit_input": { + "properties": { + "zone_id": { + "description": "The database identifier (ID) of the DNS zone, a unique numeric key value automatically incremented when you add a DNS zone. Use the ID to specify the DNS zone of your choice.", + "type": "integer" + }, + "zoneparam_key": { + "description": "The name of the DNS option you want to add, edit or remove from the zone. You can only set one option at a time.
                                                                                                                                      • To add or edit an option: specify its name in the parameter zoneparam_key, as follows zoneparam_key=<option-name>, and then specify its value in the parameter zoneparam_value.
                                                                                                                                      • To remove an option, specify its name in the parameter zoneparam_key and leave the parameter zoneparam_value empty.
                                                                                                                                      To set several options, specify as many parameters (zoneparam_key and zoneparam_value) as you need.", + "type": "string" + }, + "zoneparam_is_array": { + "description": "A way to determine is the DNS zone option is an array (1).", + "type": "integer" + }, + "zoneparam_value": { + "description": "The value of the DNS option specified in the input zoneparam_key.
                                                                                                                                      • To add or edit an option value, specify its name in the parameter zoneparam_key and set its value as follows: zoneparam_value=<option-value> .
                                                                                                                                      • To remove an option value, specify its name in the parameter zoneparam_key and leave zoneparam_value empty: zoneparam_value= .
                                                                                                                                      ", + "type": "string" + } + }, + "type": "object" + }, + "dns_zoneparam_add_success": { + "example": { + "data": [ + { + "zoneparam_id": "zoneparam_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_zoneparam_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dns_zoneparam_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_zoneparam_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_zoneparam_edit_success": { + "example": { + "data": [ + { + "zoneparam_id": "zoneparam_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_zoneparam_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dns_zoneparam_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_zoneparam_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_zoneparam_delete_success": { + "example": { + "data": [ + { + "zoneparam_id": "zoneparam_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_zoneparam_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dns_zoneparam_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_zoneparam_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "guardian_policy_data": { + "example": { + "data": [ + { + "server_name": "server_name", + "policy_id": "policy_id", + "policy_description": "policy_description", + "policy_name": "policy_name", + "server_id": "server_id", + "policy_delayed_time": "policy_delayed_time", + "parent_policy_id": "parent_policy_id", + "policy_readonly": "policy_readonly" + }, + { + "server_name": "server_name", + "policy_id": "policy_id", + "policy_description": "policy_description", + "policy_name": "policy_name", + "server_id": "server_id", + "policy_delayed_time": "policy_delayed_time", + "parent_policy_id": "parent_policy_id", + "policy_readonly": "policy_readonly" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_guardian_policy_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "guardian_policy_add_input": { + "properties": { + "policy_name": { + "description": "The name of the policy.", + "type": "string" + }, + "description": { + "description": "The description of the policy.", + "type": "string" + }, + "server_list": { + "description": "The name of all the Guardian servers associated with the policy. You can specify one or more names.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "guardian_policy_edit_input": { + "properties": { + "policy_id": { + "description": "The database identifier (ID) of the policy, a unique numeric key value automatically incremented when you add the policy. Use it to identify the policy of your choice.", + "type": "integer" + }, + "policy_name": { + "description": "The name of the policy.", + "type": "string" + }, + "description": { + "description": "The description of the policy.", + "type": "string" + }, + "server_list": { + "description": "The name of all the Guardian servers associated with the policy. You can specify one or more names.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "guardian_policy_add_success": { + "example": { + "data": [ + { + "policy_id": "policy_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_guardian_policy_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "guardian_policy_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_guardian_policy_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "guardian_policy_edit_success": { + "example": { + "data": [ + { + "policy_id": "policy_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_guardian_policy_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "guardian_policy_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_guardian_policy_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "guardian_policy_delete_success": { + "example": { + "data": [ + { + "policy_id": "policy_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_guardian_policy_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "guardian_policy_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_guardian_policy_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_address_data": { + "example": { + "data": [ + { + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "address_alias": "address_alias", + "network_is_terminal": "network_is_terminal", + "pool_class_name": "pool_class_name", + "free_end_address_addr": "free_end_address_addr", + "address_class_name": "address_class_name", + "address_operation_details_last_updated_on": "address_operation_details_last_updated_on", + "space_class_name": "space_class_name", + "port_portnumber": "port_portnumber", + "network_start_hostaddr": "network_start_hostaddr", + "space_description": "space_description", + "parent_network_end_hostaddr": "parent_network_end_hostaddr", + "device_id": "device_id", + "network_size": "network_size", + "tag_container_dhcpstatic": "tag_container_dhcpstatic", + "port_ifvlan": "port_ifvlan", + "space_is_template": "space_is_template", + "address_id": "address_id", + "network_name": "network_name", + "parent_network_class_name": "parent_network_class_name", + "network_id": "network_id", + "address_operation_details_requested_by": "address_operation_details_requested_by", + "address_operation_details_added_by": "address_operation_details_added_by", + "space_name": "space_name", + "network_start_address_addr": "network_start_address_addr", + "pool_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "address_operation_details_added_on": "address_operation_details_added_on", + "network_class_name": "network_class_name", + "free_start_address_addr": "free_start_address_addr", + "address_hostaddr": "address_hostaddr", + "interface_name": "interface_name", + "pool_start_address_addr": "pool_start_address_addr", + "network_end_hostaddr": "network_end_hostaddr", + "address_multistatus": "address_multistatus", + "address_name": "address_name", + "port_slotnumber": "port_slotnumber", + "parent_network_name": "parent_network_name", + "free_scope_size": "free_scope_size", + "tag_pool_dhcprange": "tag_pool_dhcprange", + "address_operation_details_call_stack": "address_operation_details_call_stack", + "device_name": "device_name", + "parent_network_start_hostaddr": "parent_network_start_hostaddr", + "address_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "parent_network_size": "parent_network_size", + "pool_end_address_addr": "pool_end_address_addr", + "parent_vlsm_network_id": "parent_vlsm_network_id", + "dev_name": "dev_name", + "network_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "address_addr": "address_addr", + "network_lock_network_broadcast": "network_lock_network_broadcast", + "address_type": "address_type", + "address_operation_details_origin_module": "address_operation_details_origin_module", + "static_id": "static_id", + "pool_size": "pool_size", + "pool_read_only": "pool_read_only", + "address_mac_addr": "address_mac_addr", + "pool_id": "pool_id", + "address_mac_last_seen": "address_mac_last_seen", + "parent_network_start_address_addr": "parent_network_start_address_addr", + "pool_name": "pool_name", + "dev_id": "dev_id", + "port_name": "port_name", + "lease_end_time": "lease_end_time", + "interface_id": "interface_id", + "parent_network_id": "parent_network_id", + "space_id": "space_id", + "network_end_address_addr": "network_end_address_addr", + "lease_id": "lease_id", + "parent_network_end_address_addr": "parent_network_end_address_addr" + }, + { + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "address_alias": "address_alias", + "network_is_terminal": "network_is_terminal", + "pool_class_name": "pool_class_name", + "free_end_address_addr": "free_end_address_addr", + "address_class_name": "address_class_name", + "address_operation_details_last_updated_on": "address_operation_details_last_updated_on", + "space_class_name": "space_class_name", + "port_portnumber": "port_portnumber", + "network_start_hostaddr": "network_start_hostaddr", + "space_description": "space_description", + "parent_network_end_hostaddr": "parent_network_end_hostaddr", + "device_id": "device_id", + "network_size": "network_size", + "tag_container_dhcpstatic": "tag_container_dhcpstatic", + "port_ifvlan": "port_ifvlan", + "space_is_template": "space_is_template", + "address_id": "address_id", + "network_name": "network_name", + "parent_network_class_name": "parent_network_class_name", + "network_id": "network_id", + "address_operation_details_requested_by": "address_operation_details_requested_by", + "address_operation_details_added_by": "address_operation_details_added_by", + "space_name": "space_name", + "network_start_address_addr": "network_start_address_addr", + "pool_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "address_operation_details_added_on": "address_operation_details_added_on", + "network_class_name": "network_class_name", + "free_start_address_addr": "free_start_address_addr", + "address_hostaddr": "address_hostaddr", + "interface_name": "interface_name", + "pool_start_address_addr": "pool_start_address_addr", + "network_end_hostaddr": "network_end_hostaddr", + "address_multistatus": "address_multistatus", + "address_name": "address_name", + "port_slotnumber": "port_slotnumber", + "parent_network_name": "parent_network_name", + "free_scope_size": "free_scope_size", + "tag_pool_dhcprange": "tag_pool_dhcprange", + "address_operation_details_call_stack": "address_operation_details_call_stack", + "device_name": "device_name", + "parent_network_start_hostaddr": "parent_network_start_hostaddr", + "address_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "parent_network_size": "parent_network_size", + "pool_end_address_addr": "pool_end_address_addr", + "parent_vlsm_network_id": "parent_vlsm_network_id", + "dev_name": "dev_name", + "network_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "address_addr": "address_addr", + "network_lock_network_broadcast": "network_lock_network_broadcast", + "address_type": "address_type", + "address_operation_details_origin_module": "address_operation_details_origin_module", + "static_id": "static_id", + "pool_size": "pool_size", + "pool_read_only": "pool_read_only", + "address_mac_addr": "address_mac_addr", + "pool_id": "pool_id", + "address_mac_last_seen": "address_mac_last_seen", + "parent_network_start_address_addr": "parent_network_start_address_addr", + "pool_name": "pool_name", + "dev_id": "dev_id", + "port_name": "port_name", + "lease_end_time": "lease_end_time", + "interface_id": "interface_id", + "parent_network_id": "parent_network_id", + "space_id": "space_id", + "network_end_address_addr": "network_end_address_addr", + "lease_id": "lease_id", + "parent_network_end_address_addr": "parent_network_end_address_addr" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_address_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_address_add_input": { + "properties": { + "address_hostaddr": { + "description": "The IP address.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "check_is_server_ip": { + "description": "A way to force a validity check, if you configured the IPAM to DHCP replication. If the check is enabled (1), the configuration of the IP address you are adding must be valid as well for the DHCP.", + "type": "integer" + }, + "static_id": { + "description": "The database identifier (ID) of the DHCP static you want to associate with the IP address.", + "type": "integer" + }, + "lease_id": { + "description": "The database identifier (ID) of the DHCP lease you want to associate with the IP address.", + "type": "integer" + }, + "device_id": { + "description": "The database identifier (ID) of the Device Manager device you want to associate with the IP address.", + "type": "integer" + }, + "interface_id": { + "description": "The database identifier (ID) of the Device Manager interface you want to associate with the IP address.", + "type": "integer" + }, + "port_id": { + "description": "The database identifier (ID) of the NetChange port you want to associate with the IP address.", + "type": "integer" + }, + "address_mac_addr": { + "description": "The MAC address you want to associate with the IPv4 address.", + "type": "string" + }, + "address_name": { + "description": "The name of the IPv4 address, each IPv4 address must have a unique name.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "address_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "address_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "ipam_address_edit_input": { + "properties": { + "address_hostaddr": { + "description": "The IP address.", + "type": "string" + }, + "address_id": { + "description": "The database identifier (ID) of the IPv4 address, a unique numeric key value automatically incremented when you add an IPv4 address. Use the ID to specify the IPv4 address of your choice.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "check_is_server_ip": { + "description": "A way to force a validity check, if you configured the IPAM to DHCP replication. If the check is enabled (1), the configuration of the IP address you are adding must be valid as well for the DHCP.", + "type": "integer" + }, + "static_id": { + "description": "The database identifier (ID) of the DHCP static you want to associate with the IP address.", + "type": "integer" + }, + "lease_id": { + "description": "The database identifier (ID) of the DHCP lease you want to associate with the IP address.", + "type": "integer" + }, + "device_id": { + "description": "The database identifier (ID) of the Device Manager device you want to associate with the IP address.", + "type": "integer" + }, + "interface_id": { + "description": "The database identifier (ID) of the Device Manager interface you want to associate with the IP address.", + "type": "integer" + }, + "port_id": { + "description": "The database identifier (ID) of the NetChange port you want to associate with the IP address.", + "type": "integer" + }, + "address_mac_addr": { + "description": "The MAC address you want to associate with the IPv4 address.", + "type": "string" + }, + "address_name": { + "description": "The name of the IPv4 address, each IPv4 address must have a unique name.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "address_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "address_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "ipam_address_add_success": { + "example": { + "data": [ + { + "address_id": "address_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_address_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_address_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_address_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_address_edit_success": { + "example": { + "data": [ + { + "address_id": "address_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_address_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_address_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_address_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_address_delete_success": { + "example": { + "data": [ + { + "address_id": "address_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_address_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_address_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_address_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_address6_data": { + "example": { + "data": [ + { + "parent_network6_class_name": "parent_network6_class_name", + "pool6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "address6_operation_details_added_on": "address6_operation_details_added_on", + "address6_multistatus": "address6_multistatus", + "address6_operation_details_added_by": "address6_operation_details_added_by", + "parent_network6_prefix": "parent_network6_prefix", + "space_class_name": "space_class_name", + "space_description": "space_description", + "address6_alias": "address6_alias", + "free_start_address6_addr": "free_start_address6_addr", + "address6_operation_details_call_stack": "address6_operation_details_call_stack", + "parent_network6_end_hostaddr": "parent_network6_end_hostaddr", + "network6_start_address6_addr": "network6_start_address6_addr", + "pool6_size": "pool6_size", + "parent_vlsm_network6_id": "parent_vlsm_network6_id", + "device_id": "device_id", + "network_size": "network_size", + "network6_is_terminal": "network6_is_terminal", + "vlsm_network6_id": "vlsm_network6_id", + "address6_type": "address6_type", + "pool6_id": "pool6_id", + "pool6_name": "pool6_name", + "space_name": "space_name", + "network6_id": "network6_id", + "network6_start_hostaddr": "network6_start_hostaddr", + "address6_operation_details_requested_by": "address6_operation_details_requested_by", + "pool6_end_address6_addr": "pool6_end_address6_addr", + "interface_name": "interface_name", + "network6_end_hostaddr": "network6_end_hostaddr", + "parent_network6_id": "parent_network6_id", + "network6_name": "network6_name", + "free_scope_size": "free_scope_size", + "free_end_address6_addr": "free_end_address6_addr", + "device_name": "device_name", + "address6_name": "address6_name", + "parent_network6_start_address6_addr": "parent_network6_start_address6_addr", + "parent_network6_start_hostaddr": "parent_network6_start_hostaddr", + "pool6_read_only": "pool6_read_only", + "pool6_class_name": "pool6_class_name", + "network6_end_address6_addr": "network6_end_address6_addr", + "address6_mac_addr": "address6_mac_addr", + "parent_space_name": "parent_space_name", + "network6_prefix": "network6_prefix", + "address6_id": "address6_id", + "network6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "parent_network6_size": "parent_network6_size", + "parent_network6_name": "parent_network6_name", + "parent_network6_end_address6_addr": "parent_network6_end_address6_addr", + "network6_lock_network_broadcast": "network6_lock_network_broadcast", + "address6_operation_details_last_updated_on": "address6_operation_details_last_updated_on", + "network6_size": "network6_size", + "interface_id": "interface_id", + "address6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "network6_class_name": "network6_class_name", + "address6_operation_details_origin_module": "address6_operation_details_origin_module", + "address6_addr": "address6_addr", + "address6_hostaddr": "address6_hostaddr", + "space_id": "space_id", + "address6_class_name": "address6_class_name", + "pool6_start_address6_addr": "pool6_start_address6_addr" + }, + { + "parent_network6_class_name": "parent_network6_class_name", + "pool6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "address6_operation_details_added_on": "address6_operation_details_added_on", + "address6_multistatus": "address6_multistatus", + "address6_operation_details_added_by": "address6_operation_details_added_by", + "parent_network6_prefix": "parent_network6_prefix", + "space_class_name": "space_class_name", + "space_description": "space_description", + "address6_alias": "address6_alias", + "free_start_address6_addr": "free_start_address6_addr", + "address6_operation_details_call_stack": "address6_operation_details_call_stack", + "parent_network6_end_hostaddr": "parent_network6_end_hostaddr", + "network6_start_address6_addr": "network6_start_address6_addr", + "pool6_size": "pool6_size", + "parent_vlsm_network6_id": "parent_vlsm_network6_id", + "device_id": "device_id", + "network_size": "network_size", + "network6_is_terminal": "network6_is_terminal", + "vlsm_network6_id": "vlsm_network6_id", + "address6_type": "address6_type", + "pool6_id": "pool6_id", + "pool6_name": "pool6_name", + "space_name": "space_name", + "network6_id": "network6_id", + "network6_start_hostaddr": "network6_start_hostaddr", + "address6_operation_details_requested_by": "address6_operation_details_requested_by", + "pool6_end_address6_addr": "pool6_end_address6_addr", + "interface_name": "interface_name", + "network6_end_hostaddr": "network6_end_hostaddr", + "parent_network6_id": "parent_network6_id", + "network6_name": "network6_name", + "free_scope_size": "free_scope_size", + "free_end_address6_addr": "free_end_address6_addr", + "device_name": "device_name", + "address6_name": "address6_name", + "parent_network6_start_address6_addr": "parent_network6_start_address6_addr", + "parent_network6_start_hostaddr": "parent_network6_start_hostaddr", + "pool6_read_only": "pool6_read_only", + "pool6_class_name": "pool6_class_name", + "network6_end_address6_addr": "network6_end_address6_addr", + "address6_mac_addr": "address6_mac_addr", + "parent_space_name": "parent_space_name", + "network6_prefix": "network6_prefix", + "address6_id": "address6_id", + "network6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "parent_network6_size": "parent_network6_size", + "parent_network6_name": "parent_network6_name", + "parent_network6_end_address6_addr": "parent_network6_end_address6_addr", + "network6_lock_network_broadcast": "network6_lock_network_broadcast", + "address6_operation_details_last_updated_on": "address6_operation_details_last_updated_on", + "network6_size": "network6_size", + "interface_id": "interface_id", + "address6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "network6_class_name": "network6_class_name", + "address6_operation_details_origin_module": "address6_operation_details_origin_module", + "address6_addr": "address6_addr", + "address6_hostaddr": "address6_hostaddr", + "space_id": "space_id", + "address6_class_name": "address6_class_name", + "pool6_start_address6_addr": "pool6_start_address6_addr" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_address6_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_address6_add_input": { + "properties": { + "address6_hostaddr": { + "description": "The IP address.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "device_id": { + "description": "The database identifier (ID) of the Device Manager device you want to associate with the IP address.", + "type": "integer" + }, + "interface_id": { + "description": "The database identifier (ID) of the Device Manager interface you want to associate with the IP address.", + "type": "integer" + }, + "address6_mac_addr": { + "description": "The MAC address you want to associate with the IPv6 address.", + "type": "string" + }, + "address6_name": { + "description": "The name of the IPv6 address, each IPv6 address must have a unique name.", + "type": "string" + }, + "port_id": { + "description": "The database identifier (ID) of the NetChange port you want to associate with the IP address.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "address6_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "address6_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "ipam_address6_edit_input": { + "properties": { + "address6_hostaddr": { + "description": "The IP address.", + "type": "string" + }, + "address6_id": { + "description": "The database identifier (ID) of the IPv6 address, a unique numeric key value automatically incremented when you add an IPv6 address. Use the ID to specify the IPv6 address of your choice.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "device_id": { + "description": "The database identifier (ID) of the Device Manager device you want to associate with the IP address.", + "type": "integer" + }, + "interface_id": { + "description": "The database identifier (ID) of the Device Manager interface you want to associate with the IP address.", + "type": "integer" + }, + "address6_mac_addr": { + "description": "The MAC address you want to associate with the IPv6 address.", + "type": "string" + }, + "address6_name": { + "description": "The name of the IPv6 address, each IPv6 address must have a unique name.", + "type": "string" + }, + "port_id": { + "description": "The database identifier (ID) of the NetChange port you want to associate with the IP address.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "address6_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "address6_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "ipam_address6_add_success": { + "example": { + "data": [ + { + "address6_id": "address6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_address6_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_address6_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_address6_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_address6_edit_success": { + "example": { + "data": [ + { + "address6_id": "address6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_address6_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_address6_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_address6_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_address6_delete_success": { + "example": { + "data": [ + { + "address6_id": "address6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_address6_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_address6_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_address6_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_alias_data": { + "example": { + "data": [ + { + "device_id": "device_id", + "address_addr": "address_addr", + "address_type": "address_type", + "static_id": "static_id", + "alias_id": "alias_id", + "address_id": "address_id", + "address_name": "address_name", + "alias_name": "alias_name", + "address_mac_addr": "address_mac_addr", + "pool_id": "pool_id", + "alias_type": "alias_type", + "network_id": "network_id", + "interface_id": "interface_id", + "address_class_name": "address_class_name", + "address_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_name": "space_name", + "space_class_name": "space_class_name", + "port_id": "port_id", + "space_id": "space_id", + "lease_id": "lease_id" + }, + { + "device_id": "device_id", + "address_addr": "address_addr", + "address_type": "address_type", + "static_id": "static_id", + "alias_id": "alias_id", + "address_id": "address_id", + "address_name": "address_name", + "alias_name": "alias_name", + "address_mac_addr": "address_mac_addr", + "pool_id": "pool_id", + "alias_type": "alias_type", + "network_id": "network_id", + "interface_id": "interface_id", + "address_class_name": "address_class_name", + "address_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_name": "space_name", + "space_class_name": "space_class_name", + "port_id": "port_id", + "space_id": "space_id", + "lease_id": "lease_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_alias_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_alias_add_input": { + "properties": { + "address_hostaddr": { + "description": "The IP address.", + "type": "string" + }, + "address_id": { + "description": "The database identifier (ID) of the IPv4 address, a unique numeric key value automatically incremented when you add an IPv4 address. Use the ID to specify the IPv4 address of your choice.", + "type": "integer" + }, + "alias_name": { + "description": "The name of the IPv4 alias.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "alias_type": { + "description": "The type of the alias.", + "enum": [ + "A", + "a", + "CNAME", + "cname" + ], + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "ipam_alias_edit_input": { + "properties": { + "address_hostaddr": { + "description": "The IP address.", + "type": "string" + }, + "address_id": { + "description": "The database identifier (ID) of the IPv4 address, a unique numeric key value automatically incremented when you add an IPv4 address. Use the ID to specify the IPv4 address of your choice.", + "type": "integer" + }, + "alias_name": { + "description": "The name of the IPv4 alias.", + "type": "string" + }, + "alias_id": { + "description": "The database identifier (ID) of the IPv4 alias, a unique numeric key value automatically incremented when you add an IPv4 alias. Use the ID to specify the IPv4 alias of your choice.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "alias_type": { + "description": "The type of the alias.", + "enum": [ + "A", + "a", + "CNAME", + "cname" + ], + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "ipam_alias_add_success": { + "example": { + "data": [ + { + "alias_id": "alias_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_alias_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_alias_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_alias_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_alias_edit_success": { + "example": { + "data": [ + { + "alias_id": "alias_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_alias_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_alias_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_alias_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_alias_delete_success": { + "example": { + "data": [ + { + "alias_id": "alias_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_alias_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_alias_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_alias_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_alias6_data": { + "example": { + "data": [ + { + "address6_id": "address6_id", + "device_id": "device_id", + "alias_name": "alias_name", + "pool6_id": "pool6_id", + "interface_id": "interface_id", + "address6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "address6_name": "address6_name", + "space_name": "space_name", + "network6_id": "network6_id", + "space_class_name": "space_class_name", + "alias6_type": "alias6_type", + "port_id": "port_id", + "address6_addr": "address6_addr", + "alias6_id": "alias6_id", + "address6_mac_addr": "address6_mac_addr", + "space_id": "space_id", + "address6_class_name": "address6_class_name" + }, + { + "address6_id": "address6_id", + "device_id": "device_id", + "alias_name": "alias_name", + "pool6_id": "pool6_id", + "interface_id": "interface_id", + "address6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "address6_name": "address6_name", + "space_name": "space_name", + "network6_id": "network6_id", + "space_class_name": "space_class_name", + "alias6_type": "alias6_type", + "port_id": "port_id", + "address6_addr": "address6_addr", + "alias6_id": "alias6_id", + "address6_mac_addr": "address6_mac_addr", + "space_id": "space_id", + "address6_class_name": "address6_class_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_alias6_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_alias6_add_input": { + "properties": { + "address6_hostaddr": { + "description": "The IP address.", + "type": "string" + }, + "address6_id": { + "description": "The database identifier (ID) of the IPv6 address, a unique numeric key value automatically incremented when you add an IPv6 address. Use the ID to specify the IPv6 address of your choice.", + "type": "integer" + }, + "alias6_name": { + "description": "The name of the IPv6 address.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "alias6_type": { + "description": "The type of the alias.", + "enum": [ + "AAAA", + "aaaa", + "CNAME", + "cname" + ], + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "ipam_alias6_edit_input": { + "properties": { + "address6_hostaddr": { + "description": "The IP address.", + "type": "string" + }, + "address6_id": { + "description": "The database identifier (ID) of the IPv6 address, a unique numeric key value automatically incremented when you add an IPv6 address. Use the ID to specify the IPv6 address of your choice.", + "type": "integer" + }, + "alias6_name": { + "description": "The name of the IPv6 address.", + "type": "string" + }, + "alias6_id": { + "description": "The database identifier (ID) of the IPv6 alias, a unique numeric key value automatically incremented when you add an IPv6 alias. Use the ID to specify the IPv6 alias of your choice.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "alias6_type": { + "description": "The type of the alias.", + "enum": [ + "AAAA", + "aaaa", + "CNAME", + "cname" + ], + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "ipam_alias6_add_success": { + "example": { + "data": [ + { + "alias6_id": "alias6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_alias6_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_alias6_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_alias6_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_alias6_edit_success": { + "example": { + "data": [ + { + "alias6_id": "alias6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_alias6_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_alias6_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_alias6_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_alias6_delete_success": { + "example": { + "data": [ + { + "alias6_id": "alias6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_alias6_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_alias6_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_alias6_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_network_data": { + "example": { + "data": [ + { + "range_name": "range_name", + "network_address_used_size": "network_address_used_size", + "vlan_id": "vlan_id", + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "vlsm_space_id": "vlsm_space_id", + "vlan_vlan_id": "vlan_vlan_id", + "network_is_terminal": "network_is_terminal", + "vlan_name": "vlan_name", + "parent_network_level": "parent_network_level", + "domain_id": "domain_id", + "vlsm_space_name": "vlsm_space_name", + "domain_name": "domain_name", + "network_ripe_waiting_status": "network_ripe_waiting_status", + "network_operation_details_call_stack": "network_operation_details_call_stack", + "network_operation_details_added_by": "network_operation_details_added_by", + "space_class_name": "space_class_name", + "network_start_hostaddr": "network_start_hostaddr", + "parent_space_id": "parent_space_id", + "space_description": "space_description", + "parent_network_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "network_address_used_percent": "network_address_used_percent", + "network_level": "network_level", + "network_size": "network_size", + "space_parent_space_id": "space_parent_space_id", + "space_is_template": "space_is_template", + "network_name": "network_name", + "parent_network_is_terminal": "parent_network_is_terminal", + "network_operation_details_requested_by": "network_operation_details_requested_by", + "network_operation_details_added_on": "network_operation_details_added_on", + "network_operation_details_origin_module": "network_operation_details_origin_module", + "parent_network_class_name": "parent_network_class_name", + "network_start_ip_addr": "network_start_ip_addr", + "network_address_free_size": "network_address_free_size", + "network_id": "network_id", + "space_name": "space_name", + "network_is_valid": "network_is_valid", + "parent_network_path": "parent_network_path", + "network_allocated_percent": "network_allocated_percent", + "parent_network_start_ip_addr": "parent_network_start_ip_addr", + "network_end_ip_addr": "network_end_ip_addr", + "network_class_name": "network_class_name", + "network_path": "network_path", + "network_end_hostaddr": "network_end_hostaddr", + "network_operation_details_last_updated_on": "network_operation_details_last_updated_on", + "vlsm_network_id": "vlsm_network_id", + "parent_network_name": "parent_network_name", + "range_id": "range_id", + "parent_network_size": "parent_network_size", + "network_used_size": "network_used_size", + "network_ripe_waiting_state": "network_ripe_waiting_state", + "parent_network_end_ip_addr": "parent_network_end_ip_addr", + "parent_vlsm_network_id": "parent_vlsm_network_id", + "parent_space_name": "parent_space_name", + "network_used_percent": "network_used_percent", + "network_is_in_orphan": "network_is_in_orphan", + "network_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "network_lock_network_broadcast": "network_lock_network_broadcast", + "network_multistatus": "network_multistatus", + "parent_network_id": "parent_network_id", + "vlsm_block_id": "vlsm_block_id", + "space_id": "space_id", + "network_allocated_size": "network_allocated_size" + }, + { + "range_name": "range_name", + "network_address_used_size": "network_address_used_size", + "vlan_id": "vlan_id", + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "vlsm_space_id": "vlsm_space_id", + "vlan_vlan_id": "vlan_vlan_id", + "network_is_terminal": "network_is_terminal", + "vlan_name": "vlan_name", + "parent_network_level": "parent_network_level", + "domain_id": "domain_id", + "vlsm_space_name": "vlsm_space_name", + "domain_name": "domain_name", + "network_ripe_waiting_status": "network_ripe_waiting_status", + "network_operation_details_call_stack": "network_operation_details_call_stack", + "network_operation_details_added_by": "network_operation_details_added_by", + "space_class_name": "space_class_name", + "network_start_hostaddr": "network_start_hostaddr", + "parent_space_id": "parent_space_id", + "space_description": "space_description", + "parent_network_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "network_address_used_percent": "network_address_used_percent", + "network_level": "network_level", + "network_size": "network_size", + "space_parent_space_id": "space_parent_space_id", + "space_is_template": "space_is_template", + "network_name": "network_name", + "parent_network_is_terminal": "parent_network_is_terminal", + "network_operation_details_requested_by": "network_operation_details_requested_by", + "network_operation_details_added_on": "network_operation_details_added_on", + "network_operation_details_origin_module": "network_operation_details_origin_module", + "parent_network_class_name": "parent_network_class_name", + "network_start_ip_addr": "network_start_ip_addr", + "network_address_free_size": "network_address_free_size", + "network_id": "network_id", + "space_name": "space_name", + "network_is_valid": "network_is_valid", + "parent_network_path": "parent_network_path", + "network_allocated_percent": "network_allocated_percent", + "parent_network_start_ip_addr": "parent_network_start_ip_addr", + "network_end_ip_addr": "network_end_ip_addr", + "network_class_name": "network_class_name", + "network_path": "network_path", + "network_end_hostaddr": "network_end_hostaddr", + "network_operation_details_last_updated_on": "network_operation_details_last_updated_on", + "vlsm_network_id": "vlsm_network_id", + "parent_network_name": "parent_network_name", + "range_id": "range_id", + "parent_network_size": "parent_network_size", + "network_used_size": "network_used_size", + "network_ripe_waiting_state": "network_ripe_waiting_state", + "parent_network_end_ip_addr": "parent_network_end_ip_addr", + "parent_vlsm_network_id": "parent_vlsm_network_id", + "parent_space_name": "parent_space_name", + "network_used_percent": "network_used_percent", + "network_is_in_orphan": "network_is_in_orphan", + "network_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "network_lock_network_broadcast": "network_lock_network_broadcast", + "network_multistatus": "network_multistatus", + "parent_network_id": "parent_network_id", + "vlsm_block_id": "vlsm_block_id", + "space_id": "space_id", + "network_allocated_size": "network_allocated_size" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_network_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_network_add_input": { + "properties": { + "parent_network_id": { + "description": "The database identifier (ID) of an existing IPv4 network you want to set as the parent of the IPv4 network you are adding. You can specify a subnet-type network to set up a network-based VLSM organization.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "network_addr": { + "description": "The start IP address of the IPv4 network, its first IP address.", + "type": "string" + }, + "network_end_addr": { + "description": "The end IP address of the IPv4 network, its last IP address.", + "type": "string" + }, + "network_mask": { + "description": "The netmask of the IPv4 network. It is expressed in dot-decimal notation and defines the number of addresses the network contains.", + "type": "string" + }, + "network_prefix": { + "description": "The prefix of the IPv4 network, an integer that defines the number of addresses the network contains.", + "type": "string" + }, + "network_size": { + "description": "The size of the IPv4 network, the number of IP addresses it contains.", + "type": "integer" + }, + "allow_block_creation": { + "description": "Internal use. Not documented.", + "type": "integer" + }, + "allow_tree_reparenting": { + "description": "A way to allow (1) or prevent (0) changing the parent of the network you are adding. Upon editing of the network, this parameter decides if you can associate it with a different parent network.", + "type": "integer" + }, + "network_is_terminal": { + "description": "A way to determine if a network can contain other networks. If set to 1, the network is terminal and cannot contain other subnet-type networks. By essence, block-type networks are non-terminal and are always set to 0.", + "type": "integer" + }, + "network_lock_network_broadcast": { + "description": "A way to prevent (1) users from assigning the broadcast IP address and network IP address of the network.", + "type": "integer" + }, + "permit_invalid": { + "description": "A way to authorize (1) IPv4 networks overlapping within a space.", + "type": "integer" + }, + "permit_no_block": { + "description": "A way to force the creation of an IPv4 subnet-type network. If set to 1, you can create a subnet-type network even if no block-type network matching the start address exists.", + "type": "integer" + }, + "relative_position": { + "description": "The position of the network within the hierarchy of networks of a VLSM organization. It calculates between 0 and n all the levels of the organization, its behavior depends on the value of the parameter use_reversed_relative_position:
                                                                                                                                      • use_reversed_relative_position=0 where 0 indicates a block-type network at the highest level possible, in a space-based organization, it belongs to the top space. The levels increment from 0 down to n, the lowest level you set up, within networks or spaces.
                                                                                                                                      • use_reversed_relative_position=1 where 1 indicates a network located at the lowest level of the organization, within networks or spaces. The levels increment from 0 up to n, the network at the highest level of the organization.
                                                                                                                                      ", + "type": "integer" + }, + "row_state": { + "description": "The object activation status.
                                                                                                                                      • If set to 0, the object is present in the database but ignored, i.e. it cannot be managed, counted or listed. This status is applied on objects deleted from the GUI.
                                                                                                                                      • If set to 1, the object is enabled and managed.
                                                                                                                                      • If set to 2, the object is unmanaged, disabled or both depending on the context.
                                                                                                                                      By default, row_state is set to 1 when an object is created.", + "enum": [ + "1", + "2" + ], + "type": "string" + }, + "network_level": { + "description": "The level of the network within the space:
                                                                                                                                      • Set it to 0 for a block-type network.
                                                                                                                                      • Set it to a value between 1 and n for a subnet-type network.
                                                                                                                                      If you set a value between 2 and n, you are setting a network-based VLSM organization where non terminal subnet-type networks can contain other subnet-type networks.", + "type": "integer" + }, + "network_name": { + "description": "The name of the IPv4 network, each IPv4 network must have a unique name.", + "type": "string" + }, + "use_reversed_relative_position": { + "description": "A way to determine if the calculation of the parameter relative_position should start from the top (0) or the bottom (1) of the VLSM organization.", + "type": "integer" + }, + "vlan_id": { + "description": "The database identifier (ID) of the VLAN you want to associate with the network.", + "type": "integer" + }, + "vlsm_space_id": { + "description": "The database identifier (ID) of a VLSM child space of the space specified in space_id. If you specify an ID, the subnet-type network you are adding is duplicated as a VLSM block-type network in the child space, with the same name but a different ID. This parameter serves the same purpose as vlsm_space_name.", + "type": "integer" + }, + "vlsm_space_name": { + "description": "The name of a VLSM child space of the space specified in space_id. If you specify a name, the subnet-type network you are adding is duplicated as a VLSM block-type network in the child space, with the same name but a different ID. This parameter serves the same purpose as vlsm_space_id.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "network_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "network_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "ipam_network_edit_input": { + "properties": { + "parent_network_id": { + "description": "The database identifier (ID) of an existing IPv4 network you want to set as the parent of the IPv4 network you are editing. You can specify a subnet-type network to set up a network-based VLSM organization.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "network_addr": { + "description": "The start IP address of the IPv4 network, its first IP address.", + "type": "string" + }, + "network_end_addr": { + "description": "The end IP address of the IPv4 network, its last IP address.", + "type": "string" + }, + "network_id": { + "description": "The database identifier (ID) of the IPv4 network, a unique numeric key value automatically incremented when you add an IPv4 network. Use the ID to specify the IPv4 network of your choice.", + "type": "integer" + }, + "network_mask": { + "description": "The netmask of the IPv4 network. It is expressed in dot-decimal notation and defines the number of addresses the network contains.", + "type": "string" + }, + "network_prefix": { + "description": "The prefix of the IPv4 network, an integer that defines the number of addresses the network contains.", + "type": "string" + }, + "network_size": { + "description": "The size of the IPv4 network, the number of IP addresses it contains.", + "type": "integer" + }, + "allow_block_creation": { + "description": "Internal use. Not documented.", + "type": "integer" + }, + "allow_tree_reparenting": { + "description": "A way to allow (1) or prevent (0) changing the parent of the network you are adding. Upon editing of the network, this parameter decides if you can associate it with a different parent network.", + "type": "integer" + }, + "network_is_terminal": { + "description": "A way to determine if a network can contain other networks. If set to 1, the network is terminal and cannot contain other subnet-type networks. By essence, block-type networks are non-terminal and are always set to 0.", + "type": "integer" + }, + "network_lock_network_broadcast": { + "description": "A way to prevent (1) users from assigning the broadcast IP address and network IP address of the network.", + "type": "integer" + }, + "permit_invalid": { + "description": "A way to authorize (1) IPv4 networks overlapping within a space.", + "type": "integer" + }, + "permit_no_block": { + "description": "A way to force the creation of an IPv4 subnet-type network. If set to 1, you can create a subnet-type network even if no block-type network matching the start address exists.", + "type": "integer" + }, + "relative_position": { + "description": "The position of the network within the hierarchy of networks of a VLSM organization. It calculates between 0 and n all the levels of the organization, its behavior depends on the value of the parameter use_reversed_relative_position:
                                                                                                                                      • use_reversed_relative_position=0 where 0 indicates a block-type network at the highest level possible, in a space-based organization, it belongs to the top space. The levels increment from 0 down to n, the lowest level you set up, within networks or spaces.
                                                                                                                                      • use_reversed_relative_position=1 where 1 indicates a network located at the lowest level of the organization, within networks or spaces. The levels increment from 0 up to n, the network at the highest level of the organization.
                                                                                                                                      ", + "type": "integer" + }, + "row_state": { + "description": "The object activation status.
                                                                                                                                      • If set to 0, the object is present in the database but ignored, i.e. it cannot be managed, counted or listed. This status is applied on objects deleted from the GUI.
                                                                                                                                      • If set to 1, the object is enabled and managed.
                                                                                                                                      • If set to 2, the object is unmanaged, disabled or both depending on the context.
                                                                                                                                      By default, row_state is set to 1 when an object is created.", + "enum": [ + "1", + "2" + ], + "type": "string" + }, + "network_level": { + "description": "The level of the network within the space:
                                                                                                                                      • Set it to 0 for a block-type network.
                                                                                                                                      • Set it to a value between 1 and n for a subnet-type network.
                                                                                                                                      If you set a value between 2 and n, you are setting a network-based VLSM organization where non terminal subnet-type networks can contain other subnet-type networks.", + "type": "integer" + }, + "network_name": { + "description": "The name of the IPv4 network, each IPv4 network must have a unique name.", + "type": "string" + }, + "use_reversed_relative_position": { + "description": "A way to determine if the calculation of the parameter relative_position should start from the top (0) or the bottom (1) of the VLSM organization.", + "type": "integer" + }, + "vlan_id": { + "description": "The database identifier (ID) of the VLAN you want to associate with the network.", + "type": "integer" + }, + "vlsm_space_id": { + "description": "The database identifier (ID) of a VLSM child space of the space specified in space_id. If you specify an ID, the subnet-type network you are editing is duplicated as a VLSM block-type network in the child space, with the same name but a different ID. This parameter serves the same purpose as vlsm_space_name.", + "type": "integer" + }, + "vlsm_space_name": { + "description": "The name of a VLSM child space of the space specified in space_id. If you specify a name, the subnet-type network you are editing is duplicated as a VLSM block-type network in the child space, with the same name but a different ID. This parameter serves the same purpose as vlsm_space_id.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "network_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "network_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "ipam_network_add_success": { + "example": { + "data": [ + { + "network_id": "network_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_network_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_network_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_network_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_network_edit_success": { + "example": { + "data": [ + { + "network_id": "network_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_network_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_network_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_network_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_network_delete_success": { + "example": { + "data": [ + { + "network_id": "network_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_network_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_network_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_network_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_network6_data": { + "example": { + "data": [ + { + "range_name": "range_name", + "vlsm_block6_id": "vlsm_block6_id", + "end_address6_addr": "end_address6_addr", + "parent_network6_class_name": "parent_network6_class_name", + "parent_network6_is_terminal": "parent_network6_is_terminal", + "vlan_id": "vlan_id", + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "vlsm_space_id": "vlsm_space_id", + "vlan_vlan_id": "vlan_vlan_id", + "network6_operation_details_requested_by": "network6_operation_details_requested_by", + "vlan_name": "vlan_name", + "parent_network_level": "parent_network_level", + "domain_id": "domain_id", + "vlsm_space_name": "vlsm_space_name", + "domain_name": "domain_name", + "percent_allocated": "percent_allocated", + "parent_network6_prefix": "parent_network6_prefix", + "space_class_name": "space_class_name", + "network6_operation_details_last_updated_on": "network6_operation_details_last_updated_on", + "parent_space_id": "parent_space_id", + "space_description": "space_description", + "network_level": "network_level", + "parent_vlsm_network6_id": "parent_vlsm_network6_id", + "network_size": "network_size", + "space_parent_space_id": "space_parent_space_id", + "space_is_template": "space_is_template", + "network6_ripe_waiting_state": "network6_ripe_waiting_state", + "network6_is_terminal": "network6_is_terminal", + "vlsm_network6_id": "vlsm_network6_id", + "network6_ripe_waiting_status": "network6_ripe_waiting_status", + "percent_used": "percent_used", + "space_name": "space_name", + "network6_id": "network6_id", + "parent_network_path": "parent_network_path", + "network6_start_hostaddr": "network6_start_hostaddr", + "parent_network6_percent_allocated": "parent_network6_percent_allocated", + "network6_is_valid": "network6_is_valid", + "parent_end_address6_addr": "parent_end_address6_addr", + "parent_start_address6_addr": "parent_start_address6_addr", + "network_path": "network_path", + "network6_end_hostaddr": "network6_end_hostaddr", + "parent_network6_id": "parent_network6_id", + "network6_name": "network6_name", + "range_id": "range_id", + "network6_operation_details_added_by": "network6_operation_details_added_by", + "start_address6_addr": "start_address6_addr", + "parent_network_size": "parent_network_size", + "network6_operation_details_added_on": "network6_operation_details_added_on", + "parent_space_name": "parent_space_name", + "network6_prefix": "network6_prefix", + "parent_network6_percent_used": "parent_network6_percent_used", + "network6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "network6_operation_details_origin_module": "network6_operation_details_origin_module", + "network6_multistatus": "network6_multistatus", + "parent_network6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "parent_network6_name": "parent_network6_name", + "network6_lock_network_broadcast": "network6_lock_network_broadcast", + "network6_class_name": "network6_class_name", + "network6_is_in_orphan": "network6_is_in_orphan", + "network6_operation_details_call_stack": "network6_operation_details_call_stack", + "space_id": "space_id" + }, + { + "range_name": "range_name", + "vlsm_block6_id": "vlsm_block6_id", + "end_address6_addr": "end_address6_addr", + "parent_network6_class_name": "parent_network6_class_name", + "parent_network6_is_terminal": "parent_network6_is_terminal", + "vlan_id": "vlan_id", + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "vlsm_space_id": "vlsm_space_id", + "vlan_vlan_id": "vlan_vlan_id", + "network6_operation_details_requested_by": "network6_operation_details_requested_by", + "vlan_name": "vlan_name", + "parent_network_level": "parent_network_level", + "domain_id": "domain_id", + "vlsm_space_name": "vlsm_space_name", + "domain_name": "domain_name", + "percent_allocated": "percent_allocated", + "parent_network6_prefix": "parent_network6_prefix", + "space_class_name": "space_class_name", + "network6_operation_details_last_updated_on": "network6_operation_details_last_updated_on", + "parent_space_id": "parent_space_id", + "space_description": "space_description", + "network_level": "network_level", + "parent_vlsm_network6_id": "parent_vlsm_network6_id", + "network_size": "network_size", + "space_parent_space_id": "space_parent_space_id", + "space_is_template": "space_is_template", + "network6_ripe_waiting_state": "network6_ripe_waiting_state", + "network6_is_terminal": "network6_is_terminal", + "vlsm_network6_id": "vlsm_network6_id", + "network6_ripe_waiting_status": "network6_ripe_waiting_status", + "percent_used": "percent_used", + "space_name": "space_name", + "network6_id": "network6_id", + "parent_network_path": "parent_network_path", + "network6_start_hostaddr": "network6_start_hostaddr", + "parent_network6_percent_allocated": "parent_network6_percent_allocated", + "network6_is_valid": "network6_is_valid", + "parent_end_address6_addr": "parent_end_address6_addr", + "parent_start_address6_addr": "parent_start_address6_addr", + "network_path": "network_path", + "network6_end_hostaddr": "network6_end_hostaddr", + "parent_network6_id": "parent_network6_id", + "network6_name": "network6_name", + "range_id": "range_id", + "network6_operation_details_added_by": "network6_operation_details_added_by", + "start_address6_addr": "start_address6_addr", + "parent_network_size": "parent_network_size", + "network6_operation_details_added_on": "network6_operation_details_added_on", + "parent_space_name": "parent_space_name", + "network6_prefix": "network6_prefix", + "parent_network6_percent_used": "parent_network6_percent_used", + "network6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "network6_operation_details_origin_module": "network6_operation_details_origin_module", + "network6_multistatus": "network6_multistatus", + "parent_network6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "parent_network6_name": "parent_network6_name", + "network6_lock_network_broadcast": "network6_lock_network_broadcast", + "network6_class_name": "network6_class_name", + "network6_is_in_orphan": "network6_is_in_orphan", + "network6_operation_details_call_stack": "network6_operation_details_call_stack", + "space_id": "space_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_network6_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_network6_add_input": { + "properties": { + "parent_network6_id": { + "description": "The database identifier (ID) of an existing IPv6 network you want to set as the parent of the IPv6 network you are adding. You can specify a subnet-type network to set up a network-based VLSM organization.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "network6_addr": { + "description": "The start IP address of the IPv6 network, its first IP address.", + "type": "string" + }, + "network6_end_addr": { + "description": "The end IP address of the IPv6 network, its last IP address.", + "type": "string" + }, + "network6_prefix": { + "description": "The prefix of the IPv6 network, an integer that defines the number of address the network contains.", + "type": "string" + }, + "allow_block6_creation": { + "description": "Internal use. Not documented.", + "type": "integer" + }, + "allow_tree_reparenting": { + "description": "A way to allow (1) or prevent (0) changing the parent of the network you are adding. Upon editing of the network, this parameter decides if you can associate it with a different parent network.", + "type": "integer" + }, + "network6_is_terminal": { + "description": "A way to determine if a network can contain other networks. If set to 1, the network is terminal and cannot contain other subnet-type networks. By essence, block-type networks are non-terminal and are always set to 0.", + "type": "integer" + }, + "network6_lock_network_broadcast": { + "description": "A way to prevent (1) users from assigning the broadcast IP address and network IP address of the network.", + "type": "integer" + }, + "permit_invalid": { + "description": "A way to authorize (1) IPv6 networks overlapping within a space.", + "type": "integer" + }, + "permit_no_block6": { + "description": "A way to force the creation of an IPv6 subnet-type network. If set to 1, you can create a subnet-type network even if no block-type network matching the start address exists.", + "type": "integer" + }, + "relative_position": { + "description": "The position of the network within the hierarchy of networks of a VLSM organization. It calculates between 0 and n all the levels of the organization, its behavior depends on the value of the parameter use_reversed_relative_position:
                                                                                                                                      • use_reversed_relative_position=0 where 0 indicates a block-type network at the highest level possible, in a space-based organization, it belongs to the top space. The levels increment from 0 down to n, the lowest level you set up, within networks or spaces.
                                                                                                                                      • use_reversed_relative_position=1 where 1 indicates a network located at the lowest level of the organization, within networks or spaces. The levels increment from 0 up to n, the network at the highest level of the organization.
                                                                                                                                      ", + "type": "integer" + }, + "row_state": { + "description": "The object activation status.
                                                                                                                                      • If set to 0, the object is present in the database but ignored, i.e. it cannot be managed, counted or listed. This status is applied on objects deleted from the GUI.
                                                                                                                                      • If set to 1, the object is enabled and managed.
                                                                                                                                      • If set to 2, the object is unmanaged, disabled or both depending on the context.
                                                                                                                                      By default, row_state is set to 1 when an object is created.", + "enum": [ + "1", + "2" + ], + "type": "string" + }, + "network6_name": { + "description": "The name of the IPv6 network, each IPv6 network must have a unique name.", + "type": "string" + }, + "network_level": { + "description": "The level of the network within the space:
                                                                                                                                      • Set it to 0 for a block-type network.
                                                                                                                                      • Set it to a value between 1 and n for a subnet-type network.
                                                                                                                                      If you set a value between 2 and n, you are setting a network-based VLSM organization where non terminal subnet-type networks can contain other subnet-type networks.", + "type": "integer" + }, + "use_reversed_relative_position": { + "description": "A way to determine if the calculation of the parameter relative_position should start from the top (0) or the bottom (1) of the VLSM organization.", + "type": "integer" + }, + "vlan_id": { + "description": "The database identifier (ID) of the VLAN you want to associate with the network.", + "type": "integer" + }, + "vlsm_space_id": { + "description": "The database identifier (ID) of a VLSM child space of the space specified in space_id. If you specify an ID, the subnet-type network you are adding is duplicated as a VLSM block-type network in the child space, with the same name but a different ID. This parameter serves the same purpose as vlsm_space_name.", + "type": "integer" + }, + "vlsm_space_name": { + "description": "The name of a VLSM child space of the space specified in space_id. If you specify a name, the subnet-type network you are adding is duplicated as a VLSM block-type network in the child space, with the same name but a different ID. This parameter serves the same purpose as vlsm_space_id.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "network6_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "network6_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "ipam_network6_edit_input": { + "properties": { + "parent_network6_id": { + "description": "The database identifier (ID) of an existing IPv6 network you want to set as the parent of the IPv6 network you are editing. You can specify a subnet-type network to set up a network-based VLSM organization.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "network6_addr": { + "description": "The start IP address of the IPv6 network, its first IP address.", + "type": "string" + }, + "network6_end_addr": { + "description": "The end IP address of the IPv6 network, its last IP address.", + "type": "string" + }, + "network6_id": { + "description": "The database identifier (ID) of the IPv6 network, a unique numeric key value automatically incremented when you add an IPv6 network. Use the ID to specify the IPv6 network of your choice.", + "type": "integer" + }, + "network6_prefix": { + "description": "The prefix of the IPv6 network, an integer that defines the number of address the network contains.", + "type": "string" + }, + "allow_block6_creation": { + "description": "Internal use. Not documented.", + "type": "integer" + }, + "allow_tree_reparenting": { + "description": "A way to allow (1) or prevent (0) changing the parent of the network you are adding. Upon editing of the network, this parameter decides if you can associate it with a different parent network.", + "type": "integer" + }, + "network6_is_terminal": { + "description": "A way to determine if a network can contain other networks. If set to 1, the network is terminal and cannot contain other subnet-type networks. By essence, block-type networks are non-terminal and are always set to 0.", + "type": "integer" + }, + "network6_lock_network_broadcast": { + "description": "A way to prevent (1) users from assigning the broadcast IP address and network IP address of the network.", + "type": "integer" + }, + "permit_invalid": { + "description": "A way to authorize (1) IPv6 networks overlapping within a space.", + "type": "integer" + }, + "permit_no_block6": { + "description": "A way to force the creation of an IPv6 subnet-type network. If set to 1, you can create a subnet-type network even if no block-type network matching the start address exists.", + "type": "integer" + }, + "relative_position": { + "description": "The position of the network within the hierarchy of networks of a VLSM organization. It calculates between 0 and n all the levels of the organization, its behavior depends on the value of the parameter use_reversed_relative_position:
                                                                                                                                      • use_reversed_relative_position=0 where 0 indicates a block-type network at the highest level possible, in a space-based organization, it belongs to the top space. The levels increment from 0 down to n, the lowest level you set up, within networks or spaces.
                                                                                                                                      • use_reversed_relative_position=1 where 1 indicates a network located at the lowest level of the organization, within networks or spaces. The levels increment from 0 up to n, the network at the highest level of the organization.
                                                                                                                                      ", + "type": "integer" + }, + "row_state": { + "description": "The object activation status.
                                                                                                                                      • If set to 0, the object is present in the database but ignored, i.e. it cannot be managed, counted or listed. This status is applied on objects deleted from the GUI.
                                                                                                                                      • If set to 1, the object is enabled and managed.
                                                                                                                                      • If set to 2, the object is unmanaged, disabled or both depending on the context.
                                                                                                                                      By default, row_state is set to 1 when an object is created.", + "enum": [ + "1", + "2" + ], + "type": "string" + }, + "network6_name": { + "description": "The name of the IPv6 network, each IPv6 network must have a unique name.", + "type": "string" + }, + "network_level": { + "description": "The level of the network within the space:
                                                                                                                                      • Set it to 0 for a block-type network.
                                                                                                                                      • Set it to a value between 1 and n for a subnet-type network.
                                                                                                                                      If you set a value between 2 and n, you are setting a network-based VLSM organization where non terminal subnet-type networks can contain other subnet-type networks.", + "type": "integer" + }, + "use_reversed_relative_position": { + "description": "A way to determine if the calculation of the parameter relative_position should start from the top (0) or the bottom (1) of the VLSM organization.", + "type": "integer" + }, + "vlan_id": { + "description": "The database identifier (ID) of the VLAN you want to associate with the network.", + "type": "integer" + }, + "vlsm_space_id": { + "description": "The database identifier (ID) of a VLSM child space of the space specified in space_id. If you specify an ID, the subnet-type network you are editing is duplicated as a VLSM block-type network in the child space, with the same name but a different ID. This parameter serves the same purpose as vlsm_space_name.", + "type": "integer" + }, + "vlsm_space_name": { + "description": "The name of a VLSM child space of the space specified in space_id. If you specify a name, the subnet-type network you are editing is duplicated as a VLSM block-type network in the child space, with the same name but a different ID. This parameter serves the same purpose as vlsm_space_id.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "network6_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "network6_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "ipam_network6_add_success": { + "example": { + "data": [ + { + "network6_id": "network6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_network6_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_network6_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_network6_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_network6_edit_success": { + "example": { + "data": [ + { + "network6_id": "network6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_network6_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_network6_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_network6_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_network6_delete_success": { + "example": { + "data": [ + { + "network6_id": "network6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_network6_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_network6_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_network6_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_pool_data": { + "example": { + "data": [ + { + "pool_start_hostaddr": "pool_start_hostaddr", + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "pool_operation_details_added_on": "pool_operation_details_added_on", + "pool_operation_details_call_stack": "pool_operation_details_call_stack", + "pool_start_address_addr": "pool_start_address_addr", + "vlsm_network_id": "vlsm_network_id", + "parent_network_name": "parent_network_name", + "pool_class_name": "pool_class_name", + "space_class_name": "space_class_name", + "parent_network_size": "parent_network_size", + "space_description": "space_description", + "pool_end_ip_addr": "pool_end_ip_addr", + "pool_end_address_addr": "pool_end_address_addr", + "pool_operation_details_added_by": "pool_operation_details_added_by", + "pool_start_ip_addr": "pool_start_ip_addr", + "pool_operation_details_last_updated_on": "pool_operation_details_last_updated_on", + "network_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "network_size": "network_size", + "pool_size": "pool_size", + "space_is_template": "space_is_template", + "network_name": "network_name", + "pool_operation_details_requested_by": "pool_operation_details_requested_by", + "pool_read_only": "pool_read_only", + "pool_id": "pool_id", + "pool_multistatus": "pool_multistatus", + "parent_network_class_name": "parent_network_class_name", + "pool_name": "pool_name", + "pool_operation_details_origin_module": "pool_operation_details_origin_module", + "pool_end_hostaddr": "pool_end_hostaddr", + "network_id": "network_id", + "space_name": "space_name", + "parent_network_id": "parent_network_id", + "network_start_address_addr": "network_start_address_addr", + "pool_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "vlsm_block_id": "vlsm_block_id", + "space_id": "space_id", + "network_end_address_addr": "network_end_address_addr", + "network_class_name": "network_class_name" + }, + { + "pool_start_hostaddr": "pool_start_hostaddr", + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "pool_operation_details_added_on": "pool_operation_details_added_on", + "pool_operation_details_call_stack": "pool_operation_details_call_stack", + "pool_start_address_addr": "pool_start_address_addr", + "vlsm_network_id": "vlsm_network_id", + "parent_network_name": "parent_network_name", + "pool_class_name": "pool_class_name", + "space_class_name": "space_class_name", + "parent_network_size": "parent_network_size", + "space_description": "space_description", + "pool_end_ip_addr": "pool_end_ip_addr", + "pool_end_address_addr": "pool_end_address_addr", + "pool_operation_details_added_by": "pool_operation_details_added_by", + "pool_start_ip_addr": "pool_start_ip_addr", + "pool_operation_details_last_updated_on": "pool_operation_details_last_updated_on", + "network_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "network_size": "network_size", + "pool_size": "pool_size", + "space_is_template": "space_is_template", + "network_name": "network_name", + "pool_operation_details_requested_by": "pool_operation_details_requested_by", + "pool_read_only": "pool_read_only", + "pool_id": "pool_id", + "pool_multistatus": "pool_multistatus", + "parent_network_class_name": "parent_network_class_name", + "pool_name": "pool_name", + "pool_operation_details_origin_module": "pool_operation_details_origin_module", + "pool_end_hostaddr": "pool_end_hostaddr", + "network_id": "network_id", + "space_name": "space_name", + "parent_network_id": "parent_network_id", + "network_start_address_addr": "network_start_address_addr", + "pool_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "vlsm_block_id": "vlsm_block_id", + "space_id": "space_id", + "network_end_address_addr": "network_end_address_addr", + "network_class_name": "network_class_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_pool_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_pool_add_input": { + "properties": { + "pool_end_ip_addr": { + "description": "The last IP address of the pool.", + "type": "string" + }, + "pool_size": { + "description": "The size of the pool, the number of IP addresses it contains.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "pool_start_ip_addr": { + "description": "The first IP address of the pool.", + "type": "string" + }, + "network_id": { + "description": "The database identifier (ID) of the IPv4 network, a unique numeric key value automatically incremented when you add an IPv4 network. Use the ID to specify the IPv4 network of your choice.", + "type": "integer" + }, + "pool_name": { + "description": "The name of the IPv4 pool, each IPv4 pool must have a unique name.", + "type": "string" + }, + "pool_read_only": { + "description": "The reservation status of the IPv4 pool. If set 1, the IP addresses it contains cannot be assigned.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "pool_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "pool_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "ipam_pool_edit_input": { + "properties": { + "pool_end_ip_addr": { + "description": "The last IP address of the pool.", + "type": "string" + }, + "pool_id": { + "description": "The database identifier (ID) of the IPv4 pool, a unique numeric key value automatically incremented when you add an IPv4 pool. Use the ID to specify the IPv4 pool of your choice.", + "type": "integer" + }, + "pool_size": { + "description": "The size of the pool, the number of IP addresses it contains.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "pool_start_ip_addr": { + "description": "The first IP address of the pool.", + "type": "string" + }, + "network_id": { + "description": "The database identifier (ID) of the IPv4 network, a unique numeric key value automatically incremented when you add an IPv4 network. Use the ID to specify the IPv4 network of your choice.", + "type": "integer" + }, + "pool_name": { + "description": "The name of the IPv4 pool, each IPv4 pool must have a unique name.", + "type": "string" + }, + "pool_read_only": { + "description": "The reservation status of the IPv4 pool. If set 1, the IP addresses it contains cannot be assigned.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "pool_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "pool_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "ipam_pool_add_success": { + "example": { + "data": [ + { + "pool_id": "pool_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_pool_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_pool_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_pool_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_pool_edit_success": { + "example": { + "data": [ + { + "pool_id": "pool_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_pool_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_pool_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_pool_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_pool_delete_success": { + "example": { + "data": [ + { + "pool_id": "pool_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_pool_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_pool_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_pool_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_pool6_data": { + "example": { + "data": [ + { + "vlsm_block6_id": "vlsm_block6_id", + "end_address6_addr": "end_address6_addr", + "parent_network6_class_name": "parent_network6_class_name", + "pool6_operation_details_requested_by": "pool6_operation_details_requested_by", + "pool6_end_address6_addr": "pool6_end_address6_addr", + "pool6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "parent_network6_id": "parent_network6_id", + "network6_name": "network6_name", + "pool6_operation_details_last_updated_on": "pool6_operation_details_last_updated_on", + "parent_network6_prefix": "parent_network6_prefix", + "space_class_name": "space_class_name", + "start_address6_addr": "start_address6_addr", + "space_description": "space_description", + "pool6_read_only": "pool6_read_only", + "pool6_class_name": "pool6_class_name", + "network6_end_address6_addr": "network6_end_address6_addr", + "network6_prefix": "network6_prefix", + "pool6_operation_details_call_stack": "pool6_operation_details_call_stack", + "network6_start_address6_addr": "network6_start_address6_addr", + "pool6_size": "pool6_size", + "pool6_start_hostaddr": "pool6_start_hostaddr", + "pool6_operation_details_origin_module": "pool6_operation_details_origin_module", + "network6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_is_template": "space_is_template", + "pool6_operation_details_added_on": "pool6_operation_details_added_on", + "vlsm_network6_id": "vlsm_network6_id", + "parent_network6_name": "parent_network6_name", + "pool6_id": "pool6_id", + "pool6_multistatus": "pool6_multistatus", + "pool6_operation_details_added_by": "pool6_operation_details_added_by", + "pool6_name": "pool6_name", + "space_name": "space_name", + "network6_id": "network6_id", + "network6_class_name": "network6_class_name", + "pool6_end_hostaddr": "pool6_end_hostaddr", + "space_id": "space_id", + "pool6_start_address6_addr": "pool6_start_address6_addr" + }, + { + "vlsm_block6_id": "vlsm_block6_id", + "end_address6_addr": "end_address6_addr", + "parent_network6_class_name": "parent_network6_class_name", + "pool6_operation_details_requested_by": "pool6_operation_details_requested_by", + "pool6_end_address6_addr": "pool6_end_address6_addr", + "pool6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "parent_network6_id": "parent_network6_id", + "network6_name": "network6_name", + "pool6_operation_details_last_updated_on": "pool6_operation_details_last_updated_on", + "parent_network6_prefix": "parent_network6_prefix", + "space_class_name": "space_class_name", + "start_address6_addr": "start_address6_addr", + "space_description": "space_description", + "pool6_read_only": "pool6_read_only", + "pool6_class_name": "pool6_class_name", + "network6_end_address6_addr": "network6_end_address6_addr", + "network6_prefix": "network6_prefix", + "pool6_operation_details_call_stack": "pool6_operation_details_call_stack", + "network6_start_address6_addr": "network6_start_address6_addr", + "pool6_size": "pool6_size", + "pool6_start_hostaddr": "pool6_start_hostaddr", + "pool6_operation_details_origin_module": "pool6_operation_details_origin_module", + "network6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_is_template": "space_is_template", + "pool6_operation_details_added_on": "pool6_operation_details_added_on", + "vlsm_network6_id": "vlsm_network6_id", + "parent_network6_name": "parent_network6_name", + "pool6_id": "pool6_id", + "pool6_multistatus": "pool6_multistatus", + "pool6_operation_details_added_by": "pool6_operation_details_added_by", + "pool6_name": "pool6_name", + "space_name": "space_name", + "network6_id": "network6_id", + "network6_class_name": "network6_class_name", + "pool6_end_hostaddr": "pool6_end_hostaddr", + "space_id": "space_id", + "pool6_start_address6_addr": "pool6_start_address6_addr" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_pool6_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_pool6_add_input": { + "properties": { + "pool6_end_ip_addr": { + "description": "The last IP address of the pool.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "pool6_start_ip_addr": { + "description": "The first IP address of the pool.", + "type": "string" + }, + "network6_id": { + "description": "The database identifier (ID) of the IPv6 network, a unique numeric key value automatically incremented when you add an IPv6 network. Use the ID to specify the IPv6 network of your choice.", + "type": "integer" + }, + "pool6_name": { + "description": "The name of the IPv6 pool, each IPv6 pool must have a unique name.", + "type": "string" + }, + "pool6_read_only": { + "description": "The reservation status of the IPv6 pool. If set 1, the IP addresses it contains cannot be assigned.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "pool6_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "pool6_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "ipam_pool6_edit_input": { + "properties": { + "pool6_end_ip_addr": { + "description": "The last IP address of the pool.", + "type": "string" + }, + "pool6_id": { + "description": "The database identifier (ID) of the IPv6 pool, a unique numeric key value automatically incremented when you add an IPv6 pool. Use the ID to specify the IPv6 pool of your choice.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "pool6_start_ip_addr": { + "description": "The first IP address of the pool.", + "type": "string" + }, + "network6_id": { + "description": "The database identifier (ID) of the IPv6 network, a unique numeric key value automatically incremented when you add an IPv6 network. Use the ID to specify the IPv6 network of your choice.", + "type": "integer" + }, + "pool6_name": { + "description": "The name of the IPv6 pool, each IPv6 pool must have a unique name.", + "type": "string" + }, + "pool6_read_only": { + "description": "The reservation status of the IPv6 pool. If set 1, the IP addresses it contains cannot be assigned.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "pool6_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "pool6_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "ipam_pool6_add_success": { + "example": { + "data": [ + { + "pool6_id": "pool6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_pool6_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_pool6_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_pool6_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_pool6_edit_success": { + "example": { + "data": [ + { + "pool6_id": "pool6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_pool6_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_pool6_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_pool6_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_pool6_delete_success": { + "example": { + "data": [ + { + "pool6_id": "pool6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_pool6_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_pool6_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_pool6_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_space_data": { + "example": { + "data": [ + { + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_name": "space_name", + "parent_space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_class_name": "space_class_name", + "space_is_template": "space_is_template", + "space_multistatus": "space_multistatus", + "parent_space_id": "parent_space_id", + "space_description": "space_description", + "parent_space_class_name": "parent_space_class_name", + "space_id": "space_id", + "parent_space_name": "parent_space_name" + }, + { + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_name": "space_name", + "parent_space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_class_name": "space_class_name", + "space_is_template": "space_is_template", + "space_multistatus": "space_multistatus", + "parent_space_id": "parent_space_id", + "space_description": "space_description", + "parent_space_class_name": "parent_space_class_name", + "space_id": "space_id", + "parent_space_name": "parent_space_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_space_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_space_add_input": { + "properties": { + "space_name": { + "description": "The name of the space, each space must have a unique name.", + "type": "string" + }, + "parent_space_id": { + "description": "The database identifier (ID) of an existing space you want to set as the VLSM parent of the space you are adding. This sets up a space-based VLSM organization.", + "type": "integer" + }, + "parent_space_name": { + "description": "The name of an existing space you want to set as the VLSM parent of the space you are adding. This sets up a space-based VLSM organization.", + "type": "string" + }, + "space_description": { + "description": "The description of the space.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "space_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "space_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "ipam_space_edit_input": { + "properties": { + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space, each space must have a unique name.", + "type": "string" + }, + "parent_space_id": { + "description": "The database identifier (ID) of an existing space you want to set as the VLSM parent of the space you are editing. This sets up a space-based VLSM organization.", + "type": "integer" + }, + "parent_space_name": { + "description": "The name of an existing space you want to set as the VLSM parent of the space you are editing. This sets up a space-based VLSM organization.", + "type": "string" + }, + "space_description": { + "description": "The description of the space.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "space_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "space_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "ipam_space_add_success": { + "example": { + "data": [ + { + "space_id": "space_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_space_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_space_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_space_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_space_edit_success": { + "example": { + "data": [ + { + "space_id": "space_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_space_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_space_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_space_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_space_delete_success": { + "example": { + "data": [ + { + "space_id": "space_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_space_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_space_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_space_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "vlan_domain_data": { + "example": { + "data": [ + { + "domain_id": "domain_id", + "domain_name": "domain_name", + "domain_end_vlan_id": "domain_end_vlan_id", + "domain_start_vlan_id": "domain_start_vlan_id", + "domain_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "domain_description": "domain_description", + "domain_support_vxlan": "domain_support_vxlan", + "domain_class_name": "domain_class_name" + }, + { + "domain_id": "domain_id", + "domain_name": "domain_name", + "domain_end_vlan_id": "domain_end_vlan_id", + "domain_start_vlan_id": "domain_start_vlan_id", + "domain_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "domain_description": "domain_description", + "domain_support_vxlan": "domain_support_vxlan", + "domain_class_name": "domain_class_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_vlan_domain_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "vlan_domain_add_input": { + "properties": { + "domain_name": { + "description": "The name of the VLAN domain, each VLAN domain must have a unique name.", + "type": "string" + }, + "domain_support_vxlan": { + "description": "The type of virtual network used by the domain. Set it to 1 to use VXLAN or 0 to use VLAN.", + "type": "integer" + }, + "domain_description": { + "description": "The description of the VLAN domain.", + "type": "string" + }, + "domain_end_vlan_id": { + "description": "The VLAN identifier (ID) of a VLAN, a numeric value between 1 and 4094. Use the ID to specify the last VLAN in the VLAN domain.", + "type": "integer" + }, + "domain_start_vlan_id": { + "description": "The VLAN identifier (ID) of a VLAN, a numeric value between 1 and 4094. Use the ID to specify the first VLAN in the VLAN domain.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "domain_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "domain_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "vlan_domain_edit_input": { + "properties": { + "domain_id": { + "description": "The database identifier (ID) of the VLAN domain, a unique numeric key value automatically incremented when you add a VLAN domain. Use the ID to specify the VLAN domain of your choice.", + "type": "integer" + }, + "domain_name": { + "description": "The name of the VLAN domain, each VLAN domain must have a unique name.", + "type": "string" + }, + "domain_support_vxlan": { + "description": "The type of virtual network used by the domain. Set it to 1 to use VXLAN or 0 to use VLAN.", + "type": "integer" + }, + "domain_description": { + "description": "The description of the VLAN domain.", + "type": "string" + }, + "domain_end_vlan_id": { + "description": "The VLAN identifier (ID) of a VLAN, a numeric value between 1 and 4094. Use the ID to specify the last VLAN in the VLAN domain.", + "type": "integer" + }, + "domain_start_vlan_id": { + "description": "The VLAN identifier (ID) of a VLAN, a numeric value between 1 and 4094. Use the ID to specify the first VLAN in the VLAN domain.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "domain_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "domain_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "vlan_domain_add_success": { + "example": { + "data": [ + { + "domain_id": "domain_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_vlan_domain_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "vlan_domain_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_vlan_domain_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "vlan_domain_edit_success": { + "example": { + "data": [ + { + "domain_id": "domain_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_vlan_domain_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "vlan_domain_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_vlan_domain_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "vlan_domain_delete_success": { + "example": { + "data": [ + { + "domain_id": "domain_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_vlan_domain_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "vlan_domain_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_vlan_domain_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "vlan_range_data": { + "example": { + "data": [ + { + "range_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_name": "range_name", + "domain_end_vlan_id": "domain_end_vlan_id", + "range_end_vlan_id": "range_end_vlan_id", + "domain_start_vlan_id": "domain_start_vlan_id", + "domain_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_start_vlan_id": "range_start_vlan_id", + "domain_description": "domain_description", + "range_id": "range_id", + "domain_id": "domain_id", + "domain_name": "domain_name", + "range_disable_overlapping": "range_disable_overlapping", + "range_class_name": "range_class_name", + "range_description": "range_description", + "domain_support_vxlan": "domain_support_vxlan", + "domain_class_name": "domain_class_name" + }, + { + "range_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_name": "range_name", + "domain_end_vlan_id": "domain_end_vlan_id", + "range_end_vlan_id": "range_end_vlan_id", + "domain_start_vlan_id": "domain_start_vlan_id", + "domain_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_start_vlan_id": "range_start_vlan_id", + "domain_description": "domain_description", + "range_id": "range_id", + "domain_id": "domain_id", + "domain_name": "domain_name", + "range_disable_overlapping": "range_disable_overlapping", + "range_class_name": "range_class_name", + "range_description": "range_description", + "domain_support_vxlan": "domain_support_vxlan", + "domain_class_name": "domain_class_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_vlan_range_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "vlan_range_add_input": { + "properties": { + "domain_id": { + "description": "The database identifier (ID) of the VLAN domain, a unique numeric key value automatically incremented when you add a VLAN domain. Use the ID to specify the VLAN domain of your choice.", + "type": "integer" + }, + "domain_name": { + "description": "The name of the VLAN domain.", + "type": "string" + }, + "range_name": { + "description": "The name of the VLAN range, each VLAN range must have a unique name.", + "type": "string" + }, + "range_description": { + "description": "The description of the VLAN range.", + "type": "string" + }, + "range_disable_overlapping": { + "description": "The overlapping restriction status of the VLAN range. Set it to 1 to prevent VLAN ID overlapping in the range.", + "type": "integer" + }, + "range_end_vlan_id": { + "description": "The VLAN identifier (ID) of an existing VLAN you want to set as the last VLAN in the VLAN range.", + "type": "integer" + }, + "range_start_vlan_id": { + "description": "The VLAN identifier (ID) of an existing VLAN you want to set as the first VLAN in the VLAN range.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "range_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "range_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "vlan_range_edit_input": { + "properties": { + "domain_id": { + "description": "The database identifier (ID) of the VLAN domain, a unique numeric key value automatically incremented when you add a VLAN domain. Use the ID to specify the VLAN domain of your choice.", + "type": "integer" + }, + "domain_name": { + "description": "The name of the VLAN domain.", + "type": "string" + }, + "range_id": { + "description": "The database identifier (ID) of the VLAN range, a unique numeric key value automatically incremented when you add a VLAN range. Use the ID to specify the VLAN range of your choice.", + "type": "integer" + }, + "range_name": { + "description": "The name of the VLAN range, each VLAN range must have a unique name.", + "type": "string" + }, + "range_description": { + "description": "The description of the VLAN range.", + "type": "string" + }, + "range_disable_overlapping": { + "description": "The overlapping restriction status of the VLAN range. Set it to 1 to prevent VLAN ID overlapping in the range.", + "type": "integer" + }, + "range_end_vlan_id": { + "description": "The VLAN identifier (ID) of an existing VLAN you want to set as the last VLAN in the VLAN range.", + "type": "integer" + }, + "range_start_vlan_id": { + "description": "The VLAN identifier (ID) of an existing VLAN you want to set as the first VLAN in the VLAN range.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "range_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "range_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "vlan_range_add_success": { + "example": { + "data": [ + { + "range_id": "range_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_vlan_range_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "vlan_range_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_vlan_range_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "vlan_range_edit_success": { + "example": { + "data": [ + { + "range_id": "range_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_vlan_range_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "vlan_range_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_vlan_range_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "vlan_range_delete_success": { + "example": { + "data": [ + { + "range_id": "range_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_vlan_range_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "vlan_range_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_vlan_range_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "vlan_vlan_data": { + "example": { + "data": [ + { + "range_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_name": "range_name", + "vlan_id": "vlan_id", + "domain_end_vlan_id": "domain_end_vlan_id", + "range_end_vlan_id": "range_end_vlan_id", + "domain_start_vlan_id": "domain_start_vlan_id", + "vlan_vlan_id": "vlan_vlan_id", + "domain_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_start_vlan_id": "range_start_vlan_id", + "free_start_vlan_id": "free_start_vlan_id", + "domain_description": "domain_description", + "vlan_name": "vlan_name", + "range_id": "range_id", + "domain_id": "domain_id", + "domain_name": "domain_name", + "vlan_class_name": "vlan_class_name", + "range_class_name": "range_class_name", + "vlan_type": "vlan_type", + "free_end_vlan_id": "free_end_vlan_id", + "range_description": "range_description", + "domain_support_vxlan": "domain_support_vxlan", + "vlan_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "domain_class_name": "domain_class_name" + }, + { + "range_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_name": "range_name", + "vlan_id": "vlan_id", + "domain_end_vlan_id": "domain_end_vlan_id", + "range_end_vlan_id": "range_end_vlan_id", + "domain_start_vlan_id": "domain_start_vlan_id", + "vlan_vlan_id": "vlan_vlan_id", + "domain_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_start_vlan_id": "range_start_vlan_id", + "free_start_vlan_id": "free_start_vlan_id", + "domain_description": "domain_description", + "vlan_name": "vlan_name", + "range_id": "range_id", + "domain_id": "domain_id", + "domain_name": "domain_name", + "vlan_class_name": "vlan_class_name", + "range_class_name": "range_class_name", + "vlan_type": "vlan_type", + "free_end_vlan_id": "free_end_vlan_id", + "range_description": "range_description", + "domain_support_vxlan": "domain_support_vxlan", + "vlan_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "domain_class_name": "domain_class_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_vlan_vlan_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "vlan_vlan_add_input": { + "properties": { + "domain_id": { + "description": "The database identifier (ID) of the VLAN domain, a unique numeric key value automatically incremented when you add a VLAN domain. Use the ID to specify the VLAN domain of your choice.", + "type": "integer" + }, + "domain_name": { + "description": "The name of the VLAN domain.", + "type": "string" + }, + "vlan_vlan_id": { + "description": "The VLAN identifier (ID) of the VLAN, a unique numeric key value within a VLAN domain. Use the ID to specify the VLAN of your choice.", + "type": "integer" + }, + "range_id": { + "description": "The database identifier (ID) of the VLAN range, a unique numeric key value automatically incremented when you add a VLAN range. Use the ID to specify the VLAN range of your choice.", + "type": "integer" + }, + "range_name": { + "description": "The name of the VLAN range.", + "type": "string" + }, + "vlan_name": { + "description": "The name of the VLAN, each VLAN must have a unique name.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "vlan_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "vlan_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "vlan_vlan_edit_input": { + "properties": { + "domain_id": { + "description": "The database identifier (ID) of the VLAN domain, a unique numeric key value automatically incremented when you add a VLAN domain. Use the ID to specify the VLAN domain of your choice.", + "type": "integer" + }, + "domain_name": { + "description": "The name of the VLAN domain.", + "type": "string" + }, + "vlan_id": { + "description": "The database identifier (ID) of the VLAN, a unique numeric key value automatically incremented when you add a VLAN. Use the ID to specify the VLAN of your choice.", + "type": "integer" + }, + "vlan_vlan_id": { + "description": "The VLAN identifier (ID) of the VLAN, a unique numeric key value within a VLAN domain. Use the ID to specify the VLAN of your choice.", + "type": "integer" + }, + "range_id": { + "description": "The database identifier (ID) of the VLAN range, a unique numeric key value automatically incremented when you add a VLAN range. Use the ID to specify the VLAN range of your choice.", + "type": "integer" + }, + "range_name": { + "description": "The name of the VLAN range.", + "type": "string" + }, + "vlan_name": { + "description": "The name of the VLAN, each VLAN must have a unique name.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "vlan_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "vlan_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "vlan_vlan_add_success": { + "example": { + "data": [ + { + "vlan_id": "vlan_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_vlan_vlan_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "vlan_vlan_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_vlan_vlan_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "vlan_vlan_edit_success": { + "example": { + "data": [ + { + "vlan_id": "vlan_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_vlan_vlan_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "vlan_vlan_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_vlan_vlan_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "vlan_vlan_delete_success": { + "example": { + "data": [ + { + "vlan_id": "vlan_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_vlan_vlan_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "vlan_vlan_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_vlan_vlan_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ApiCountResponseSuccess_data_inner": { + "example": { + "count": 0 + }, + "properties": { + "count": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "_data_inner_app_application_data": { + "example": { + "application_fqdn": "application_fqdn", + "application_inactive_nodes": "application_inactive_nodes", + "application_delayed_time": "application_delayed_time", + "application_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "application_total_nodes": "application_total_nodes", + "application_class_name": "application_class_name", + "parent_application_id": "parent_application_id", + "application_multistatus": "application_multistatus", + "gslbserver_id": "gslbserver_id", + "application_id": "application_id", + "gslbserver_list": "gslbserver_list", + "gslbserver_type": "gslbserver_type", + "gslbserver_name": "gslbserver_name", + "gslbserver_status": "gslbserver_status", + "application_name": "application_name", + "parent_application_name": "parent_application_name" + }, + "properties": { + "application_class_name": { + "description": "The name of the class applied to the object, it can be preceded by the class directory.", + "type": "string" + }, + "application_class_parameters": { + "description": "The class parameters applied to the application and their value: <class-parameter1>=<value1>&<class-parameter2>=<value2>&... .", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "application_fqdn": { + "description": "The FQDN of the application.", + "type": "string" + }, + "gslbserver_id": { + "description": "The database identifier (ID) of the GSLB server associated with the application. It is only returned for deployed applications.", + "type": "string" + }, + "gslbserver_list": { + "description": "The name of all the GSLB servers associated with the application. It lists the name of each server separated by a comma.", + "type": "string" + }, + "gslbserver_name": { + "description": "The name of the GSLB server associated with the application. It is only returned for deployed applications.", + "type": "string" + }, + "gslbserver_status": { + "description": "The status of the GSLB server associated with the application, either OK (1), GSLB Stopped (2), GSLB Invalid Credentials (4) or GSLB Timeout (5). It is only returned for deployed applications.", + "type": "string" + }, + "application_id": { + "description": "The database identifier (ID) of the application.", + "type": "string" + }, + "application_inactive_nodes": { + "description": "The number of nodes of the application that are Inactive (down).", + "type": "string" + }, + "application_name": { + "description": "The name of the application.", + "type": "string" + }, + "application_total_nodes": { + "description": "The number of nodes of the application.", + "type": "string" + }, + "application_delayed_time": { + "description": "The delay of creation/deletion status. 1 indicates that the object is not created/deleted yet.", + "type": "string" + }, + "gslbserver_type": { + "description": "The type of DNS server associated with the application. It is only returned for deployed applications.", + "type": "string" + }, + "application_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                      Multi-status severity levels
                                                                                                                                      Message number Severity Description
                                                                                                                                      0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                      17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                      34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                      51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                      67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                      84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                      ", + "type": "string" + }, + "parent_application_id": { + "description": "The database identifier (ID) of the application. It is only returned for deployed applications.", + "type": "string" + }, + "parent_application_name": { + "description": "The name of the application. It is only returned for deployed applications.", + "type": "string" + } + }, + "title": "_data_inner_app_application_data", + "type": "object" + }, + "_data_inner_app_application_add_success": { + "example": { + "application_id": "application_id" + }, + "properties": { + "application_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_app_application_add_success", + "type": "object" + }, + "_data_inner_app_application_edit_success": { + "example": { + "application_id": "application_id" + }, + "properties": { + "application_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_app_application_edit_success", + "type": "object" + }, + "_data_inner_app_application_delete_success": { + "example": { + "application_id": "application_id" + }, + "properties": { + "application_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_app_application_delete_success", + "type": "object" + }, + "_data_inner_app_node_data": { + "example": { + "healthcheck_timeout": "healthcheck_timeout", + "healthcheck_id": "healthcheck_id", + "gslbserver_name": "gslbserver_name", + "application_name": "application_name", + "node_delayed_time": "node_delayed_time", + "admin_status": "admin_status", + "pool_lb_mode": "pool_lb_mode", + "healthcheck_name": "healthcheck_name", + "translated_healthcheck_name": "translated_healthcheck_name", + "application_fqdn": "application_fqdn", + "node_status": "node_status", + "healthcheck_params": "healthcheck_params", + "node_weight": "node_weight", + "translated_pool_lb_mode": "translated_pool_lb_mode", + "node_name": "node_name", + "parent_application_id": "parent_application_id", + "healthcheck_failover": "healthcheck_failover", + "pool_id": "pool_id", + "gslbserver_id": "gslbserver_id", + "application_id": "application_id", + "pool_name": "pool_name", + "gslbserver_type": "gslbserver_type", + "node_address_addr": "node_address_addr", + "healthcheck_freq": "healthcheck_freq", + "node_address6_addr": "node_address6_addr", + "healthcheck_failback": "healthcheck_failback", + "node_id": "node_id" + }, + "properties": { + "admin_status": { + "description": "The administrative status of the node. 1 indicates the node is managed. 0 indicates that is unmanaged and ignored.", + "type": "string" + }, + "application_fqdn": { + "description": "The FQDN of the application the object belongs to.", + "type": "string" + }, + "gslbserver_id": { + "description": "The database identifier (ID) of the GSLB server associated with the application the object belongs to. It is only returned for deployed applications.", + "type": "string" + }, + "gslbserver_name": { + "description": "The name of the GSLB server associated with the application the object belongs to. It is only returned for deployed applications.", + "type": "string" + }, + "application_id": { + "description": "The database identifier (ID) of the application the object belongs to.", + "type": "string" + }, + "application_name": { + "description": "The name of the application the object belongs to.", + "type": "string" + }, + "healthcheck_failback": { + "description": "The number of times, between 1 and 10, before the parameter node_status is set to 1 (active) due to the health check result. By default, it is set to 3.", + "type": "string" + }, + "healthcheck_failover": { + "description": "The number of times, between 1 and 10, before the parameter node_status is set to 0 (inactive) due to the health check result. By default, it is set to 3.", + "type": "string" + }, + "healthcheck_freq": { + "description": "The frequency to which the health check configured for the node is performed, in seconds.", + "type": "string" + }, + "healthcheck_id": { + "description": "The database identifier (ID) of the health check configured for the node.", + "type": "string" + }, + "healthcheck_name": { + "description": "The type of health check configured for the node.", + "type": "string" + }, + "healthcheck_params": { + "description": "The rest of the health check parameters configured, when relevant.", + "type": "string" + }, + "healthcheck_timeout": { + "description": "The number of seconds, between 1 and 10, before the health check times out if the node is not responding.", + "type": "string" + }, + "node_id": { + "description": "The database identifier (ID) of the node.", + "type": "string" + }, + "node_address6_addr": { + "description": "The IPv6 address of the node.", + "type": "string" + }, + "node_address_addr": { + "description": "The IPv4 address of the node.", + "type": "string" + }, + "node_name": { + "description": "The name of the node.", + "type": "string" + }, + "node_status": { + "description": "The operational status of the node:", + "type": "string" + }, + "node_weight": { + "description": "The weight of the node, an integer between 0 and 255. 0 indicates a backup node.", + "type": "string" + }, + "pool_id": { + "description": "The database identifier (ID) of the pool.", + "type": "string" + }, + "pool_lb_mode": { + "description": "The load-balancing mode of the pool the object belongs to, either weighted, round-robin or latency.", + "type": "string" + }, + "pool_name": { + "description": "The name of the pool.", + "type": "string" + }, + "node_delayed_time": { + "description": "The delay of creation/deletion status. 1 indicates that the object is not created/deleted yet.", + "type": "string" + }, + "gslbserver_type": { + "description": "The type of DNS server associated with the application the object belongs to. It is only returned for deployed applications.", + "type": "string" + }, + "parent_application_id": { + "description": "The database identifier (ID) of the application the object belongs to. It is only returned for deployed applications.", + "type": "string" + }, + "translated_healthcheck_name": { + "description": "The health check type, as displayed in the GUI.", + "type": "string" + }, + "translated_pool_lb_mode": { + "description": "The load-balancing mode of the pool the object belongs to, as displayed in the GUI.", + "type": "string" + } + }, + "title": "_data_inner_app_node_data", + "type": "object" + }, + "_data_inner_app_node_add_success": { + "example": { + "node_id": "node_id" + }, + "properties": { + "node_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_app_node_add_success", + "type": "object" + }, + "_data_inner_app_node_edit_success": { + "example": { + "node_id": "node_id" + }, + "properties": { + "node_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_app_node_edit_success", + "type": "object" + }, + "_data_inner_app_node_delete_success": { + "example": { + "node_id": "node_id" + }, + "properties": { + "node_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_app_node_delete_success", + "type": "object" + }, + "_data_inner_app_pool_data": { + "example": { + "pool_affinity_state": "pool_affinity_state", + "application_fqdn": "application_fqdn", + "pool_inactive_nodes": "pool_inactive_nodes", + "translated_pool_lb_mode": "translated_pool_lb_mode", + "pool_weight": "pool_weight", + "parent_application_id": "parent_application_id", + "pool_delayed_time": "pool_delayed_time", + "pool_id": "pool_id", + "gslbserver_id": "gslbserver_id", + "application_id": "application_id", + "pool_total_nodes": "pool_total_nodes", + "pool_multistatus": "pool_multistatus", + "pool_name": "pool_name", + "gslbserver_type": "gslbserver_type", + "pool_best_active_nodes": "pool_best_active_nodes", + "gslbserver_name": "gslbserver_name", + "application_name": "application_name", + "pool_affinity_session_time": "pool_affinity_session_time", + "pool_lb_mode": "pool_lb_mode", + "pool_type": "pool_type" + }, + "properties": { + "application_fqdn": { + "description": "The FQDN of the application the object belongs to.", + "type": "string" + }, + "gslbserver_id": { + "description": "The database identifier (ID) of the GSLB server associated with the application the object belongs to. It is only returned for deployed applications.", + "type": "string" + }, + "gslbserver_name": { + "description": "The name of the GSLB server associated with the application the object belongs to. It is only returned for deployed applications.", + "type": "string" + }, + "application_id": { + "description": "The database identifier (ID) of the application the object belongs to.", + "type": "string" + }, + "application_name": { + "description": "The name of the application the object belongs to.", + "type": "string" + }, + "pool_affinity_session_time": { + "description": "The session duration, in seconds. It is only returned if the parameter affinity_state is set to 1.", + "type": "string" + }, + "pool_affinity_state": { + "description": "The session affinity activation status.", + "type": "string" + }, + "pool_best_active_nodes": { + "description": "The maximum number of active nodes with the lowest latency that must answer the queries made to the application FQDN. It is only returned if the parameter pool_lb_mode is set to latency.", + "type": "string" + }, + "pool_id": { + "description": "The database identifier (ID) of the pool.", + "type": "string" + }, + "pool_inactive_nodes": { + "description": "The number nodes of the pool that are Inactive (down).", + "type": "string" + }, + "pool_lb_mode": { + "description": "The load-balancing mode of the pool, either weighted, round-robin or latency.", + "type": "string" + }, + "pool_name": { + "description": "The name of the pool.", + "type": "string" + }, + "pool_total_nodes": { + "description": "The number of nodes of the pool.", + "type": "string" + }, + "pool_type": { + "description": "The type of the pool, ipv4 or ipv6.", + "type": "string" + }, + "pool_weight": { + "description": "Not documented. Internal use.", + "type": "string" + }, + "pool_delayed_time": { + "description": "The delay of creation/deletion status. 1 indicates that the object is not created/deleted yet.", + "type": "string" + }, + "gslbserver_type": { + "description": "The type of DNS server associated with the application the object belongs to. It is only returned for deployed applications.", + "type": "string" + }, + "pool_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                      Multi-status severity levels
                                                                                                                                      Message number Severity Description
                                                                                                                                      0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                      17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                      34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                      51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                      67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                      84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                      ", + "type": "string" + }, + "parent_application_id": { + "description": "The database identifier (ID) of the application the object belongs to. It is only returned for deployed applications.", + "type": "string" + }, + "translated_pool_lb_mode": { + "description": "The load-balancing mode of the pool, as displayed in the GUI.", + "type": "string" + } + }, + "title": "_data_inner_app_pool_data", + "type": "object" + }, + "_data_inner_app_pool_add_success": { + "example": { + "pool_id": "pool_id" + }, + "properties": { + "pool_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_app_pool_add_success", + "type": "object" + }, + "_data_inner_app_pool_edit_success": { + "example": { + "pool_id": "pool_id" + }, + "properties": { + "pool_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_app_pool_edit_success", + "type": "object" + }, + "_data_inner_app_pool_delete_success": { + "example": { + "pool_id": "pool_id" + }, + "properties": { + "pool_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_app_pool_delete_success", + "type": "object" + }, + "_data_inner_device_device_data": { + "example": { + "dev_name": "dev_name", + "device_id": "device_id", + "row_state": "row_state", + "device_port_used_percent": "device_port_used_percent", + "device_address_formated": "device_address_formated", + "interface_free": "interface_free", + "device_port_free": "device_port_free", + "device_class_name": "device_class_name", + "device_address_addr": "device_address_addr", + "device_space_id": "device_space_id", + "dev_id": "dev_id", + "device_name": "device_name", + "device_port_total": "device_port_total", + "interface_used_percent": "interface_used_percent", + "device_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "interface_total": "interface_total", + "device_port_used": "device_port_used", + "device_space_name": "device_space_name", + "interface_used": "interface_used" + }, + "properties": { + "device_class_name": { + "description": "The name of the class applied to the device, it can be preceded by the class directory.", + "type": "string" + }, + "device_class_parameters": { + "description": "The class parameters applied to the device.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "device_id": { + "description": "The database identifier (ID) of the Device Manager device.", + "type": "string" + }, + "device_address_addr": { + "description": "The IP address associated with the Device Manager device.", + "type": "string" + }, + "device_address_formated": { + "description": "The human readable version of the parameter device_address_addr.", + "type": "string" + }, + "device_name": { + "description": "The name of the Device Manager device.", + "type": "string" + }, + "device_space_id": { + "description": "The database identifier (ID) of the space associated with the Device Manager device.", + "type": "string" + }, + "device_space_name": { + "description": "The name of the space associated with the Device Manager device.", + "type": "string" + }, + "interface_free": { + "description": "The number of interfaces on the Device Manager device that are currently free.", + "type": "string" + }, + "interface_total": { + "description": "The total number of interfaces on the Device Manager device.", + "type": "string" + }, + "interface_used": { + "description": "The number of interfaces on the Device Manager device that are currently active.", + "type": "string" + }, + "interface_used_percent": { + "description": "The percentage of interfaces on the Device Manager device that are currently active.", + "type": "string" + }, + "dev_id": { + "description": "The database identifier (ID) of the NetChange network device associated with the Device Manager device.", + "type": "string" + }, + "dev_name": { + "description": "The name of the NetChange network device associated with the Device Manager device.", + "type": "string" + }, + "device_port_free": { + "description": "The number of ports on the Device Manager device that are currently free.", + "type": "string" + }, + "device_port_total": { + "description": "The total number of ports on the Device Manager device.", + "type": "string" + }, + "device_port_used": { + "description": "The number of ports on the Device Manager device that are currently active.", + "type": "string" + }, + "device_port_used_percent": { + "description": "The percentage of ports on the Device Manager device that are currently active.", + "type": "string" + }, + "row_state": { + "description": "The object activation status:
                                                                                                                                      • 0 indicates the object is present in the database but ignored, i.e. it cannot be managed, counted or listed. This status is applied on objects deleted from the GUI.
                                                                                                                                      • 1 indicates the object is enabled and managed.
                                                                                                                                      • 2 indicates the object is unmanaged, disabled or both depending on the context.
                                                                                                                                      By default, row_state is set to 1 when an object is created.", + "type": "string" + } + }, + "title": "_data_inner_device_device_data", + "type": "object" + }, + "_data_inner_device_device_add_success": { + "example": { + "device_id": "device_id" + }, + "properties": { + "device_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_device_device_add_success", + "type": "object" + }, + "_data_inner_device_device_edit_success": { + "example": { + "device_id": "device_id" + }, + "properties": { + "device_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_device_device_edit_success", + "type": "object" + }, + "_data_inner_device_device_delete_success": { + "example": { + "device_id": "device_id" + }, + "properties": { + "device_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_device_device_delete_success", + "type": "object" + }, + "_data_inner_device_interface_data": { + "example": { + "interface_manual_link": "interface_manual_link", + "pear_iface_id": "pear_iface_id", + "interface_vendor_key": "interface_vendor_key", + "interface_nb_ip": "interface_nb_ip", + "interface_class_name": "interface_class_name", + "interface_name": "interface_name", + "interface_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "interface_mac": "interface_mac", + "device_name": "device_name", + "data_id": "data_id", + "interface_add_time": "interface_add_time", + "interface_type": "interface_type", + "interface_address_addr": "interface_address_addr", + "dev_name": "dev_name", + "interface_address_formated": "interface_address_formated", + "device_id": "device_id", + "interface_space_id": "interface_space_id", + "interface_modify_time": "interface_modify_time", + "row_state": "row_state", + "pear_ipl_iface_id": "pear_ipl_iface_id", + "device_class_name": "device_class_name", + "dev_enabled": "dev_enabled", + "dev_id": "dev_id", + "port_name": "port_name", + "interface_id": "interface_id", + "port_enabled": "port_enabled", + "interface_vendor_mac": "interface_vendor_mac", + "device_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "port_id": "port_id", + "interface_auto_link": "interface_auto_link", + "interface_space_name": "interface_space_name" + }, + "properties": { + "interface_add_time": { + "description": "The time at which the Device Manager port or interface has been added, in decimal UNIX date format.", + "type": "string" + }, + "data_id": { + "description": "The database identifier (ID) of the Custom Database entry associated with the Device Manager port or interface.", + "type": "string" + }, + "device_class_name": { + "description": "The name of the class applied to the device the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "device_class_parameters": { + "description": "The class parameters applied to the Device Manager device the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "device_id": { + "description": "The database identifier (ID) of the Device Manager device the object belongs to.", + "type": "string" + }, + "device_name": { + "description": "The name of the Device Manager device.", + "type": "string" + }, + "interface_auto_link": { + "description": "The DM device and port or interface to which the object is automatically linked, as follows: <hostdev_name> ( <hostiface_name> )", + "type": "string" + }, + "interface_class_name": { + "description": "The name of the class applied to the port or interface, it can be preceded by the class directory.", + "type": "string" + }, + "interface_class_parameters": { + "description": "The class parameters applied to the port or interface.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "interface_id": { + "description": "The database identifier (ID) of the Device Manager port or interface.", + "type": "string" + }, + "interface_address_addr": { + "description": "The IP address associated with the Device Manager port or interface.", + "type": "string" + }, + "interface_address_formated": { + "description": "The human readable version of the parameter interface_address_addr.", + "type": "string" + }, + "interface_mac": { + "description": "The MAC address associated with the Device Manager port or interface.", + "type": "string" + }, + "interface_manual_link": { + "description": "The DM device and port or interface to which the object is manually linked, as follows: <hostdev_name> ( <hostiface_name> )", + "type": "string" + }, + "interface_name": { + "description": "The name of the Device Manager port or interface.", + "type": "string" + }, + "interface_space_id": { + "description": "The database identifier (ID) of the space associated with the Device Manager port or interface.", + "type": "string" + }, + "interface_space_name": { + "description": "The name of the space associated with the Device Manager port or interface.", + "type": "string" + }, + "interface_type": { + "description": "A way to indicate if the object is either a port or an interface.", + "type": "string" + }, + "dev_enabled": { + "description": "The activation status of the NetChange network device associated with the DM port or interface.
                                                                                                                                      • If set to 1, the NetChange network device is enabled and managed.
                                                                                                                                      • If set to 2, the NetChange network device is unmanaged, disabled or both depending on the context.
                                                                                                                                      ", + "type": "string" + }, + "dev_id": { + "description": "The database identifier (ID) of the NetChange network device associated with the Device Manager device the object belongs to.", + "type": "string" + }, + "dev_name": { + "description": "The name of the NetChange network device associated with the Device Manager device the object belongs to.", + "type": "string" + }, + "port_enabled": { + "description": "The activation status of the NetChange port associated with the DM port or interface.
                                                                                                                                      • If set to 1, the NetChange port is enabled and managed.
                                                                                                                                      • If set to 2, the NetChange port is unmanaged, disabled or both depending on the context.
                                                                                                                                      ", + "type": "string" + }, + "port_id": { + "description": "The database identifier (ID) of the NetChange port associated with the Device Manager port or interface.", + "type": "string" + }, + "port_name": { + "description": "The name of the NetChange port associated with the DM port or interface.", + "type": "string" + }, + "interface_modify_time": { + "description": "The last time the Device Manager port or interface data was reconciled, in decimal UNIX date format.", + "type": "string" + }, + "interface_nb_ip": { + "description": "The number of IP addresses associated with the Device Manager port or interface.", + "type": "string" + }, + "pear_iface_id": { + "description": "The database identifier (ID) of the Device Manager port or interface linked with interface_id.", + "type": "string" + }, + "pear_ipl_iface_id": { + "description": "The database identifier (ID) of the NetChange port linked with interface_id.", + "type": "string" + }, + "row_state": { + "description": "The object activation status:
                                                                                                                                      • 0 indicates the object is present in the database but ignored, i.e. it cannot be managed, counted or listed. This status is applied on objects deleted from the GUI.
                                                                                                                                      • 1 indicates the object is enabled and managed.
                                                                                                                                      • 2 indicates the object is unmanaged, disabled or both depending on the context.
                                                                                                                                      By default, row_state is set to 1 when an object is created.", + "type": "string" + }, + "interface_vendor_key": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "interface_vendor_mac": { + "description": "The vendor details of the client associated with the Device Manager port or interface.", + "type": "string" + } + }, + "title": "_data_inner_device_interface_data", + "type": "object" + }, + "_data_inner_device_interface_add_success": { + "example": { + "interface_id": "interface_id" + }, + "properties": { + "interface_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_device_interface_add_success", + "type": "object" + }, + "_data_inner_device_interface_edit_success": { + "example": { + "interface_id": "interface_id" + }, + "properties": { + "interface_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_device_interface_edit_success", + "type": "object" + }, + "_data_inner_device_interface_delete_success": { + "example": { + "interface_id": "interface_id" + }, + "properties": { + "interface_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_device_interface_delete_success", + "type": "object" + }, + "_data_inner_device_link_data": { + "example": { + "device_name": "device_name", + "interface_id": "interface_id", + "device_id": "device_id", + "link_add_time": "link_add_time", + "link_auto_link": "link_auto_link", + "interface_name": "interface_name", + "interface_type": "interface_type", + "link_id": "link_id", + "interface_mac": "interface_mac" + }, + "properties": { + "link_add_time": { + "description": "The time at which the Device Manager port or interface has been added, in decimal UNIX date format.", + "type": "string" + }, + "link_auto_link": { + "description": "A way to determine if the link between two Device Manager devices is set automatically (1) or manually (0).", + "type": "string" + }, + "device_id": { + "description": "The database identifier (ID) of the Device Manager device the object belongs to.", + "type": "string" + }, + "device_name": { + "description": "The name of the Device Manager device.", + "type": "string" + }, + "interface_id": { + "description": "The database identifier (ID) of the Device Manager port or interface.", + "type": "string" + }, + "interface_mac": { + "description": "The MAC address associated with the Device Manager port or interface.", + "type": "string" + }, + "interface_name": { + "description": "The name of the Device Manager port or interface.", + "type": "string" + }, + "interface_type": { + "description": "A way to indicate if the object is either a port or an interface.", + "type": "string" + }, + "link_id": { + "description": "The database identifier (ID) of the Device Manager port or interface link. Use the ID to specify the port or interface link of your choice.", + "type": "string" + } + }, + "title": "_data_inner_device_link_data", + "type": "object" + }, + "_data_inner_device_link_add_success": { + "example": { + "link_id": "link_id" + }, + "properties": { + "link_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_device_link_add_success", + "type": "object" + }, + "_data_inner_device_link_edit_success": { + "example": { + "link_id": "link_id" + }, + "properties": { + "link_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_device_link_edit_success", + "type": "object" + }, + "_data_inner_device_link_delete_success": { + "example": { + "link_id": "link_id" + }, + "properties": { + "link_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_device_link_delete_success", + "type": "object" + }, + "_data_inner_dhcp_acl_data": { + "example": { + "server_name": "server_name", + "acl_spawnwith": "acl_spawnwith", + "server_id": "server_id", + "acl_leaselimit": "acl_leaselimit", + "acl_statement": "acl_statement", + "smart_parent_id": "smart_parent_id", + "acl_name": "acl_name", + "acl_delayed_create_time": "acl_delayed_create_time", + "server_cluster_role": "server_cluster_role", + "acl_delayed_delete_time": "acl_delayed_delete_time", + "acl_id": "acl_id", + "acl_match": "acl_match", + "server_type": "server_type" + }, + "properties": { + "server_cluster_role": { + "description": "The role of the server the object belongs to in the cluster, either active (M), passive (B) or N/A (#).", + "type": "string" + }, + "acl_delayed_create_time": { + "description": "The delay of creation status. 1 indicates that the object is not created yet.", + "type": "string" + }, + "acl_delayed_delete_time": { + "description": "The delay of deletion status. 1 indicates that the object is not deleted yet.", + "type": "string" + }, + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_name": { + "description": "The name of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_type": { + "description": "The type of the DHCPv4 server the object belongs to:


                                                                                                                                      server_type possible values
                                                                                                                                      TypeDescription
                                                                                                                                      ipmEfficientIP or EfficientIP Package server
                                                                                                                                      msrpcMicrosoft Windows DHCP server
                                                                                                                                      vdhcpEfficientIP DHCPv4 smart architecture


                                                                                                                                      ", + "type": "string" + }, + "acl_id": { + "description": "The database identifier (ID) of the DHCPv4 ACL.", + "type": "string" + }, + "acl_leaselimit": { + "description": "The lease limit of the DHCPv4 ACL.", + "type": "string" + }, + "acl_match": { + "description": "The ACL rule associated with the DHCPv4 ACL, as follows: <match if (substring(option agent.remote-id,0,6) = dslam1);>", + "type": "string" + }, + "acl_name": { + "description": "The name of the DHCPv4 ACL.", + "type": "string" + }, + "acl_spawnwith": { + "description": "The spawning class associated with the DHCPv4 ACL.", + "type": "string" + }, + "acl_statement": { + "description": "The statement associated with the DHCPv4 ACL.", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_acl_data", + "type": "object" + }, + "_data_inner_dhcp_acl6_data": { + "example": { + "acl6_statement": "acl6_statement", + "smart_parent_id": "smart_parent_id", + "acl6_id": "acl6_id", + "acl6_match": "acl6_match", + "server_cluster_role": "server_cluster_role", + "acl6_spawnwith": "acl6_spawnwith", + "acl6_name": "acl6_name", + "server6_id": "server6_id", + "acl6_delayed_time": "acl6_delayed_time", + "server6_type": "server6_type", + "server6_name": "server6_name" + }, + "properties": { + "server_cluster_role": { + "description": "The role of the server the object belongs to in the cluster, either active (M), passive (B) or N/A (#).", + "type": "string" + }, + "acl6_delayed_time": { + "description": "The delay of creation/deletion status. 1 indicates that the object is not created/deleted yet.", + "type": "string" + }, + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_name": { + "description": "The name of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_type": { + "description": "The type of the DHCPv6 server the object belongs to:


                                                                                                                                      server6_type possible values
                                                                                                                                      TypeDescription
                                                                                                                                      ipmEfficientIP or EfficientIP Package server
                                                                                                                                      vdhcpEfficientIP DHCPv6 smart architecture


                                                                                                                                      ", + "type": "string" + }, + "acl6_id": { + "description": "The database identifier (ID) of the DHCPv6 ACL.", + "type": "string" + }, + "acl6_match": { + "description": "The ACL rule associated with the DHCPv6 ACL, as follows: <match if (substring(option agent.remote-id,0,6) = dslam1);>", + "type": "string" + }, + "acl6_name": { + "description": "The name of the DHCPv6 ACL.", + "type": "string" + }, + "acl6_spawnwith": { + "description": "The spawning class associated with the DHCPv6 ACL.", + "type": "string" + }, + "acl6_statement": { + "description": "The statement associated with the DHCPv6 ACL.", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv6 smart architecture managing the DHCPv6 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_acl6_data", + "type": "object" + }, + "_data_inner_dhcp_aclentry_data": { + "example": { + "aclentry_id": "aclentry_id", + "server_name": "server_name", + "aclentry_leaselimit": "aclentry_leaselimit", + "smart_parent_id": "smart_parent_id", + "acl_name": "acl_name", + "server_cluster_role": "server_cluster_role", + "aclentry_delayed_delete_time": "aclentry_delayed_delete_time", + "aclentry_value": "aclentry_value", + "aclentry_delayed_create_time": "aclentry_delayed_create_time", + "acl_id": "acl_id", + "server_id": "server_id", + "server_type": "server_type" + }, + "properties": { + "server_cluster_role": { + "description": "The role of the server the object belongs to in the cluster, either active (M), passive (B) or N/A (#).", + "type": "string" + }, + "aclentry_delayed_create_time": { + "description": "The delay of creation status. 1 indicates that the object is not created yet.", + "type": "string" + }, + "aclentry_delayed_delete_time": { + "description": "The delay of deletion status. 1 indicates that the object is not deleted yet.", + "type": "string" + }, + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_name": { + "description": "The name of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_type": { + "description": "The type of the DHCPv4 server the object belongs to:


                                                                                                                                      server_type possible values
                                                                                                                                      TypeDescription
                                                                                                                                      ipmEfficientIP or EfficientIP Package server
                                                                                                                                      msrpcMicrosoft Windows DHCP server
                                                                                                                                      vdhcpEfficientIP DHCPv4 smart architecture


                                                                                                                                      ", + "type": "string" + }, + "acl_id": { + "description": "The database identifier (ID) of the DHCPv4 ACL.", + "type": "string" + }, + "acl_name": { + "description": "The name of the DHCPv4 ACL.", + "type": "string" + }, + "aclentry_id": { + "description": "The database identifier (ID) of the DHCPv4 ACL entry.", + "type": "string" + }, + "aclentry_leaselimit": { + "description": "The lease limit of the DHCPv4 ACL entry.", + "type": "string" + }, + "aclentry_value": { + "description": "The value of the DHCPv4 ACL entry.", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_aclentry_data", + "type": "object" + }, + "_data_inner_dhcp_aclentry6_data": { + "example": { + "aclentry6_value": "aclentry6_value", + "smart_parent_id": "smart_parent_id", + "aclentry6_delayed_time": "aclentry6_delayed_time", + "acl6_id": "acl6_id", + "server_cluster_role": "server_cluster_role", + "aclentry6_id": "aclentry6_id", + "acl6_name": "acl6_name", + "server6_id": "server6_id", + "server6_type": "server6_type", + "server6_name": "server6_name" + }, + "properties": { + "server_cluster_role": { + "description": "The role of the server the object belongs to in the cluster, either active (M), passive (B) or N/A (#).", + "type": "string" + }, + "aclentry6_delayed_time": { + "description": "The delay of creation/deletion status. 1 indicates that the object is not created/deleted yet.", + "type": "string" + }, + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_name": { + "description": "The name of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_type": { + "description": "The type of the DHCPv6 server the object belongs to:


                                                                                                                                      server6_type possible values
                                                                                                                                      TypeDescription
                                                                                                                                      ipmEfficientIP or EfficientIP Package server
                                                                                                                                      vdhcpEfficientIP DHCPv6 smart architecture


                                                                                                                                      ", + "type": "string" + }, + "acl6_id": { + "description": "The database identifier (ID) of the DHCPv6 ACL.", + "type": "string" + }, + "acl6_name": { + "description": "The name of the DHCPv6 ACL.", + "type": "string" + }, + "aclentry6_id": { + "description": "The database identifier (ID) of the DHCPv6 ACL entry.", + "type": "string" + }, + "aclentry6_value": { + "description": "The value of the DHCPv6 ACL entry.", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv6 smart architecture managing the DHCPv6 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_aclentry6_data", + "type": "object" + }, + "_data_inner_dhcp_failover_data": { + "example": { + "server_name": "server_name", + "failover_mclt": "failover_mclt", + "failover_peer_port": "failover_peer_port", + "failover_state": "failover_state", + "failover_name": "failover_name", + "failover_delayed_create_time": "failover_delayed_create_time", + "server_id": "server_id", + "failover_peer_addr": "failover_peer_addr", + "failover_split": "failover_split", + "failover_delayed_delete_time": "failover_delayed_delete_time", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "smart_parent_id": "smart_parent_id", + "failover_addr": "failover_addr", + "failover_type": "failover_type", + "failover_auto_partner_down": "failover_auto_partner_down", + "server_cluster_role": "server_cluster_role", + "peer_server_id": "peer_server_id", + "failover_multistatus": "failover_multistatus", + "server_state": "server_state", + "server_type": "server_type", + "failover_id": "failover_id", + "failover_port": "failover_port" + }, + "properties": { + "server_cluster_role": { + "description": "The role of the server the object belongs to in the cluster, either active (M), passive (B) or N/A (#).", + "type": "string" + }, + "failover_delayed_create_time": { + "description": "The delay of creation status. 1 indicates that the object is not created yet.", + "type": "string" + }, + "failover_delayed_delete_time": { + "description": "The delay of deletion status. 1 indicates that the object is not deleted yet.", + "type": "string" + }, + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_name": { + "description": "The name of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_state": { + "description": "The status of the DHCPv4 smart architecture.", + "type": "string" + }, + "server_type": { + "description": "The type of the DHCPv4 server the object belongs to:


                                                                                                                                      server_type possible values
                                                                                                                                      TypeDescription
                                                                                                                                      ipmEfficientIP or EfficientIP Package server
                                                                                                                                      msrpcMicrosoft Windows DHCP server
                                                                                                                                      vdhcpEfficientIP DHCPv4 smart architecture


                                                                                                                                      ", + "type": "string" + }, + "failover_addr": { + "description": "The IP address of the primary DHCPv4 server.", + "type": "string" + }, + "failover_auto_partner_down": { + "description": "The time after which the DHCPv4 failover channel automatically switches to partner-down after being in communication-interrupted state, in hours.", + "type": "string" + }, + "failover_id": { + "description": "The database identifier (ID) of the DHCPv4 failover channel, a unique numeric key value automatically incremented when you add a failover channel.", + "type": "string" + }, + "failover_mclt": { + "description": "The maximum client lead time (MCLT) of the failover channel, in seconds. It indicates for how long each DHCP server can extend the lease of a client, beyond the time known by its partner server.", + "type": "string" + }, + "failover_name": { + "description": "The name of the DHCPv4 failover channel.", + "type": "string" + }, + "failover_peer_addr": { + "description": "The IP address of the secondary DHCPv4 server.", + "type": "string" + }, + "failover_peer_port": { + "description": "The port number of the secondary DHCPv4 server.", + "type": "string" + }, + "failover_port": { + "description": "The port number of the primary DHCPv4 server.", + "type": "string" + }, + "failover_split": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "failover_state": { + "description": "The status of the DHCPv4 failover channel, either startup, normal, communications-interrupted or recover-wait.", + "type": "string" + }, + "failover_type": { + "description": "The type of the DHCPv4 failover channel, either primary or secondary.", + "type": "string" + }, + "server_hostaddr": { + "description": "The human readable version of the parameter server_addr or server_addr6.", + "type": "string" + }, + "server_addr6": { + "description": "The Management IP address of the DHCPv4 server, the IPv6 address configured when adding the server, on which the failover channel is configured, in hexadecimal format.", + "type": "string" + }, + "server_addr": { + "description": "The Management IP address of the DHCPv4 server, the IPv4 address configured when adding the server, on which the failover channel is configured, in hexadecimal format.", + "type": "string" + }, + "failover_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                      Multi-status severity levels
                                                                                                                                      Message number Severity Description
                                                                                                                                      0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                      17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                      34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                      51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                      67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                      84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                      ", + "type": "string" + }, + "peer_server_id": { + "description": "The database identifier (ID) of the secondary DHCPv4 server.", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_failover_data", + "type": "object" + }, + "_data_inner_dhcp_group_data": { + "example": { + "server_name": "server_name", + "group_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "group_name": "group_name", + "server_class_name": "server_class_name", + "group_class_name": "group_class_name", + "group_multistatus": "group_multistatus", + "server_id": "server_id", + "server_version": "server_version", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "smart_parent_id": "smart_parent_id", + "group_id": "group_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "smart_parent_name": "smart_parent_name", + "group_delayed_create_time": "group_delayed_create_time", + "group_delayed_delete_time": "group_delayed_delete_time", + "server_type": "server_type" + }, + "properties": { + "group_delayed_create_time": { + "description": "The delay of creation status. 1 indicates that the object is not created yet.", + "type": "string" + }, + "group_delayed_delete_time": { + "description": "The delay of deletion status. 1 indicates that the object is not deleted yet.", + "type": "string" + }, + "server_class_name": { + "description": "The name of the class applied to the DHCPv4 server the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "server_class_parameters": { + "description": "The class parameters applied to the DHCPv4 server the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_name": { + "description": "The name of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_type": { + "description": "The type of the DHCPv4 server the object belongs to:


                                                                                                                                      server_type possible values
                                                                                                                                      TypeDescription
                                                                                                                                      ipmEfficientIP or EfficientIP Package server
                                                                                                                                      msrpcMicrosoft Windows DHCP server
                                                                                                                                      vdhcpEfficientIP DHCPv4 smart architecture


                                                                                                                                      ", + "type": "string" + }, + "server_version": { + "description": "The version details of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "group_class_name": { + "description": "The name of the class applied to the DHCPv4 group, it can be preceded by the class directory.", + "type": "string" + }, + "group_class_parameters": { + "description": "The class parameters applied to the DHCPv4 group.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "group_id": { + "description": "The database identifier (ID) of the DHCPv4 group.", + "type": "string" + }, + "group_name": { + "description": "The name of the DHCPv4 group.", + "type": "string" + }, + "server_hostaddr": { + "description": "The human readable version of the parameter server_addr or server_addr6.", + "type": "string" + }, + "server_addr6": { + "description": "The Management IP address of the DHCPv4 server the object belongs to, the IPv6 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "server_addr": { + "description": "The Management IP address of the DHCPv4 server the object belongs to, the IPv4 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "group_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                      Multi-status severity levels
                                                                                                                                      Message number Severity Description
                                                                                                                                      0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                      17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                      34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                      51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                      67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                      84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                      ", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_name": { + "description": "The name of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. # indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_group_data", + "type": "object" + }, + "_data_inner_dhcp_group_add_success": { + "example": { + "group_id": "group_id" + }, + "properties": { + "group_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_group_add_success", + "type": "object" + }, + "_data_inner_dhcp_group_edit_success": { + "example": { + "group_id": "group_id" + }, + "properties": { + "group_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_group_edit_success", + "type": "object" + }, + "_data_inner_dhcp_group_delete_success": { + "example": { + "group_id": "group_id" + }, + "properties": { + "group_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_group_delete_success", + "type": "object" + }, + "_data_inner_dhcp_group6_data": { + "example": { + "server6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server6_version": "server6_version", + "server6_addr6": "server6_addr6", + "group6_name": "group6_name", + "server6_hostaddr": "server6_hostaddr", + "group6_multistatus": "group6_multistatus", + "group6_delayed_time": "group6_delayed_time", + "group6_id": "group6_id", + "server6_name": "server6_name", + "server6_addr": "server6_addr", + "smart_parent_id": "smart_parent_id", + "smart_parent_name": "smart_parent_name", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "server6_type": "server6_type", + "group6_class_name": "group6_class_name", + "group6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ] + }, + "properties": { + "group6_delayed_time": { + "description": "The delay of creation/deletion status. 1 indicates that the object is not created/deleted yet.", + "type": "string" + }, + "server6_class_name": { + "description": "The name of the class applied to the DHCPv6 server the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "server6_class_parameters": { + "description": "The class parameters applied to the DHCPv6 server the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_name": { + "description": "The name of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_type": { + "description": "The type of the DHCPv6 server the object belongs to:


                                                                                                                                      server6_type possible values
                                                                                                                                      TypeDescription
                                                                                                                                      ipmEfficientIP or EfficientIP Package server
                                                                                                                                      vdhcpEfficientIP DHCPv6 smart architecture


                                                                                                                                      ", + "type": "string" + }, + "server6_version": { + "description": "The version details of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "group6_class_name": { + "description": "The name of the class applied to the DHCPv6 group, it can be preceded by the class directory.", + "type": "string" + }, + "group6_class_parameters": { + "description": "The class parameters applied to the DHCPv6 group.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "group6_id": { + "description": "The database identifier (ID) of the DHCPv6 group.", + "type": "string" + }, + "group6_name": { + "description": "The name of the DHCPv6 group.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The human readable version of the parameter server6_addr or server6_addr6.", + "type": "string" + }, + "server6_addr6": { + "description": "The Management IP address of the DHCPv6 server the object belongs to, the IPv6 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "server6_addr": { + "description": "The Management IP address of the DHCPv6 server the object belongs to, the IPv4 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "group6_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                      Multi-status severity levels
                                                                                                                                      Message number Severity Description
                                                                                                                                      0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                      17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                      34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                      51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                      67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                      84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                      ", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv6 smart architecture managing the DHCPv6 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_name": { + "description": "The name of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. # indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_group6_data", + "type": "object" + }, + "_data_inner_dhcp_lease_data": { + "example": { + "range_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_name": "range_name", + "server_name": "server_name", + "lease_mac_addr": "lease_mac_addr", + "sharednetwork_id": "sharednetwork_id", + "server_class_name": "server_class_name", + "lease_vendor_id": "lease_vendor_id", + "server_version": "server_version", + "lease_addr": "lease_addr", + "percent": "percent", + "scope_name": "scope_name", + "range_id": "range_id", + "lease_name": "lease_name", + "smart_parent_id": "smart_parent_id", + "parameter_request_list": "parameter_request_list", + "scope_id": "scope_id", + "lease_circuit_id": "lease_circuit_id", + "lease_time": "lease_time", + "smart_parent_name": "smart_parent_name", + "server_cluster_role": "server_cluster_role", + "scope_size": "scope_size", + "lease_fingerbank_os": "lease_fingerbank_os", + "lease_address_addr": "lease_address_addr", + "lease_remote_id": "lease_remote_id", + "lease_first_time": "lease_first_time", + "lease_giaddr": "lease_giaddr", + "range_end_addr": "range_end_addr", + "time_to_expire": "time_to_expire", + "sharednetwork_name": "sharednetwork_name", + "lease_multistatus": "lease_multistatus", + "server_id": "server_id", + "server_addr": "server_addr", + "lease_clientname": "lease_clientname", + "lease_period": "lease_period", + "server_hostaddr": "server_hostaddr", + "scope_net_addr": "scope_net_addr", + "server_addr6": "server_addr6", + "lease_domain": "lease_domain", + "lease_end_time": "lease_end_time", + "range_start_addr": "range_start_addr", + "range_class_name": "range_class_name", + "range_failover_name": "range_failover_name", + "lease_mac_vendor": "lease_mac_vendor", + "lease_client_ident": "lease_client_ident", + "lease_id": "lease_id", + "server_type": "server_type", + "scope_class_name": "scope_class_name" + }, + "properties": { + "server_cluster_role": { + "description": "The role of the server the object belongs to in the cluster, either active (M), passive (B) or N/A (#).", + "type": "string" + }, + "server_class_name": { + "description": "The name of the class applied to the DHCPv4 server the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_name": { + "description": "The name of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_type": { + "description": "The type of the DHCPv4 server the object belongs to:


                                                                                                                                      server_type possible values
                                                                                                                                      TypeDescription
                                                                                                                                      ipmEfficientIP or EfficientIP Package server
                                                                                                                                      msrpcMicrosoft Windows DHCP server
                                                                                                                                      vdhcpEfficientIP DHCPv4 smart architecture


                                                                                                                                      ", + "type": "string" + }, + "server_version": { + "description": "The version details of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "lease_addr": { + "description": "The IP address associated with the DHCPv4 lease.", + "type": "string" + }, + "lease_circuit_id": { + "description": "The circuit identifier (ID) of the relay agent associated with the DHCPv4 lease.", + "type": "string" + }, + "lease_client_ident": { + "description": "The client identifier (ID) of the client associated with the DHCPv4 lease.", + "type": "string" + }, + "lease_clientname": { + "description": "The name of the client associated with the DHCPv4 lease.", + "type": "string" + }, + "lease_domain": { + "description": "The domain name associated with the DHCPv4 lease.", + "type": "string" + }, + "lease_end_time": { + "description": "The expiration time of the lease, in decimal UNIX date format.", + "type": "string" + }, + "lease_fingerbank_os": { + "description": "The operating system details of the client associated with the DHCPv4 lease.", + "type": "string" + }, + "lease_first_time": { + "description": "The first time the DHCPv4 lease has been attributed to the client, in decimal UNIX date format.", + "type": "string" + }, + "lease_giaddr": { + "description": "The gateway IP address of the relay agent of the DHCPv4 lease.", + "type": "string" + }, + "lease_id": { + "description": "The database identifier (ID) of the DHCPv4 lease.", + "type": "string" + }, + "lease_address_addr": { + "description": "The IP address associated with the DHCPv4 lease, in hexadecimal format.", + "type": "string" + }, + "lease_mac_addr": { + "description": "The MAC address associated with the IPv4 lease.", + "type": "string" + }, + "lease_name": { + "description": "The name of the DHCPv4 lease.", + "type": "string" + }, + "lease_period": { + "description": "The duration time (time to live) of the DHCPv4 lease, in seconds.", + "type": "string" + }, + "lease_remote_id": { + "description": "The remote identifier (ID) of the relay agent associated with the DHCPv4 lease.", + "type": "string" + }, + "lease_time": { + "description": "The last time the DHCPv4 lease has been attributed to the client, in decimal UNIX date format.", + "type": "string" + }, + "lease_vendor_id": { + "description": "The vendor class identifier (ID) of the client associated with the DHCPv4 lease.", + "type": "string" + }, + "range_class_name": { + "description": "The name of the class applied to the DHCPv4 range the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "range_class_parameters": { + "description": "The class parameters applied to the DHCPv4 range the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "range_end_addr": { + "description": "The last IP address of the DHCPv4 range the lease belongs to.", + "type": "string" + }, + "range_failover_name": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "range_id": { + "description": "The database identifier (ID) of the DHCPv4 range the object belongs to.", + "type": "string" + }, + "range_name": { + "description": "The start and end IP address of the DHCPv4 range the object belongs to, range_start_addr and range_end_addr, as follows: <start-ip>-<end-ip>.", + "type": "string" + }, + "range_start_addr": { + "description": "The first IP address of the DHCPv4 range the lease belongs to.", + "type": "string" + }, + "scope_class_name": { + "description": "The name of the class applied to the DHCPv4 scope the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "scope_id": { + "description": "The database identifier (ID) of the DHCPv4 scope the object belongs to.", + "type": "string" + }, + "scope_name": { + "description": "The name of the DHCPv4 scope the object belongs to.", + "type": "string" + }, + "scope_net_addr": { + "description": "The first IP address of the DHCPv4 scope the object belongs to.", + "type": "string" + }, + "scope_size": { + "description": "The number of IP addresses the DHCPv4 scope the object belongs to contains.", + "type": "string" + }, + "sharednetwork_id": { + "description": "The database identifier (ID) of the DHCPv4 shared network the object belongs to.", + "type": "string" + }, + "sharednetwork_name": { + "description": "The name of the DHCPv4 shared network the object belongs to.", + "type": "string" + }, + "server_hostaddr": { + "description": "The human readable version of the parameter server_addr or server_addr6.", + "type": "string" + }, + "server_addr6": { + "description": "The Management IP address of the DHCPv4 server the object belongs to, the IPv6 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "server_addr": { + "description": "The Management IP address of the DHCPv4 server the object belongs to, the IPv4 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "lease_mac_vendor": { + "description": "The vendor details of the client associated with the DHCPv4 lease.", + "type": "string" + }, + "lease_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                      Multi-status severity levels
                                                                                                                                      Message number Severity Description
                                                                                                                                      0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                      17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                      34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                      51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                      67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                      84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                      ", + "type": "string" + }, + "parameter_request_list": { + "description": "The list of parameters requested with the DHCPv4 lease returned by the server, integers separated by a comma.", + "type": "string" + }, + "percent": { + "description": "The percentage of time the lease has really been in use.", + "type": "string" + }, + "time_to_expire": { + "description": "The time left to the lease before it expires, in seconds.", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_name": { + "description": "The name of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. # indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_lease_data", + "type": "object" + }, + "_data_inner_dhcp_lease6_data": { + "example": { + "scope6_size": "scope6_size", + "lease6_multistatus": "lease6_multistatus", + "server6_version": "server6_version", + "lease6_id": "lease6_id", + "lease6_address6_addr": "lease6_address6_addr", + "range6_failover_name": "range6_failover_name", + "server6_name": "server6_name", + "lease6_end_time": "lease6_end_time", + "lease6_first_time": "lease6_first_time", + "lease6_period": "lease6_period", + "range6_end_address6_addr": "range6_end_address6_addr", + "scope6_prefix": "scope6_prefix", + "smart_parent_id": "smart_parent_id", + "smart_parent_name": "smart_parent_name", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "lease6_clientname": "lease6_clientname", + "server6_type": "server6_type", + "lease6_mac_vendor": "lease6_mac_vendor", + "lease6_domain": "lease6_domain", + "range6_id": "range6_id", + "range6_start_address6_addr": "range6_start_address6_addr", + "server6_addr6": "server6_addr6", + "lease6_time": "lease6_time", + "sharednetwork6_name": "sharednetwork6_name", + "lease6_client_duid": "lease6_client_duid", + "server6_hostaddr": "server6_hostaddr", + "lease6_percent": "lease6_percent", + "server6_addr": "server6_addr", + "lease6_mac_addr": "lease6_mac_addr", + "scope6_class_name": "scope6_class_name", + "scope6_name": "scope6_name", + "range6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_id": "scope6_id", + "sharednetwork6_id": "sharednetwork6_id", + "lease6_giaddr": "lease6_giaddr", + "lease6_time_to_expire": "lease6_time_to_expire", + "lease6_name": "lease6_name", + "scope6_start_address6_addr": "scope6_start_address6_addr", + "range6_class_name": "range6_class_name" + }, + "properties": { + "server6_class_name": { + "description": "The name of the class applied to the DHCPv6 server the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_name": { + "description": "The name of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_type": { + "description": "The type of the DHCPv6 server the object belongs to:


                                                                                                                                      server6_type possible values
                                                                                                                                      TypeDescription
                                                                                                                                      ipmEfficientIP or EfficientIP Package server
                                                                                                                                      vdhcpEfficientIP DHCPv6 smart architecture


                                                                                                                                      ", + "type": "string" + }, + "server6_version": { + "description": "The version details of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "lease6_client_duid": { + "description": "The client DHCP Unique Identifier (DUID) associated with the DHCPv6 lease.", + "type": "string" + }, + "lease6_clientname": { + "description": "The name of the client associated with the DHCPv6 lease.", + "type": "string" + }, + "lease6_domain": { + "description": "The domain name associated with the DHCPv6 lease.", + "type": "string" + }, + "lease6_end_time": { + "description": "The expiration time of the lease, in decimal UNIX date format.", + "type": "string" + }, + "lease6_first_time": { + "description": "The first time the DHCPv6 lease has been attributed to the client, in decimal UNIX date format.", + "type": "string" + }, + "lease6_giaddr": { + "description": "The gateway IP address of the relay agent of the DHCPv6 lease.", + "type": "string" + }, + "lease6_id": { + "description": "The database identifier (ID) of the DHCPv6 lease.", + "type": "string" + }, + "lease6_address6_addr": { + "description": "The IP address associated with the DHCPv6 lease, in hexadecimal format.", + "type": "string" + }, + "lease6_mac_addr": { + "description": "The MAC address associated with the DHCPv6 lease.", + "type": "string" + }, + "lease6_name": { + "description": "The name of the DHCPv6 lease.", + "type": "string" + }, + "lease6_period": { + "description": "The duration time (time to live) of the DHCPv6 lease, in seconds.", + "type": "string" + }, + "lease6_time": { + "description": "The last time the DHCPv6 lease has been attributed to the client, in decimal UNIX date format.", + "type": "string" + }, + "range6_class_name": { + "description": "The name of the class applied to the DHCPv6 range the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "range6_class_parameters": { + "description": "The class parameters applied to the DHCPv6 range the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "range6_end_address6_addr": { + "description": "The last IP address of the DHCPv6 range the object belongs to, in hexadecimal format.", + "type": "string" + }, + "range6_failover_name": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "range6_id": { + "description": "The database identifier (ID) of the DHCPv6 range the object belongs to.", + "type": "string" + }, + "range6_start_address6_addr": { + "description": "The first IP address of the DHCPv6 range the object belongs to, in hexadecimal format.", + "type": "string" + }, + "scope6_class_name": { + "description": "The name of the class applied to the DHCPv6 scope the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "scope6_id": { + "description": "The database identifier (ID) of the DHCPv6 scope the object belongs to.", + "type": "string" + }, + "scope6_name": { + "description": "The name of the DHCPv6 scope the object belongs to.", + "type": "string" + }, + "scope6_prefix": { + "description": "The prefix of the DHCPv6 scope the object belongs to.", + "type": "string" + }, + "scope6_size": { + "description": "The number of IP addresses the DHCPv6 scope the object belongs to contains.", + "type": "string" + }, + "scope6_start_address6_addr": { + "description": "The first IP address of the DHCPv6 scope the object belongs to, in hexadecimal format.", + "type": "string" + }, + "sharednetwork6_id": { + "description": "The database identifier (ID) of the DHCPv6 shared network the object belongs to.", + "type": "string" + }, + "sharednetwork6_name": { + "description": "The name of the DHCPv6 shared network the object belongs to.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The human readable version of the parameter server6_addr or server6_addr6.", + "type": "string" + }, + "server6_addr6": { + "description": "The Management IP address of the DHCPv6 server the object belongs to, the IPv6 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "server6_addr": { + "description": "The Management IP address of the DHCPv6 server the object belongs to, the IPv4 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "lease6_mac_vendor": { + "description": "The vendor details of the client associated with the DHCPv6 lease.", + "type": "string" + }, + "lease6_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                      Multi-status severity levels
                                                                                                                                      Message number Severity Description
                                                                                                                                      0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                      17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                      34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                      51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                      67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                      84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                      ", + "type": "string" + }, + "lease6_percent": { + "description": "The percentage of time the lease has really been in use.", + "type": "string" + }, + "lease6_time_to_expire": { + "description": "The time left to the lease before it expires, in seconds.", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv6 smart architecture managing the DHCPv6 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_name": { + "description": "The name of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. # indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_lease6_data", + "type": "object" + }, + "_data_inner_dhcp_range_data": { + "example": { + "range_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_name": "range_name", + "server_name": "server_name", + "range_lease_count": "range_lease_count", + "sharednetwork_id": "sharednetwork_id", + "server_class_name": "server_class_name", + "scope_start_address_addr": "scope_start_address_addr", + "server_version": "server_version", + "range_size": "range_size", + "scope_name": "scope_name", + "range_id": "range_id", + "range_lease_percent": "range_lease_percent", + "smart_parent_id": "smart_parent_id", + "scope_id": "scope_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope_if_name": "scope_if_name", + "smart_parent_name": "smart_parent_name", + "scope_size": "scope_size", + "range_delayed_create_time": "range_delayed_create_time", + "range_delayed_delete_time": "range_delayed_delete_time", + "server_comment": "server_comment", + "range_end_addr": "range_end_addr", + "scope_if_addr": "scope_if_addr", + "range_state": "range_state", + "sharednetwork_name": "sharednetwork_name", + "server_id": "server_id", + "server_addr": "server_addr", + "scope_net_mask": "scope_net_mask", + "server_hostaddr": "server_hostaddr", + "scope_net_addr": "scope_net_addr", + "server_addr6": "server_addr6", + "range_start_addr": "range_start_addr", + "range_class_name": "range_class_name", + "range_failover_name": "range_failover_name", + "scope_space_id": "scope_space_id", + "scope_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_multistatus": "range_multistatus", + "range_start_address_addr": "range_start_address_addr", + "range_end_address_addr": "range_end_address_addr", + "server_type": "server_type", + "range_acl": "range_acl", + "scope_class_name": "scope_class_name" + }, + "properties": { + "range_delayed_create_time": { + "description": "The delay of creation status. 1 indicates that the object is not created yet.", + "type": "string" + }, + "range_delayed_delete_time": { + "description": "The delay of deletion status. 1 indicates that the object is not deleted yet.", + "type": "string" + }, + "server_class_name": { + "description": "The name of the class applied to the DHCPv4 server the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "server_class_parameters": { + "description": "The class parameters applied to the DHCPv4 server the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "server_comment": { + "description": "The description of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_name": { + "description": "The name of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_type": { + "description": "The type of the DHCPv4 server the object belongs to:


                                                                                                                                      server_type possible values
                                                                                                                                      TypeDescription
                                                                                                                                      ipmEfficientIP or EfficientIP Package server
                                                                                                                                      msrpcMicrosoft Windows DHCP server
                                                                                                                                      vdhcpEfficientIP DHCPv4 smart architecture


                                                                                                                                      ", + "type": "string" + }, + "server_version": { + "description": "The version details of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "range_acl": { + "description": "The list of ACLs associated with the DHCPv4 range, as follows: <ACL_name>;<ACL_name>;... .", + "type": "string" + }, + "range_class_name": { + "description": "The name of the class applied to the DHCPv4 range, it can be preceded by the class directory.", + "type": "string" + }, + "range_class_parameters": { + "description": "The class parameters applied to the DHCPv4 range.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "range_end_addr": { + "description": "The last IP address of the DHCPv4 range.", + "type": "string" + }, + "range_end_address_addr": { + "description": "The last IP address of the DHCPv4 range, in hexadecimal format.", + "type": "string" + }, + "range_failover_name": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "range_id": { + "description": "The database identifier (ID) of the DHCPv4 range.", + "type": "string" + }, + "range_lease_count": { + "description": "The total number of leases currently delivered by the DHCPv4 range.", + "type": "string" + }, + "range_lease_percent": { + "description": "The percentage of leases currently delivered by the DHCPv4 range.", + "type": "string" + }, + "range_name": { + "description": "The start and end IP address of the DHCPv4 range, range_start_addr and range_end_addr, as follows: <start-ip>-<end-ip>.", + "type": "string" + }, + "range_size": { + "description": "The number of IP addresses the DHCPv4 range contains.", + "type": "string" + }, + "range_start_addr": { + "description": "The first IP address of the DHCPv4 range.", + "type": "string" + }, + "range_start_address_addr": { + "description": "The first IP address of the DHCPv4 range, in hexadecimal format.", + "type": "string" + }, + "range_state": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "scope_class_name": { + "description": "The name of the class applied to the DHCPv4 scope the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "scope_class_parameters": { + "description": "The class parameters applied to the DHCPv4 scope the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "scope_id": { + "description": "The database identifier (ID) of the DHCPv4 scope the object belongs to.", + "type": "string" + }, + "scope_if_addr": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "scope_if_name": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "scope_name": { + "description": "The name of the DHCPv4 scope the object belongs to.", + "type": "string" + }, + "scope_net_addr": { + "description": "The first IP address of the DHCPv4 scope the object belongs.", + "type": "string" + }, + "scope_net_mask": { + "description": "The netmask of the DHCPv4 scope the object belongs to. It is expressed in dot-decimal notation and defines the number of addresses the scope contains.", + "type": "string" + }, + "scope_space_id": { + "description": "The database identifier (ID) of the space associated with the DHCPv4 scope the object belongs to.", + "type": "string" + }, + "scope_size": { + "description": "The number of IP addresses the DHCPv4 scope the object belongs to contains.", + "type": "string" + }, + "scope_start_address_addr": { + "description": "The first IP address of the DHCPv4 scope the object belongs to, in hexadecimal format.", + "type": "string" + }, + "sharednetwork_id": { + "description": "The database identifier (ID) of the DHCPv4 shared network the object belongs to.", + "type": "string" + }, + "sharednetwork_name": { + "description": "The name of the DHCPv4 shared network the object belongs to.", + "type": "string" + }, + "server_hostaddr": { + "description": "The human readable version of the parameter server_addr or server_addr6.", + "type": "string" + }, + "server_addr6": { + "description": "The Management IP address of the DHCPv4 server the object belongs to, the IPv6 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "server_addr": { + "description": "The Management IP address of the DHCPv4 server the object belongs to, the IPv4 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "range_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                      Multi-status severity levels
                                                                                                                                      Message number Severity Description
                                                                                                                                      0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                      17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                      34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                      51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                      67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                      84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                      ", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_name": { + "description": "The name of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. # indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_range_data", + "type": "object" + }, + "_data_inner_dhcp_range_add_success": { + "example": { + "range_id": "range_id" + }, + "properties": { + "range_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_range_add_success", + "type": "object" + }, + "_data_inner_dhcp_range_edit_success": { + "example": { + "range_id": "range_id" + }, + "properties": { + "range_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_range_edit_success", + "type": "object" + }, + "_data_inner_dhcp_range_delete_success": { + "example": { + "range_id": "range_id" + }, + "properties": { + "range_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_range_delete_success", + "type": "object" + }, + "_data_inner_dhcp_range6_data": { + "example": { + "server6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_size": "scope6_size", + "server6_version": "server6_version", + "range6_state": "range6_state", + "scope6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range6_failover_name": "range6_failover_name", + "server6_name": "server6_name", + "range6_end_address6_addr": "range6_end_address6_addr", + "scope6_prefix": "scope6_prefix", + "server6_comment": "server6_comment", + "smart_parent_id": "smart_parent_id", + "smart_parent_name": "smart_parent_name", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "server6_type": "server6_type", + "range6_delayed_time": "range6_delayed_time", + "range6_acl": "range6_acl", + "range6_id": "range6_id", + "range6_name": "range6_name", + "range6_start_address6_addr": "range6_start_address6_addr", + "server6_addr6": "server6_addr6", + "sharednetwork6_name": "sharednetwork6_name", + "range6_multistatus": "range6_multistatus", + "server6_hostaddr": "server6_hostaddr", + "scope6_end_address6_addr": "scope6_end_address6_addr", + "server6_addr": "server6_addr", + "range6_size": "range6_size", + "scope6_class_name": "scope6_class_name", + "scope6_name": "scope6_name", + "scope6_space_id": "scope6_space_id", + "range6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_id": "scope6_id", + "range6_lease_count": "range6_lease_count", + "sharednetwork6_id": "sharednetwork6_id", + "scope6_start_address6_addr": "scope6_start_address6_addr", + "range6_class_name": "range6_class_name" + }, + "properties": { + "range6_delayed_time": { + "description": "The delay of creation/deletion status. 1 indicates that the object is not created/deleted yet.", + "type": "string" + }, + "server6_class_name": { + "description": "The name of the class applied to the DHCPv6 server the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "server6_class_parameters": { + "description": "The class parameters applied to the DHCPv6 server the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "server6_comment": { + "description": "The description of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_name": { + "description": "The name of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_type": { + "description": "The type of the DHCPv6 server the object belongs to:


                                                                                                                                      server6_type possible values
                                                                                                                                      TypeDescription
                                                                                                                                      ipmEfficientIP or EfficientIP Package server
                                                                                                                                      vdhcpEfficientIP DHCPv6 smart architecture


                                                                                                                                      ", + "type": "string" + }, + "server6_version": { + "description": "The version details of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "range6_acl": { + "description": "The list of ACLs associated with the DHCPv6 range, as follows: <ACL_name>;<ACL_name>;... .", + "type": "string" + }, + "range6_class_name": { + "description": "The name of the class applied to the DHCPv6 range, it can be preceded by the class directory.", + "type": "string" + }, + "range6_class_parameters": { + "description": "The class parameters applied to the DHCPv6 range.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "range6_end_address6_addr": { + "description": "The last IP address of the DHCPv6 range, in hexadecimal format.", + "type": "string" + }, + "range6_failover_name": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "range6_id": { + "description": "The database identifier (ID) of the DHCPv6 range.", + "type": "string" + }, + "range6_lease_count": { + "description": "The total number of leases currently delivered by the DHCPv6 range.", + "type": "string" + }, + "range6_name": { + "description": "The start and end IP address of the DHCPv6 range, range6_start_address6_addr and range6_end_address6_addr, in compressed format as follows: <start-ip> - <end-ip>.", + "type": "string" + }, + "range6_size": { + "description": "The number of IP addresses the DHCPv6 range contains.", + "type": "string" + }, + "range6_start_address6_addr": { + "description": "The first IP address of the DHCPv6 range, in hexadecimal format.", + "type": "string" + }, + "range6_state": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "scope6_class_name": { + "description": "The name of the class applied to the DHCPv6 scope the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "scope6_class_parameters": { + "description": "The class parameters applied to the DHCPv6 scope the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "scope6_end_address6_addr": { + "description": "The last IP address of the DHCPv6 scope the object belongs to, in hexadecimal format.", + "type": "string" + }, + "scope6_id": { + "description": "The database identifier (ID) of the DHCPv6 scope the object belongs to.", + "type": "string" + }, + "scope6_name": { + "description": "The name of the DHCPv6 scope the object belongs to.", + "type": "string" + }, + "scope6_prefix": { + "description": "The prefix of the DHCPv6 scope the object belongs to.", + "type": "string" + }, + "scope6_space_id": { + "description": "The database identifier (ID) of the space associated with the DHCPv6 scope the object belongs to.", + "type": "string" + }, + "scope6_size": { + "description": "The number of IP addresses the DHCPv6 scope the object belongs to contains.", + "type": "string" + }, + "scope6_start_address6_addr": { + "description": "The first IP address of the DHCPv6 scope the object belongs to, in hexadecimal format.", + "type": "string" + }, + "sharednetwork6_id": { + "description": "The database identifier (ID) of the DHCPv6 shared network the object belongs to.", + "type": "string" + }, + "sharednetwork6_name": { + "description": "The name of the DHCPv6 shared network the object belongs to.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The human readable version of the parameter server6_addr or server6_addr6.", + "type": "string" + }, + "server6_addr6": { + "description": "The Management IP address of the DHCPv6 server the object belongs to, the IPv6 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "server6_addr": { + "description": "The Management IP address of the DHCPv6 server the object belongs to, the IPv4 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "range6_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                      Multi-status severity levels
                                                                                                                                      Message number Severity Description
                                                                                                                                      0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                      17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                      34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                      51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                      67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                      84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                      ", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv6 smart architecture managing the DHCPv6 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_name": { + "description": "The name of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. # indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_range6_data", + "type": "object" + }, + "_data_inner_dhcp_range6_add_success": { + "example": { + "range6_id": "range6_id" + }, + "properties": { + "range6_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_range6_add_success", + "type": "object" + }, + "_data_inner_dhcp_range6_edit_success": { + "example": { + "range6_id": "range6_id" + }, + "properties": { + "range6_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_range6_edit_success", + "type": "object" + }, + "_data_inner_dhcp_range6_delete_success": { + "example": { + "range6_id": "range6_id" + }, + "properties": { + "range6_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_range6_delete_success", + "type": "object" + }, + "_data_inner_dhcp_scope_data": { + "example": { + "server_name": "server_name", + "sharednetwork_id": "sharednetwork_id", + "server_class_name": "server_class_name", + "scope_start_address_addr": "scope_start_address_addr", + "server_version": "server_version", + "scope_space_name": "scope_space_name", + "scope_name": "scope_name", + "scope_delayed_create_time": "scope_delayed_create_time", + "smart_parent_id": "smart_parent_id", + "scope_multistatus": "scope_multistatus", + "scope_id": "scope_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "smart_parent_name": "smart_parent_name", + "scope_size": "scope_size", + "smart_arch": "smart_arch", + "scope_end_address_addr": "scope_end_address_addr", + "failover_name": "failover_name", + "sharednetwork_name": "sharednetwork_name", + "scope_delayed_delete_time": "scope_delayed_delete_time", + "server_id": "server_id", + "server_addr": "server_addr", + "scope_net_mask": "scope_net_mask", + "server_hostaddr": "server_hostaddr", + "scope_net_addr": "scope_net_addr", + "server_addr6": "server_addr6", + "scope_space_id": "scope_space_id", + "scope_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_type": "server_type", + "failover_id": "failover_id", + "scope_class_name": "scope_class_name" + }, + "properties": { + "scope_delayed_create_time": { + "description": "The delay of creation status. 1 indicates that the object is not created yet.", + "type": "string" + }, + "scope_delayed_delete_time": { + "description": "The delay of deletion status. 1 indicates that the object is not deleted yet.", + "type": "string" + }, + "server_class_name": { + "description": "The name of the class applied to the DHCPv4 server the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "server_class_parameters": { + "description": "The class parameters applied to the DHCPv4 server the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_name": { + "description": "The name of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_type": { + "description": "The type of the DHCPv4 server the object belongs to:


                                                                                                                                      server_type possible values
                                                                                                                                      TypeDescription
                                                                                                                                      ipmEfficientIP or EfficientIP Package server
                                                                                                                                      msrpcMicrosoft Windows DHCP server
                                                                                                                                      vdhcpEfficientIP DHCPv4 smart architecture


                                                                                                                                      ", + "type": "string" + }, + "server_version": { + "description": "The version details of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "failover_id": { + "description": "The database identifier (ID) of the DHCPv4 failover channel associated with the object.", + "type": "string" + }, + "failover_name": { + "description": "The name of the DHCPv4 failover channel associated with the object.", + "type": "string" + }, + "scope_class_name": { + "description": "The name of the class applied to the DHCPv4 scope, it can be preceded by the class directory.", + "type": "string" + }, + "scope_class_parameters": { + "description": "The class parameters applied to the DHCPv4 scope.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "scope_end_address_addr": { + "description": "The last IP address of the DHCPv4 scope, in hexadecimal format.", + "type": "string" + }, + "scope_id": { + "description": "The database identifier (ID) of the DHCPv4 scope.", + "type": "string" + }, + "scope_name": { + "description": "The name of the DHCPv4 scope.", + "type": "string" + }, + "scope_net_addr": { + "description": "The first IP address of the DHCPv4 scope.", + "type": "string" + }, + "scope_net_mask": { + "description": "The netmask of the DHCPv4 scope. It is expressed in dot-decimal notation and defines the number of addresses the scope contains.", + "type": "string" + }, + "scope_space_id": { + "description": "The database identifier (ID) of the space associated with the DHCPv4 scope.", + "type": "string" + }, + "scope_space_name": { + "description": "The name of the space associated with the DHCPv4 scope.", + "type": "string" + }, + "scope_size": { + "description": "The number of IP addresses the DHCPv4 scope contains.", + "type": "string" + }, + "scope_start_address_addr": { + "description": "The first IP address of the DHCPv4 scope, in hexadecimal format.", + "type": "string" + }, + "sharednetwork_id": { + "description": "The database identifier (ID) of the DHCPv4 shared network the object belongs to.", + "type": "string" + }, + "sharednetwork_name": { + "description": "The name of the DHCPv4 shared network the object belongs to.", + "type": "string" + }, + "server_hostaddr": { + "description": "The human readable version of the parameter server_addr or server_addr6.", + "type": "string" + }, + "server_addr6": { + "description": "The Management IP address of the DHCPv4 server the object belongs to, the IPv6 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "server_addr": { + "description": "The Management IP address of the DHCPv4 server the object belongs to, the IPv4 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "scope_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                      Multi-status severity levels
                                                                                                                                      Message number Severity Description
                                                                                                                                      0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                      17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                      34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                      51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                      67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                      84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                      ", + "type": "string" + }, + "smart_arch": { + "description": "The type of the DHCPv4 smart architecture the object belongs to.


                                                                                                                                      smart_arch possible values
                                                                                                                                      TypeDescription
                                                                                                                                      masterslaveThe One-to-One smart architecture sets a pair of DHCP servers in a Master/Backup configuration.
                                                                                                                                      starThe One-to-Many smart architecture sets a multi-site failover configuration at the cost of n-servers+1.
                                                                                                                                      splitscopeThe Split-Scope smart architecture sets a pair of DHCP servers in a configuration where the two scopes listen to the same subnet, but the range of addresses is divided.
                                                                                                                                      singleThe Single-Server smart architecture manages a single DHCP server.


                                                                                                                                      ", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_name": { + "description": "The name of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. # indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_scope_data", + "type": "object" + }, + "_data_inner_dhcp_scope_add_success": { + "example": { + "scope_id": "scope_id" + }, + "properties": { + "scope_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_scope_add_success", + "type": "object" + }, + "_data_inner_dhcp_scope_edit_success": { + "example": { + "scope_id": "scope_id" + }, + "properties": { + "scope_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_scope_edit_success", + "type": "object" + }, + "_data_inner_dhcp_scope_delete_success": { + "example": { + "scope_id": "scope_id" + }, + "properties": { + "scope_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_scope_delete_success", + "type": "object" + }, + "_data_inner_dhcp_scope6_data": { + "example": { + "scope6_delayed_time": "scope6_delayed_time", + "server6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_size": "scope6_size", + "server6_version": "server6_version", + "scope6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server6_name": "server6_name", + "scope6_prefix": "scope6_prefix", + "smart_parent_id": "smart_parent_id", + "scope6_sort_name": "scope6_sort_name", + "scope6_multistatus": "scope6_multistatus", + "failover6_name": "failover6_name", + "smart_parent_name": "smart_parent_name", + "smart_arch": "smart_arch", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "server6_type": "server6_type", + "scope6_space_name": "scope6_space_name", + "failover6_id": "failover6_id", + "server6_addr6": "server6_addr6", + "sharednetwork6_name": "sharednetwork6_name", + "server6_hostaddr": "server6_hostaddr", + "scope6_end_address6_addr": "scope6_end_address6_addr", + "server6_addr": "server6_addr", + "scope6_class_name": "scope6_class_name", + "scope6_name": "scope6_name", + "scope6_space_id": "scope6_space_id", + "scope6_id": "scope6_id", + "sharednetwork6_id": "sharednetwork6_id", + "scope6_start_address6_addr": "scope6_start_address6_addr" + }, + "properties": { + "scope6_delayed_time": { + "description": "The delay of creation/deletion status. 1 indicates that the object is not created/deleted yet.", + "type": "string" + }, + "server6_class_name": { + "description": "The name of the class applied to the DHCPv6 server the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "server6_class_parameters": { + "description": "The class parameters applied to the DHCPv6 server the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_name": { + "description": "The name of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_type": { + "description": "The type of the DHCPv6 server the object belongs to:


                                                                                                                                      server6_type possible values
                                                                                                                                      TypeDescription
                                                                                                                                      ipmEfficientIP or EfficientIP Package server
                                                                                                                                      vdhcpEfficientIP DHCPv6 smart architecture


                                                                                                                                      ", + "type": "string" + }, + "server6_version": { + "description": "The version details of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "failover6_id": { + "description": "The database identifier (ID) of the DHCPv6 failover channel associated with the object.", + "type": "string" + }, + "failover6_name": { + "description": "The name of the DHCPv6 failover channel associated with the object.", + "type": "string" + }, + "scope6_class_name": { + "description": "The name of the class applied to the DHCPv6 scope, it can be preceded by the class directory.", + "type": "string" + }, + "scope6_class_parameters": { + "description": "The class parameters applied to the DHCPv6 scope.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "scope6_end_address6_addr": { + "description": "The last IP address of the DHCPv6 scope, in hexadecimal format.", + "type": "string" + }, + "scope6_id": { + "description": "The database identifier (ID) of the DHCPv6 scope.", + "type": "string" + }, + "scope6_name": { + "description": "The name of the DHCPv6 scope.", + "type": "string" + }, + "scope6_prefix": { + "description": "The prefix of the DHCPv6 scope.", + "type": "string" + }, + "scope6_space_id": { + "description": "The database identifier (ID) of the space associated with the DHCPv6 scope.", + "type": "string" + }, + "scope6_space_name": { + "description": "The name of the space associated with the DHCPv6 scope.", + "type": "string" + }, + "scope6_size": { + "description": "The number of IP addresses the DHCPv6 scope contains.", + "type": "string" + }, + "scope6_sort_name": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "scope6_start_address6_addr": { + "description": "The first IP address of the DHCPv6 scope, in hexadecimal format.", + "type": "string" + }, + "sharednetwork6_id": { + "description": "The database identifier (ID) of the DHCPv6 shared network the object belongs to.", + "type": "string" + }, + "sharednetwork6_name": { + "description": "The name of the DHCPv6 shared network the object belongs to.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The human readable version of the parameter server6_addr or server6_addr6.", + "type": "string" + }, + "server6_addr6": { + "description": "The Management IP address of the DHCPv6 server the object belongs to, the IPv6 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "server6_addr": { + "description": "The Management IP address of the DHCPv6 server the object belongs to, the IPv4 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "scope6_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                      Multi-status severity levels
                                                                                                                                      Message number Severity Description
                                                                                                                                      0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                      17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                      34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                      51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                      67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                      84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                      ", + "type": "string" + }, + "smart_arch": { + "description": "The type of the DHCPv6 smart architecture the object belongs to.


                                                                                                                                      smart_arch possible values
                                                                                                                                      TypeDescription
                                                                                                                                      singleThe Single-Server smart architecture manages a single DHCPv6 server.
                                                                                                                                      splitscopeThe Split-Scope smart architecture sets a pair of DHCP servers in a configuration where the two scopes listen to the same subnet, but the range of addresses is divided.
                                                                                                                                      statelessThe Stateless smart architecture offers a limited number of options to the DHCP clients. The IP address is delivered thanks to the subnet gateway and it is impossible to create any ranges or statics or to retrieve any leases.


                                                                                                                                      ", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv6 smart architecture managing the DHCPv6 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_name": { + "description": "The name of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. # indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_scope6_data", + "type": "object" + }, + "_data_inner_dhcp_scope6_add_success": { + "example": { + "scope6_id": "scope6_id" + }, + "properties": { + "scope6_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_scope6_add_success", + "type": "object" + }, + "_data_inner_dhcp_scope6_edit_success": { + "example": { + "scope6_id": "scope6_id" + }, + "properties": { + "scope6_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_scope6_edit_success", + "type": "object" + }, + "_data_inner_dhcp_scope6_delete_success": { + "example": { + "scope6_id": "scope6_id" + }, + "properties": { + "scope6_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_scope6_delete_success", + "type": "object" + }, + "_data_inner_dhcp_server_data": { + "example": { + "server_stat_enabled": "server_stat_enabled", + "server_cisco_password": "server_cisco_password", + "server_uboottime": "server_uboottime", + "server_stat_time": "server_stat_time", + "server_ms_use_ssl": "server_ms_use_ssl", + "server_version": "server_version", + "server_stat_niceness": "server_stat_niceness", + "server_multistatus": "server_multistatus", + "service_address_addr": "service_address_addr", + "smart_parent_name": "smart_parent_name", + "server_localtime": "server_localtime", + "smart_ref2_server_id": "smart_ref2_server_id", + "cluster_ssh_keyring_id": "cluster_ssh_keyring_id", + "server_tcp_port": "server_tcp_port", + "server_snmp_timeout": "server_snmp_timeout", + "server_stat_period": "server_stat_period", + "server_windhcp_protocol": "server_windhcp_protocol", + "cluster_hb_hostaddr": "cluster_hb_hostaddr", + "server_ipmdhcp_protocol": "server_ipmdhcp_protocol", + "server_id": "server_id", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "connectionprofile_name": "connectionprofile_name", + "reverse_proxy_conf": "reverse_proxy_conf", + "cluster_peer_server_id": "cluster_peer_server_id", + "server_msrpc_login": "server_msrpc_login", + "cluster_vip_phys_hostaddr": "cluster_vip_phys_hostaddr", + "server_name": "server_name", + "smart_parent_arch": "smart_parent_arch", + "server_cisco_login": "server_cisco_login", + "server_class_name": "server_class_name", + "server_snmp_profile_id": "server_snmp_profile_id", + "smart_ref2_server_name": "smart_ref2_server_name", + "smart_ref1_server_name": "smart_ref1_server_name", + "server_snmp_use_tcp": "server_snmp_use_tcp", + "smart_parent_id": "smart_parent_id", + "server_cisco_use_ssh": "server_cisco_use_ssh", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_https_login": "server_https_login", + "server_cluster_role": "server_cluster_role", + "smart_arch": "smart_arch", + "server_cisco_root_password": "server_cisco_root_password", + "server_state": "server_state", + "server_comment": "server_comment", + "server_synching": "server_synching", + "smart_ref1_server_id": "smart_ref1_server_id", + "server_is_package": "server_is_package", + "server_snmp_port": "server_snmp_port", + "total_smart_members": "total_smart_members", + "server_isolated": "server_isolated", + "smart_param1": "smart_param1", + "server_msrpc_domain": "server_msrpc_domain", + "ref2_server_name": "ref2_server_name", + "server_snmp_retry": "server_snmp_retry", + "ref1_server_name": "ref1_server_name", + "server_snmp_id": "server_snmp_id", + "smart_members_name": "smart_members_name", + "server_type": "server_type" + }, + "properties": { + "server_cisco_login": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_cisco_password": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_cisco_root_password": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_cisco_use_ssh": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "cluster_hb_hostaddr": { + "description": "The IP address of the heartbeat of the server, a direct link between the servers of the cluster.", + "type": "string" + }, + "cluster_peer_server_id": { + "description": "The database identifier (ID) of the other server of the cluster.", + "type": "string" + }, + "server_cluster_role": { + "description": "The role of the server in the cluster, either active (M), passive (B) or N/A (#).", + "type": "string" + }, + "cluster_ssh_keyring_id": { + "description": "The database identifier (ID) of the SSH key dedicated to the cluster communication.", + "type": "string" + }, + "cluster_vip_phys_hostaddr": { + "description": "The local physical IP address of the VIP the cluster relies on.", + "type": "string" + }, + "connectionprofile_name": { + "description": "The name of the connection profile used as connection method for the DHCPv4 server.", + "type": "string" + }, + "server_class_name": { + "description": "The name of the class applied to the DHCPv4 server, it can be preceded by the class directory.", + "type": "string" + }, + "server_class_parameters": { + "description": "The class parameters applied to the DHCPv4 server.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "server_comment": { + "description": "The description of the DHCPv4 server.", + "type": "string" + }, + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server.", + "type": "string" + }, + "server_localtime": { + "description": "The local time on the DHCPv4 server, in decimal UNIX date format.", + "type": "string" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "server_state": { + "description": "The status of the DHCPv4 server:


                                                                                                                                      server_state possible values
                                                                                                                                      StatusDescription
                                                                                                                                      ERThe license used in SOLIDserver is not compliant with the added server: the license is invalid.
                                                                                                                                      ESThe server configuration could not be parsed properly.
                                                                                                                                      ETThe server does not answer anymore due to a scheduled configuration of the server.
                                                                                                                                      ISThere was a setting error during the server declaration. For instance, some settings were added to a server that does not support them or a smart architecture is not managing any physical server.
                                                                                                                                      ICThe SSL credentials are invalid
                                                                                                                                      IPThe account used to add the Microsoft Windows DHCP server does not have sufficient privileges to manage it.
                                                                                                                                      LSThe server configuration is not viable.
                                                                                                                                      NThe server does not have a status as it has not synchronized yet.
                                                                                                                                      YThe server is operational.


                                                                                                                                      ", + "type": "string" + }, + "server_synching": { + "description": "The synchronization status of the DHCPv4 server. 1 indicates that the server is currently being synchronized.", + "type": "string" + }, + "server_type": { + "description": "The type of the DHCPv4 server:


                                                                                                                                      server_type possible values
                                                                                                                                      TypeDescription
                                                                                                                                      ipmEfficientIP or EfficientIP Package server
                                                                                                                                      msrpcMicrosoft Windows DHCP server
                                                                                                                                      vdhcpEfficientIP DHCPv4 smart architecture


                                                                                                                                      ", + "type": "string" + }, + "server_uboottime": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_version": { + "description": "The version details of the DHCPv4 server.", + "type": "string" + }, + "server_hostaddr": { + "description": "The human readable version of the parameter server_addr or server_addr6.", + "type": "string" + }, + "server_addr6": { + "description": "The Management IP address of the DHCPv4 server, the IPv6 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "server_addr": { + "description": "The Management IP address of the DHCPv4 server, the IPv4 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "server_https_login": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_is_package": { + "description": "The DHCPv4 server package information. Y for an EfficientIP Package server, N for an appliance or virtual machine, U the package information is irrelevant. For servers with a server_type set to ipm, U indicates either EfficientIP Packages or appliances/virtual machines.", + "type": "string" + }, + "server_ipmdhcp_protocol": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_isolated": { + "description": "A way to determine if the server can update any other module (1).", + "type": "string" + }, + "server_ms_use_ssl": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_msrpc_domain": { + "description": "The domain name of the Microsoft Windows DHCP server.", + "type": "string" + }, + "server_msrpc_login": { + "description": "The login of the Microsoft Windows DHCP server.", + "type": "string" + }, + "server_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                      Multi-status severity levels
                                                                                                                                      Message number Severity Description
                                                                                                                                      0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                      17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                      34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                      51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                      67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                      84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                      ", + "type": "string" + }, + "ref1_server_name": { + "description": "The name of the Master or Single DHCPv4 server within the smart architecture.", + "type": "string" + }, + "ref2_server_name": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "reverse_proxy_conf": { + "description": "The URL of the HTTP(S) reverse proxy server that forwards client requests to the DHCPv4 server, if you configured one.", + "type": "string" + }, + "service_address_addr": { + "description": "The Service IP address of the DHCPv4 server, the IPv4 address configured when adding the server.", + "type": "string" + }, + "server_snmp_id": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_snmp_port": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_snmp_profile_id": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_snmp_retry": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_snmp_timeout": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_snmp_use_tcp": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_stat_enabled": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_stat_niceness": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_stat_period": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_stat_time": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_tcp_port": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "total_smart_members": { + "description": "The total number of servers managed by the DHCPv4 smart architecture.", + "type": "string" + }, + "smart_arch": { + "description": "The type of the DHCPv4 smart architecture:


                                                                                                                                      smart_arch possible values
                                                                                                                                      TypeDescription
                                                                                                                                      masterslaveThe One-to-One smart architecture sets a pair of DHCP servers in a Master/Backup configuration.
                                                                                                                                      starThe One-to-Many smart architecture sets a multi-site failover configuration at the cost of n-servers+1.
                                                                                                                                      splitscopeThe Split-Scope smart architecture sets a pair of DHCP servers in a configuration where the two scopes listen to the same subnet, but the range of addresses is divided.
                                                                                                                                      singleThe Single-Server smart architecture manages a single DHCP server.


                                                                                                                                      ", + "type": "string" + }, + "smart_members_name": { + "description": "The list of the servers managed by the DHCPv4 smart architecture, as follows: <dhcp_name>,<dhcp_name>,... .", + "type": "string" + }, + "smart_param1": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "smart_parent_arch": { + "description": "The type of the DHCPv4 smart architecture managing the DHCPv4 server. No value indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv4 smart architecture managing the DHCPv4 server. 0 indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_name": { + "description": "The name of the DHCPv4 smart architecture managing the DHCPv4 server. # indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_ref1_server_id": { + "description": "The database identifier (ID) of the DHCPv4 smart architecture the server belongs to.", + "type": "string" + }, + "smart_ref1_server_name": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "smart_ref2_server_id": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "smart_ref2_server_name": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_windhcp_protocol": { + "description": "Internal use. Not documented.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_server_data", + "type": "object" + }, + "_data_inner_dhcp_server6_data": { + "example": { + "server6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server6_snmp_id": "server6_snmp_id", + "server6_version": "server6_version", + "smart_parent_arch": "smart_parent_arch", + "server6_state": "server6_state", + "smart_ref2_server6_id": "smart_ref2_server6_id", + "server6_stat_period": "server6_stat_period", + "server6_snmp_profile_id": "server6_snmp_profile_id", + "server6_multistatus": "server6_multistatus", + "server6_name": "server6_name", + "server6_stat_time": "server6_stat_time", + "server6_comment": "server6_comment", + "server6_snmp_timeout": "server6_snmp_timeout", + "smart_parent_id": "smart_parent_id", + "smart_parent_name": "smart_parent_name", + "smart_ref1_server6_id": "smart_ref1_server6_id", + "smart_arch": "smart_arch", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "server6_type": "server6_type", + "server6_snmp_port": "server6_snmp_port", + "server6_stat_niceness": "server6_stat_niceness", + "smart_ref1_server6_name": "smart_ref1_server6_name", + "smart_ref2_server6_name": "smart_ref2_server6_name", + "server6_synching": "server6_synching", + "server6_addr6": "server6_addr6", + "total_smart_members": "total_smart_members", + "server6_isolated": "server6_isolated", + "smart_param1": "smart_param1", + "server6_hostaddr": "server6_hostaddr", + "server6_last_refresh_time": "server6_last_refresh_time", + "server6_https_login": "server6_https_login", + "server6_uboottime": "server6_uboottime", + "server6_addr": "server6_addr", + "server6_snmp_retry": "server6_snmp_retry", + "smart_members_name": "smart_members_name", + "server6_snmp_use_tcp": "server6_snmp_use_tcp", + "connectionprofile_name": "connectionprofile_name", + "server6_is_package": "server6_is_package", + "reverse_proxy_conf": "reverse_proxy_conf", + "server6_stat_enabled": "server6_stat_enabled" + }, + "properties": { + "connectionprofile_name": { + "description": "The name of the connection profile used as connection method for the DHCPv6 server.", + "type": "string" + }, + "server6_class_name": { + "description": "The name of the class applied to the DHCPv6 server, it can be preceded by the class directory.", + "type": "string" + }, + "server6_class_parameters": { + "description": "The class parameters applied to the DHCPv6 server.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "server6_comment": { + "description": "The description of the DHCPv6 server.", + "type": "string" + }, + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server.", + "type": "string" + }, + "server6_last_refresh_time": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "server6_state": { + "description": "The status of the DHCPv6 server:


                                                                                                                                      server6_state possible values
                                                                                                                                      StatusDescription
                                                                                                                                      ERThe license used in SOLIDserver is not compliant with the added server: the license is invalid.
                                                                                                                                      ESThe server configuration could not be parsed properly.
                                                                                                                                      ETThe server does not answer anymore due to a scheduled configuration of the server.
                                                                                                                                      ISThere was a setting error during the server declaration. For instance, some settings were added to a server that does not support them or a smart architecture is not managing any physical server.
                                                                                                                                      ICThe SSL credentials are invalid
                                                                                                                                      IPThe account used to add the Microsoft Windows DHCP server does not have sufficient privileges to manage it.
                                                                                                                                      LSThe server configuration is not viable.
                                                                                                                                      NThe server does not have a status as it has not synchronized yet.
                                                                                                                                      YThe server is operational.


                                                                                                                                      ", + "type": "string" + }, + "server6_synching": { + "description": "The synchronization status of the DHCPv6 server. 1 indicates that the server is currently being synchronized.", + "type": "string" + }, + "server6_type": { + "description": "The type of the DHCPv6 server:


                                                                                                                                      server6_type possible values
                                                                                                                                      TypeDescription
                                                                                                                                      ipmEfficientIP or EfficientIP Package server
                                                                                                                                      vdhcpEfficientIP DHCPv6 smart architecture


                                                                                                                                      ", + "type": "string" + }, + "server6_uboottime": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server6_version": { + "description": "The version details of the DHCPv6 server.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The human readable version of the parameter server6_addr or server6_addr6.", + "type": "string" + }, + "server6_addr6": { + "description": "The Management IP address of the DHCPv6 server, the IPv6 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "server6_addr": { + "description": "The Management IP address of the DHCPv6 server, the IPv4 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "server6_https_login": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server6_is_package": { + "description": "The DHCPv6 server package information. Y for an EfficientIP Package server, N for an appliance or virtual machine, U the package information is irrelevant. For servers with a server6_type set to ipm, U indicates either EfficientIP Packages or appliances/virtual machines.", + "type": "string" + }, + "server6_isolated": { + "description": "A way to determine if the server can update any other module (1).", + "type": "string" + }, + "server6_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                      Multi-status severity levels
                                                                                                                                      Message number Severity Description
                                                                                                                                      0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                      17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                      34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                      51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                      67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                      84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                      ", + "type": "string" + }, + "reverse_proxy_conf": { + "description": "The URL of the HTTP(S) reverse proxy server that forwards client requests to the DHCPv6 server, if you configured one.", + "type": "string" + }, + "server6_snmp_id": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server6_snmp_port": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server6_snmp_profile_id": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server6_snmp_retry": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server6_snmp_timeout": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server6_snmp_use_tcp": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server6_stat_enabled": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server6_stat_niceness": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server6_stat_period": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server6_stat_time": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "total_smart_members": { + "description": "The total number of servers managed by the DHCPv6 smart architecture.", + "type": "string" + }, + "smart_arch": { + "description": "The type of the DHCPv6 smart architecture.


                                                                                                                                      smart_arch possible values
                                                                                                                                      TypeDescription
                                                                                                                                      singleThe Single-Server smart architecture manages a single DHCPv6 server.
                                                                                                                                      splitscopeThe Split-Scope smart architecture sets a pair of DHCP servers in a configuration where the two scopes listen to the same subnet, but the range of addresses is divided.
                                                                                                                                      statelessThe Stateless smart architecture offers a limited number of options to the DHCP clients. The IP address is delivered thanks to the subnet gateway and it is impossible to create any ranges or statics or to retrieve any leases.


                                                                                                                                      ", + "type": "string" + }, + "smart_members_name": { + "description": "The list of the servers managed by the DHCPv6 smart architecture, as follows: <dhcp6_name>,<dhcp6_name>,... .", + "type": "string" + }, + "smart_param1": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "smart_parent_arch": { + "description": "The type of the DHCPv6 smart architecture managing the DHCPv6 server. No value indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv6 smart architecture managing the DHCPv6 server. 0 indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_name": { + "description": "The name of the DHCPv6 smart architecture managing the DHCPv6 server. # indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_ref1_server6_id": { + "description": "The database identifier (ID) of the DHCPv6 smart architecture the server belongs to.", + "type": "string" + }, + "smart_ref1_server6_name": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "smart_ref2_server6_id": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "smart_ref2_server6_name": { + "description": "Internal use. Not documented.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_server6_data", + "type": "object" + }, + "_data_inner_dhcp_sharednetwork_data": { + "example": { + "server_name": "server_name", + "smart_parent_id": "smart_parent_id", + "sharednetwork_multistatus": "sharednetwork_multistatus", + "sharednetwork_id": "sharednetwork_id", + "sharednetwork_name": "sharednetwork_name", + "server_id": "server_id", + "sharednetwork_delayed_create_time": "sharednetwork_delayed_create_time", + "sharednetwork_delayed_delete_time": "sharednetwork_delayed_delete_time", + "server_type": "server_type" + }, + "properties": { + "sharednetwork_delayed_create_time": { + "description": "The delay of creation status. 1 indicates that the object is not created yet.", + "type": "string" + }, + "sharednetwork_delayed_delete_time": { + "description": "The delay of deletion status. 1 indicates that the object is not deleted yet.", + "type": "string" + }, + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_name": { + "description": "The name of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_type": { + "description": "The type of the DHCPv4 server the object belongs to:


                                                                                                                                      server_type possible values
                                                                                                                                      TypeDescription
                                                                                                                                      ipmEfficientIP or EfficientIP Package server
                                                                                                                                      msrpcMicrosoft Windows DHCP server
                                                                                                                                      vdhcpEfficientIP DHCPv4 smart architecture


                                                                                                                                      ", + "type": "string" + }, + "sharednetwork_id": { + "description": "The database identifier (ID) of the DHCPv4 shared network.", + "type": "string" + }, + "sharednetwork_name": { + "description": "The name of the DHCPv4 shared network.", + "type": "string" + }, + "sharednetwork_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                      Multi-status severity levels
                                                                                                                                      Message number Severity Description
                                                                                                                                      0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                      17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                      34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                      51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                      67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                      84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                      ", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_sharednetwork_data", + "type": "object" + }, + "_data_inner_dhcp_sharednetwork_add_success": { + "example": { + "sharednetwork_id": "sharednetwork_id" + }, + "properties": { + "sharednetwork_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_sharednetwork_add_success", + "type": "object" + }, + "_data_inner_dhcp_sharednetwork_edit_success": { + "example": { + "sharednetwork_id": "sharednetwork_id" + }, + "properties": { + "sharednetwork_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_sharednetwork_edit_success", + "type": "object" + }, + "_data_inner_dhcp_sharednetwork_delete_success": { + "example": { + "sharednetwork_id": "sharednetwork_id" + }, + "properties": { + "sharednetwork_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_sharednetwork_delete_success", + "type": "object" + }, + "_data_inner_dhcp_sharednetwork6_data": { + "example": { + "smart_parent_id": "smart_parent_id", + "sharednetwork6_name": "sharednetwork6_name", + "sharednetwork6_multistatus": "sharednetwork6_multistatus", + "sharednetwork6_delayed_time": "sharednetwork6_delayed_time", + "smart_arch": "smart_arch", + "sharednetwork6_id": "sharednetwork6_id", + "server6_id": "server6_id", + "server6_type": "server6_type", + "server6_name": "server6_name" + }, + "properties": { + "sharednetwork6_delayed_time": { + "description": "The delay of creation/deletion status. 1 indicates that the object is not created/deleted yet.", + "type": "string" + }, + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_name": { + "description": "The name of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_type": { + "description": "The type of the DHCPv6 server the object belongs to:


                                                                                                                                      server6_type possible values
                                                                                                                                      TypeDescription
                                                                                                                                      ipmEfficientIP or EfficientIP Package server
                                                                                                                                      vdhcpEfficientIP DHCPv6 smart architecture


                                                                                                                                      ", + "type": "string" + }, + "sharednetwork6_id": { + "description": "The database identifier (ID) of the DHCPv6 shared network.", + "type": "string" + }, + "sharednetwork6_name": { + "description": "The name of the DHCPv6 shared network.", + "type": "string" + }, + "sharednetwork6_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                      Multi-status severity levels
                                                                                                                                      Message number Severity Description
                                                                                                                                      0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                      17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                      34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                      51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                      67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                      84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                      ", + "type": "string" + }, + "smart_arch": { + "description": "The type of the DHCPv6 smart architecture the object belongs to.


                                                                                                                                      smart_arch possible values
                                                                                                                                      TypeDescription
                                                                                                                                      singleThe Single-Server smart architecture manages a single DHCPv6 server.
                                                                                                                                      splitscopeThe Split-Scope smart architecture sets a pair of DHCP servers in a configuration where the two scopes listen to the same subnet, but the range of addresses is divided.
                                                                                                                                      statelessThe Stateless smart architecture offers a limited number of options to the DHCP clients. The IP address is delivered thanks to the subnet gateway and it is impossible to create any ranges or statics or to retrieve any leases.


                                                                                                                                      ", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv6 smart architecture managing the DHCPv6 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_sharednetwork6_data", + "type": "object" + }, + "_data_inner_dhcp_sharednetwork6_add_success": { + "example": { + "sharednetwork6_id": "sharednetwork6_id" + }, + "properties": { + "sharednetwork6_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_sharednetwork6_add_success", + "type": "object" + }, + "_data_inner_dhcp_sharednetwork6_edit_success": { + "example": { + "sharednetwork6_id": "sharednetwork6_id" + }, + "properties": { + "sharednetwork6_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_sharednetwork6_edit_success", + "type": "object" + }, + "_data_inner_dhcp_sharednetwork6_delete_success": { + "example": { + "sharednetwork6_id": "sharednetwork6_id" + }, + "properties": { + "sharednetwork6_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_sharednetwork6_delete_success", + "type": "object" + }, + "_data_inner_dhcp_static_data": { + "example": { + "server_name": "server_name", + "static_mac_vendor": "static_mac_vendor", + "sharednetwork_id": "sharednetwork_id", + "server_class_name": "server_class_name", + "group_class_name": "group_class_name", + "scope_start_address_addr": "scope_start_address_addr", + "server_version": "server_version", + "static_multistatus": "static_multistatus", + "scope_name": "scope_name", + "static_mac_addr": "static_mac_addr", + "static_delayed_create_time": "static_delayed_create_time", + "static_delayed_delete_time": "static_delayed_delete_time", + "smart_parent_id": "smart_parent_id", + "scope_id": "scope_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "smart_parent_name": "smart_parent_name", + "scope_size": "scope_size", + "static_last_seen": "static_last_seen", + "static_expire_time": "static_expire_time", + "scope_end_address_addr": "scope_end_address_addr", + "static_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "static_addr": "static_addr", + "group_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "group_name": "group_name", + "static_domain": "static_domain", + "static_id": "static_id", + "sharednetwork_name": "sharednetwork_name", + "static_class_name": "static_class_name", + "server_id": "server_id", + "scope_net_mask": "scope_net_mask", + "scope_net_addr": "scope_net_addr", + "group_id": "group_id", + "scope_space_id": "scope_space_id", + "scope_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "static_address_addr": "static_address_addr", + "static_name": "static_name", + "static_identifier": "static_identifier", + "server_type": "server_type", + "scope_class_name": "scope_class_name" + }, + "properties": { + "static_delayed_create_time": { + "description": "The delay of creation status. 1 indicates that the object is not created yet.", + "type": "string" + }, + "static_delayed_delete_time": { + "description": "The delay of deletion status. 1 indicates that the object is not deleted yet.", + "type": "string" + }, + "server_class_name": { + "description": "The name of the class applied to the DHCPv4 server the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "server_class_parameters": { + "description": "The class parameters applied to the DHCPv4 server the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_name": { + "description": "The name of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_type": { + "description": "The type of the DHCPv4 server the object belongs to:


                                                                                                                                      server_type possible values
                                                                                                                                      TypeDescription
                                                                                                                                      ipmEfficientIP or EfficientIP Package server
                                                                                                                                      msrpcMicrosoft Windows DHCP server
                                                                                                                                      vdhcpEfficientIP DHCPv4 smart architecture


                                                                                                                                      ", + "type": "string" + }, + "server_version": { + "description": "The version details of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "group_class_name": { + "description": "The name of the class applied to the DHCPv4 group the static belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "group_class_parameters": { + "description": "The class parameters applied to the DHCPv4 group the static belongs to,.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "group_id": { + "description": "The database identifier (ID) of the DHCPv4 group.", + "type": "string" + }, + "group_name": { + "description": "The name of the DHCPv4 group associated with the object.", + "type": "string" + }, + "static_addr": { + "description": "The IP address associated with the DHCPv4 static.", + "type": "string" + }, + "static_class_name": { + "description": "The name of the class applied to the DHCPv4 static, it can be preceded by the class directory.", + "type": "string" + }, + "static_class_parameters": { + "description": "The class parameters applied to the DHCPv4 static.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "static_domain": { + "description": "The domain name associated with the DHCPv4 static.", + "type": "string" + }, + "static_expire_time": { + "description": "The expiration time of the lease associated with the DHCPv4 static, in decimal UNIX date format.", + "type": "string" + }, + "static_id": { + "description": "The database identifier (ID) of the DHCPv4 static.", + "type": "string" + }, + "static_identifier": { + "description": "The host identifier of the DHCPv4 static, specified as follows: option <option-name> expected value.", + "type": "string" + }, + "static_address_addr": { + "description": "The IP address associated with the DHCPv4 static, in hexadecimal format.", + "type": "string" + }, + "static_last_seen": { + "description": "The last time the MAC address associated with the DHCPv4 static was seen on the network, in decimal UNIX date format.", + "type": "string" + }, + "static_mac_addr": { + "description": "The MAC address associated with the DHCPv4 static. It is composed of 7 sections, 00:11:22:33:44:55:66, where 00 is the MAC address type. The type 01 indicates Ethernet.", + "type": "string" + }, + "static_name": { + "description": "The name of the DHCPv4 static.", + "type": "string" + }, + "scope_class_name": { + "description": "The name of the class applied to the DHCPv4 scope the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "scope_class_parameters": { + "description": "The class parameters applied to the DHCPv4 scope the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "scope_end_address_addr": { + "description": "The last IP address of the DHCPv4 scope the object belongs to, in hexadecimal format.", + "type": "string" + }, + "scope_id": { + "description": "The database identifier (ID) of the DHCPv4 scope the object belongs to.", + "type": "string" + }, + "scope_name": { + "description": "The name of the DHCPv4 scope the object belongs to.", + "type": "string" + }, + "scope_net_addr": { + "description": "The first IP address of the DHCPv4 scope the object belongs.", + "type": "string" + }, + "scope_net_mask": { + "description": "The netmask of the DHCPv4 scope the object belongs to. It is expressed in dot-decimal notation and defines the number of addresses the scope contains.", + "type": "string" + }, + "scope_space_id": { + "description": "The database identifier (ID) of the space associated with the DHCPv4 scope the object belongs to.", + "type": "string" + }, + "scope_size": { + "description": "The number of IP addresses the DHCPv4 scope the object belongs to contains.", + "type": "string" + }, + "scope_start_address_addr": { + "description": "The first IP address of the DHCPv4 scope the object belongs to, in hexadecimal format.", + "type": "string" + }, + "sharednetwork_id": { + "description": "The database identifier (ID) of the DHCPv4 shared network the object belongs to.", + "type": "string" + }, + "sharednetwork_name": { + "description": "The name of the DHCPv4 shared network the object belongs to.", + "type": "string" + }, + "static_mac_vendor": { + "description": "The vendor details of the client associated with the DHCPv4 static.", + "type": "string" + }, + "static_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                      Multi-status severity levels
                                                                                                                                      Message number Severity Description
                                                                                                                                      0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                      17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                      34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                      51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                      67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                      84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                      ", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_name": { + "description": "The name of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. # indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_static_data", + "type": "object" + }, + "_data_inner_dhcp_static_add_success": { + "example": { + "static_id": "static_id" + }, + "properties": { + "static_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_static_add_success", + "type": "object" + }, + "_data_inner_dhcp_static_edit_success": { + "example": { + "static_id": "static_id" + }, + "properties": { + "static_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_static_edit_success", + "type": "object" + }, + "_data_inner_dhcp_static_delete_success": { + "example": { + "static_id": "static_id" + }, + "properties": { + "static_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_static_delete_success", + "type": "object" + }, + "_data_inner_dhcp_static6_data": { + "example": { + "server6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_size": "scope6_size", + "static6_address6_addr": "static6_address6_addr", + "server6_version": "server6_version", + "static6_prefix6": "static6_prefix6", + "scope6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "static6_prefix6_prefix": "static6_prefix6_prefix", + "static6_mac_vendor": "static6_mac_vendor", + "group6_id": "group6_id", + "server6_name": "server6_name", + "smart_parent_id": "smart_parent_id", + "static6_class_name": "static6_class_name", + "smart_parent_name": "smart_parent_name", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "static6_time": "static6_time", + "static6_prefix6_addr": "static6_prefix6_addr", + "server6_type": "server6_type", + "static6_name": "static6_name", + "static6_client_duid": "static6_client_duid", + "sharednetwork6_name": "sharednetwork6_name", + "group6_name": "group6_name", + "static6_id": "static6_id", + "static6_end_time": "static6_end_time", + "scope6_end_address6_addr": "scope6_end_address6_addr", + "static6_domain": "static6_domain", + "scope6_class_name": "scope6_class_name", + "scope6_name": "scope6_name", + "scope6_space_id": "scope6_space_id", + "static6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_id": "scope6_id", + "static6_multistatus": "static6_multistatus", + "static6_mac_addr": "static6_mac_addr", + "sharednetwork6_id": "sharednetwork6_id", + "group6_class_name": "group6_class_name", + "static6_state": "static6_state", + "scope6_start_address6_addr": "scope6_start_address6_addr", + "static6_delayed_time": "static6_delayed_time", + "group6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ] + }, + "properties": { + "static6_delayed_time": { + "description": "The delay of creation/deletion status. 1 indicates that the object is not created/deleted yet.", + "type": "string" + }, + "server6_class_name": { + "description": "The name of the class applied to the DHCPv6 server the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "server6_class_parameters": { + "description": "The class parameters applied to the DHCPv6 server the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_name": { + "description": "The name of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_type": { + "description": "The type of the DHCPv6 server the object belongs to:


                                                                                                                                      server6_type possible values
                                                                                                                                      TypeDescription
                                                                                                                                      ipmEfficientIP or EfficientIP Package server
                                                                                                                                      vdhcpEfficientIP DHCPv6 smart architecture


                                                                                                                                      ", + "type": "string" + }, + "server6_version": { + "description": "The version details of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "group6_class_name": { + "description": "The name of the class applied to the DHCPv6 group the static belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "group6_class_parameters": { + "description": "The class parameters applied to the DHCPv6 group the static belongs to,.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "group6_id": { + "description": "The database identifier (ID) of the DHCPv6 group.", + "type": "string" + }, + "group6_name": { + "description": "The name of the DHCPv6 group associated with the object.", + "type": "string" + }, + "static6_class_name": { + "description": "The name of the class applied to the DHCPv6static, it can be preceded by the class directory.", + "type": "string" + }, + "static6_class_parameters": { + "description": "The class parameters applied to the DHCPv6 static.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "static6_client_duid": { + "description": "The client DHCP Unique Identifier (DUID) associated with the DHCPv6 static.", + "type": "string" + }, + "static6_domain": { + "description": "The domain name associated with the DHCPv6 static.", + "type": "string" + }, + "static6_end_time": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "static6_id": { + "description": "The database identifier (ID) of the DHCPv6 static.", + "type": "string" + }, + "static6_address6_addr": { + "description": "The IP address associated with the DHCPv6 static, in hexadecimal format.", + "type": "string" + }, + "static6_mac_addr": { + "description": "The MAC address associated with the DHCPv6 static.", + "type": "string" + }, + "static6_name": { + "description": "The name of the DHCPv6 static.", + "type": "string" + }, + "static6_prefix6": { + "description": "The IP address and prefix of the delegated prefix of the DHCPv6 static, in hexadecimal format as follows: <IPv6-address>/<prefix>.", + "type": "string" + }, + "static6_prefix6_addr": { + "description": "The IP address of the delegated prefix of the DHCPv6 static, in hexadecimal format.", + "type": "string" + }, + "static6_prefix6_prefix": { + "description": "The prefix of the delegated prefix of the DHCPv6 static.", + "type": "string" + }, + "static6_state": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "static6_time": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "scope6_class_name": { + "description": "The name of the class applied to the DHCPv6 scope the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "scope6_class_parameters": { + "description": "The class parameters applied to the DHCPv6 scope the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "scope6_end_address6_addr": { + "description": "The last IP address of the DHCPv6 scope the object belongs to, in hexadecimal format.", + "type": "string" + }, + "scope6_id": { + "description": "The database identifier (ID) of the DHCPv6 scope the object belongs to.", + "type": "string" + }, + "scope6_name": { + "description": "The name of the DHCPv6 scope the object belongs to.", + "type": "string" + }, + "scope6_space_id": { + "description": "The database identifier (ID) of the space associated with the DHCPv6 scope the object belongs to.", + "type": "string" + }, + "scope6_size": { + "description": "The number of IP addresses the DHCPv6 scope the object belongs to contains.", + "type": "string" + }, + "scope6_start_address6_addr": { + "description": "The first IP address of the DHCPv6 scope the object belongs to, in hexadecimal format.", + "type": "string" + }, + "sharednetwork6_id": { + "description": "The database identifier (ID) of the DHCPv6 shared network the object belongs to.", + "type": "string" + }, + "sharednetwork6_name": { + "description": "The name of the DHCPv6 shared network the object belongs to.", + "type": "string" + }, + "static6_mac_vendor": { + "description": "The vendor details of the client associated with the DHCPv6 static.", + "type": "string" + }, + "static6_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                      Multi-status severity levels
                                                                                                                                      Message number Severity Description
                                                                                                                                      0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                      17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                      34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                      51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                      67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                      84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                      ", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv6 smart architecture managing the DHCPv6 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_name": { + "description": "The name of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. # indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_static6_data", + "type": "object" + }, + "_data_inner_dhcp_static6_add_success": { + "example": { + "static6_id": "static6_id" + }, + "properties": { + "static6_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_static6_add_success", + "type": "object" + }, + "_data_inner_dhcp_static6_edit_success": { + "example": { + "static6_id": "static6_id" + }, + "properties": { + "static6_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_static6_edit_success", + "type": "object" + }, + "_data_inner_dhcp_static6_delete_success": { + "example": { + "static6_id": "static6_id" + }, + "properties": { + "static6_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_static6_delete_success", + "type": "object" + }, + "_data_inner_dns_acl_data": { + "example": { + "acl_value": "acl_value", + "acl_name": "acl_name", + "acl_id": "acl_id", + "server_id": "server_id" + }, + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server the object belongs to.", + "type": "string" + }, + "acl_id": { + "description": "The database identifier (ID) of the DNS ACL.", + "type": "string" + }, + "acl_name": { + "description": "The name of the DNS ACL.", + "type": "string" + }, + "acl_value": { + "description": "The values of the DNS ACL in order of priority, as follows: <value_1>;<value_2>... .", + "type": "string" + } + }, + "title": "_data_inner_dns_acl_data", + "type": "object" + }, + "_data_inner_dns_acl_add_success": { + "example": { + "acl_id": "acl_id" + }, + "properties": { + "acl_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_dns_acl_add_success", + "type": "object" + }, + "_data_inner_dns_acl_edit_success": { + "example": { + "acl_id": "acl_id" + }, + "properties": { + "acl_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_dns_acl_edit_success", + "type": "object" + }, + "_data_inner_dns_acl_delete_success": { + "example": { + "acl_id": "acl_id" + }, + "properties": { + "acl_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_dns_acl_delete_success", + "type": "object" + }, + "_data_inner_dns_rr_data": { + "example": { + "rr_id": "rr_id", + "rr_value_ip4_addr": "rr_value_ip4_addr", + "server_version": "server_version", + "rr_auth_gsstsig": "rr_auth_gsstsig", + "rr_ttl": "rr_ttl", + "smart_parent_name": "smart_parent_name", + "rr_full_name_utf": "rr_full_name_utf", + "zone_space_name": "zone_space_name", + "zone_type": "zone_type", + "rr_all_value": "rr_all_value", + "view_class_name": "view_class_name", + "rr_type_id": "rr_type_id", + "rr_value1": "rr_value1", + "rr_value_id": "rr_value_id", + "server_id": "server_id", + "rr_glue_id": "rr_glue_id", + "rr_glue": "rr_glue", + "rr_name_id": "rr_name_id", + "rr_delayed_delete_time": "rr_delayed_delete_time", + "rr_last_update_time": "rr_last_update_time", + "zone_masters": "zone_masters", + "zone_is_reverse": "zone_is_reverse", + "view_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "rr_full_name": "rr_full_name", + "rr_last_update_days": "rr_last_update_days", + "server_name": "server_name", + "zone_sort_zone": "zone_sort_zone", + "zone_forwarders": "zone_forwarders", + "server_class_name": "server_class_name", + "zone_class_name": "zone_class_name", + "zone_name": "zone_name", + "rr_name_address_addr": "rr_name_address_addr", + "rr_value7": "rr_value7", + "zone_id": "zone_id", + "rr_value6": "rr_value6", + "rr_delayed_time": "rr_delayed_time", + "rr_class_name": "rr_class_name", + "smart_parent_id": "smart_parent_id", + "rr_value3": "rr_value3", + "rr_value2": "rr_value2", + "rr_value5": "rr_value5", + "rr_value4": "rr_value4", + "rr_type": "rr_type", + "server_cloud": "server_cloud", + "view_name": "view_name", + "server_comment": "server_comment", + "rr_value_address_addr": "rr_value_address_addr", + "view_id": "view_id", + "zone_is_rpz": "zone_is_rpz", + "rr_multistatus": "rr_multistatus", + "rr_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "zone_name_utf": "zone_name_utf", + "rr_name_ip4_addr": "rr_name_ip4_addr", + "rr_delayed_create_time": "rr_delayed_create_time", + "server_type": "server_type" + }, + "properties": { + "rr_delayed_create_time": { + "description": "The delay of creation status. 1 indicates that the object is not created yet.", + "type": "string" + }, + "rr_delayed_delete_time": { + "description": "The delay of deletion status. 1 indicates that the object is not deleted yet.", + "type": "string" + }, + "rr_delayed_time": { + "description": "The delay of creation/deletion status. 1 indicates that the object is not created/deleted yet.", + "type": "string" + }, + "server_class_name": { + "description": "The name of the class applied to the DNS server the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "server_cloud": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_comment": { + "description": "The description of the DNS server the object belongs to.", + "type": "string" + }, + "server_id": { + "description": "The database identifier (ID) of the DNS server the object belongs to.", + "type": "string" + }, + "server_name": { + "description": "The name of the DNS server the object belongs to.", + "type": "string" + }, + "server_type": { + "description": "The type of the DNS server the object belongs to.


                                                                                                                                      server_type possible values
                                                                                                                                      TypeDescription
                                                                                                                                      ipmEfficientIP or EfficientIP Package server
                                                                                                                                      msdaemonMicrosoft Windows DNS server
                                                                                                                                      awsAmazon Route 53 server
                                                                                                                                      otherGeneric DNS server
                                                                                                                                      vdnsEfficientIP DNS smart architecture


                                                                                                                                      ", + "type": "string" + }, + "server_version": { + "description": "The version details of the DNS server the object belongs to.", + "type": "string" + }, + "view_class_name": { + "description": "The name of the class applied to the DNS view the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "view_class_parameters": { + "description": "The class parameters applied to the DNS view the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "view_id": { + "description": "The database identifier (ID) of the DNS view the object belongs to.", + "type": "string" + }, + "view_name": { + "description": "The name of the DNS view the object belongs to.", + "type": "string" + }, + "zone_class_name": { + "description": "The name of the class applied to the DNS zone the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "zone_forwarders": { + "description": "The IP address(es) of the forwarder(s) associated with the DNS zone the resource record belongs to. It lists the DNS servers to which any unknown query on this zone should be sent, as follows: <ip_address1>;<ip_address2>;... .", + "type": "string" + }, + "zone_id": { + "description": "The database identifier (ID) of the DNS zone the object belongs to.", + "type": "string" + }, + "zone_is_reverse": { + "description": "A way to determine if the DNS zone the resource record belongs to provides reverse resolution (1) or direct/name resolution (0),", + "type": "string" + }, + "zone_is_rpz": { + "description": "The RPZ status of the DNS zone the resource record belongs to. 1 indicates that the DNS zone the record belongs to is a Response Policy Zone.", + "type": "string" + }, + "zone_masters": { + "description": "For resource records in slave DNS zones, the IP address of the DNS server and, if relevant, the name of the DNS view that contain the master DNS zone, as follows: <ip_addr>; or <ip_addr> key <dnsview_name>; .", + "type": "string" + }, + "zone_name": { + "description": "The name of the DNS zone the object belongs to.", + "type": "string" + }, + "zone_name_utf": { + "description": "The name of the DNS zone the resource record belongs to, in UTF-8 format.", + "type": "string" + }, + "zone_space_name": { + "description": "The name of the space associated with the DNS zone the RR belongs to.", + "type": "string" + }, + "zone_sort_zone": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "zone_type": { + "description": "The type of the DNS zone the object belongs to, either master, slave, forward, stub, hint or delegation-only.", + "type": "string" + }, + "rr_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                      Multi-status severity levels
                                                                                                                                      Message number Severity Description
                                                                                                                                      0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                      17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                      34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                      51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                      67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                      84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                      ", + "type": "string" + }, + "rr_all_value": { + "description": "The concatenated values of the DNS resource record, as follows: <value1>, <value2>, <value3>, <value4>, <value5>, <value6>, <value7>.", + "type": "string" + }, + "rr_auth_gsstsig": { + "description": "A way to determine if the record was authenticated via dynamic update (GSS-TSIG) 1, or not 0.", + "type": "string" + }, + "rr_class_name": { + "description": "The name of the class applied to the resource record, it can be preceded by the class directory.", + "type": "string" + }, + "rr_class_parameters": { + "description": "The class parameters applied to the DNS rr the object belongs to and their value", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "rr_full_name": { + "description": "The full name of the DNS resource record.", + "type": "string" + }, + "rr_full_name_utf": { + "description": "The name of the DNS resource record in UTF-8 format.", + "type": "string" + }, + "rr_glue": { + "description": "The shortname of the DNS resource record.", + "type": "string" + }, + "rr_glue_id": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "rr_id": { + "description": "The database identifier (ID) of the DNS resource record.", + "type": "string" + }, + "rr_last_update_days": { + "description": "The number of days since the record was last updated.", + "type": "string" + }, + "rr_last_update_time": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "rr_name_id": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "rr_name_ip4_addr": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "rr_name_address_addr": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "rr_type": { + "description": "The type of the DNS resource record.


                                                                                                                                      rr_type possible values
                                                                                                                                      ValueRecord type description
                                                                                                                                      SOAStart of Authority. Defines the zone name, an email contact and various time and refresh values applicable to the zone. It is automatically generated upon creation of a zone and cannot be added manually.
                                                                                                                                      NSName Server. Defines the authoritative name server(s) for the domain (defined by the SOA record) or the subdomain. The NS record that indicates which server has authority over a zone is automatically generated upon the creation of a zone, once the server has been synchronized.
                                                                                                                                      AIPv4 Address. An IPv4 address for a host.
                                                                                                                                      PTRPointer Record. Address Resolution, from an IP address (IPv4 or IPv6) to a host. Used in reverse mapping.
                                                                                                                                      AAAAIPv6 Address. An IPv6 address for a host.
                                                                                                                                      CNAMECanonical Name. An alias name for a host.
                                                                                                                                      MXMail Exchange. The mail server/exchanger that services this zone.
                                                                                                                                      SRVServices record. Defines services available in the zone, for example, LDAP, HTTP, etc...
                                                                                                                                      DNAMEDelegation of Reverse Names. Delegation of reverse addresses primarily in IPv6. (Deprecated, use the CNAME RR instead)
                                                                                                                                      TXTText. Information associated with a name.
                                                                                                                                      DSDelegation Signer, a DNSSEC related RR used to verify the validity of the ZSK of a subdomain.
                                                                                                                                      DNSKEYDNS Key. It contains the public cryptographic key used to sign the zone with DNSSEC.
                                                                                                                                      65534A private type record automatically added to the zone once it is signed with DNSSEC.
                                                                                                                                      HINFOSystem Information. Information about a host: hardware type and operating system description.
                                                                                                                                      MINFOMailbox mail list Information. Defines the mail administrator for a mail list and optionally a mailbox to receive error messages relating to the mail list.
                                                                                                                                      AFSDBAFS Database. Location of the AFS servers.
                                                                                                                                      WKSWell-Known Service. Defines the services and protocols supported by a host. (Deprecated, use the SRV RR instead)
                                                                                                                                      NAPTRNaming Authority Pointer Record. General purpose definition of rule set to be used by applications e.g. VoIP.
                                                                                                                                      NSAPNetwork Service Access Point. Defines record (equivalent of an A record) maps a host name to an endpoint address.


                                                                                                                                      ", + "type": "string" + }, + "rr_type_id": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "rr_value_id": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "rr_value_ip4_addr": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "rr_value_address_addr": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "rr_ttl": { + "description": "The time to live of the DNS resource record, in seconds.", + "type": "string" + }, + "rr_value1": { + "description": "The first or only value required for the DNS resource record, as detailed in the service description.", + "type": "string" + }, + "rr_value2": { + "description": "The second value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value3": { + "description": "The third value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value4": { + "description": "The fourth value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value5": { + "description": "The fifth value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value6": { + "description": "The sixth value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value7": { + "description": "The seventh value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DNS smart architecture managing the DNS server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_name": { + "description": "The name of the DNS smart architecture managing the DNS server the object belongs to. # indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dns_rr_data", + "type": "object" + }, + "_data_inner_dns_rr_add_success": { + "example": { + "rr_id": "rr_id" + }, + "properties": { + "rr_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_dns_rr_add_success", + "type": "object" + }, + "_data_inner_dns_rr_edit_success": { + "example": { + "rr_id": "rr_id" + }, + "properties": { + "rr_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_dns_rr_edit_success", + "type": "object" + }, + "_data_inner_dns_rr_delete_success": { + "example": { + "rr_id": "rr_id" + }, + "properties": { + "rr_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_dns_rr_delete_success", + "type": "object" + }, + "_data_inner_dns_server_data": { + "example": { + "server_ipm_protocol": "server_ipm_protocol", + "server_aws_role_arn": "server_aws_role_arn", + "server_stat_enabled": "server_stat_enabled", + "server_dnssec_validation": "server_dnssec_validation", + "server_ipm_type": "server_ipm_type", + "server_stat_time": "server_stat_time", + "server_gss_keytab_id": "server_gss_keytab_id", + "server_ldap_domain": "server_ldap_domain", + "server_version": "server_version", + "server_stat_niceness": "server_stat_niceness", + "server_recursion": "server_recursion", + "server_multistatus": "server_multistatus", + "smart_parent_name": "smart_parent_name", + "server_allow_recursion": "server_allow_recursion", + "server_az_tenantid": "server_az_tenantid", + "server_key_name": "server_key_name", + "server_aws_use_role": "server_aws_use_role", + "server_key_proto": "server_key_proto", + "server_also_notify": "server_also_notify", + "server_allow_query_cache": "server_allow_query_cache", + "server_notify": "server_notify", + "server_rpz_max_policy_ttl": "server_rpz_max_policy_ttl", + "server_stat_period": "server_stat_period", + "server_aws_role_external_id": "server_aws_role_external_id", + "server_id": "server_id", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "server_rpz_qname_wait_recurse": "server_rpz_qname_wait_recurse", + "server_gslb_supported": "server_gslb_supported", + "server_vpc_list": "server_vpc_list", + "server_forward": "server_forward", + "server_aws_role_session_name": "server_aws_role_session_name", + "connectionprofile_name": "connectionprofile_name", + "server_role": "server_role", + "reverse_proxy_conf": "reverse_proxy_conf", + "server_aws_delegation_set": "server_aws_delegation_set", + "server_querylog_state": "server_querylog_state", + "server_name": "server_name", + "smart_parent_arch": "smart_parent_arch", + "server_gss_enabled": "server_gss_enabled", + "server_class_name": "server_class_name", + "server_guardian_stats_only_supported": "server_guardian_stats_only_supported", + "server_forwarders": "server_forwarders", + "server_hybrid": "server_hybrid", + "server_guardian_gui_management_supported": "server_guardian_gui_management_supported", + "server_rpz_break_dnssec": "server_rpz_break_dnssec", + "smart_parent_id": "smart_parent_id", + "server_blast_status": "server_blast_status", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_ipm_is_package": "server_ipm_is_package", + "smart_arch": "smart_arch", + "server_aws_keyid": "server_aws_keyid", + "server_rpz_min_ns_dots": "server_rpz_min_ns_dots", + "server_ipm_login": "server_ipm_login", + "server_az_group": "server_az_group", + "server_state": "server_state", + "server_cloud": "server_cloud", + "server_cloud_private": "server_cloud_private", + "server_blast_enabled": "server_blast_enabled", + "server_az_subscriptionid": "server_az_subscriptionid", + "server_comment": "server_comment", + "server_synching": "server_synching", + "total_smart_members": "total_smart_members", + "server_isolated": "server_isolated", + "server_windns_port": "server_windns_port", + "server_az_keyid": "server_az_keyid", + "server_force_hybrid": "server_force_hybrid", + "smart_public_ns_list": "smart_public_ns_list", + "server_key_value": "server_key_value", + "server_snmp_id": "server_snmp_id", + "server_rpz_recursive_only": "server_rpz_recursive_only", + "smart_members_name": "smart_members_name", + "server_allow_query": "server_allow_query", + "server_ldap_user": "server_ldap_user", + "server_guardian_push_status": "server_guardian_push_status", + "server_guardian_supported": "server_guardian_supported", + "server_windns_protocol": "server_windns_protocol", + "server_allow_transfer": "server_allow_transfer", + "server_windns_use_ssl": "server_windns_use_ssl", + "server_type": "server_type" + }, + "properties": { + "server_aws_delegation_set": { + "description": "The reusable delegation set ID configured on the Amazon Route 53 public server.", + "type": "string" + }, + "server_aws_keyid": { + "description": "The AWS access key identifier (ID) of the DNS server.", + "type": "string" + }, + "server_aws_role_arn": { + "description": "The Amazon Resource Name (ARN) of the role used for the Amazon Route 53 DNS server.", + "type": "string" + }, + "server_aws_role_external_id": { + "description": "The external ID of the role used for the Amazon Route 53 DNS server.", + "type": "string" + }, + "server_aws_role_session_name": { + "description": "The session name of the role used for the Amazon Route 53 DNS server.", + "type": "string" + }, + "server_aws_use_role": { + "description": "The configuration of the option Use a role of the Amazon Route 53 DNS server, either enabled (1) or not (0). If enabled, the role can rely on ARN, an external ID or a session.", + "type": "string" + }, + "server_az_group": { + "description": "For Microsoft Azure servers, the resource group of the DNS server.", + "type": "string" + }, + "server_az_keyid": { + "description": "For Microsoft Azure servers, the Azure Application ID of the DNS server.", + "type": "string" + }, + "server_az_subscriptionid": { + "description": "For Microsoft Azure servers, the subscription ID of the DNS server.", + "type": "string" + }, + "server_az_tenantid": { + "description": "For Microsoft Azure servers, the tenant ID of the DNS server.", + "type": "string" + }, + "connectionprofile_name": { + "description": "The name of the connection profile used as connection method for the DNS server.", + "type": "string" + }, + "server_allow_query": { + "description": "The ACL values associated with the allow-query configuration of the DNS server, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "server_allow_query_cache": { + "description": "The ACL values associated with the allow-query-cache configuration of the DNS server, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "server_allow_recursion": { + "description": "The ACL values associated with the allow-recursion configuration of the DNS server, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "server_allow_transfer": { + "description": "The ACL values associated with the allow-transfer configuration of the DNS server, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "server_also_notify": { + "description": "The IP address and port of the DNS server managing the smart architecture. If the parameter server_notify is set to yes or explicit, the server specified is instantly notified of any slave zones updates.", + "type": "string" + }, + "server_class_name": { + "description": "The name of the class applied to the DNS server, it can be preceded by the class directory.", + "type": "string" + }, + "server_class_parameters": { + "description": "The class parameters applied to the DNS server.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "server_cloud": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_cloud_private": { + "description": "The type of the DNS Amazon Route 53 or Azure server, either Public (0) or Private (1). If the server is not a cloud server, 0 is returned.", + "type": "string" + }, + "server_comment": { + "description": "The description of the DNS server.", + "type": "string" + }, + "server_force_hybrid": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_forward": { + "description": "The forwarding mode of the DNS server. No value indicates that the forwarding is disabled:


                                                                                                                                      server_forward possible values
                                                                                                                                      StatusDescription
                                                                                                                                      firstThe server sends the queries to the forwarder(s). If no answer is returned, it attempts to answer the queries on its own.
                                                                                                                                      onlyThe server only forwards the queries to the forwarder(s). Required by some reverse forward zones (e.g., in the case of private addresses).


                                                                                                                                      ", + "type": "string" + }, + "server_forwarders": { + "description": "The IP address(es) of the forwarder(s) associated with the DNS server. It lists the DNS servers to which any unknown zone should be sent, as follows: <ip_address1>;<ip_address2>;... .", + "type": "string" + }, + "server_hybrid": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server.", + "type": "string" + }, + "server_key_name": { + "description": "The name of the DNS TSIG key associated with the DNS server.", + "type": "string" + }, + "server_key_proto": { + "description": "The encryption protocol of the TSIG key associated with the DNS server.", + "type": "string" + }, + "server_key_value": { + "description": "The value of the TSIG key associated with the DNS server.", + "type": "string" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "server_notify": { + "description": "The notify status of the DNS server:


                                                                                                                                      server_notify possible values
                                                                                                                                      StatusDescription
                                                                                                                                      noNo notify message is sent when changes are performed in the master zones.
                                                                                                                                      yesThe notify messages are sent to the target of the NS records of the master zone. They are also sent to the IP address(es) specified in the parameter .
                                                                                                                                      explicitThe notify messages are only sent to the IP address(es) specified in the parameter .


                                                                                                                                      ", + "type": "string" + }, + "server_recursion": { + "description": "The recursion status of the DNS server:


                                                                                                                                      server_recursion possible values
                                                                                                                                      StatusDescription
                                                                                                                                      noThe server only provides iterative query behavior - normally resulting in a referral. If the answer to the query already exists in the cache it will be returned whatever the value of this statement.
                                                                                                                                      yesThe server always provides recursive query behavior if requested by the client.


                                                                                                                                      ", + "type": "string" + }, + "server_role": { + "description": "The role of the DNS server in the smart architecture, either master, hidden-master, pseudo-master or slave.", + "type": "string" + }, + "server_rpz_break_dnssec": { + "description": "The configuration of the option Enable break-dnssec on the server. It applies to the RPZ zones of the server, if it is not set at zone level. By default it is set to 0 (no), if set to 1 (yes) the server processes policies on all DNSSEC queries.", + "type": "string" + }, + "server_rpz_max_policy_ttl": { + "description": "The configuration of the option Server max policy TTL, i.e. the number of seconds of the max policy Time To Live of the server. It applies to the RPZ zones of the server, if it is not set at zone level. By default it is empty, i.e. set to 5 seconds.", + "type": "string" + }, + "server_rpz_min_ns_dots": { + "description": "The configuration of the option Server minimum dot separatorsof the server, i.e. the minimum number of dot separators required in any QNAME to process policies. It applies to the RPZ zones of the server, if it is not set at zone level. By default it is empty, i.e. set to 1.", + "type": "string" + }, + "server_rpz_qname_wait_recurse": { + "description": "The configuration of the option Enable qname-wait-recurse on the server. It applies to the RPZ zones of the server, if it is not set at zone level. By default it is set to 0 (no), if set to 1 (yes) the server only process policies when the results of any query are available.", + "type": "string" + }, + "server_rpz_recursive_only": { + "description": "The configuration of the option Enable recursive-only on the server. It applies to the RPZ zones of the server, if it is not set at zone level. By default it is set to 1 (yes), the server only processes policies on recursive queries.", + "type": "string" + }, + "server_state": { + "description": "The status of the DNS server:


                                                                                                                                      server_state possible values
                                                                                                                                      StatusDescription
                                                                                                                                      ERThe license used in SOLIDserver is not compliant with the added server: the license is invalid.
                                                                                                                                      ESThe server configuration could not be parsed properly.
                                                                                                                                      ETThe server does not answer anymore due to a scheduled configuration of the server.
                                                                                                                                      ICThe SSL credentials are invalid
                                                                                                                                      IPThe account used to add the Microsoft Windows DNS server does not have sufficient privileges to manage it.
                                                                                                                                      IRSOLIDserver cannot resolve the AWS DNS service. The Amazon services are unreachable and the Amazon Route 53 server cannot be managed. Make sure that the DNS resolvers declared on the page are valid.
                                                                                                                                      ISThere was a setting error during the server declaration. For instance, some settings were added to a server that does not support them or a smart architecture is not managing any physical server.
                                                                                                                                      ITThe server editing performed from the GUI is not pushed to the server because SOLIDserver time and date are incorrect. You must use the UTC system on the appliance, especially when managing Amazon Route 53 servers.
                                                                                                                                      LSThe server configuration is not viable.
                                                                                                                                      NThe server does not have a status as it has not synchronized yet.
                                                                                                                                      UEAn error occurred that SOLIDserver could not identify.
                                                                                                                                      YThe server is operational.


                                                                                                                                      ", + "type": "string" + }, + "server_synching": { + "description": "The synchronization status of the DNS server. 1 indicates that the server is currently being synchronized.", + "type": "string" + }, + "server_type": { + "description": "The type of the DNS server:


                                                                                                                                      server_type possible values
                                                                                                                                      TypeDescription
                                                                                                                                      ipmEfficientIP or EfficientIP Package server
                                                                                                                                      msdaemonMicrosoft Windows DNS server
                                                                                                                                      awsAmazon Route 53 server
                                                                                                                                      otherGeneric DNS server
                                                                                                                                      vdnsEfficientIP DNS smart architecture


                                                                                                                                      ", + "type": "string" + }, + "server_version": { + "description": "The version details of the DNS server.", + "type": "string" + }, + "server_vpc_list": { + "description": "The list of cloud networks configured on the DNS private server, separated by a comma:
                                                                                                                                      • For an Azure server, it returns the list of virtual networks.
                                                                                                                                      • For an Amazon Route 53 server, it returns the list of Virtual Private Cloud (VPC).
                                                                                                                                      ", + "type": "string" + }, + "server_blast_enabled": { + "description": "The status of the service DNS Guardian, either enabled (1) or disabled (0).", + "type": "string" + }, + "server_guardian_push_status": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_blast_status": { + "description": "The status of the Guardian server, either OK (1), Stopped (2), Invalid Credentials (4) or Timeout (5).", + "type": "string" + }, + "server_gslb_supported": { + "description": "The license GSLB activation status. 1 indicates your license includes GSLB and your appliance supports it.", + "type": "string" + }, + "server_guardian_gui_management_supported": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_guardian_supported": { + "description": "The license Guardian activation status. 1 indicates your license includes Guardian and your appliance supports its latest features.", + "type": "string" + }, + "server_dnssec_validation": { + "description": "The DNSSEC resolution status of the DNS server. yes indicates it is enabled.", + "type": "string" + }, + "server_gss_enabled": { + "description": "The GSS-TSIG status of the DNS server. 1 indicates that GSS-TSIG is enabled on the server.", + "type": "string" + }, + "server_gss_keytab_id": { + "description": "The database identifier (ID) of the DNS GSS-TSIG keytab.", + "type": "string" + }, + "server_guardian_stats_only_supported": { + "description": "A way to determine if the server only retrieves Guardian statistics (1) or not (0). On appliances where the service DNS Guardian / GSLB server is not configured, the server cannot be configured with Guardian options, it can only retrieve statistics.", + "type": "string" + }, + "server_hostaddr": { + "description": "The human readable version of the parameter server_addr or server_addr6.", + "type": "string" + }, + "server_addr6": { + "description": "The IPv6 address of the DNS server, in hexadecimal format.", + "type": "string" + }, + "server_addr": { + "description": "The IPv4 address of the DNS server, in hexadecimal format.", + "type": "string" + }, + "server_ipm_login": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_ipm_is_package": { + "description": "The DNS server package information. Y for an EfficientIP Package server, N for an appliance or virtual machine, U the package information is irrelevant. For servers with a server_type set to ipm, U indicates either EfficientIP Packages or appliances/virtual machines.", + "type": "string" + }, + "server_ipm_protocol": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_ipm_type": { + "description": "The engine type of the DNS server: named (BIND engine), nsd (NSD engine) or unbound (Unbound engine).", + "type": "string" + }, + "server_isolated": { + "description": "A way to determine if the server can update any other module (1).", + "type": "string" + }, + "server_ldap_domain": { + "description": "For Microsoft Windows servers, the domain of the DNS server.", + "type": "string" + }, + "server_ldap_user": { + "description": "For Microsoft Windows servers, the login of the user communicating with the DNS server.", + "type": "string" + }, + "server_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                      Multi-status severity levels
                                                                                                                                      Message number Severity Description
                                                                                                                                      0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                      17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                      34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                      51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                      67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                      84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                      ", + "type": "string" + }, + "server_querylog_state": { + "description": "The DNS querylog status. 1 indicates that the DNS server querylog is enabled.", + "type": "string" + }, + "reverse_proxy_conf": { + "description": "The URL of the HTTP(S) reverse proxy server that forwards client queries to the DNS server, if you configured one.", + "type": "string" + }, + "server_snmp_id": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_stat_enabled": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_stat_niceness": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_stat_period": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_stat_time": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "total_smart_members": { + "description": "The total number of servers managed by the DNS smart architecture.", + "type": "string" + }, + "smart_arch": { + "description": "The type of the DNS smart architecture:


                                                                                                                                      smart_arch possible values
                                                                                                                                      StatusDescription
                                                                                                                                      masterslaveMaster/Slave
                                                                                                                                      stealthStealth
                                                                                                                                      multimasterMulti-Master
                                                                                                                                      singleSingle-Server
                                                                                                                                      farmFarm


                                                                                                                                      ", + "type": "string" + }, + "smart_members_name": { + "description": "The list of the servers managed by the DNS smart architecture, as follows: <dns_name>,<dns_name>,... .", + "type": "string" + }, + "smart_parent_arch": { + "description": "The type of the DNS smart architecture managing the DNS server. No value indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DNS smart architecture managing the DNS server. 0 indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_name": { + "description": "The name of the DNS smart architecture managing the DNS server. # indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_public_ns_list": { + "description": "The list of the published name servers associated with the DNS smart architecture, as follows: <ns1>;<ns2>;... .", + "type": "string" + }, + "server_windns_port": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_windns_protocol": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_windns_use_ssl": { + "description": "Internal use. Not documented.", + "type": "string" + } + }, + "title": "_data_inner_dns_server_data", + "type": "object" + }, + "_data_inner_dns_view_data": { + "example": { + "server_name": "server_name", + "view_order": "view_order", + "server_class_name": "server_class_name", + "server_gss_keytab_id": "server_gss_keytab_id", + "server_version": "server_version", + "view_allow_transfer": "view_allow_transfer", + "view_delayed_create_time": "view_delayed_create_time", + "view_delayed_delete_time": "view_delayed_delete_time", + "view_recursion": "view_recursion", + "smart_parent_id": "smart_parent_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "smart_parent_name": "smart_parent_name", + "server_cloud": "server_cloud", + "view_name": "view_name", + "server_comment": "server_comment", + "view_class_name": "view_class_name", + "view_key_name": "view_key_name", + "view_id": "view_id", + "server_id": "server_id", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "view_multistatus": "view_multistatus", + "view_match_clients": "view_match_clients", + "view_match_to": "view_match_to", + "view_allow_recursion": "view_allow_recursion", + "view_allow_query": "view_allow_query", + "view_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_type": "server_type" + }, + "properties": { + "view_delayed_create_time": { + "description": "The delay of creation status. 1 indicates that the object is not created yet.", + "type": "string" + }, + "view_delayed_delete_time": { + "description": "The delay of deletion status. 1 indicates that the object is not deleted yet.", + "type": "string" + }, + "server_class_name": { + "description": "The name of the class applied to the DNS server the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "server_class_parameters": { + "description": "The class parameters applied to the DNS server the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "server_cloud": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_comment": { + "description": "The description of the DNS server the object belongs to.", + "type": "string" + }, + "server_id": { + "description": "The database identifier (ID) of the DNS server the object belongs to.", + "type": "string" + }, + "server_name": { + "description": "The name of the DNS server the object belongs to.", + "type": "string" + }, + "server_type": { + "description": "The type of the DNS server the object belongs to.


                                                                                                                                      server_type possible values
                                                                                                                                      TypeDescription
                                                                                                                                      ipmEfficientIP or EfficientIP Package server
                                                                                                                                      msdaemonMicrosoft Windows DNS server
                                                                                                                                      awsAmazon Route 53 server
                                                                                                                                      otherGeneric DNS server
                                                                                                                                      vdnsEfficientIP DNS smart architecture


                                                                                                                                      ", + "type": "string" + }, + "server_version": { + "description": "The version details of the DNS server the object belongs to.", + "type": "string" + }, + "view_allow_query": { + "description": "The ACL values associated with the allow-query configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_allow_recursion": { + "description": "The ACL values associated with the allow-recursion configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_allow_transfer": { + "description": "The ACL values associated with the allow-transfer configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_class_name": { + "description": "The name of the class applied to the DNS view, it can be preceded by the class directory.", + "type": "string" + }, + "view_class_parameters": { + "description": "The class parameters applied to the DNS view.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "view_id": { + "description": "The database identifier (ID) of the DNS view.", + "type": "string" + }, + "view_key_name": { + "description": "The name of the DNS TSIG key associated with the DNS view.", + "type": "string" + }, + "view_match_clients": { + "description": "The ACL values associated with the match clients configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_match_to": { + "description": "The ACL values associated with the match destination configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_name": { + "description": "The name of the DNS view.", + "type": "string" + }, + "view_order": { + "description": "The level of the DNS view, where 0 represents the highest level in the views hierarchy. The parameters dnsview_match_client and view_match_to of each view in a server are reviewed following this order.", + "type": "string" + }, + "view_recursion": { + "description": "The recursion status of the DNS view:


                                                                                                                                      view_recursion possible values
                                                                                                                                      StatusDescription
                                                                                                                                      noThe view only provides iterative query behavior - normally resulting in a referral. If the answer to the query already exists in the cache it will be returned whatever the value of this statement.
                                                                                                                                      yesThe view always provides recursive query behavior if requested by the client.


                                                                                                                                      ", + "type": "string" + }, + "server_gss_keytab_id": { + "description": "The database identifier (ID) of the DNS GSS-TSIG keytab.", + "type": "string" + }, + "server_hostaddr": { + "description": "The human readable version of the parameter server_addr or server_addr6.", + "type": "string" + }, + "server_addr6": { + "description": "The IPv6 address of the DNS server the object belongs to, in hexadecimal format.", + "type": "string" + }, + "server_addr": { + "description": "The IPv4 address of the DNS server the object belongs to, in hexadecimal format.", + "type": "string" + }, + "view_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                      Multi-status severity levels
                                                                                                                                      Message number Severity Description
                                                                                                                                      0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                      17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                      34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                      51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                      67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                      84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                      ", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DNS smart architecture managing the DNS server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_name": { + "description": "The name of the DNS smart architecture managing the DNS server the object belongs to. # indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dns_view_data", + "type": "object" + }, + "_data_inner_dns_view_add_success": { + "example": { + "view_id": "view_id" + }, + "properties": { + "view_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_dns_view_add_success", + "type": "object" + }, + "_data_inner_dns_view_edit_success": { + "example": { + "view_id": "view_id" + }, + "properties": { + "view_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_dns_view_edit_success", + "type": "object" + }, + "_data_inner_dns_view_delete_success": { + "example": { + "view_id": "view_id" + }, + "properties": { + "view_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_dns_view_delete_success", + "type": "object" + }, + "_data_inner_dns_viewparam_data": { + "example": { + "server_name": "server_name", + "viewparam_key": "viewparam_key", + "viewparam_delayed_delete_time": "viewparam_delayed_delete_time", + "viewparam_delayed_create_time": "viewparam_delayed_create_time", + "viewparam_value": "viewparam_value", + "view_id": "view_id", + "oid": "oid", + "server_id": "server_id", + "view_name": "view_name" + }, + "properties": { + "viewparam_value": { + "description": "The value of the DNS option set on the view.", + "type": "string" + }, + "viewparam_delayed_create_time": { + "description": "The delay of creation status. 1 indicates that the object is not created yet.", + "type": "string" + }, + "viewparam_delayed_delete_time": { + "description": "The delay of deletion status. 1 indicates that the object is not deleted yet.", + "type": "string" + }, + "server_id": { + "description": "The database identifier (ID) of the DNS server the object belongs to.", + "type": "string" + }, + "server_name": { + "description": "The name of the DNS server the object belongs to.", + "type": "string" + }, + "view_id": { + "description": "The database identifier (ID) of the DNS view.", + "type": "string" + }, + "view_name": { + "description": "The name of the DNS view.", + "type": "string" + }, + "oid": { + "description": "The database identifier (ID) of the DNS view param the object belongs to.", + "type": "string" + }, + "viewparam_key": { + "description": "The name of the DNS option set on the view.", + "type": "string" + } + }, + "title": "_data_inner_dns_viewparam_data", + "type": "object" + }, + "_data_inner_dns_viewparam_add_success": { + "example": { + "viewparam_id": "viewparam_id" + }, + "properties": { + "viewparam_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_dns_viewparam_add_success", + "type": "object" + }, + "_data_inner_dns_viewparam_edit_success": { + "example": { + "viewparam_id": "viewparam_id" + }, + "properties": { + "viewparam_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_dns_viewparam_edit_success", + "type": "object" + }, + "_data_inner_dns_viewparam_delete_success": { + "example": { + "viewparam_id": "viewparam_id" + }, + "properties": { + "viewparam_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_dns_viewparam_delete_success", + "type": "object" + }, + "_data_inner_dns_zone_data": { + "example": { + "server_ipm_protocol": "server_ipm_protocol", + "zone_space_id": "zone_space_id", + "zone_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_ipm_type": "server_ipm_type", + "server_gss_keytab_id": "server_gss_keytab_id", + "server_version": "server_version", + "smart_parent_name": "smart_parent_name", + "zone_response_policy": "zone_response_policy", + "zone_rpz_log": "zone_rpz_log", + "zone_space_name": "zone_space_name", + "zone_type": "zone_type", + "zone_allow_update": "zone_allow_update", + "zone_rev_sort_zone": "zone_rev_sort_zone", + "zone_ad_integrated": "zone_ad_integrated", + "zone_forward": "zone_forward", + "view_class_name": "view_class_name", + "zone_allow_transfer": "zone_allow_transfer", + "zone_also_notify": "zone_also_notify", + "zone_synching": "zone_synching", + "zone_rpz_recursive_only": "zone_rpz_recursive_only", + "zone_use_update_policy": "zone_use_update_policy", + "server_id": "server_id", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "server_vpc_list": "server_vpc_list", + "zone_xfer_done": "zone_xfer_done", + "zone_masters": "zone_masters", + "zone_is_reverse": "zone_is_reverse", + "zone_notify": "zone_notify", + "server_aws_delegation_set": "server_aws_delegation_set", + "view_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_name": "server_name", + "zone_num_keys": "zone_num_keys", + "server_gss_enabled": "server_gss_enabled", + "zone_sort_zone": "zone_sort_zone", + "zone_forwarders": "zone_forwarders", + "server_class_name": "server_class_name", + "zone_class_name": "zone_class_name", + "zone_name": "zone_name", + "zone_order": "zone_order", + "zone_delayed_create_time": "zone_delayed_create_time", + "zone_id": "zone_id", + "smart_parent_id": "smart_parent_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "zone_ds": "zone_ds", + "server_state": "server_state", + "server_cloud": "server_cloud", + "view_name": "view_name", + "server_comment": "server_comment", + "view_id": "view_id", + "zone_delayed_delete_time": "zone_delayed_delete_time", + "zone_is_rpz": "zone_is_rpz", + "server_force_hybrid": "server_force_hybrid", + "zone_rpz_max_policy_ttl": "zone_rpz_max_policy_ttl", + "server_ddns_scavenging": "server_ddns_scavenging", + "zone_name_utf": "zone_name_utf", + "zone_allow_query": "zone_allow_query", + "zone_multistatus": "zone_multistatus", + "server_type": "server_type" + }, + "properties": { + "server_aws_delegation_set": { + "description": "The reusable delegation set ID configured on the Amazon Route 53 public server the zone belongs to.", + "type": "string" + }, + "server_ddns_scavenging": { + "description": "The DDNS scavenging status of the zone, either enabled (1) or disabled (0). DDNS scavenging is only effective if the parameters zone_use_update_policy and server_gss_enabled are set to 1, and the rule 416 is enabled in the GUI.", + "type": "string" + }, + "zone_delayed_create_time": { + "description": "The delay of creation status. 1 indicates that the object is not created yet.", + "type": "string" + }, + "zone_delayed_delete_time": { + "description": "The delay of deletion status. 1 indicates that the object is not deleted yet.", + "type": "string" + }, + "server_class_name": { + "description": "The name of the class applied to the DNS server the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "server_class_parameters": { + "description": "The class parameters applied to the DNS server the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "server_cloud": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_comment": { + "description": "The description of the DNS server the object belongs to.", + "type": "string" + }, + "server_force_hybrid": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_id": { + "description": "The database identifier (ID) of the DNS server the object belongs to.", + "type": "string" + }, + "server_name": { + "description": "The name of the DNS server the object belongs to.", + "type": "string" + }, + "server_state": { + "description": "The status of the DNS server the object belongs to.


                                                                                                                                      server_state possible values
                                                                                                                                      StatusDescription
                                                                                                                                      ERThe license used in SOLIDserver is not compliant with the added server: the license is invalid.
                                                                                                                                      ESThe server configuration could not be parsed properly.
                                                                                                                                      ETThe server does not answer anymore due to a scheduled configuration of the server.
                                                                                                                                      ICThe SSL credentials are invalid
                                                                                                                                      IPThe provided account does not have sufficient privileges to remotely manage the MS server.
                                                                                                                                      IRSOLIDserver cannot resolve the AWS DNS service. The Amazon services are unreachable and the Amazon Route 53 server cannot be managed. Make sure that the DNS resolvers declared on the page are valid.
                                                                                                                                      ISThere was a setting error during the server declaration. For instance, some settings were added to a server that does not support them or a smart architecture is not managing any physical server.
                                                                                                                                      ITThe server editing performed from the GUI is not pushed to the server because SOLIDserver time and date are incorrect. You must use the UTC system on the appliance, especially when managing Amazon Route 53 servers.
                                                                                                                                      LSThe server configuration is not viable.
                                                                                                                                      NThe server does not have a status as it has not synchronized yet.
                                                                                                                                      UEAn error occurred that SOLIDserver could not identify.
                                                                                                                                      YThe server is operational.


                                                                                                                                      ", + "type": "string" + }, + "server_type": { + "description": "The type of the DNS server the object belongs to.


                                                                                                                                      server_type possible values
                                                                                                                                      TypeDescription
                                                                                                                                      ipmEfficientIP or EfficientIP Package server
                                                                                                                                      msdaemonMicrosoft Windows DNS server
                                                                                                                                      awsAmazon Route 53 server
                                                                                                                                      otherGeneric DNS server
                                                                                                                                      vdnsEfficientIP DNS smart architecture


                                                                                                                                      ", + "type": "string" + }, + "server_version": { + "description": "The version details of the DNS server the object belongs to.", + "type": "string" + }, + "server_vpc_list": { + "description": "The list of cloud networks configured on the DNS private server the zone belongs to, separated by a comma:
                                                                                                                                      • For an Azure server, it returns the list of virtual networks.
                                                                                                                                      • For an Amazon Route 53 server, it returns the list of Virtual Private Cloud (VPC).
                                                                                                                                      ", + "type": "string" + }, + "view_class_name": { + "description": "The name of the class applied to the DNS view the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "view_class_parameters": { + "description": "The class parameters applied to the DNS view the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "view_id": { + "description": "The database identifier (ID) of the DNS view the object belongs to.", + "type": "string" + }, + "view_name": { + "description": "The name of the DNS view the object belongs to.", + "type": "string" + }, + "zone_ad_integrated": { + "description": "The AD integrated status of the DNS zone. 1 indicates that the DNS zone belongs to an Active Directory integrated Microsoft Windows DNS server.", + "type": "string" + }, + "zone_allow_query": { + "description": "The ACL values associated with the allow-query configuration of the DNS zone, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "zone_allow_transfer": { + "description": "The ACL values associated with the allow-transfer configuration of the DNS zone, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "zone_allow_update": { + "description": "The ACL values associated with the allow-update configuration of the DNS zone, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "zone_also_notify": { + "description": "The IP address and port of the DNS server managing the smart architecture the DNS zone belongs to. If the parameter zone_notify is set to yes or explicit, the server specified is instantly notified of any slave zones updates.", + "type": "string" + }, + "zone_class_name": { + "description": "The name of the class applied to the DNS zone, it can be preceded by the class directory.", + "type": "string" + }, + "zone_class_parameters": { + "description": "The class parameters applied to the DNS zone.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "zone_forward": { + "description": "The forwarding mode of the DNS zone.


                                                                                                                                      zone_forward possible values
                                                                                                                                      StatusDescription
                                                                                                                                      firstThe zone sends the queries to the forwarder(s). If no answer is returned, it attempts to answer the queries on its own.
                                                                                                                                      onlyThe zone only forwards the queries to the forwarder(s). Required by some reverse forward zones (e.g., in the case of private addresses).


                                                                                                                                      If the parameter has no value, it indicates that the forwarding is disabled.", + "type": "string" + }, + "zone_forwarders": { + "description": "The IP address(es) of the forwarder(s) associated with the DNS zone. It lists the DNS servers to which any unknown query on this zone should be sent, as follows: <ip_address1>;<ip_address2>;... .", + "type": "string" + }, + "zone_id": { + "description": "The database identifier (ID) of the DNS zone.", + "type": "string" + }, + "zone_is_reverse": { + "description": "A way to determine if the DNS zone provides reverse resolution (1) or direct/name resolution (0),", + "type": "string" + }, + "zone_is_rpz": { + "description": "The RPZ status of the DNS zone. 1 indicates that the DNS zone is a Response Policy Zone.", + "type": "string" + }, + "zone_masters": { + "description": "For slave DNS zones, the IP address of the DNS server and, if relevant, the name of the DNS view that contain the master DNS zone, as follows: <ip_addr>; or <ip_addr> key <dnsview_name>; .", + "type": "string" + }, + "zone_name": { + "description": "The name of the DNS zone.", + "type": "string" + }, + "zone_name_utf": { + "description": "The name of the DNS zone in UTF-8 format.", + "type": "string" + }, + "zone_notify": { + "description": "The notify status of the DNS zone.


                                                                                                                                      zone_notify possible values
                                                                                                                                      StatusDescription
                                                                                                                                      noNo notify message is sent.
                                                                                                                                      yesA notify message is sent to the name servers defined in the NS records of the zone and to the IP address(es) specified in the parameter .
                                                                                                                                      explicitA notify message is sent only to the IP address(es) specified in the parameter .


                                                                                                                                      The notify message is not sent to the server itself or to the primary server defined in the SOA record of the zone.", + "type": "string" + }, + "zone_order": { + "description": "The level of the DNS zone, where 0 represents the highest level in the zones hierarchy. The RPZ rules parameters of each zone are reviewed following this order. The zones with the parameter zone_is_rpz set to 0 will always return 0 for the parameter zone_order.", + "type": "string" + }, + "zone_response_policy": { + "description": "The Overriding rule of the RPZ zone. DNS zones are set with the policy given.", + "type": "string" + }, + "zone_rev_sort_zone": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "zone_rpz_log": { + "description": "The logging status of an RPZ zone.", + "type": "string" + }, + "zone_rpz_max_policy_ttl": { + "description": "The configuration of the option Server max policy TTL, i.e. the number of seconds of the max policy Time To Live of the zone. It overrides the value set at server level. By default it is empty, i.e. set to 5 seconds.", + "type": "string" + }, + "zone_rpz_recursive_only": { + "description": "The configuration of the option Enable recursive-only on the server of the zone. It overrides the value set at server level. By default it is set to 1 (yes), the server only processes policies on recursive queries.", + "type": "string" + }, + "zone_space_id": { + "description": "The database identifier (ID) of the space associated with the DNS zone.", + "type": "string" + }, + "zone_space_name": { + "description": "The name of the space associated with the DNS zone.", + "type": "string" + }, + "zone_sort_zone": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "zone_synching": { + "description": "The synchronization status of the DNS zone. 1 indicates that the zone is currently being synchronized.", + "type": "string" + }, + "zone_type": { + "description": "The type of the DNS zone, either master, slave, forward, stub, hint or delegation-only.", + "type": "string" + }, + "zone_xfer_done": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "zone_ds": { + "description": "The DNSSEC delegation signer (DS) fingerprint key associated with the DNS zone, if it is signed.", + "type": "string" + }, + "server_gss_enabled": { + "description": "The GSS-TSIG status of the DNS server the zone belongs to. 1 indicates that GSS-TSIG is enabled on the server.", + "type": "string" + }, + "server_gss_keytab_id": { + "description": "The database identifier (ID) of the DNS GSS-TSIG keytab.", + "type": "string" + }, + "server_hostaddr": { + "description": "The human readable version of the parameter server_addr or server_addr6.", + "type": "string" + }, + "server_addr6": { + "description": "The IPv6 address of the DNS server the object belongs to, in hexadecimal format.", + "type": "string" + }, + "server_addr": { + "description": "The IPv4 address of the DNS server the object belongs to, in hexadecimal format.", + "type": "string" + }, + "server_ipm_protocol": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_ipm_type": { + "description": "The engine type of the DNS server the DNS zone belongs to: named (BIND engine), nsd (NSD engine) or unbound (Unbound engine).", + "type": "string" + }, + "zone_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                      Multi-status severity levels
                                                                                                                                      Message number Severity Description
                                                                                                                                      0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                      17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                      34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                      51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                      67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                      84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                      ", + "type": "string" + }, + "zone_num_keys": { + "description": "The number of keys associated with the zone. This number of keys includes all ZSK and KSK.", + "type": "string" + }, + "zone_use_update_policy": { + "description": "The update policy status of the DNS zone. 1 indicates that the DNS zone uses a specific GSS-TSIG/update-policy. The parameter server_gss_enabled must be set to 1.", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DNS smart architecture managing the DNS server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_name": { + "description": "The name of the DNS smart architecture managing the DNS server the object belongs to. # indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dns_zone_data", + "type": "object" + }, + "_data_inner_dns_zone_add_success": { + "example": { + "zone_id": "zone_id" + }, + "properties": { + "zone_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_dns_zone_add_success", + "type": "object" + }, + "_data_inner_dns_zone_edit_success": { + "example": { + "zone_id": "zone_id" + }, + "properties": { + "zone_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_dns_zone_edit_success", + "type": "object" + }, + "_data_inner_dns_zone_delete_success": { + "example": { + "zone_id": "zone_id" + }, + "properties": { + "zone_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_dns_zone_delete_success", + "type": "object" + }, + "_data_inner_dns_zoneparam_data": { + "example": { + "server_name": "server_name", + "zone_id": "zone_id", + "zoneparam_key": "zoneparam_key", + "zoneparam_delayed_delete_time": "zoneparam_delayed_delete_time", + "zoneparam_delayed_create_time": "zoneparam_delayed_create_time", + "zoneparam_value": "zoneparam_value", + "zone_name": "zone_name", + "oid": "oid", + "server_id": "server_id" + }, + "properties": { + "zoneparam_value": { + "description": "The value of the DNS option set on the zone.", + "type": "string" + }, + "zoneparam_delayed_create_time": { + "description": "The delay of creation status. 1 indicates that the object is not created yet.", + "type": "string" + }, + "zoneparam_delayed_delete_time": { + "description": "The delay of deletion status. 1 indicates that the object is not deleted yet.", + "type": "string" + }, + "server_id": { + "description": "The database identifier (ID) of the DNS server the object belongs to.", + "type": "string" + }, + "server_name": { + "description": "The name of the DNS server the object belongs to.", + "type": "string" + }, + "zone_id": { + "description": "The database identifier (ID) of the DNS zone.", + "type": "string" + }, + "zone_name": { + "description": "The name of the DNS zone.", + "type": "string" + }, + "oid": { + "description": "The database identifier (ID) of the DNS zone param the object belongs to.", + "type": "string" + }, + "zoneparam_key": { + "description": "The name of the DNS option set on the zone.", + "type": "string" + } + }, + "title": "_data_inner_dns_zoneparam_data", + "type": "object" + }, + "_data_inner_dns_zoneparam_add_success": { + "example": { + "zoneparam_id": "zoneparam_id" + }, + "properties": { + "zoneparam_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_dns_zoneparam_add_success", + "type": "object" + }, + "_data_inner_dns_zoneparam_edit_success": { + "example": { + "zoneparam_id": "zoneparam_id" + }, + "properties": { + "zoneparam_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_dns_zoneparam_edit_success", + "type": "object" + }, + "_data_inner_dns_zoneparam_delete_success": { + "example": { + "zoneparam_id": "zoneparam_id" + }, + "properties": { + "zoneparam_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_dns_zoneparam_delete_success", + "type": "object" + }, + "_data_inner_guardian_policy_data": { + "example": { + "server_name": "server_name", + "policy_id": "policy_id", + "policy_description": "policy_description", + "policy_name": "policy_name", + "server_id": "server_id", + "policy_delayed_time": "policy_delayed_time", + "parent_policy_id": "parent_policy_id", + "policy_readonly": "policy_readonly" + }, + "properties": { + "policy_delayed_time": { + "description": "The delay of creation/deletion status. 1 indicates that the object is not created/deleted yet.", + "type": "string" + }, + "server_id": { + "description": "The database identifier (ID) of the Guardian server associated with the policy. It is only returned for deployed policies.", + "type": "string" + }, + "server_name": { + "description": "The name of the Guardian server associated with the policy. It is only returned for deployed policies.", + "type": "string" + }, + "policy_description": { + "description": "The description of the policy.", + "type": "string" + }, + "policy_id": { + "description": "The database identifier (ID) of the policy.", + "type": "string" + }, + "policy_name": { + "description": "The name of the policy.", + "type": "string" + }, + "policy_readonly": { + "description": "The read only status of the policy. If set to 1, the policy cannot be edited.", + "type": "string" + }, + "parent_policy_id": { + "description": "The database identifier (ID) of the policy. It is only returned for deployed policies.", + "type": "string" + } + }, + "title": "_data_inner_guardian_policy_data", + "type": "object" + }, + "_data_inner_guardian_policy_add_success": { + "example": { + "policy_id": "policy_id" + }, + "properties": { + "policy_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_guardian_policy_add_success", + "type": "object" + }, + "_data_inner_guardian_policy_edit_success": { + "example": { + "policy_id": "policy_id" + }, + "properties": { + "policy_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_guardian_policy_edit_success", + "type": "object" + }, + "_data_inner_guardian_policy_delete_success": { + "example": { + "policy_id": "policy_id" + }, + "properties": { + "policy_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_guardian_policy_delete_success", + "type": "object" + }, + "_data_inner_ipam_address_data": { + "example": { + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "address_alias": "address_alias", + "network_is_terminal": "network_is_terminal", + "pool_class_name": "pool_class_name", + "free_end_address_addr": "free_end_address_addr", + "address_class_name": "address_class_name", + "address_operation_details_last_updated_on": "address_operation_details_last_updated_on", + "space_class_name": "space_class_name", + "port_portnumber": "port_portnumber", + "network_start_hostaddr": "network_start_hostaddr", + "space_description": "space_description", + "parent_network_end_hostaddr": "parent_network_end_hostaddr", + "device_id": "device_id", + "network_size": "network_size", + "tag_container_dhcpstatic": "tag_container_dhcpstatic", + "port_ifvlan": "port_ifvlan", + "space_is_template": "space_is_template", + "address_id": "address_id", + "network_name": "network_name", + "parent_network_class_name": "parent_network_class_name", + "network_id": "network_id", + "address_operation_details_requested_by": "address_operation_details_requested_by", + "address_operation_details_added_by": "address_operation_details_added_by", + "space_name": "space_name", + "network_start_address_addr": "network_start_address_addr", + "pool_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "address_operation_details_added_on": "address_operation_details_added_on", + "network_class_name": "network_class_name", + "free_start_address_addr": "free_start_address_addr", + "address_hostaddr": "address_hostaddr", + "interface_name": "interface_name", + "pool_start_address_addr": "pool_start_address_addr", + "network_end_hostaddr": "network_end_hostaddr", + "address_multistatus": "address_multistatus", + "address_name": "address_name", + "port_slotnumber": "port_slotnumber", + "parent_network_name": "parent_network_name", + "free_scope_size": "free_scope_size", + "tag_pool_dhcprange": "tag_pool_dhcprange", + "address_operation_details_call_stack": "address_operation_details_call_stack", + "device_name": "device_name", + "parent_network_start_hostaddr": "parent_network_start_hostaddr", + "address_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "parent_network_size": "parent_network_size", + "pool_end_address_addr": "pool_end_address_addr", + "parent_vlsm_network_id": "parent_vlsm_network_id", + "dev_name": "dev_name", + "network_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "address_addr": "address_addr", + "network_lock_network_broadcast": "network_lock_network_broadcast", + "address_type": "address_type", + "address_operation_details_origin_module": "address_operation_details_origin_module", + "static_id": "static_id", + "pool_size": "pool_size", + "pool_read_only": "pool_read_only", + "address_mac_addr": "address_mac_addr", + "pool_id": "pool_id", + "address_mac_last_seen": "address_mac_last_seen", + "parent_network_start_address_addr": "parent_network_start_address_addr", + "pool_name": "pool_name", + "dev_id": "dev_id", + "port_name": "port_name", + "lease_end_time": "lease_end_time", + "interface_id": "interface_id", + "parent_network_id": "parent_network_id", + "space_id": "space_id", + "network_end_address_addr": "network_end_address_addr", + "lease_id": "lease_id", + "parent_network_end_address_addr": "parent_network_end_address_addr" + }, + "properties": { + "static_id": { + "description": "The database identifier (ID) of the DHCP static associated with the IP address.", + "type": "string" + }, + "lease_end_time": { + "description": "The expiration time of the lease, if the IP address was imported from the DHCP, in decimal UNIX date format.", + "type": "string" + }, + "lease_id": { + "description": "The database identifier (ID) of the DHCP lease associated with the IP address.", + "type": "string" + }, + "free_end_address_addr": { + "description": "An IP address in hexadecimal format. For addresses In use (typeip), it returns the IP address itself.For free addresses (typefree), it returns the last IP address of a range of IPv4 addresses that are not assigned yet. The first address in that range is returned in free_start_address_addr.", + "type": "string" + }, + "free_scope_size": { + "description": "The number of IP addresses that are not assigned yet (typefree) between free_start_address_addr and free_end_address_addr.", + "type": "string" + }, + "free_start_address_addr": { + "description": "An IP address in hexadecimal format. For addresses In use (typeip), it returns the IP address itself.For free addresses (typefree), it returns the first IP address of a range of IPv4 addresses that are not assigned yet. The last address in that range is returned in free_end_address_addr.", + "type": "string" + }, + "address_hostaddr": { + "description": "The human readable version of the parameter address_addr.", + "type": "string" + }, + "device_id": { + "description": "The database identifier (ID) of the Device Manager device associated with the IP address.", + "type": "string" + }, + "device_name": { + "description": "The name of the Device Manager device associated with the IP address.", + "type": "string" + }, + "interface_id": { + "description": "The database identifier (ID) of the Device Manager interface associated with the IP address.", + "type": "string" + }, + "interface_name": { + "description": "The name of the Device Manager interface associated with the IP address.", + "type": "string" + }, + "address_addr": { + "description": "The IPv4 address itself, in hexadecimal format.", + "type": "string" + }, + "address_alias": { + "description": "The name of the IPv4 alias(es) associated with the IPv4 address.", + "type": "string" + }, + "address_class_name": { + "description": "The name of the class applied to the IPv4 address, it can be preceded by the class directory.", + "type": "string" + }, + "address_class_parameters": { + "description": "The class parameters applied to the IPv4 address.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "address_id": { + "description": "The database identifier (ID) of the IPv4 address.", + "type": "string" + }, + "dev_id": { + "description": "The database identifier (ID) of the NetChange network device associated with the IP address.", + "type": "string" + }, + "dev_name": { + "description": "The name of the NetChange network device associated with the IP address.", + "type": "string" + }, + "port_ifvlan": { + "description": "The VLAN identifier (ID) of the NetChange port, for IP addresses which MAC addresses is imported from NetChange.", + "type": "string" + }, + "port_name": { + "description": "The name of the NetChange port associated with the IP address.", + "type": "string" + }, + "port_portnumber": { + "description": "The number of the port, for IP addresses which MAC addresses is imported from NetChange.", + "type": "string" + }, + "port_slotnumber": { + "description": "The slot number of the port, for IP addresses which MAC addresses is imported from NetChange.", + "type": "string" + }, + "address_mac_last_seen": { + "description": "The last time the MAC address associated with the IP address was seen on the network, in decimal UNIX date format.", + "type": "string" + }, + "network_lock_network_broadcast": { + "description": "A way to prevent (1) users from assigning the broadcast IP address and network IP address of the network the IP address belongs to.", + "type": "string" + }, + "address_mac_addr": { + "description": "The MAC address associated with the IPv4 address.", + "type": "string" + }, + "address_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                      Multi-status severity levels
                                                                                                                                      Message number Severity Description
                                                                                                                                      0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                      17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                      34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                      51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                      67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                      84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                      ", + "type": "string" + }, + "address_name": { + "description": "The name of the IPv4 address.", + "type": "string" + }, + "parent_network_class_name": { + "description": "The name of the class applied to the parent of the IPv4 network the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "parent_network_end_hostaddr": { + "description": "The human readable version of the parameter parent_network_end_address_addr.", + "type": "string" + }, + "parent_network_end_address_addr": { + "description": "The last IP address of the parent of the IPv4 network the IP address belongs to.", + "type": "string" + }, + "parent_network_id": { + "description": "The database identifier (ID) of the parent IPv4 network. It identifies the parent of the IPv4 network the object belongs to. 0 indicates that the network the object belongs to has no parent network.", + "type": "string" + }, + "parent_network_name": { + "description": "The name of the parent IPv4 network:
                                                                                                                                      • # indicates that the network the object belongs to has no parent network.
                                                                                                                                      • Default indicates that the network the object belongs to is in an orphan network.
                                                                                                                                      ", + "type": "string" + }, + "parent_network_size": { + "description": "The number of IP addresses of the parent of the network the object belongs to.", + "type": "string" + }, + "parent_network_start_hostaddr": { + "description": "The human readable version of the parameter parent_network_start_address_addr.", + "type": "string" + }, + "parent_network_start_address_addr": { + "description": "The first IP address of the parent of the IPv4 network the IP address belongs to.", + "type": "string" + }, + "parent_vlsm_network_id": { + "description": "The database identifier (ID) of the IPv4 subnet-type network, located in the VLSM parent space, from which the parent of the network the IP address belongs to was duplicated. 0 indicates that the parent of the network the IP address belongs to is not a VLSM block-type network duplicated from a parent space.", + "type": "string" + }, + "pool_class_name": { + "description": "The name of the class applied to the IPv4 pool the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "pool_class_parameters": { + "description": "The class parameters applied to the IPv4 pool the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "pool_end_address_addr": { + "description": "The last IP address of the IPv4 pool the IP address belongs to.", + "type": "string" + }, + "pool_id": { + "description": "The database identifier (ID) of the IPv4 pool the object belongs to.", + "type": "string" + }, + "pool_name": { + "description": "The name of the IPv4 pool the object belongs to.", + "type": "string" + }, + "pool_read_only": { + "description": "The reservation status of the pool the IPv4 address belongs to. If set 1, the pool is reserved and you cannot assign the IP address.", + "type": "string" + }, + "pool_size": { + "description": "The number of IP addresses that contains the pool the IPv4 address belongs to.", + "type": "string" + }, + "pool_start_address_addr": { + "description": "The first IP address of the IPv4 pool the IP address belongs to.", + "type": "string" + }, + "space_class_name": { + "description": "The name of the class applied to the space the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "space_class_parameters": { + "description": "The class parameters applied to the space the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "space_description": { + "description": "The description of the space the object belongs to.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space the object belongs to, a unique numeric key value automatically incremented when you add a space.", + "type": "string" + }, + "space_is_template": { + "description": "The template status of the space the object belongs to. If the space is used as template (1), all the IPv4 networks, pools and IP addresses it contains are also used as template.", + "type": "string" + }, + "space_name": { + "description": "The name of the space the object belongs to.", + "type": "string" + }, + "network_class_name": { + "description": "The name of the class applied to the IPv4 network the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "network_class_parameters": { + "description": "The class parameters applied to the IPv4 network the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "network_end_hostaddr": { + "description": "The human readable version of the parameter network_end_address_addr.", + "type": "string" + }, + "network_end_address_addr": { + "description": "The last IP address of the IPv4 network the object belongs to.", + "type": "string" + }, + "network_id": { + "description": "The database identifier (ID) of the IPv4 network the object belongs to.", + "type": "string" + }, + "network_is_terminal": { + "description": "A way to determine if the network the IP address belongs to is terminal (1) or non-terminal (0).", + "type": "string" + }, + "network_name": { + "description": "The name of the IPv4 network the object belongs to. Default indicates that the network the object belongs to is an orphan network.", + "type": "string" + }, + "network_size": { + "description": "The number of IP addresses the network the object belongs to contains.", + "type": "string" + }, + "network_start_hostaddr": { + "description": "The human readable version of the parameter network_start_address_addr.", + "type": "string" + }, + "network_start_address_addr": { + "description": "The first IP address of the IPv4 network the object belongs to.", + "type": "string" + }, + "tag_container_dhcpstatic": { + "description": "A way to determine if the terminal network or pool the IP address belongs to is configured to Add a DHCP static (1) or not (0).", + "type": "string" + }, + "tag_pool_dhcprange": { + "description": "A way to determine if the pool the IP address belongs to is configured to Create DHCP range (1) or not (0).", + "type": "string" + }, + "address_operation_details_added_on": { + "description": "The creation date of the IPv4 address, in decimal UNIX date format.", + "type": "string" + }, + "address_operation_details_call_stack": { + "description": "The call stack of the IPv4 address operation details, as follows: <service1>&<service2>&<service3>... .", + "type": "string" + }, + "address_operation_details_origin_module": { + "description": "The name of the module where the IPv4 address addition originated.", + "type": "string" + }, + "address_operation_details_requested_by": { + "description": "The login of the user who requested the IPv4 address.", + "type": "string" + }, + "address_operation_details_added_by": { + "description": "The login of the user who added the IPv4 address.", + "type": "string" + }, + "address_operation_details_last_updated_on": { + "description": "The last time the IPv4 address was updated, in decimal UNIX date format.", + "type": "string" + }, + "address_type": { + "description": "A way to determine if you can assign the IP address (free) or if it is In use (ip).", + "type": "string" + } + }, + "title": "_data_inner_ipam_address_data", + "type": "object" + }, + "_data_inner_ipam_address_add_success": { + "example": { + "address_id": "address_id" + }, + "properties": { + "address_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_ipam_address_add_success", + "type": "object" + }, + "_data_inner_ipam_address_edit_success": { + "example": { + "address_id": "address_id" + }, + "properties": { + "address_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_ipam_address_edit_success", + "type": "object" + }, + "_data_inner_ipam_address_delete_success": { + "example": { + "address_id": "address_id" + }, + "properties": { + "address_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_ipam_address_delete_success", + "type": "object" + }, + "_data_inner_ipam_address6_data": { + "example": { + "parent_network6_class_name": "parent_network6_class_name", + "pool6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "address6_operation_details_added_on": "address6_operation_details_added_on", + "address6_multistatus": "address6_multistatus", + "address6_operation_details_added_by": "address6_operation_details_added_by", + "parent_network6_prefix": "parent_network6_prefix", + "space_class_name": "space_class_name", + "space_description": "space_description", + "address6_alias": "address6_alias", + "free_start_address6_addr": "free_start_address6_addr", + "address6_operation_details_call_stack": "address6_operation_details_call_stack", + "parent_network6_end_hostaddr": "parent_network6_end_hostaddr", + "network6_start_address6_addr": "network6_start_address6_addr", + "pool6_size": "pool6_size", + "parent_vlsm_network6_id": "parent_vlsm_network6_id", + "device_id": "device_id", + "network_size": "network_size", + "network6_is_terminal": "network6_is_terminal", + "vlsm_network6_id": "vlsm_network6_id", + "address6_type": "address6_type", + "pool6_id": "pool6_id", + "pool6_name": "pool6_name", + "space_name": "space_name", + "network6_id": "network6_id", + "network6_start_hostaddr": "network6_start_hostaddr", + "address6_operation_details_requested_by": "address6_operation_details_requested_by", + "pool6_end_address6_addr": "pool6_end_address6_addr", + "interface_name": "interface_name", + "network6_end_hostaddr": "network6_end_hostaddr", + "parent_network6_id": "parent_network6_id", + "network6_name": "network6_name", + "free_scope_size": "free_scope_size", + "free_end_address6_addr": "free_end_address6_addr", + "device_name": "device_name", + "address6_name": "address6_name", + "parent_network6_start_address6_addr": "parent_network6_start_address6_addr", + "parent_network6_start_hostaddr": "parent_network6_start_hostaddr", + "pool6_read_only": "pool6_read_only", + "pool6_class_name": "pool6_class_name", + "network6_end_address6_addr": "network6_end_address6_addr", + "address6_mac_addr": "address6_mac_addr", + "parent_space_name": "parent_space_name", + "network6_prefix": "network6_prefix", + "address6_id": "address6_id", + "network6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "parent_network6_size": "parent_network6_size", + "parent_network6_name": "parent_network6_name", + "parent_network6_end_address6_addr": "parent_network6_end_address6_addr", + "network6_lock_network_broadcast": "network6_lock_network_broadcast", + "address6_operation_details_last_updated_on": "address6_operation_details_last_updated_on", + "network6_size": "network6_size", + "interface_id": "interface_id", + "address6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "network6_class_name": "network6_class_name", + "address6_operation_details_origin_module": "address6_operation_details_origin_module", + "address6_addr": "address6_addr", + "address6_hostaddr": "address6_hostaddr", + "space_id": "space_id", + "address6_class_name": "address6_class_name", + "pool6_start_address6_addr": "pool6_start_address6_addr" + }, + "properties": { + "free_end_address6_addr": { + "description": "An IP address in hexadecimal format. For addresses In use (typeip6), it returns the IP address itself.For free addresses (typefree), it returns the last IP address of a range of IPv6 addresses that are not assigned yet. The first address in that range is returned in free_start_address6_addr.", + "type": "string" + }, + "free_scope_size": { + "description": "The number of IP addresses that are not assigned yet (typefree) between free_start_address6_addr and free_end_address6_addr.", + "type": "string" + }, + "free_start_address6_addr": { + "description": "An IP address in hexadecimal format. For addresses In use (typeip6), it returns the IP address itself.For free addresses (typefree), it returns the first IP address of a range of IPv6 addresses that are not assigned yet. The last address in that range is returned in free_end_address6_addr.", + "type": "string" + }, + "address6_hostaddr": { + "description": "The human readable version of the parameter address6_addr.", + "type": "string" + }, + "device_id": { + "description": "The database identifier (ID) of the Device Manager device associated with the IP address.", + "type": "string" + }, + "device_name": { + "description": "The name of the Device Manager device associated with the IP address.", + "type": "string" + }, + "interface_id": { + "description": "The database identifier (ID) of the Device Manager interface associated with the IP address.", + "type": "string" + }, + "interface_name": { + "description": "The name of the Device Manager interface associated with the IP address.", + "type": "string" + }, + "address6_addr": { + "description": "The IPv6 address itself.", + "type": "string" + }, + "address6_alias": { + "description": "The name of the IPv6 alias(es) associated with the IPv6 address.", + "type": "string" + }, + "address6_class_name": { + "description": "The name of the class applied to the IPv6 address, it can be preceded by the class directory.", + "type": "string" + }, + "address6_class_parameters": { + "description": "The class parameters applied to the IPv6 address.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "address6_id": { + "description": "The database identifier (ID) of the IPv6 address.", + "type": "string" + }, + "address6_mac_addr": { + "description": "The MAC address associated with the IPv6 address.", + "type": "string" + }, + "address6_name": { + "description": "The name of the IPv6 address.", + "type": "string" + }, + "network6_lock_network_broadcast": { + "description": "A way to prevent (1) users from assigning the broadcast IP address and network IP address of the network the IP address belongs to.", + "type": "string" + }, + "address6_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                      Multi-status severity levels
                                                                                                                                      Message number Severity Description
                                                                                                                                      0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                      17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                      34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                      51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                      67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                      84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                      ", + "type": "string" + }, + "parent_space_name": { + "description": "The name of the space where is located the parent of the network the IPv6 address belongs to. # indicates that the network the IPv6 address belongs to has no parent network.", + "type": "string" + }, + "parent_network6_class_name": { + "description": "The name of the class applied to the parent of the IPv6 network the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "parent_network6_end_hostaddr": { + "description": "The human readable version of the parameter parent_network6_end_address6_addr.", + "type": "string" + }, + "parent_network6_end_address6_addr": { + "description": "The last IP address of the parent of the IPv6 network the IP address belongs to.", + "type": "string" + }, + "parent_network6_id": { + "description": "The database identifier (ID) of the parent IPv6 network. It identifies the parent of the IPv6 network the object belongs to. 0 indicates that the network the object belongs to has no parent network.", + "type": "string" + }, + "parent_network6_name": { + "description": "The name of the parent IPv6 network. # indicates that the network the object belongs to has no parent network.", + "type": "string" + }, + "parent_network6_prefix": { + "description": "The prefix of the parent of the IPv6 network the object belongs to.", + "type": "string" + }, + "parent_network6_size": { + "description": "The number of IP addresses of the network parent, in hexadecimal format.", + "type": "string" + }, + "parent_network6_start_hostaddr": { + "description": "The human readable version of the parameter parent_network6_start_address6_addr.", + "type": "string" + }, + "parent_network6_start_address6_addr": { + "description": "The first IP address of the parent of the IPv6 network the IP address belongs to.", + "type": "string" + }, + "parent_vlsm_network6_id": { + "description": "The database identifier (ID) of the IPv6 subnet-type network, located in the VLSM parent space, from which the parent of the network the IP address belongs to was duplicated. 0 indicates that the parent of the network the IP address belongs to is not a VLSM block-type network duplicated from a parent space.", + "type": "string" + }, + "pool6_class_name": { + "description": "The name of the class applied to the IPv6 pool the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "pool6_class_parameters": { + "description": "The class parameters applied to the IPv6 pool the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "pool6_end_address6_addr": { + "description": "The last IP address of the IPv6 pool the IP address belongs to.", + "type": "string" + }, + "pool6_id": { + "description": "The database identifier (ID) of the IPv6 pool the object belongs to.", + "type": "string" + }, + "pool6_name": { + "description": "The name of the IPv6 pool the object belongs to.", + "type": "string" + }, + "pool6_read_only": { + "description": "The reservation status of the pool the IPv6 address belongs to. If set 1, the pool is reserved and you cannot assign the IP address.", + "type": "string" + }, + "pool6_size": { + "description": "The number of IP addresses that contains the pool the IPv6 address belongs to.", + "type": "string" + }, + "pool6_start_address6_addr": { + "description": "The first IP address of the IPv6 pool the IP address belongs to.", + "type": "string" + }, + "space_class_name": { + "description": "The name of the class applied to the space the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "space_class_parameters": { + "description": "The class parameters applied to the space the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "space_description": { + "description": "The description of the space the object belongs to.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space the object belongs to, a unique numeric key value automatically incremented when you add a space.", + "type": "string" + }, + "space_name": { + "description": "The name of the space the object belongs to.", + "type": "string" + }, + "network6_class_name": { + "description": "The name of the class applied to the IPv6 network the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "network6_class_parameters": { + "description": "The class parameters applied to the IPv6 network the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "network6_end_hostaddr": { + "description": "The human readable version of the parameter network6_end_address6_addr.", + "type": "string" + }, + "network6_end_address6_addr": { + "description": "The last IP address of the IPv6 network the object belongs to.", + "type": "string" + }, + "network6_id": { + "description": "The database identifier (ID) of the IPv6 network the object belongs to.", + "type": "string" + }, + "network6_is_terminal": { + "description": "A way to determine if the network the IP address belongs to is terminal (1) or non-terminal (0).", + "type": "string" + }, + "network6_name": { + "description": "The name of the IPv6 network the object belongs to.", + "type": "string" + }, + "network6_prefix": { + "description": "The prefix of the IPv6 network the object belongs to.", + "type": "string" + }, + "network6_size": { + "description": "The number of IP addresses the network the object belongs to contains.", + "type": "string" + }, + "network6_start_hostaddr": { + "description": "The human readable version of the parameter network6_start_address6_addr.", + "type": "string" + }, + "network6_start_address6_addr": { + "description": "The first IP address of the IPv6 network the object belongs to.", + "type": "string" + }, + "network_size": { + "description": "The number of IP addresses the network the object belongs to contains.", + "type": "string" + }, + "address6_operation_details_added_on": { + "description": "The creation date of the IPv6 address, in decimal UNIX date format.", + "type": "string" + }, + "address6_operation_details_call_stack": { + "description": "The call stack of the IPv6 address operation details, as follows: <service1>&<service2>&<service3>... .", + "type": "string" + }, + "address6_operation_details_origin_module": { + "description": "The name of the module where the IPv6 address addition originated.", + "type": "string" + }, + "address6_operation_details_requested_by": { + "description": "The login of the user who requested the IPv6 address.", + "type": "string" + }, + "address6_operation_details_added_by": { + "description": "The login of the user who added the IPv6 address.", + "type": "string" + }, + "address6_operation_details_last_updated_on": { + "description": "The last time the IPv6 address was updated, in decimal UNIX date format.", + "type": "string" + }, + "address6_type": { + "description": "A way to determine if you can assign the IP address (free) or if it is In use (ip6).", + "type": "string" + }, + "vlsm_network6_id": { + "description": "The database identifier (ID) of the IPv6 subnet-type network, located in the VLSM parent space, from which the network the IP address belongs to was duplicated. 0 indicates the network the IP address belongs to is not a VLSM block-type network duplicated from a parent space.", + "type": "string" + } + }, + "title": "_data_inner_ipam_address6_data", + "type": "object" + }, + "_data_inner_ipam_address6_add_success": { + "example": { + "address6_id": "address6_id" + }, + "properties": { + "address6_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_ipam_address6_add_success", + "type": "object" + }, + "_data_inner_ipam_address6_edit_success": { + "example": { + "address6_id": "address6_id" + }, + "properties": { + "address6_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_ipam_address6_edit_success", + "type": "object" + }, + "_data_inner_ipam_address6_delete_success": { + "example": { + "address6_id": "address6_id" + }, + "properties": { + "address6_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_ipam_address6_delete_success", + "type": "object" + }, + "_data_inner_ipam_alias_data": { + "example": { + "device_id": "device_id", + "address_addr": "address_addr", + "address_type": "address_type", + "static_id": "static_id", + "alias_id": "alias_id", + "address_id": "address_id", + "address_name": "address_name", + "alias_name": "alias_name", + "address_mac_addr": "address_mac_addr", + "pool_id": "pool_id", + "alias_type": "alias_type", + "network_id": "network_id", + "interface_id": "interface_id", + "address_class_name": "address_class_name", + "address_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_name": "space_name", + "space_class_name": "space_class_name", + "port_id": "port_id", + "space_id": "space_id", + "lease_id": "lease_id" + }, + "properties": { + "alias_name": { + "description": "The name of the alias.", + "type": "string" + }, + "static_id": { + "description": "The database identifier (ID) of the DHCP static associated with the IP address.", + "type": "string" + }, + "lease_id": { + "description": "The database identifier (ID) of the DHCP lease associated with the IP address.", + "type": "string" + }, + "device_id": { + "description": "The database identifier (ID) of the Device Manager device associated with the IP address.", + "type": "string" + }, + "interface_id": { + "description": "The database identifier (ID) of the Device Manager interface associated with the IP address.", + "type": "string" + }, + "address_addr": { + "description": "The IPv4 alias itself, in hexadecimal format.", + "type": "string" + }, + "address_class_name": { + "description": "The name of the class applied to the object, it can be preceded by the class directory.", + "type": "string" + }, + "address_class_parameters": { + "description": "The class parameters applied to the IPv4 alias.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "address_id": { + "description": "The database identifier (ID) of the IPv4 address associated with the alias.", + "type": "string" + }, + "alias_id": { + "description": "The database identifier (ID) of the IPv4 alias.", + "type": "string" + }, + "alias_type": { + "description": "The type of the alias, either CNAME or A.", + "type": "string" + }, + "address_type": { + "description": "A way to determine if you can assign the IP alias (free) or if it is In use (ip).", + "type": "string" + }, + "port_id": { + "description": "The database identifier (ID) of the NetChange port associated with the IP address.", + "type": "string" + }, + "address_mac_addr": { + "description": "The MAC address associated with the IPv4 alias.", + "type": "string" + }, + "address_name": { + "description": "The name of the IPv4 alias.", + "type": "string" + }, + "pool_id": { + "description": "The database identifier (ID) of the IPv4 pool the object belongs to.", + "type": "string" + }, + "space_class_name": { + "description": "The name of the class applied to the space the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space the object belongs to, a unique numeric key value automatically incremented when you add a space.", + "type": "string" + }, + "space_name": { + "description": "The name of the space the object belongs to.", + "type": "string" + }, + "network_id": { + "description": "The database identifier (ID) of the IPv4 network the object belongs to.", + "type": "string" + } + }, + "title": "_data_inner_ipam_alias_data", + "type": "object" + }, + "_data_inner_ipam_alias_add_success": { + "example": { + "alias_id": "alias_id" + }, + "properties": { + "alias_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_ipam_alias_add_success", + "type": "object" + }, + "_data_inner_ipam_alias_edit_success": { + "example": { + "alias_id": "alias_id" + }, + "properties": { + "alias_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_ipam_alias_edit_success", + "type": "object" + }, + "_data_inner_ipam_alias_delete_success": { + "example": { + "alias_id": "alias_id" + }, + "properties": { + "alias_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_ipam_alias_delete_success", + "type": "object" + }, + "_data_inner_ipam_alias6_data": { + "example": { + "address6_id": "address6_id", + "device_id": "device_id", + "alias_name": "alias_name", + "pool6_id": "pool6_id", + "interface_id": "interface_id", + "address6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "address6_name": "address6_name", + "space_name": "space_name", + "network6_id": "network6_id", + "space_class_name": "space_class_name", + "alias6_type": "alias6_type", + "port_id": "port_id", + "address6_addr": "address6_addr", + "alias6_id": "alias6_id", + "address6_mac_addr": "address6_mac_addr", + "space_id": "space_id", + "address6_class_name": "address6_class_name" + }, + "properties": { + "alias_name": { + "description": "The name of the alias.", + "type": "string" + }, + "device_id": { + "description": "The database identifier (ID) of the Device Manager device associated with the IP address.", + "type": "string" + }, + "interface_id": { + "description": "The database identifier (ID) of the Device Manager interface associated with the IP address.", + "type": "string" + }, + "address6_addr": { + "description": "The IPv6 alias itself.", + "type": "string" + }, + "address6_class_name": { + "description": "The name of the class applied to the object, it can be preceded by the class directory.", + "type": "string" + }, + "address6_class_parameters": { + "description": "The class parameters applied to the IPv6 alias.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "address6_id": { + "description": "The database identifier (ID) of the IPv6 address associated with the alias.", + "type": "string" + }, + "address6_mac_addr": { + "description": "The MAC address associated with the IPv6 alias.", + "type": "string" + }, + "address6_name": { + "description": "The name of the IPv6 address associated with the alias.", + "type": "string" + }, + "alias6_id": { + "description": "The database identifier (ID) of the IPv6 alias.", + "type": "string" + }, + "alias6_type": { + "description": "The type of the alias, either CNAME or AAAA.", + "type": "string" + }, + "port_id": { + "description": "The database identifier (ID) of the NetChange port associated with the IP address.", + "type": "string" + }, + "pool6_id": { + "description": "The database identifier (ID) of the IPv6 pool the object belongs to.", + "type": "string" + }, + "space_class_name": { + "description": "The name of the class applied to the space the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space the object belongs to, a unique numeric key value automatically incremented when you add a space.", + "type": "string" + }, + "space_name": { + "description": "The name of the space the object belongs to.", + "type": "string" + }, + "network6_id": { + "description": "The database identifier (ID) of the IPv6 network the object belongs to.", + "type": "string" + } + }, + "title": "_data_inner_ipam_alias6_data", + "type": "object" + }, + "_data_inner_ipam_alias6_add_success": { + "example": { + "alias6_id": "alias6_id" + }, + "properties": { + "alias6_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_ipam_alias6_add_success", + "type": "object" + }, + "_data_inner_ipam_alias6_edit_success": { + "example": { + "alias6_id": "alias6_id" + }, + "properties": { + "alias6_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_ipam_alias6_edit_success", + "type": "object" + }, + "_data_inner_ipam_alias6_delete_success": { + "example": { + "alias6_id": "alias6_id" + }, + "properties": { + "alias6_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_ipam_alias6_delete_success", + "type": "object" + }, + "_data_inner_ipam_network_data": { + "example": { + "range_name": "range_name", + "network_address_used_size": "network_address_used_size", + "vlan_id": "vlan_id", + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "vlsm_space_id": "vlsm_space_id", + "vlan_vlan_id": "vlan_vlan_id", + "network_is_terminal": "network_is_terminal", + "vlan_name": "vlan_name", + "parent_network_level": "parent_network_level", + "domain_id": "domain_id", + "vlsm_space_name": "vlsm_space_name", + "domain_name": "domain_name", + "network_ripe_waiting_status": "network_ripe_waiting_status", + "network_operation_details_call_stack": "network_operation_details_call_stack", + "network_operation_details_added_by": "network_operation_details_added_by", + "space_class_name": "space_class_name", + "network_start_hostaddr": "network_start_hostaddr", + "parent_space_id": "parent_space_id", + "space_description": "space_description", + "parent_network_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "network_address_used_percent": "network_address_used_percent", + "network_level": "network_level", + "network_size": "network_size", + "space_parent_space_id": "space_parent_space_id", + "space_is_template": "space_is_template", + "network_name": "network_name", + "parent_network_is_terminal": "parent_network_is_terminal", + "network_operation_details_requested_by": "network_operation_details_requested_by", + "network_operation_details_added_on": "network_operation_details_added_on", + "network_operation_details_origin_module": "network_operation_details_origin_module", + "parent_network_class_name": "parent_network_class_name", + "network_start_ip_addr": "network_start_ip_addr", + "network_address_free_size": "network_address_free_size", + "network_id": "network_id", + "space_name": "space_name", + "network_is_valid": "network_is_valid", + "parent_network_path": "parent_network_path", + "network_allocated_percent": "network_allocated_percent", + "parent_network_start_ip_addr": "parent_network_start_ip_addr", + "network_end_ip_addr": "network_end_ip_addr", + "network_class_name": "network_class_name", + "network_path": "network_path", + "network_end_hostaddr": "network_end_hostaddr", + "network_operation_details_last_updated_on": "network_operation_details_last_updated_on", + "vlsm_network_id": "vlsm_network_id", + "parent_network_name": "parent_network_name", + "range_id": "range_id", + "parent_network_size": "parent_network_size", + "network_used_size": "network_used_size", + "network_ripe_waiting_state": "network_ripe_waiting_state", + "parent_network_end_ip_addr": "parent_network_end_ip_addr", + "parent_vlsm_network_id": "parent_vlsm_network_id", + "parent_space_name": "parent_space_name", + "network_used_percent": "network_used_percent", + "network_is_in_orphan": "network_is_in_orphan", + "network_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "network_lock_network_broadcast": "network_lock_network_broadcast", + "network_multistatus": "network_multistatus", + "parent_network_id": "parent_network_id", + "vlsm_block_id": "vlsm_block_id", + "space_id": "space_id", + "network_allocated_size": "network_allocated_size" + }, + "properties": { + "network_end_hostaddr": { + "description": "The human readable version of the parameter network_end_ip_addr.", + "type": "string" + }, + "network_end_ip_addr": { + "description": "The last IP address of the IPv4 network, in hexadecimal format.", + "type": "string" + }, + "network_is_in_orphan": { + "description": "A way to determine if the network has a parent (0) or if it belongs to a container Orphan networks (1).", + "type": "string" + }, + "network_is_terminal": { + "description": "A way to determine if a network can contain other networks. If set to 1, the network is terminal and cannot contain other subnet-type networks. Block-type networks are always set to 0.", + "type": "string" + }, + "network_lock_network_broadcast": { + "description": "A way to prevent (1) users from assigning the broadcast IP address and network IP address of the network.", + "type": "string" + }, + "network_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                      Multi-status severity levels
                                                                                                                                      Message number Severity Description
                                                                                                                                      0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                      17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                      34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                      51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                      67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                      84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                      ", + "type": "string" + }, + "parent_network_end_ip_addr": { + "description": "The last IP address of the parent IPv4 network, in hexadecimal format.", + "type": "string" + }, + "parent_network_is_terminal": { + "description": "A way to determine if the parent network is terminal (1) or non-terminal (0).", + "type": "string" + }, + "parent_space_id": { + "description": "The database identifier (ID) of the space where is located the parent network. 0 indicates that the network has no parent network.", + "type": "string" + }, + "parent_space_name": { + "description": "The name of the space where is located the parent network. # indicates that the network has no parent network.", + "type": "string" + }, + "parent_network_start_ip_addr": { + "description": "The first IP address of the parent IPv4 network, in hexadecimal format.", + "type": "string" + }, + "parent_network_class_name": { + "description": "The name of the class applied to the parent IPv4 network, it can be preceded by the class directory.", + "type": "string" + }, + "parent_network_class_parameters": { + "description": "The class parameters applied to the parent IPv4 network and their value: <class-parameter1>=<value1>&<class-parameter2>=<value2>&... .", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "parent_network_id": { + "description": "The database identifier (ID) of the parent IPv4 network. 0 indicates that the network has no parent network.", + "type": "string" + }, + "parent_network_level": { + "description": "The level of the parent network within the space. It returns values between 0 (block-type network) and n (subnet-type network). A value higher than 1 indicates a VLSM organization where a block-type network can belong to another subnet-type network.", + "type": "string" + }, + "parent_network_name": { + "description": "The name of the parent IPv4 network:
                                                                                                                                      • # indicates that the network has no parent network.
                                                                                                                                      • Default indicates that the network belongs to an orphan network.
                                                                                                                                      ", + "type": "string" + }, + "parent_network_path": { + "description": "The path toward the parent network in the database. # indicates the network has no parent network.", + "type": "string" + }, + "parent_network_size": { + "description": "The number of IP addresses of the network parent.", + "type": "string" + }, + "parent_vlsm_network_id": { + "description": "The database identifier (ID) of the IPv4 subnet-type network, located in the VLSM parent space, from which the parent network was duplicated. 0 indicates that the parent network is not a VLSM block-type network duplicated from a parent space.", + "type": "string" + }, + "space_class_name": { + "description": "The name of the class applied to the space the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "space_class_parameters": { + "description": "The class parameters applied to the space the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "space_description": { + "description": "The description of the space the object belongs to.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space the object belongs to, a unique numeric key value automatically incremented when you add a space.", + "type": "string" + }, + "space_is_template": { + "description": "The template status of the space the object belongs to. If the space is used as template (1), all the IPv4 networks, pools and IP addresses it contains are also used as template.", + "type": "string" + }, + "space_name": { + "description": "The name of the space the object belongs to.", + "type": "string" + }, + "space_parent_space_id": { + "description": "The database identifier (ID) of the VLSM parent of the space where is located the network. 0 indicates that the space where is located the network has no parent space.", + "type": "string" + }, + "network_start_hostaddr": { + "description": "The human readable version of the parameter network_start_ip_addr.", + "type": "string" + }, + "network_start_ip_addr": { + "description": "The first IP address of the IPv4 network, in hexadecimal format.", + "type": "string" + }, + "network_allocated_percent": { + "description": "The percentage of subnet-type networks the non-terminal network contains.", + "type": "string" + }, + "network_allocated_size": { + "description": "The sum of the size of all the subnet-type networks that belong to the block-type network.", + "type": "string" + }, + "network_class_name": { + "description": "The name of the class applied to the IPv4 network, it can be preceded by the class directory.", + "type": "string" + }, + "network_class_parameters": { + "description": "The class parameters applied to the IPv4 network.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "network_id": { + "description": "The database identifier (ID) of the IPv4 network.", + "type": "string" + }, + "network_address_free_size": { + "description": "The total number of free addresses, for terminal networks only. It excludes the network and broadcast IP address.", + "type": "string" + }, + "network_address_used_percent": { + "description": "The percentage of IP addresses In use in terminal networks.", + "type": "string" + }, + "network_address_used_size": { + "description": "The number of IP addresses In use in terminal networks.", + "type": "string" + }, + "network_is_valid": { + "description": "The network validity. A valid network (1) has a size, prefix and/or netmask that match.", + "type": "string" + }, + "network_level": { + "description": "The level of the network within the space. It returns values between 0 (block-type network) and n (subnet-type network). A value higher than 1 indicates a VLSM organization where a block-type network can belong to another subnet-type network.", + "type": "string" + }, + "network_name": { + "description": "The name of the IPv4 network. Default indicates that the network is an orphan network.", + "type": "string" + }, + "network_path": { + "description": "The path toward the network in the database from the containing block-type network down to the subnet-type network: <block-network-start-IP>#<block-network-ID>#<subnet-network-start-IP>#<subnet-network-ID>. The IP address is returned in hexadecimal format.
                                                                                                                                      • In network-based VLSM organizations, the path includes all the subnet-type networks there are from the containing block-type network down to the subnet-type network specified in network_id.
                                                                                                                                      • In space-based VLSM organizations, the path includes the block-type network of the top parent space and all the subnet-type networks there are until the network specified in network_id. Only one block-type network is returned.
                                                                                                                                      ", + "type": "string" + }, + "network_size": { + "description": "The number of IP addresses the IPv4 network contains.", + "type": "string" + }, + "network_used_percent": { + "description": "The percentage of terminal networks the non-terminal network contains.", + "type": "string" + }, + "network_used_size": { + "description": "The sum of the size of all the terminal networks within the block-type network. This sum includes the terminal networks that might belong to non-terminal subnet-type networks.", + "type": "string" + }, + "network_operation_details_added_on": { + "description": "The creation date of the IPv4 network, in decimal UNIX date format.", + "type": "string" + }, + "network_operation_details_call_stack": { + "description": "The call stack of the IPv4 network operation details, as follows: <service1>&<service2>&<service3>... .", + "type": "string" + }, + "network_operation_details_origin_module": { + "description": "The name of the module where the IPv4 network addition originated.", + "type": "string" + }, + "network_operation_details_requested_by": { + "description": "The login of the user who requested the IPv4 network.", + "type": "string" + }, + "network_operation_details_added_by": { + "description": "The login of the user who added the IPv4 network.", + "type": "string" + }, + "network_operation_details_last_updated_on": { + "description": "The last time the IPv4 network was updated, in decimal UNIX date format.", + "type": "string" + }, + "domain_id": { + "description": "The database identifier (ID) of the VLAN domain associated with the network.", + "type": "string" + }, + "domain_name": { + "description": "The name of the VLAN domain associated with the network.", + "type": "string" + }, + "range_id": { + "description": "The database identifier (ID) of the VLAN range associated with the network.", + "type": "string" + }, + "range_name": { + "description": "The name of the VLAN range associated with the network.", + "type": "string" + }, + "vlan_id": { + "description": "The database identifier (ID) of the VLAN associated with the network.", + "type": "string" + }, + "vlan_name": { + "description": "The name of the VLAN associated with the network.", + "type": "string" + }, + "vlan_vlan_id": { + "description": "The VLAN identifier (ID) of the VLAN associated with the network.", + "type": "string" + }, + "vlsm_block_id": { + "description": "The database identifier (ID) of the IPv4 VLSM block-type network duplicated, in a VLSM child space, from the network. 0 indicates that the network is not duplicated as a VLSM block-type network in a child space.", + "type": "string" + }, + "vlsm_space_id": { + "description": "The database identifier (ID) of the VLSM child space where the network is duplicated as a VLSM block-type network. 0 indicates that the network is not duplicated as a VLSM block-type network in a child space.", + "type": "string" + }, + "vlsm_space_name": { + "description": "The name of the VLSM child space where the network is duplicated as a VLSM block-type network. 0 indicates that the network is not duplicated as a VLSM block-type network in a child space.", + "type": "string" + }, + "vlsm_network_id": { + "description": "The database identifier (ID) of the IPv4 subnet-type network, located in the VLSM parent space, from which the network was duplicated. 0 indicates that the network is not a VLSM block-type network duplicated from a parent space.", + "type": "string" + }, + "network_ripe_waiting_state": { + "description": "The state of the exchange between SOLIDserver and the RIPE for the assigned network:


                                                                                                                                      network_ripe_waiting_state possible values
                                                                                                                                      StatusDescription
                                                                                                                                      must_send_mail_addAn email must be sent to the RIPE to notify them of a subnet-type network creation.
                                                                                                                                      wait_mail_addA network creation email was sent to the RIPE, no reply has been received yet.
                                                                                                                                      must_send_mail_delAn email must be sent to the RIPE to notify them of a subnet-type network deletion.
                                                                                                                                      wait_mail_delA network deletion email was sent to the RIPE, no reply has been received yet.
                                                                                                                                      wait_aw_confirmThe number of IP addresses of the assigned network exceeds the Assignment Window declared during your RIPE configuration.


                                                                                                                                      ", + "type": "string" + }, + "network_ripe_waiting_status": { + "description": "The status of a RIPE assigned network within SOLIDserver until it is confirmed that you can create or delete it. If set to 1, it is about to be created. If set to 2, it is about to be deleted.", + "type": "string" + } + }, + "title": "_data_inner_ipam_network_data", + "type": "object" + }, + "_data_inner_ipam_network_add_success": { + "example": { + "network_id": "network_id" + }, + "properties": { + "network_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_ipam_network_add_success", + "type": "object" + }, + "_data_inner_ipam_network_edit_success": { + "example": { + "network_id": "network_id" + }, + "properties": { + "network_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_ipam_network_edit_success", + "type": "object" + }, + "_data_inner_ipam_network_delete_success": { + "example": { + "network_id": "network_id" + }, + "properties": { + "network_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_ipam_network_delete_success", + "type": "object" + }, + "_data_inner_ipam_network6_data": { + "example": { + "range_name": "range_name", + "vlsm_block6_id": "vlsm_block6_id", + "end_address6_addr": "end_address6_addr", + "parent_network6_class_name": "parent_network6_class_name", + "parent_network6_is_terminal": "parent_network6_is_terminal", + "vlan_id": "vlan_id", + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "vlsm_space_id": "vlsm_space_id", + "vlan_vlan_id": "vlan_vlan_id", + "network6_operation_details_requested_by": "network6_operation_details_requested_by", + "vlan_name": "vlan_name", + "parent_network_level": "parent_network_level", + "domain_id": "domain_id", + "vlsm_space_name": "vlsm_space_name", + "domain_name": "domain_name", + "percent_allocated": "percent_allocated", + "parent_network6_prefix": "parent_network6_prefix", + "space_class_name": "space_class_name", + "network6_operation_details_last_updated_on": "network6_operation_details_last_updated_on", + "parent_space_id": "parent_space_id", + "space_description": "space_description", + "network_level": "network_level", + "parent_vlsm_network6_id": "parent_vlsm_network6_id", + "network_size": "network_size", + "space_parent_space_id": "space_parent_space_id", + "space_is_template": "space_is_template", + "network6_ripe_waiting_state": "network6_ripe_waiting_state", + "network6_is_terminal": "network6_is_terminal", + "vlsm_network6_id": "vlsm_network6_id", + "network6_ripe_waiting_status": "network6_ripe_waiting_status", + "percent_used": "percent_used", + "space_name": "space_name", + "network6_id": "network6_id", + "parent_network_path": "parent_network_path", + "network6_start_hostaddr": "network6_start_hostaddr", + "parent_network6_percent_allocated": "parent_network6_percent_allocated", + "network6_is_valid": "network6_is_valid", + "parent_end_address6_addr": "parent_end_address6_addr", + "parent_start_address6_addr": "parent_start_address6_addr", + "network_path": "network_path", + "network6_end_hostaddr": "network6_end_hostaddr", + "parent_network6_id": "parent_network6_id", + "network6_name": "network6_name", + "range_id": "range_id", + "network6_operation_details_added_by": "network6_operation_details_added_by", + "start_address6_addr": "start_address6_addr", + "parent_network_size": "parent_network_size", + "network6_operation_details_added_on": "network6_operation_details_added_on", + "parent_space_name": "parent_space_name", + "network6_prefix": "network6_prefix", + "parent_network6_percent_used": "parent_network6_percent_used", + "network6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "network6_operation_details_origin_module": "network6_operation_details_origin_module", + "network6_multistatus": "network6_multistatus", + "parent_network6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "parent_network6_name": "parent_network6_name", + "network6_lock_network_broadcast": "network6_lock_network_broadcast", + "network6_class_name": "network6_class_name", + "network6_is_in_orphan": "network6_is_in_orphan", + "network6_operation_details_call_stack": "network6_operation_details_call_stack", + "space_id": "space_id" + }, + "properties": { + "network6_end_hostaddr": { + "description": "The human readable version of the parameter end_address6_addr.", + "type": "string" + }, + "end_address6_addr": { + "description": "The last IP address of the IPv6 network, in hexadecimal format.", + "type": "string" + }, + "network6_is_in_orphan": { + "description": "A way to determine if the network has a parent (0) or if it belongs to a container Orphan networks (1).", + "type": "string" + }, + "network6_is_terminal": { + "description": "A way to determine if a network can contain other networks. If set to 1, the network is terminal and cannot contain other subnet-type networks. Block-type networks are always set to 0.", + "type": "string" + }, + "network6_lock_network_broadcast": { + "description": "A way to prevent (1) users from assigning the broadcast IP address and network IP address of the network.", + "type": "string" + }, + "network6_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                      Multi-status severity levels
                                                                                                                                      Message number Severity Description
                                                                                                                                      0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                      17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                      34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                      51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                      67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                      84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                      ", + "type": "string" + }, + "parent_end_address6_addr": { + "description": "The last IP address of the parent IPv6 network, in hexadecimal format.", + "type": "string" + }, + "parent_network6_is_terminal": { + "description": "A way to determine if the parent network is terminal (1) or non-terminal (0).", + "type": "string" + }, + "parent_network6_percent_allocated": { + "description": "The percentage of subnet-type networks the parent network contains.", + "type": "string" + }, + "parent_network6_percent_used": { + "description": "The percentage of terminal networks the parent network contains.", + "type": "string" + }, + "parent_space_id": { + "description": "The database identifier (ID) of the space where is located the parent network. 0 indicates that the network has no parent network.", + "type": "string" + }, + "parent_space_name": { + "description": "The name of the space where is located the parent network. # indicates that the network has no parent network.", + "type": "string" + }, + "parent_start_address6_addr": { + "description": "The first IP address of the parent IPv6 network, in hexadecimal format.", + "type": "string" + }, + "parent_network6_class_name": { + "description": "The name of the class applied to the parent IPv6 network, it can be preceded by the class directory.", + "type": "string" + }, + "parent_network6_class_parameters": { + "description": "The class parameters applied to the parent IPv6 network and their value: <class-parameter1>=<value1>&<class-parameter2>=<value2>&... .", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "parent_network6_id": { + "description": "The database identifier (ID) of the parent IPv6 network. 0 indicates that the network has no parent network.", + "type": "string" + }, + "parent_network6_name": { + "description": "The name of the parent IPv6 network. # indicates that the network has no parent network.", + "type": "string" + }, + "parent_network6_prefix": { + "description": "The prefix of the parent of the IPv6 network the object belongs to.", + "type": "string" + }, + "parent_network_level": { + "description": "The level of the parent network within the space. It returns values between 0 (block-type network) and n (subnet-type network). A value higher than 1 indicates a VLSM organization where a block-type network can belong to another subnet-type network.", + "type": "string" + }, + "parent_network_path": { + "description": "The path toward the parent network in the database. # indicates the network has no parent network.", + "type": "string" + }, + "parent_network_size": { + "description": "The number of IP addresses of the network parent, in hexadecimal format.", + "type": "string" + }, + "parent_vlsm_network6_id": { + "description": "The database identifier (ID) of the IPv6 subnet-type network, located in the VLSM parent space, from which the parent network was duplicated. 0 indicates that the parent network is not a VLSM block-type network duplicated from a parent space.", + "type": "string" + }, + "percent_allocated": { + "description": "The percentage of subnet-type networks the non-terminal network contains.", + "type": "string" + }, + "percent_used": { + "description": "The percentage of terminal networks the non-terminal network contains.", + "type": "string" + }, + "space_class_name": { + "description": "The name of the class applied to the space the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "space_class_parameters": { + "description": "The class parameters applied to the space the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "space_description": { + "description": "The description of the space the object belongs to.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space the object belongs to, a unique numeric key value automatically incremented when you add a space.", + "type": "string" + }, + "space_is_template": { + "description": "The template status of the space the object belongs to. If the space is used as template (1), all the IPv4 networks, pools and IP addresses it contains are also used as template.", + "type": "string" + }, + "space_name": { + "description": "The name of the space the object belongs to.", + "type": "string" + }, + "space_parent_space_id": { + "description": "The database identifier (ID) of the VLSM parent of the space where is located the network. 0 indicates that the space where is located the network has no parent space.", + "type": "string" + }, + "network6_start_hostaddr": { + "description": "The human readable version of the parameter start_address6_addr.", + "type": "string" + }, + "start_address6_addr": { + "description": "The first IP address of the IPv6 network, in hexadecimal format.", + "type": "string" + }, + "network6_class_name": { + "description": "The name of the class applied to the IPv6 network, it can be preceded by the class directory.", + "type": "string" + }, + "network6_class_parameters": { + "description": "The class parameters applied to the IPv6 network.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "network6_id": { + "description": "The database identifier (ID) of the IPv6 network.", + "type": "string" + }, + "network6_is_valid": { + "description": "The network validity. A valid network (1) has a prefix and last IP address that match.", + "type": "string" + }, + "network6_name": { + "description": "The name of the IPv6 network.", + "type": "string" + }, + "network6_prefix": { + "description": "The prefix of the IPv6 network.", + "type": "string" + }, + "network_level": { + "description": "The level of the network within the space. It returns values between 0 (block-type network) and n (subnet-type network). A value higher than 1 indicates a VLSM organization where a block-type network can belong to another subnet-type network.", + "type": "string" + }, + "network_path": { + "description": "The path toward the network in the database from the containing block-type network down to the subnet-type network: <block-network-start-IP>#<block-network-ID>#<subnet-network-start-IP>#<subnet-network-ID>. The IP address is returned in hexadecimal format.
                                                                                                                                      • In network-based VLSM organizations, the path includes all the subnet-type networks there are from the containing block-type network down to the subnet-type network specified in subnet_id.
                                                                                                                                      • In space-based VLSM organizations, the path includes the block-type network of the top parent space and all the subnet-type networks there are until the network specified in subnet_id. Only one block-type network is returned.
                                                                                                                                      ", + "type": "string" + }, + "network_size": { + "description": "The number of IP addresses the IPv6 network contains.", + "type": "string" + }, + "network6_operation_details_added_on": { + "description": "The creation date of the IPv6 network, in decimal UNIX date format.", + "type": "string" + }, + "network6_operation_details_call_stack": { + "description": "The call stack of the IPv6 network operation details, as follows: <service1>&<service2>&<service3>... .", + "type": "string" + }, + "network6_operation_details_origin_module": { + "description": "The name of the module where the IPv6 network addition originated.", + "type": "string" + }, + "network6_operation_details_requested_by": { + "description": "The login of the user who requested the IPv6 network.", + "type": "string" + }, + "network6_operation_details_added_by": { + "description": "The login of the user who added the IPv6 network.", + "type": "string" + }, + "network6_operation_details_last_updated_on": { + "description": "The last time the IPv6 network was updated, in decimal UNIX date format.", + "type": "string" + }, + "domain_id": { + "description": "The database identifier (ID) of the VLAN domain associated with the network.", + "type": "string" + }, + "domain_name": { + "description": "The name of the VLAN domain associated with the network.", + "type": "string" + }, + "range_id": { + "description": "The database identifier (ID) of the VLAN range associated with the network.", + "type": "string" + }, + "range_name": { + "description": "The name of the VLAN range associated with the network.", + "type": "string" + }, + "vlan_id": { + "description": "The database identifier (ID) of the VLAN associated with the network.", + "type": "string" + }, + "vlan_name": { + "description": "The name of the VLAN associated with the network.", + "type": "string" + }, + "vlan_vlan_id": { + "description": "The VLAN identifier (ID) of the VLAN associated with the network.", + "type": "string" + }, + "vlsm_block6_id": { + "description": "The database identifier (ID) of the IPv6 VLSM block-type network duplicated, in a VLSM child space, from the network. 0 indicates that the network is not duplicated as a VLSM block-type network in a child space.", + "type": "string" + }, + "vlsm_space_id": { + "description": "The database identifier (ID) of the VLSM child space where the network is duplicated as a VLSM block-type network. 0 indicates that the network is not duplicated as a VLSM block-type network in a child space.", + "type": "string" + }, + "vlsm_space_name": { + "description": "The name of the VLSM child space where the network is duplicated as a VLSM block-type network. 0 indicates that the network is not duplicated as a VLSM block-type network in a child space.", + "type": "string" + }, + "vlsm_network6_id": { + "description": "The database identifier (ID) of the IPv6 subnet-type network, located in the VLSM parent space, from which the network was duplicated. 0 indicates that the network is not a VLSM block-type network duplicated from a parent space.", + "type": "string" + }, + "network6_ripe_waiting_state": { + "description": "The state of the exchange between SOLIDserver and the RIPE for the assigned network:


                                                                                                                                      network6_ripe_waiting_state possible values
                                                                                                                                      StatusDescription
                                                                                                                                      must_send_mail_addAn email must be sent to the RIPE to notify them of a subnet-type network creation.
                                                                                                                                      wait_mail_addA network creation email was sent to the RIPE, no reply has been received yet.
                                                                                                                                      must_send_mail_delAn email must be sent to the RIPE to notify them of a subnet-type network deletion.
                                                                                                                                      wait_mail_delA network deletion email was sent to the RIPE, no reply has been received yet.
                                                                                                                                      wait_aw_confirmThe number of IP addresses of the assigned network exceeds the Assignment Window declared during your RIPE configuration.


                                                                                                                                      ", + "type": "string" + }, + "network6_ripe_waiting_status": { + "description": "The status of a RIPE assigned network within SOLIDserver until it is confirmed that you can create or delete it. If set to 1, it is about to be created. If set to 2, it is about to be deleted.", + "type": "string" + } + }, + "title": "_data_inner_ipam_network6_data", + "type": "object" + }, + "_data_inner_ipam_network6_add_success": { + "example": { + "network6_id": "network6_id" + }, + "properties": { + "network6_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_ipam_network6_add_success", + "type": "object" + }, + "_data_inner_ipam_network6_edit_success": { + "example": { + "network6_id": "network6_id" + }, + "properties": { + "network6_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_ipam_network6_edit_success", + "type": "object" + }, + "_data_inner_ipam_network6_delete_success": { + "example": { + "network6_id": "network6_id" + }, + "properties": { + "network6_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_ipam_network6_delete_success", + "type": "object" + }, + "_data_inner_ipam_pool_data": { + "example": { + "pool_start_hostaddr": "pool_start_hostaddr", + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "pool_operation_details_added_on": "pool_operation_details_added_on", + "pool_operation_details_call_stack": "pool_operation_details_call_stack", + "pool_start_address_addr": "pool_start_address_addr", + "vlsm_network_id": "vlsm_network_id", + "parent_network_name": "parent_network_name", + "pool_class_name": "pool_class_name", + "space_class_name": "space_class_name", + "parent_network_size": "parent_network_size", + "space_description": "space_description", + "pool_end_ip_addr": "pool_end_ip_addr", + "pool_end_address_addr": "pool_end_address_addr", + "pool_operation_details_added_by": "pool_operation_details_added_by", + "pool_start_ip_addr": "pool_start_ip_addr", + "pool_operation_details_last_updated_on": "pool_operation_details_last_updated_on", + "network_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "network_size": "network_size", + "pool_size": "pool_size", + "space_is_template": "space_is_template", + "network_name": "network_name", + "pool_operation_details_requested_by": "pool_operation_details_requested_by", + "pool_read_only": "pool_read_only", + "pool_id": "pool_id", + "pool_multistatus": "pool_multistatus", + "parent_network_class_name": "parent_network_class_name", + "pool_name": "pool_name", + "pool_operation_details_origin_module": "pool_operation_details_origin_module", + "pool_end_hostaddr": "pool_end_hostaddr", + "network_id": "network_id", + "space_name": "space_name", + "parent_network_id": "parent_network_id", + "network_start_address_addr": "network_start_address_addr", + "pool_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "vlsm_block_id": "vlsm_block_id", + "space_id": "space_id", + "network_end_address_addr": "network_end_address_addr", + "network_class_name": "network_class_name" + }, + "properties": { + "pool_end_hostaddr": { + "description": "The human readable version of the parameter pool_end_ip_addr.", + "type": "string" + }, + "pool_end_ip_addr": { + "description": "The last IP address of the IPv4 pool, in hexadecimal format.", + "type": "string" + }, + "pool_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                      Multi-status severity levels
                                                                                                                                      Message number Severity Description
                                                                                                                                      0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                      17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                      34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                      51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                      67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                      84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                      ", + "type": "string" + }, + "parent_network_class_name": { + "description": "The name of the class applied to the parent of the IPv4 network the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "parent_network_id": { + "description": "The database identifier (ID) of the parent IPv4 network. It identifies the parent of the IPv4 network the object belongs to. 0 indicates that the network the object belongs to has no parent network.", + "type": "string" + }, + "parent_network_name": { + "description": "The name of the parent IPv4 network:
                                                                                                                                      • # indicates that the network the object belongs to has no parent network.
                                                                                                                                      • Default indicates that the network the object belongs to is in an orphan network.
                                                                                                                                      ", + "type": "string" + }, + "parent_network_size": { + "description": "The number of IP addresses of the parent of the network the object belongs to.", + "type": "string" + }, + "pool_class_name": { + "description": "The name of the class applied to the IPv4 pool, it can be preceded by the class directory.", + "type": "string" + }, + "pool_class_parameters": { + "description": "The class parameters applied to the IPv4 pool.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "pool_end_address_addr": { + "description": "The last IP address of the IPv4 pool, in hexadecimal format.", + "type": "string" + }, + "pool_id": { + "description": "The database identifier (ID) of the IPv4 pool.", + "type": "string" + }, + "pool_name": { + "description": "The name of the IPv4 pool.", + "type": "string" + }, + "pool_read_only": { + "description": "The reservation status of the IPv4 pool. If set 1, the IP addresses it contains cannot be assigned.", + "type": "string" + }, + "pool_size": { + "description": "The number of IP addresses the IPv4 pool contains.", + "type": "string" + }, + "pool_start_address_addr": { + "description": "The first IP address of the IPv4 pool, in hexadecimal format.", + "type": "string" + }, + "space_class_name": { + "description": "The name of the class applied to the space the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "space_class_parameters": { + "description": "The class parameters applied to the space the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "space_description": { + "description": "The description of the space the object belongs to.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space the object belongs to, a unique numeric key value automatically incremented when you add a space.", + "type": "string" + }, + "space_is_template": { + "description": "The template status of the space the object belongs to. If the space is used as template (1), all the IPv4 networks, pools and IP addresses it contains are also used as template.", + "type": "string" + }, + "space_name": { + "description": "The name of the space the object belongs to.", + "type": "string" + }, + "pool_start_hostaddr": { + "description": "The human readable version of the parameter pool_start_ip_addr.", + "type": "string" + }, + "pool_start_ip_addr": { + "description": "The first IP address of the IPv4 pool, in hexadecimal format.", + "type": "string" + }, + "network_class_name": { + "description": "The name of the class applied to the IPv4 network the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "network_class_parameters": { + "description": "The class parameters applied to the IPv4 network the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "network_end_address_addr": { + "description": "The last IP address of the IPv4 network the object belongs to.", + "type": "string" + }, + "network_id": { + "description": "The database identifier (ID) of the IPv4 network the object belongs to.", + "type": "string" + }, + "network_name": { + "description": "The name of the IPv4 network the object belongs to. Default indicates that the network the object belongs to is an orphan network.", + "type": "string" + }, + "network_size": { + "description": "The number of IP addresses the network the object belongs to contains.", + "type": "string" + }, + "network_start_address_addr": { + "description": "The first IP address of the IPv4 network the object belongs to.", + "type": "string" + }, + "pool_operation_details_added_on": { + "description": "The creation date of the IPv4 pool, in decimal UNIX date format.", + "type": "string" + }, + "pool_operation_details_call_stack": { + "description": "The call stack of the IPv4 pool operation details, as follows: <service1>&<service2>&<service3>... .", + "type": "string" + }, + "pool_operation_details_origin_module": { + "description": "The name of the module where the IPv4 pool addition originated.", + "type": "string" + }, + "pool_operation_details_requested_by": { + "description": "The login of the user who requested the IPv4 pool.", + "type": "string" + }, + "pool_operation_details_added_by": { + "description": "The login of the user who added the IPv4 pool.", + "type": "string" + }, + "pool_operation_details_last_updated_on": { + "description": "The last time the IPv4 pool was updated, in decimal UNIX date format.", + "type": "string" + }, + "vlsm_block_id": { + "description": "The database identifier (ID) of the IPv4 VLSM block-type network duplicated, in a VLSM child space, from the network the pool belongs to. 0 indicates that the parent of the network the pool belongs to is not duplicated as a VLSM block-type network in a child space.", + "type": "string" + }, + "vlsm_network_id": { + "description": "The database identifier (ID) of the IPv4 subnet-type network, located in the VLSM parent space, from which the parent of the network the pool belongs to was duplicated. 0 indicates that the parent of the network the pool belongs to is not a VLSM block-type network duplicated from a parent space.", + "type": "string" + } + }, + "title": "_data_inner_ipam_pool_data", + "type": "object" + }, + "_data_inner_ipam_pool_add_success": { + "example": { + "pool_id": "pool_id" + }, + "properties": { + "pool_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_ipam_pool_add_success", + "type": "object" + }, + "_data_inner_ipam_pool_edit_success": { + "example": { + "pool_id": "pool_id" + }, + "properties": { + "pool_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_ipam_pool_edit_success", + "type": "object" + }, + "_data_inner_ipam_pool_delete_success": { + "example": { + "pool_id": "pool_id" + }, + "properties": { + "pool_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_ipam_pool_delete_success", + "type": "object" + }, + "_data_inner_ipam_pool6_data": { + "example": { + "vlsm_block6_id": "vlsm_block6_id", + "end_address6_addr": "end_address6_addr", + "parent_network6_class_name": "parent_network6_class_name", + "pool6_operation_details_requested_by": "pool6_operation_details_requested_by", + "pool6_end_address6_addr": "pool6_end_address6_addr", + "pool6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "parent_network6_id": "parent_network6_id", + "network6_name": "network6_name", + "pool6_operation_details_last_updated_on": "pool6_operation_details_last_updated_on", + "parent_network6_prefix": "parent_network6_prefix", + "space_class_name": "space_class_name", + "start_address6_addr": "start_address6_addr", + "space_description": "space_description", + "pool6_read_only": "pool6_read_only", + "pool6_class_name": "pool6_class_name", + "network6_end_address6_addr": "network6_end_address6_addr", + "network6_prefix": "network6_prefix", + "pool6_operation_details_call_stack": "pool6_operation_details_call_stack", + "network6_start_address6_addr": "network6_start_address6_addr", + "pool6_size": "pool6_size", + "pool6_start_hostaddr": "pool6_start_hostaddr", + "pool6_operation_details_origin_module": "pool6_operation_details_origin_module", + "network6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_is_template": "space_is_template", + "pool6_operation_details_added_on": "pool6_operation_details_added_on", + "vlsm_network6_id": "vlsm_network6_id", + "parent_network6_name": "parent_network6_name", + "pool6_id": "pool6_id", + "pool6_multistatus": "pool6_multistatus", + "pool6_operation_details_added_by": "pool6_operation_details_added_by", + "pool6_name": "pool6_name", + "space_name": "space_name", + "network6_id": "network6_id", + "network6_class_name": "network6_class_name", + "pool6_end_hostaddr": "pool6_end_hostaddr", + "space_id": "space_id", + "pool6_start_address6_addr": "pool6_start_address6_addr" + }, + "properties": { + "pool6_end_hostaddr": { + "description": "The human readable version of the parameter end_address6_addr.", + "type": "string" + }, + "end_address6_addr": { + "description": "The last IP address of the IPv6 pool, in hexadecimal format.", + "type": "string" + }, + "pool6_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                      Multi-status severity levels
                                                                                                                                      Message number Severity Description
                                                                                                                                      0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                      17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                      34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                      51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                      67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                      84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                      ", + "type": "string" + }, + "parent_network6_class_name": { + "description": "The name of the class applied to the parent of the IPv6 network the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "parent_network6_id": { + "description": "The database identifier (ID) of the parent IPv6 network. It identifies the parent of the IPv6 network the object belongs to. 0 indicates that the network the object belongs to has no parent network.", + "type": "string" + }, + "parent_network6_name": { + "description": "The name of the parent IPv6 network. # indicates that the network the object belongs to has no parent network.", + "type": "string" + }, + "parent_network6_prefix": { + "description": "The prefix of the parent of the IPv6 network the object belongs to.", + "type": "string" + }, + "pool6_class_name": { + "description": "The name of the class applied to the IPv6 pool, it can be preceded by the class directory.", + "type": "string" + }, + "pool6_class_parameters": { + "description": "The class parameters applied to the IPv6 pool.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "pool6_end_address6_addr": { + "description": "The last IP address of the IPv6 pool, in hexadecimal format.", + "type": "string" + }, + "pool6_id": { + "description": "The database identifier (ID) of the IPv6 pool.", + "type": "string" + }, + "pool6_name": { + "description": "The name of the IPv6 pool.", + "type": "string" + }, + "pool6_read_only": { + "description": "The reservation status of the IPv6 pool. If set 1, the IP addresses it contains cannot be assigned.", + "type": "string" + }, + "pool6_size": { + "description": "The number of IP addresses the IPv6 pool contains.", + "type": "string" + }, + "pool6_start_address6_addr": { + "description": "The first IP address of the IPv6 pool, in hexadecimal format.", + "type": "string" + }, + "space_class_name": { + "description": "The name of the class applied to the space the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "space_class_parameters": { + "description": "The class parameters applied to the space the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "space_description": { + "description": "The description of the space the object belongs to.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space the object belongs to, a unique numeric key value automatically incremented when you add a space.", + "type": "string" + }, + "space_is_template": { + "description": "The template status of the space the object belongs to. If the space is used as template (1), all the IPv4 networks, pools and IP addresses it contains are also used as template.", + "type": "string" + }, + "space_name": { + "description": "The name of the space the object belongs to.", + "type": "string" + }, + "pool6_start_hostaddr": { + "description": "The human readable version of the parameter start_address6_addr.", + "type": "string" + }, + "start_address6_addr": { + "description": "The first IP address of the IPv6 pool, in hexadecimal format.", + "type": "string" + }, + "network6_class_name": { + "description": "The name of the class applied to the IPv6 network the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "network6_class_parameters": { + "description": "The class parameters applied to the IPv6 network the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "network6_end_address6_addr": { + "description": "The last IP address of the IPv6 network the object belongs to.", + "type": "string" + }, + "network6_id": { + "description": "The database identifier (ID) of the IPv6 network the object belongs to.", + "type": "string" + }, + "network6_name": { + "description": "The name of the IPv6 network the object belongs to.", + "type": "string" + }, + "network6_prefix": { + "description": "The prefix of the IPv6 network the object belongs to.", + "type": "string" + }, + "network6_start_address6_addr": { + "description": "The first IP address of the IPv6 network the object belongs to.", + "type": "string" + }, + "pool6_operation_details_added_on": { + "description": "The creation date of the IPv6 pool, in decimal UNIX date format.", + "type": "string" + }, + "pool6_operation_details_call_stack": { + "description": "The call stack of the IPv6 pool operation details, as follows: <service1>&<service2>&<service3>... .", + "type": "string" + }, + "pool6_operation_details_origin_module": { + "description": "The name of the module where the IPv6 pool addition originated.", + "type": "string" + }, + "pool6_operation_details_requested_by": { + "description": "The login of the user who requested the IPv6 pool.", + "type": "string" + }, + "pool6_operation_details_added_by": { + "description": "The login of the user who added the IPv6 pool.", + "type": "string" + }, + "pool6_operation_details_last_updated_on": { + "description": "The last time the IPv6 pool was updated, in decimal UNIX date format.", + "type": "string" + }, + "vlsm_block6_id": { + "description": "The database identifier (ID) of the IPv6 VLSM block-type network duplicated, in a VLSM child space, from the network the pool belongs to. 0 indicates that the parent of the network the pool belongs to is not duplicated as a VLSM block-type network in a child space.", + "type": "string" + }, + "vlsm_network6_id": { + "description": "The database identifier (ID) of the IPv6 subnet-type network, located in the VLSM parent space, from which the parent of the network the pool belongs to was duplicated. 0 indicates that the parent of the network the pool belongs to is not a VLSM block-type network duplicated from a parent space.", + "type": "string" + } + }, + "title": "_data_inner_ipam_pool6_data", + "type": "object" + }, + "_data_inner_ipam_pool6_add_success": { + "example": { + "pool6_id": "pool6_id" + }, + "properties": { + "pool6_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_ipam_pool6_add_success", + "type": "object" + }, + "_data_inner_ipam_pool6_edit_success": { + "example": { + "pool6_id": "pool6_id" + }, + "properties": { + "pool6_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_ipam_pool6_edit_success", + "type": "object" + }, + "_data_inner_ipam_pool6_delete_success": { + "example": { + "pool6_id": "pool6_id" + }, + "properties": { + "pool6_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_ipam_pool6_delete_success", + "type": "object" + }, + "_data_inner_ipam_space_data": { + "example": { + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_name": "space_name", + "parent_space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_class_name": "space_class_name", + "space_is_template": "space_is_template", + "space_multistatus": "space_multistatus", + "parent_space_id": "parent_space_id", + "space_description": "space_description", + "parent_space_class_name": "parent_space_class_name", + "space_id": "space_id", + "parent_space_name": "parent_space_name" + }, + "properties": { + "space_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                      Multi-status severity levels
                                                                                                                                      Message number Severity Description
                                                                                                                                      0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                      17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                      34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                      51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                      67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                      84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                      ", + "type": "string" + }, + "parent_space_class_name": { + "description": "The name of the class applied to the VLSM parent space, it can be preceded by the class directory.", + "type": "string" + }, + "parent_space_class_parameters": { + "description": "The class parameters applied to the VLSM parent space and their value: <class-parameter1>=<value1>&<class-parameter2>=<value2>&... .", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "parent_space_id": { + "description": "The database identifier (ID) of the VLSM parent space. 0 indicates that space has no parent space.", + "type": "string" + }, + "parent_space_name": { + "description": "The name of the VLSM parent space. # indicates that space has no parent space.", + "type": "string" + }, + "space_class_name": { + "description": "The name of the class applied to the space, it can be preceded by the class directory.", + "type": "string" + }, + "space_class_parameters": { + "description": "The class parameters applied to the space.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "space_description": { + "description": "The description of the space.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space.", + "type": "string" + }, + "space_is_template": { + "description": "The template status of the space. If the space is used as template (1), all the IPv4 networks, pools and IP addresses it contains are also used as template.", + "type": "string" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + } + }, + "title": "_data_inner_ipam_space_data", + "type": "object" + }, + "_data_inner_ipam_space_add_success": { + "example": { + "space_id": "space_id" + }, + "properties": { + "space_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_ipam_space_add_success", + "type": "object" + }, + "_data_inner_ipam_space_edit_success": { + "example": { + "space_id": "space_id" + }, + "properties": { + "space_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_ipam_space_edit_success", + "type": "object" + }, + "_data_inner_ipam_space_delete_success": { + "example": { + "space_id": "space_id" + }, + "properties": { + "space_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_ipam_space_delete_success", + "type": "object" + }, + "_data_inner_vlan_domain_data": { + "example": { + "domain_id": "domain_id", + "domain_name": "domain_name", + "domain_end_vlan_id": "domain_end_vlan_id", + "domain_start_vlan_id": "domain_start_vlan_id", + "domain_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "domain_description": "domain_description", + "domain_support_vxlan": "domain_support_vxlan", + "domain_class_name": "domain_class_name" + }, + "properties": { + "domain_support_vxlan": { + "description": "The type of virtual network used by the domain, VXLAN (1) or VLAN (0).", + "type": "string" + }, + "domain_class_name": { + "description": "The name of the class applied to the VLAN domain, it can be preceded by the class directory.", + "type": "string" + }, + "domain_class_parameters": { + "description": "The class parameters applied to the VLAN domain.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "domain_description": { + "description": "The description of the VLAN domain.", + "type": "string" + }, + "domain_end_vlan_id": { + "description": "The VLAN identifier (ID) of the last VLAN in the VLAN domain.", + "type": "string" + }, + "domain_id": { + "description": "The database identifier (ID) of the VLAN domain.", + "type": "string" + }, + "domain_name": { + "description": "The name of the VLAN domain.", + "type": "string" + }, + "domain_start_vlan_id": { + "description": "The VLAN identifier (ID) of the first VLAN in the VLAN domain.", + "type": "string" + } + }, + "title": "_data_inner_vlan_domain_data", + "type": "object" + }, + "_data_inner_vlan_domain_add_success": { + "example": { + "domain_id": "domain_id" + }, + "properties": { + "domain_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_vlan_domain_add_success", + "type": "object" + }, + "_data_inner_vlan_domain_edit_success": { + "example": { + "domain_id": "domain_id" + }, + "properties": { + "domain_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_vlan_domain_edit_success", + "type": "object" + }, + "_data_inner_vlan_domain_delete_success": { + "example": { + "domain_id": "domain_id" + }, + "properties": { + "domain_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_vlan_domain_delete_success", + "type": "object" + }, + "_data_inner_vlan_range_data": { + "example": { + "range_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_name": "range_name", + "domain_end_vlan_id": "domain_end_vlan_id", + "range_end_vlan_id": "range_end_vlan_id", + "domain_start_vlan_id": "domain_start_vlan_id", + "domain_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_start_vlan_id": "range_start_vlan_id", + "domain_description": "domain_description", + "range_id": "range_id", + "domain_id": "domain_id", + "domain_name": "domain_name", + "range_disable_overlapping": "range_disable_overlapping", + "range_class_name": "range_class_name", + "range_description": "range_description", + "domain_support_vxlan": "domain_support_vxlan", + "domain_class_name": "domain_class_name" + }, + "properties": { + "domain_support_vxlan": { + "description": "The type of virtual network used by the domain the range belongs to, VXLAN (1) or VLAN (0).", + "type": "string" + }, + "domain_class_name": { + "description": "The name of the class applied to the VLAN domain the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "domain_class_parameters": { + "description": "The class parameters applied to the VLAN domain the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "domain_description": { + "description": "The description of the VLAN domain the object belongs to.", + "type": "string" + }, + "domain_end_vlan_id": { + "description": "The VLAN identifier (ID) of the last VLAN in the VLAN domain the object belongs to.", + "type": "string" + }, + "domain_id": { + "description": "The database identifier (ID) of the VLAN domain the object belongs to.", + "type": "string" + }, + "domain_name": { + "description": "The name of the VLAN domain the object belongs to.", + "type": "string" + }, + "domain_start_vlan_id": { + "description": "The VLAN identifier (ID) of the first VLAN in the VLAN domain the object belongs to.", + "type": "string" + }, + "range_class_name": { + "description": "The name of the class applied to the VLAN range, it can be preceded by the class directory.", + "type": "string" + }, + "range_class_parameters": { + "description": "The class parameters applied to the VLAN range.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "range_description": { + "description": "The description of the VLAN range.", + "type": "string" + }, + "range_disable_overlapping": { + "description": "The overlapping restriction status of the VLAN range. 1 indicates that when creating VLANs in the range, their IDs should not overlap.", + "type": "string" + }, + "range_end_vlan_id": { + "description": "The VLAN identifier (ID) of the last VLAN in the VLAN range.", + "type": "string" + }, + "range_id": { + "description": "The database identifier (ID) of the VLAN range.", + "type": "string" + }, + "range_name": { + "description": "The name of the VLAN range.", + "type": "string" + }, + "range_start_vlan_id": { + "description": "The VLAN identifier (ID) of the first VLAN in the VLAN range.", + "type": "string" + } + }, + "title": "_data_inner_vlan_range_data", + "type": "object" + }, + "_data_inner_vlan_range_add_success": { + "example": { + "range_id": "range_id" + }, + "properties": { + "range_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_vlan_range_add_success", + "type": "object" + }, + "_data_inner_vlan_range_edit_success": { + "example": { + "range_id": "range_id" + }, + "properties": { + "range_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_vlan_range_edit_success", + "type": "object" + }, + "_data_inner_vlan_range_delete_success": { + "example": { + "range_id": "range_id" + }, + "properties": { + "range_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_vlan_range_delete_success", + "type": "object" + }, + "_data_inner_vlan_vlan_data": { + "example": { + "range_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_name": "range_name", + "vlan_id": "vlan_id", + "domain_end_vlan_id": "domain_end_vlan_id", + "range_end_vlan_id": "range_end_vlan_id", + "domain_start_vlan_id": "domain_start_vlan_id", + "vlan_vlan_id": "vlan_vlan_id", + "domain_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_start_vlan_id": "range_start_vlan_id", + "free_start_vlan_id": "free_start_vlan_id", + "domain_description": "domain_description", + "vlan_name": "vlan_name", + "range_id": "range_id", + "domain_id": "domain_id", + "domain_name": "domain_name", + "vlan_class_name": "vlan_class_name", + "range_class_name": "range_class_name", + "vlan_type": "vlan_type", + "free_end_vlan_id": "free_end_vlan_id", + "range_description": "range_description", + "domain_support_vxlan": "domain_support_vxlan", + "vlan_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "domain_class_name": "domain_class_name" + }, + "properties": { + "free_end_vlan_id": { + "description": "For free VLAN IDs (typefree), it returns the last VLAN of a range of VLANs that are not assigned yet. The first VLAN in that range is returned in the parameter free_start_vlan_id.", + "type": "string" + }, + "free_start_vlan_id": { + "description": "For free VLAN IDs (typefree), it returns the first VLAN of the range of VLANs that are not assigned yet. The last VLAN in that range is returned in the parameter free_end_vlan_id.", + "type": "string" + }, + "domain_support_vxlan": { + "description": "The type of virtual network used by the domain the VLAN belongs to, VXLAN (1) or VLAN (0).", + "type": "string" + }, + "vlan_type": { + "description": "The type of the VLAN (free or used).", + "type": "string" + }, + "domain_class_name": { + "description": "The name of the class applied to the VLAN domain the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "domain_class_parameters": { + "description": "The class parameters of the domain the VLAN belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "domain_description": { + "description": "The description of the VLAN domain the object belongs to.", + "type": "string" + }, + "domain_end_vlan_id": { + "description": "The VLAN identifier (ID) of the last VLAN in the VLAN domain the object belongs to.", + "type": "string" + }, + "domain_id": { + "description": "The database identifier (ID) of the VLAN domain the object belongs to.", + "type": "string" + }, + "domain_name": { + "description": "The name of the VLAN domain the object belongs to.", + "type": "string" + }, + "domain_start_vlan_id": { + "description": "The VLAN identifier (ID) of the first VLAN in the VLAN domain the object belongs to.", + "type": "string" + }, + "range_class_name": { + "description": "The name of the class applied to the VLAN range the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "range_class_parameters": { + "description": "The class parameters of the range the VLAN belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "range_description": { + "description": "The description of the VLAN range the object belongs to.", + "type": "string" + }, + "range_end_vlan_id": { + "description": "The VLAN identifier (ID) of the last VLAN in the VLAN range the object belongs to.", + "type": "string" + }, + "range_id": { + "description": "The database identifier (ID) of the VLAN range the object belongs to.", + "type": "string" + }, + "range_name": { + "description": "The name of the VLAN range the object belongs to.", + "type": "string" + }, + "range_start_vlan_id": { + "description": "The VLAN identifier (ID) of the first VLAN in the VLAN range the object belongs to.", + "type": "string" + }, + "vlan_class_name": { + "description": "The name of the class applied to the object, it can be preceded by the class directory.", + "type": "string" + }, + "vlan_class_parameters": { + "description": "The class parameters of the VLAN.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "vlan_id": { + "description": "The database identifier (ID) of the VLAN.", + "type": "string" + }, + "vlan_name": { + "description": "The name of the VLAN.", + "type": "string" + }, + "vlan_vlan_id": { + "description": "The VLAN identifier (ID) of the VLAN.", + "type": "string" + } + }, + "title": "_data_inner_vlan_vlan_data", + "type": "object" + }, + "_data_inner_vlan_vlan_add_success": { + "example": { + "vlan_id": "vlan_id" + }, + "properties": { + "vlan_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_vlan_vlan_add_success", + "type": "object" + }, + "_data_inner_vlan_vlan_edit_success": { + "example": { + "vlan_id": "vlan_id" + }, + "properties": { + "vlan_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_vlan_vlan_edit_success", + "type": "object" + }, + "_data_inner_vlan_vlan_delete_success": { + "example": { + "vlan_id": "vlan_id" + }, + "properties": { + "vlan_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_vlan_vlan_delete_success", + "type": "object" + } + }, + "securitySchemes": { + "BasicAuth": { + "scheme": "basic", + "type": "http" + }, + "HttpHeaderLoginKey": { + "in": "header", + "name": "X-IPM-Username", + "type": "apiKey" + }, + "HttpHeaderPasswordKey": { + "in": "header", + "name": "X-IPM-Password", + "type": "apiKey" + }, + "EipApiTokenAuth": { + "description": "the value is format like this 'SDS <Token-ID>:<StringToSign-in-SHA256-format>'

                                                                                                                                      With the StringToSign being:

                                                                                                                                      <Token-Secret><epoch-timestamp-in-seconds><method><URL>", + "in": "header", + "name": "Authorization", + "type": "apiKey" + }, + "EipApiTokenTime": { + "description": "epoch timestamp in seconds", + "in": "header", + "name": "x-sds-ts", + "type": "apiKey" + } + } + } +} \ No newline at end of file diff --git a/EfficientIP/SOLIDserver/OpenAPIs/efficientip_solidserver-latest.json b/EfficientIP/SOLIDserver/OpenAPIs/efficientip_solidserver-latest.json new file mode 100644 index 0000000..d13211c --- /dev/null +++ b/EfficientIP/SOLIDserver/OpenAPIs/efficientip_solidserver-latest.json @@ -0,0 +1,37642 @@ +{ + "openapi": "3.0.0", + "info": { + "version": "latest", + "x-vendor-api-version": "2.0", + "title": "EfficientIP SOLIDserver", + "description": "EfficientIP SOLIDserver DDI (DNS-DHCP-IPAM) API for managing DNS zones/records, DHCP scopes/leases/reservations, IP address space (networks/pools/addresses, IPv4 and IPv6), and VLANs.\n\nAuthentication: HTTP Basic Auth (username/password of a SOLIDserver account).\n\nSource: https://github.com/EfficientIP-Labs/solidserver-go-client", + "x-itential-curated": "Curated to the core DDI categories -- DNS, DHCP, IPAM, and VLAN -- out of SOLIDserver's full API, which also covers Device Manager (physical device/port/link inventory), Application (load-balancing), and DNS Guardian (security policy), all excluded as outside DDI automation scope. Within the kept categories, only \"count\" operations (return a count of matching objects, not needed for CRUD automation) were dropped -- every other operation, including full IPv4/IPv6 parity, is included." + }, + "servers": [ + { + "url": "https://SDS-HOST:443/api/v2.0", + "description": "Replace SDS-HOST with your SOLIDserver appliance's hostname or IP." + } + ], + "security": [ + { + "BasicAuth": [] + } + ], + "paths": { + "/dhcp/acl/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_acl_info", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv4 ACL, a unique numeric key value automatically incremented when you add a DHCPv4 ACL. Use the ID to specify the DHCPv4 ACL of your choice.", + "explode": true, + "in": "query", + "name": "acl_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_acl_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCP ACL", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/acl/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_acl_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                      .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_acl_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCP ACLs", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/acl6/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_acl6_info", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv6 ACL, a unique numeric key value automatically incremented when you add a DHCPv6 ACL. Use the ID to specify the DHCPv6 ACL of your choice.", + "explode": true, + "in": "query", + "name": "acl6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_acl6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCPv6 ACL", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/acl6/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_acl6_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                      .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_acl6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv6 ACLs", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/aclentry/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_aclentry_info", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv4 ACL entry, a unique numeric key value automatically incremented when you add a DHCPv4 ACL entry. Use the ID to specify the DHCPv4 ACL entry of your choice.", + "explode": true, + "in": "query", + "name": "aclentry_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_aclentry_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCP ACL entry", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/aclentry/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_aclentry_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                      .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_aclentry_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCP ACL entries", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/aclentry6/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_aclentry6_info", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv6 ACL entry, a unique numeric key value automatically incremented when you add a DHCPv6 ACL entry. Use the ID to specify the DHCPv6 ACL entry of your choice.", + "explode": true, + "in": "query", + "name": "aclentry6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_aclentry6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCPv6 ACL entry", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/aclentry6/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_aclentry6_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                      .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_aclentry6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv6 ACL entries", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/failover/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_failover_info", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv4 failover channel, a unique numeric key value automatically incremented when you add a DHCPv4 failover channel. Use the ID to specify the DHCPv4 failover channel of your choice.", + "explode": true, + "in": "query", + "name": "failover_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_failover_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCPv4 failover channel", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/failover/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_failover_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                      .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_failover_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv4 failover channels", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/group/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                                                      • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                        Mandatory Parameters: (group_name && (server_id || server_name || server_hostaddr))", + "operationId": "dhcp_group_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_group_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_group_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_group_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a DHCPv4 group", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/group/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                                        To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                        Mandatory Parameters: (group_id || (group_name && (server_id || server_name || server_hostaddr)))", + "operationId": "dhcp_group_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "explode": true, + "in": "query", + "name": "server_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DHCPv4 server.", + "explode": true, + "in": "query", + "name": "server_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv4 group, a unique numeric key value automatically incremented when you add a DHCPv4 group. Use the ID to specify the DHCPv4 group of your choice.", + "explode": true, + "in": "query", + "name": "group_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DHCPv4 group.", + "explode": true, + "in": "query", + "name": "group_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The IP address of the DHCP server.", + "explode": true, + "in": "query", + "name": "server_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_group_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_group_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a DHCPv4 group", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/group/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                                                        • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                          Mandatory Parameters: (group_id || (group_name && (server_id || server_name || server_hostaddr)))", + "operationId": "dhcp_group_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_group_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_group_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_group_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a DHCPv4 group", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/group/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_group_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv4 group, a unique numeric key value automatically incremented when you add a DHCPv4 group. Use the ID to specify the DHCPv4 group of your choice.", + "explode": true, + "in": "query", + "name": "group_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_group_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCPv4 group", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/group/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_group_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                          .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_group_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv4 groups", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/group6/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_group6_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                          .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_group6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv6 groups", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/lease/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_lease_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv4 lease, a unique numeric key value automatically incremented when you add a DHCPv4 lease. Use the ID to specify the DHCPv4 lease of your choice.", + "explode": true, + "in": "query", + "name": "lease_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_lease_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCPv4 lease", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/lease/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_lease_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                          .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_lease_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv4 leases", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/lease6/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_lease6_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                          .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_lease6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv6 leases", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/range/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                                                          • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                            Mandatory Parameters: (range_start_addr && range_end_addr && (scope_id || server_id || server_name || server_hostaddr))", + "operationId": "dhcp_range_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a DHCPv4 range", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/range/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                                            To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                            Mandatory Parameters: (range_id || ((range_name || range_start_addr || range_end_addr) && (server_id || server_name || server_hostaddr || scope_id)))", + "operationId": "dhcp_range_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "explode": true, + "in": "query", + "name": "server_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DHCPv4 server.", + "explode": true, + "in": "query", + "name": "server_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The last IP address of the DHCPv4 range.", + "explode": true, + "in": "query", + "name": "range_end_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv4 range, a unique numeric key value automatically incremented when you add a DHCPv4 range. Use the ID to specify the DHCPv4 range of your choice.", + "explode": true, + "in": "query", + "name": "range_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The start and end IP address of the DHCPv4 range, as follows: <start-ip>-<end-ip>.", + "explode": true, + "in": "query", + "name": "range_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The first IP address of the DHCPv4 range.", + "explode": true, + "in": "query", + "name": "range_start_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv4 scope, a unique numeric key value automatically incremented when you add a DHCPv4 scope. Use the ID to specify the DHCPv4 scope of your choice.", + "explode": true, + "in": "query", + "name": "scope_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The IP address of the DHCP server.", + "explode": true, + "in": "query", + "name": "server_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a DHCPv4 range", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/range/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                                                            • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                              Mandatory Parameters: (range_id || (range_start_addr && range_end_addr && (scope_id || server_id || server_name || server_hostaddr)))", + "operationId": "dhcp_range_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a DHCPv4 range", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/range/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_range_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv4 range, a unique numeric key value automatically incremented when you add a DHCPv4 range. Use the ID to specify the DHCPv4 range of your choice.", + "explode": true, + "in": "query", + "name": "range_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCPv4 range", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/range/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_range_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                              .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv4 ranges", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/range6/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                                                              • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                Mandatory Parameters: (range6_start_addr && range6_end_addr && (scope6_id || server6_id || server6_name || server6_hostaddr))", + "operationId": "dhcp_range6_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range6_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range6_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range6_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a DHCPv6 range", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/range6/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                                                To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                Mandatory Parameters: (range6_id || ((range6_start_addr || range6_end_addr) && (server6_id || server6_name || server6_hostaddr || scope6_id)))", + "operationId": "dhcp_range6_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "explode": true, + "in": "query", + "name": "server6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DHCPv6 server.", + "explode": true, + "in": "query", + "name": "server6_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The last IP address of the DHCPv6 range.", + "explode": true, + "in": "query", + "name": "range6_end_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv6 range, a unique numeric key value automatically incremented when you add a DHCPv6 range. Use the ID to specify the DHCPv6 of your choice.", + "explode": true, + "in": "query", + "name": "range6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The first IP address of the DHCPv6 range.", + "explode": true, + "in": "query", + "name": "range6_start_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv6 scope, a unique numeric key value automatically incremented when you add a DHCPv6 scope. Use the ID to specify the DHCPv6 scope of your choice.", + "explode": true, + "in": "query", + "name": "scope6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The IP address of the DHCP server.", + "explode": true, + "in": "query", + "name": "server6_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range6_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range6_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a DHCPv6 range", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/range6/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                                                                • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                  Mandatory Parameters: (range6_id || (range6_start_addr && range6_end_addr && (scope6_id || server6_id || server6_name || server6_hostaddr)))", + "operationId": "dhcp_range6_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range6_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range6_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range6_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a DHCPv6 range", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/range6/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_range6_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv6 range, a unique numeric key value automatically incremented when you add a DHCPv6 range. Use the ID to specify the DHCPv6 of your choice.", + "explode": true, + "in": "query", + "name": "range6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCPv6 range", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/range6/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_range6_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                                  .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_range6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv6 ranges", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/scope/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                                                                  • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                    Mandatory Parameters: (scope_net_addr && scope_net_mask && (server_id || server_name || server_hostaddr))", + "operationId": "dhcp_scope_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a DHCPv4 scope", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/scope/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                                                    To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                    Mandatory Parameters: (scope_id || (scope_net_addr && (server_id || server_name || server_hostaddr)))", + "operationId": "dhcp_scope_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "explode": true, + "in": "query", + "name": "server_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DHCPv4 server.", + "explode": true, + "in": "query", + "name": "server_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv4 scope, a unique numeric key value automatically incremented when you add a DHCPv4 scope. Use the ID to specify the DHCPv4 scope of your choice.", + "explode": true, + "in": "query", + "name": "scope_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The first IP address of the DHCPv4 scope.", + "explode": true, + "in": "query", + "name": "scope_net_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The IP address of the DHCP server.", + "explode": true, + "in": "query", + "name": "server_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a DHCPv4 scope", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/scope/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                                                                    • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                      Mandatory Parameters: (scope_id || (scope_net_addr && scope_net_mask && (server_id || server_name || server_hostaddr)))", + "operationId": "dhcp_scope_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a DHCPv4 scope", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/scope/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_scope_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv4 scope, a unique numeric key value automatically incremented when you add a DHCPv4 scope. Use the ID to specify the DHCPv4 scope of your choice.", + "explode": true, + "in": "query", + "name": "scope_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCPv4 scope", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/scope/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_scope_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                                      .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv4 scopes", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/scope6/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                                                                      • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                        Mandatory Parameters: (scope6_start_addr && (scope6_end_addr || scope6_prefix) && (server6_id || server6_name || server6_hostaddr))", + "operationId": "dhcp_scope6_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope6_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope6_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope6_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a DHCPv6 scope", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/scope6/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                                                        To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                        Mandatory Parameters: (scope6_id || (scope6_start_addr && (server6_id || server6_name || server6_hostaddr)))", + "operationId": "dhcp_scope6_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "explode": true, + "in": "query", + "name": "server6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DHCPv6 server.", + "explode": true, + "in": "query", + "name": "server6_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv6 scope, a unique numeric key value automatically incremented when you add a DHCPv6 scope. Use the ID to specify the DHCPv6 scope of your choice.", + "explode": true, + "in": "query", + "name": "scope6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The first IP address of the DHCPv6 scope.", + "explode": true, + "in": "query", + "name": "scope6_start_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The IP address of the DHCP server.", + "explode": true, + "in": "query", + "name": "server6_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope6_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope6_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a DHCPv6 scope", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/scope6/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                                                                        • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                          Mandatory Parameters: (scope6_id || (scope6_start_addr && (scope6_end_addr || scope6_prefix) && (server6_id || server6_name || server6_hostaddr)))", + "operationId": "dhcp_scope6_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope6_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope6_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope6_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a DHCPv6 scope", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/scope6/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_scope6_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv6 scope, a unique numeric key value automatically incremented when you add a DHCPv6 scope. Use the ID to specify the DHCPv6 scope of your choice.", + "explode": true, + "in": "query", + "name": "scope6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCPv6 scope", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/scope6/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_scope6_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                                          .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_scope6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv6 scopes", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/server/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_server_info", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "explode": true, + "in": "query", + "name": "server_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_server_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCPv4 server", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/server/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_server_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                                          .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_server_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv4 servers", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/server6/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_server6_info", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "explode": true, + "in": "query", + "name": "server6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_server6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCPv6 server", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/server6/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_server6_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                                          .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_server6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv6 servers", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/sharednetwork/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                                                                          • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                            Mandatory Parameters: (sharednetwork_name && (server_id || server_name || server_hostaddr))", + "operationId": "dhcp_sharednetwork_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a DHCPv4 shared network", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/sharednetwork/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                                                            To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                            Mandatory Parameters: ((sharednetwork_id || sharednetwork_name) && (server_id || server_name || server_hostaddr))", + "operationId": "dhcp_sharednetwork_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "explode": true, + "in": "query", + "name": "server_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DHCPv4 server.", + "explode": true, + "in": "query", + "name": "server_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv4 shared network, a unique numeric key value automatically incremented when you add a DHCPv4 shared network. Use the ID to specify the DHCPv4 shared network of your choice.", + "explode": true, + "in": "query", + "name": "sharednetwork_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DHCPv4 shared network.", + "explode": true, + "in": "query", + "name": "sharednetwork_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The IP address of the DHCP server.", + "explode": true, + "in": "query", + "name": "server_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a DHCPv4 Shared Network", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/sharednetwork/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                                                                            • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                              Mandatory Parameters: ((sharednetwork_id || sharednetwork_name) && (server_id || server_name || server_hostaddr))", + "operationId": "dhcp_sharednetwork_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a DHCPv4 shared network", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/sharednetwork/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_sharednetwork_info", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv4 shared network, a unique numeric key value automatically incremented when you add a DHCPv4 shared network. Use the ID to specify the DHCPv4 shared network of your choice.", + "explode": true, + "in": "query", + "name": "sharednetwork_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCPv4 shared network", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/sharednetwork/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_sharednetwork_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                                              .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv4 shared networks", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/sharednetwork6/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                                                                              • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                Mandatory Parameters: (sharednetwork6_name && (server6_id || server6_name || server6_hostaddr))", + "operationId": "dhcp_sharednetwork6_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork6_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork6_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork6_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a DHCPv6 shared network", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/sharednetwork6/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                                                                To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                Mandatory Parameters: ((sharednetwork6_id || sharednetwork6_name) && (server6_id || server6_name || server6_hostaddr))", + "operationId": "dhcp_sharednetwork6_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "explode": true, + "in": "query", + "name": "server6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DHCPv6 server.", + "explode": true, + "in": "query", + "name": "server6_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv6 shared network, a unique numeric key value automatically incremented when you add a DHCPv6 shared network. Use the ID to specify the DHCPv6 shared network of your choice.", + "explode": true, + "in": "query", + "name": "sharednetwork6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DHCPv6 shared network.", + "explode": true, + "in": "query", + "name": "sharednetwork6_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The IP address of the DHCP server.", + "explode": true, + "in": "query", + "name": "server6_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork6_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork6_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a DHCPv6 Shared Network", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/sharednetwork6/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                                                                                • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                  Mandatory Parameters: ((sharednetwork6_id || sharednetwork6_name) && (server6_id || server6_name || server6_hostaddr))", + "operationId": "dhcp_sharednetwork6_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork6_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork6_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork6_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a DHCPv6 shared network", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/sharednetwork6/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_sharednetwork6_info", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv6 shared network, a unique numeric key value automatically incremented when you add a DHCPv6 shared network. Use the ID to specify the DHCPv6 shared network of your choice.", + "explode": true, + "in": "query", + "name": "sharednetwork6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCPv6 shared network", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/sharednetwork6/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_sharednetwork6_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                                                  .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_sharednetwork6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv6 shared networks", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/static/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                                                                                  • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                    Mandatory Parameters: (server_id || server_name || server_hostaddr) && (static_addr || static_mac_addr || static_identifier)", + "operationId": "dhcp_static_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a DHCPv4 static", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/static/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                                                                    To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                    Mandatory Parameters: (static_id || (static_addr && (static_mac_addr || static_identifier) && (server_id || server_name || server_hostaddr || scope_id)))", + "operationId": "dhcp_static_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "explode": true, + "in": "query", + "name": "server_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DHCPv4 server.", + "explode": true, + "in": "query", + "name": "server_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The IP address associated with the DHCPv4 static.", + "explode": true, + "in": "query", + "name": "static_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv4 static, a unique numeric key value automatically incremented when you add a DHCPv4 static. Use the ID to specify the DHCPv4 static of your choice.", + "explode": true, + "in": "query", + "name": "static_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The host identifier associated with the IPv4 static. An option and value to look for to identify clients and assign them the static, specified as follows: option <option-name> expected value.", + "explode": true, + "in": "query", + "name": "static_identifier", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The MAC address associated with the IPv4 static, it must include the MAC address type. The address has 7 sections, 00:11:22:33:44:55:66 , where 00 indicates the type. For Ethernet, type in 01.", + "explode": true, + "in": "query", + "name": "static_mac_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv4 scope, a unique numeric key value automatically incremented when you add a DHCPv4 scope. Use the ID to specify the DHCPv4 scope of your choice.", + "explode": true, + "in": "query", + "name": "scope_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The IP address of the DHCP server.", + "explode": true, + "in": "query", + "name": "server_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The name of the DHCPv4 static.", + "explode": true, + "in": "query", + "name": "static_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a DHCPv4 static", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/static/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                                                                                    • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                      Mandatory Parameters: (static_id || (server_id || server_name || server_hostaddr) && (static_addr || static_mac_addr || static_identifier))", + "operationId": "dhcp_static_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a DHCPv4 static", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/static/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_static_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCP static, a unique numeric key value automatically incremented when you add a DHCP sttestatic. Use the ID to specify the DHCP static of your choice.", + "explode": true, + "in": "query", + "name": "static_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCPv4 static", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/static/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_static_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                                                      .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv4 statics", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/static6/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                                                                                      • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                        Mandatory Parameters: (static6_name && (static6_mac_addr || static6_client_duid) && (server6_id || server6_name || server6_hostaddr))", + "operationId": "dhcp_static6_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static6_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static6_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static6_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a DHCPv6 static", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/static6/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                                                                        To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                        Mandatory Parameters: (static6_id || ((static6_name || static6_addr) && (server6_id || server6_name || server6_hostaddr || scope6_id)))", + "operationId": "dhcp_static6_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "explode": true, + "in": "query", + "name": "server6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DHCPv6 server.", + "explode": true, + "in": "query", + "name": "server6_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The IP address associated with the DHCPv6 static.", + "explode": true, + "in": "query", + "name": "static6_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv6 static, a unique numeric key value automatically incremented when you add a DHCPv6 static. Use the ID to specify the DHCPv6 static of your choice.", + "explode": true, + "in": "query", + "name": "static6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DHCPv6 static.", + "explode": true, + "in": "query", + "name": "static6_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCPv6 scope, a unique numeric key value automatically incremented when you add a DHCPv6 scope. Use the ID to specify the DHCPv6 scope of your choice.", + "explode": true, + "in": "query", + "name": "scope6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The IP address of the DHCP server.", + "explode": true, + "in": "query", + "name": "server6_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static6_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static6_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a DHCPv6 static", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/static6/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                                                                                        • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                          Mandatory Parameters: (static6_id || (static6_name && (static6_mac_addr || static6_client_duid) && (server6_id || server6_name || server6_hostaddr)))", + "operationId": "dhcp_static6_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static6_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static6_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static6_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a DHCPv6 static", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/static6/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_static6_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DHCP static, a unique numeric key value automatically incremented when you add a DHCP static. Use the ID to specify the DHCP static of your choice.", + "explode": true, + "in": "query", + "name": "static6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DHCPv6 static", + "tags": [ + "dhcp" + ] + } + }, + "/dhcp/static6/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dhcp_static6_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                                                          .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dhcp_static6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DHCPv6 statics", + "tags": [ + "dhcp" + ] + } + }, + "/dns/acl/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                                                                                          • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                            Mandatory Parameters: ((acl_name && (server_id || server_name || server_hostaddr)) && acl_value)", + "operationId": "dns_acl_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_acl_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_acl_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_acl_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a DNS ACL", + "tags": [ + "dns" + ] + } + }, + "/dns/acl/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                                                                            To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                            Mandatory Parameters: acl_id", + "operationId": "dns_acl_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the DNS ACL, a unique numeric key value automatically incremented when you add a DNS ACL. Use the ID to specify the DNS ACL of your choice.", + "explode": true, + "in": "query", + "name": "acl_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "explode": true, + "in": "query", + "name": "server_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DNS server.", + "explode": true, + "in": "query", + "name": "server_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The name of the DNS ACL.", + "explode": true, + "in": "query", + "name": "acl_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The IP address of the DNS server.", + "explode": true, + "in": "query", + "name": "server_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_acl_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_acl_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a DNS ACL", + "tags": [ + "dns" + ] + } + }, + "/dns/acl/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                                                                                            • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                              Mandatory Parameters: ((acl_id || (acl_name && (server_id || server_name || server_hostaddr))) && acl_value)", + "operationId": "dns_acl_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_acl_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_acl_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_acl_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a DNS ACL", + "tags": [ + "dns" + ] + } + }, + "/dns/acl/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dns_acl_info", + "parameters": [ + { + "description": "The database identifier (ID) of the DNS ACL, a unique numeric key value automatically incremented when you add a DNS ACL. Use the ID to specify the DNS ACL of your choice.", + "explode": true, + "in": "query", + "name": "acl_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_acl_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DNS ACL", + "tags": [ + "dns" + ] + } + }, + "/dns/acl/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dns_acl_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                                                              .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_acl_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DNS ACLs", + "tags": [ + "dns" + ] + } + }, + "/dns/rr/add": { + "post": { + "description": "This service allows you to add a resource record or edit an existing one.
                                                                                                                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.
                                                                                                                                                                              Adding some resource records requires to specify one or more values:


                                                                                                                                                                              Expected values for the DNS records
                                                                                                                                                                              TypeValuenumberRelated field(s)Description
                                                                                                                                                                              SOA1Name serverThe FQDN of the primary Master name server for the zone the record belongs to. Has a special meaning when used with Dynamic DNS (DDNS): called MNAME, it allows the DNS client to know on which DNS server it has to update itself with DDNS.
                                                                                                                                                                              2ResponsibleThe administrator email address for the zone the record belongs to.
                                                                                                                                                                              3Serial numberThe serial number for the zone the record belongs to. The serial number is automatically incremented for each zone change.
                                                                                                                                                                              4RefreshThe refresh delay for the zone the record belongs to, in seconds. When reached, it forces the slave name server(s) to read the SOA record. If this record is higher than the slave's one, a zone transfer will be triggered by the slave to get the latest version of the zone. Typical values are 3 to 24 hours.
                                                                                                                                                                              5RetryThe retry delay for the zone the record belongs to, in seconds. When reached, it forces the slave server to retry the request if it fails to reach the master server during a refresh cycle. Typical values are from 10 to 60 minutes.
                                                                                                                                                                              6ExpirationThe expiration time for the zone the record belongs to, in seconds. When reached, the zone records are considered to be no longer valid/authoritative. The DNS server then stops responding to queries for the zone. To avoid a major outage, the typical value is pretty high, between 1 to 3 weeks.
                                                                                                                                                                              7MinimumThe minimum time for the zone the record belongs to, in seconds. It defines the period of time that negative responses can be cached from the slave. For instance, if a request cannot be resolved, the server will answer with a NXDOMAIN result (No such domain). The server will continue returning this value until the Minimum value expires, then it will retry the resolution. This value has to be between 0 and 3 hours.
                                                                                                                                                                              NS1DNS serverThe DNS server hostname.
                                                                                                                                                                              MX1PreferenceA number, between 0 and 65535, to define which server has priority if there are several RRs in the zone. The lowest the value has the priority over the other server(s).
                                                                                                                                                                              2Mail serverThe SMTP (mail) server hostname.
                                                                                                                                                                              A1IP addressThe IPv4 Address of the host.
                                                                                                                                                                              AAAA1IPv6 addressThe IPv6 Address of the host.
                                                                                                                                                                              PTR1LocalizationThe hostname that should be returned when the IP address is queried.
                                                                                                                                                                              CNAME1HostnameThe hostname.
                                                                                                                                                                              TXT1TextThe description of your choice (max. 255 characters including spaces).
                                                                                                                                                                              SRV1PriorityA number, between 0 and 65535, to define which server has priority if there are several SRV RRs in the zone. The lowest the value has the priority over the other server(s).
                                                                                                                                                                              2WeightA number, between 0 and 65535, that defines the server weight. If two SRV RRs have the same priority, the weight defines which server is more used. The field gives priority to the SRV RR with the greatest weight value: the greater the value is, the more the server is solicited. If you type in , there is no weighting.
                                                                                                                                                                              3PortsThe port number that delivers the service to the target.
                                                                                                                                                                              4TargetThe hostname of the server delivering the service.
                                                                                                                                                                              HINFO1CPUThe name of the CPU, either , , , , , , , or .
                                                                                                                                                                              2OSThe name of the operating system, either , , , , , , , , , , , or .
                                                                                                                                                                              MINFO1ResponsibleemailThe email address of the administrator of the mail list.
                                                                                                                                                                              2Error emailThe email address that should receive the error messages regarding the mail list.
                                                                                                                                                                              DNAME1DomainThe domain name of a subdomain of the zone.
                                                                                                                                                                              AFSDB1PreferenceType the version of AFS service used: (AFS version 3.0) or (OSF DCE/NCA version).
                                                                                                                                                                              2AFS serverThe AFS hostname.
                                                                                                                                                                              NAPTR1OrderA number, between 0 and 65535, to define which RR has priority if there are several NAPTR RRs in the zone. The lowest the value has the priority over the other record(s).
                                                                                                                                                                              2PreferenceA number, between 0 and 65535, to define which RR has priority if there are several NAPTR RRs have the same order in the zone. The lowest the value has the priority over the other record(s).
                                                                                                                                                                              2FlagsThe string that corresponds to the action you want your client application to perform. The flag specified impacts the data expected in the field , and/or .
                                                                                                                                                                              3ServicesThe services parameters to which applies the action specified in the field . You must respect your client application syntax.
                                                                                                                                                                              4RegexThe string that contains a substitution expression matching the format to which applies the action specified the field .
                                                                                                                                                                              5ReplaceAn FQDN domain name to which applies the action specified the field . You can specify no domain name if you type in (dot) in the field.
                                                                                                                                                                              For more details, refer to available on IETF website at .
                                                                                                                                                                              NSAP1NameThe NSAP address of the end system. It should start with and not exceed 255 hexadecimal characters separated by dots.
                                                                                                                                                                              DS1Key TagThe parent zone DS key tag.
                                                                                                                                                                              2Key AlgorithmThe parent zone DS algorithm key.
                                                                                                                                                                              3Digest TypeThe parent zone DS digest type.
                                                                                                                                                                              4DigestThe parent zone DS digest.
                                                                                                                                                                              DNSKEY1FlagsThe zone key flag.
                                                                                                                                                                              2ProtocolThe protocol value.
                                                                                                                                                                              3AlgorithmThe public key's cryptographic algorithm.
                                                                                                                                                                              4KeyThe public key material.
                                                                                                                                                                              WKS1IP addressThe IPv4 Address of the host that contains the services listed in the Services field.
                                                                                                                                                                              2ProtocolThe communication protocol, either or .
                                                                                                                                                                              3ServicesThe list of needed services.




                                                                                                                                                                              Mandatory Parameters: (rr_name && rr_type && rr_value1 && (server_id || server_name || server_hostaddr))", + "operationId": "dns_rr_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_rr_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_rr_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_rr_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a resource record", + "tags": [ + "dns" + ] + } + }, + "/dns/rr/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                              Mandatory Parameters: (rr_id || (rr_name && (server_id || server_name || server_hostaddr)))", + "operationId": "dns_rr_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "explode": true, + "in": "query", + "name": "server_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DNS server.", + "explode": true, + "in": "query", + "name": "server_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The IP address of the DNS server.", + "explode": true, + "in": "query", + "name": "server_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DNS resource record, a unique numeric key value automatically incremented when you add a DNS RR. Use the ID to specify the DNS RR of your choice.", + "explode": true, + "in": "query", + "name": "rr_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DNS resource record.", + "explode": true, + "in": "query", + "name": "rr_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DNS view, a unique numeric key value automatically incremented when you add a DNS view. Use the ID to specify the DNS view of your choice.", + "explode": true, + "in": "query", + "name": "view_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DNS view.", + "explode": true, + "in": "query", + "name": "view_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DNS zone, a unique numeric key value automatically incremented when you add a DNS zone. Use the ID to specify the DNS zone of your choice.", + "explode": true, + "in": "query", + "name": "zone_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DNS zone the object belongs to.", + "explode": true, + "in": "query", + "name": "zone_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the space associated with the DNS zone the record belongs to.", + "explode": true, + "in": "query", + "name": "zone_space_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The type of the DNS resource record.


                                                                                                                                                                              rr_type possible values
                                                                                                                                                                              ValueRecord type description
                                                                                                                                                                              SOAStart of Authority. Defines the zone name, an email contact and various time and refresh values applicable to the zone. It is automatically generated upon creation of a zone and cannot be added manually.
                                                                                                                                                                              NSName Server. Defines the authoritative name server(s) for the domain (defined by the SOA record) or the subdomain. The NS record that indicates which server has authority over a zone is automatically generated upon the creation of a zone, once the server has been synchronized.
                                                                                                                                                                              AIPv4 Address. An IPv4 address for a host.
                                                                                                                                                                              PTRPointer Record. Address Resolution, from an IP address (IPv4 or IPv6) to a host. Used in reverse mapping.
                                                                                                                                                                              AAAAIPv6 Address. An IPv6 address for a host.
                                                                                                                                                                              CNAMECanonical Name. An alias name for a host.
                                                                                                                                                                              MXMail Exchange. The mail server/exchanger that services this zone.
                                                                                                                                                                              SRVServices record. Defines services available in the zone, for example, LDAP, HTTP, etc...
                                                                                                                                                                              DNAMEDelegation of Reverse Names. Delegation of reverse addresses primarily in IPv6. (Deprecated, use the CNAME RR instead)
                                                                                                                                                                              TXTText. Information associated with a name.
                                                                                                                                                                              DSDelegation Signer, a DNSSEC related RR used to verify the validity of the ZSK of a subdomain.
                                                                                                                                                                              DNSKEYDNS Key. It contains the public cryptographic key used to sign the zone with DNSSEC.
                                                                                                                                                                              65534A private type record automatically added to the zone once it is signed with DNSSEC.
                                                                                                                                                                              HINFOSystem Information. Information about a host: hardware type and operating system description.
                                                                                                                                                                              MINFOMailbox mail list Information. Defines the mail administrator for a mail list and optionally a mailbox to receive error messages relating to the mail list.
                                                                                                                                                                              AFSDBAFS Database. Location of the AFS servers.
                                                                                                                                                                              WKSWell-Known Service. Defines the services and protocols supported by a host. (Deprecated, use the SRV RR instead)
                                                                                                                                                                              NAPTRNaming Authority Pointer Record. General purpose definition of rule set to be used by applications e.g. VoIP.
                                                                                                                                                                              NSAPNetwork Service Access Point. Defines record (equivalent of an A record) maps a host name to an endpoint address.


                                                                                                                                                                              Note that the parameter is not case sensitive, you could type in A or a.", + "explode": true, + "in": "query", + "name": "rr_type", + "required": false, + "schema": { + "enum": [ + "A", + "NS", + "MD", + "MF", + "CNAME", + "SOA", + "MB", + "MG", + "MR", + "NULL", + "WKS", + "PTR", + "HINFO", + "MINFO", + "MX", + "TXT", + "SPF", + "RP", + "AFSDB", + "X25", + "ISDN", + "RT", + "NSAP", + "NSAP_PTR", + "SIG", + "KEY", + "PX", + "GPOS", + "AAAA", + "LOC", + "NXT", + "EID", + "NIMLOC", + "SRV", + "ATMA", + "NAPTR", + "KX", + "CERT", + "A6", + "DNAME", + "OPT", + "DS", + "DNSSIG", + "NSEC", + "DNSKEY", + "NSEC3", + "NSEC3PARAM", + "CDS", + "CDNSKEY", + "CAA", + "TLSA", + "SSHFP", + "OPENPGPKEY", + "URI", + "AVC", + "NINFO", + "DLV", + "DHCID", + "EUI48", + "EUI64", + "NID", + "L32", + "L64", + "HTTPS", + "SVCB" + ], + "type": "string" + }, + "style": "form" + }, + { + "description": "The first or only value required for the DNS resource record, as detailed in the service description", + "explode": true, + "in": "query", + "name": "rr_value1", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The second value of the DNS resource record, depending on its type, as detailed in the service description", + "explode": true, + "in": "query", + "name": "rr_value2", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The third value of the DNS resource record, depending on its type, as detailed in the service description", + "explode": true, + "in": "query", + "name": "rr_value3", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The fourth value of the DNS resource record, depending on its type, as detailed in the service description", + "explode": true, + "in": "query", + "name": "rr_value4", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The fifth value of the DNS resource record, depending on its type, as detailed in the service description", + "explode": true, + "in": "query", + "name": "rr_value5", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The sixth value of the DNS resource record, depending on its type, as detailed in the service description", + "explode": true, + "in": "query", + "name": "rr_value6", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The seventh value of the DNS resource record, depending on its type, as detailed in the service description", + "explode": true, + "in": "query", + "name": "rr_value7", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_rr_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_rr_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a resource record", + "tags": [ + "dns" + ] + } + }, + "/dns/rr/edit": { + "put": { + "description": "This service allows you to add a resource record or edit an existing one.
                                                                                                                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.
                                                                                                                                                                              Adding some resource records requires to specify one or more values:


                                                                                                                                                                              Expected values for the DNS records
                                                                                                                                                                              TypeValuenumberRelated field(s)Description
                                                                                                                                                                              SOA1Name serverThe FQDN of the primary Master name server for the zone the record belongs to. Has a special meaning when used with Dynamic DNS (DDNS): called MNAME, it allows the DNS client to know on which DNS server it has to update itself with DDNS.
                                                                                                                                                                              2ResponsibleThe administrator email address for the zone the record belongs to.
                                                                                                                                                                              3Serial numberThe serial number for the zone the record belongs to. The serial number is automatically incremented for each zone change.
                                                                                                                                                                              4RefreshThe refresh delay for the zone the record belongs to, in seconds. When reached, it forces the slave name server(s) to read the SOA record. If this record is higher than the slave's one, a zone transfer will be triggered by the slave to get the latest version of the zone. Typical values are 3 to 24 hours.
                                                                                                                                                                              5RetryThe retry delay for the zone the record belongs to, in seconds. When reached, it forces the slave server to retry the request if it fails to reach the master server during a refresh cycle. Typical values are from 10 to 60 minutes.
                                                                                                                                                                              6ExpirationThe expiration time for the zone the record belongs to, in seconds. When reached, the zone records are considered to be no longer valid/authoritative. The DNS server then stops responding to queries for the zone. To avoid a major outage, the typical value is pretty high, between 1 to 3 weeks.
                                                                                                                                                                              7MinimumThe minimum time for the zone the record belongs to, in seconds. It defines the period of time that negative responses can be cached from the slave. For instance, if a request cannot be resolved, the server will answer with a NXDOMAIN result (No such domain). The server will continue returning this value until the Minimum value expires, then it will retry the resolution. This value has to be between 0 and 3 hours.
                                                                                                                                                                              NS1DNS serverThe DNS server hostname.
                                                                                                                                                                              MX1PreferenceA number, between 0 and 65535, to define which server has priority if there are several RRs in the zone. The lowest the value has the priority over the other server(s).
                                                                                                                                                                              2Mail serverThe SMTP (mail) server hostname.
                                                                                                                                                                              A1IP addressThe IPv4 Address of the host.
                                                                                                                                                                              AAAA1IPv6 addressThe IPv6 Address of the host.
                                                                                                                                                                              PTR1LocalizationThe hostname that should be returned when the IP address is queried.
                                                                                                                                                                              CNAME1HostnameThe hostname.
                                                                                                                                                                              TXT1TextThe description of your choice (max. 255 characters including spaces).
                                                                                                                                                                              SRV1PriorityA number, between 0 and 65535, to define which server has priority if there are several SRV RRs in the zone. The lowest the value has the priority over the other server(s).
                                                                                                                                                                              2WeightA number, between 0 and 65535, that defines the server weight. If two SRV RRs have the same priority, the weight defines which server is more used. The field gives priority to the SRV RR with the greatest weight value: the greater the value is, the more the server is solicited. If you type in , there is no weighting.
                                                                                                                                                                              3PortsThe port number that delivers the service to the target.
                                                                                                                                                                              4TargetThe hostname of the server delivering the service.
                                                                                                                                                                              HINFO1CPUThe name of the CPU, either , , , , , , , or .
                                                                                                                                                                              2OSThe name of the operating system, either , , , , , , , , , , , or .
                                                                                                                                                                              MINFO1ResponsibleemailThe email address of the administrator of the mail list.
                                                                                                                                                                              2Error emailThe email address that should receive the error messages regarding the mail list.
                                                                                                                                                                              DNAME1DomainThe domain name of a subdomain of the zone.
                                                                                                                                                                              AFSDB1PreferenceType the version of AFS service used: (AFS version 3.0) or (OSF DCE/NCA version).
                                                                                                                                                                              2AFS serverThe AFS hostname.
                                                                                                                                                                              NAPTR1OrderA number, between 0 and 65535, to define which RR has priority if there are several NAPTR RRs in the zone. The lowest the value has the priority over the other record(s).
                                                                                                                                                                              2PreferenceA number, between 0 and 65535, to define which RR has priority if there are several NAPTR RRs have the same order in the zone. The lowest the value has the priority over the other record(s).
                                                                                                                                                                              2FlagsThe string that corresponds to the action you want your client application to perform. The flag specified impacts the data expected in the field , and/or .
                                                                                                                                                                              3ServicesThe services parameters to which applies the action specified in the field . You must respect your client application syntax.
                                                                                                                                                                              4RegexThe string that contains a substitution expression matching the format to which applies the action specified the field .
                                                                                                                                                                              5ReplaceAn FQDN domain name to which applies the action specified the field . You can specify no domain name if you type in (dot) in the field.
                                                                                                                                                                              For more details, refer to available on IETF website at .
                                                                                                                                                                              NSAP1NameThe NSAP address of the end system. It should start with and not exceed 255 hexadecimal characters separated by dots.
                                                                                                                                                                              DS1Key TagThe parent zone DS key tag.
                                                                                                                                                                              2Key AlgorithmThe parent zone DS algorithm key.
                                                                                                                                                                              3Digest TypeThe parent zone DS digest type.
                                                                                                                                                                              4DigestThe parent zone DS digest.
                                                                                                                                                                              DNSKEY1FlagsThe zone key flag.
                                                                                                                                                                              2ProtocolThe protocol value.
                                                                                                                                                                              3AlgorithmThe public key's cryptographic algorithm.
                                                                                                                                                                              4KeyThe public key material.
                                                                                                                                                                              WKS1IP addressThe IPv4 Address of the host that contains the services listed in the Services field.
                                                                                                                                                                              2ProtocolThe communication protocol, either or .
                                                                                                                                                                              3ServicesThe list of needed services.




                                                                                                                                                                              Mandatory Parameters: (rr_id || (rr_name && rr_type && rr_value1 && (server_id || server_name || server_hostaddr)))", + "operationId": "dns_rr_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_rr_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_rr_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_rr_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a resource record", + "tags": [ + "dns" + ] + } + }, + "/dns/rr/info": { + "get": { + "description": "This service allows to display the properties of a resource record.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.Adding some resource records requires to specify one or more values:
                                                                                                                                                                              Expected values for the DNS records







                                                                                                                                                                              Type
                                                                                                                                                                              Value number
                                                                                                                                                                              Related field(s)
                                                                                                                                                                              Syntax




                                                                                                                                                                              SOA
                                                                                                                                                                              1
                                                                                                                                                                              Name server
                                                                                                                                                                              Type in the FQDN of the primary Master name server for the zone the record belongs to. Has a special meaning when used with Dynamic DNS (DDNS): called MNAME, it allows the DNS client to know on which DNS server it has to update itself with DDNS.


                                                                                                                                                                              2
                                                                                                                                                                              Responsible
                                                                                                                                                                              Type in the administrator email address for the zone the record belongs to.


                                                                                                                                                                              3
                                                                                                                                                                              Serial number
                                                                                                                                                                              Type in the serial number for the zone the record belongs to. The serial number is automatically incremented for each zone change.


                                                                                                                                                                              4
                                                                                                                                                                              Refresh
                                                                                                                                                                              Type in the refresh delay for the zone the record belongs to, in seconds. When reached, it forces the slave name server(s) to read the SOA record. If this record is higher than the slave's one, a zone transfer will be triggered by the slave to get the latest version of the zone. Typical values are 3 to 24 hours.


                                                                                                                                                                              5
                                                                                                                                                                              Retry
                                                                                                                                                                              Type in the retry delay for the zone the record belongs to, in seconds. When reached, it forces the slave server to retry the request if it fails to reach the master server during a refresh cycle. Typical values are from 10 to 60 minutes.


                                                                                                                                                                              6
                                                                                                                                                                              Expiration
                                                                                                                                                                              Type in the expiration time for the zone the record belongs to, in seconds. When reached, the zone records are considered to be no longer valid/authoritative. The DNS server then stops responding to queries for the zone. To avoid a major outage, the typical value is pretty high, between 1 to 3 weeks.


                                                                                                                                                                              7
                                                                                                                                                                              Minimum
                                                                                                                                                                              Type in the minimum time for the zone the record belongs to, in seconds. It defines the period of time that negative responses can be cached from the slave. For instance, if a request cannot be resolved, the server will answer with a NXDOMAIN result (No such domain). The server will continue returning this value until the Minimum value expires, then it will retry the resolution. This value has to be between 0 and 3 hours.


                                                                                                                                                                              NS
                                                                                                                                                                              1
                                                                                                                                                                              DNS server
                                                                                                                                                                              Type in the DNS server hostname.


                                                                                                                                                                              MX
                                                                                                                                                                              1
                                                                                                                                                                              Preference
                                                                                                                                                                              Type a number, between 0 and 65535, to define which server has priority if there are several RRs in the zone. The lowest the value has the priority over the other server(s).


                                                                                                                                                                              2
                                                                                                                                                                              Mail server
                                                                                                                                                                              Type in the SMTP (mail) server hostname.


                                                                                                                                                                              A
                                                                                                                                                                              1
                                                                                                                                                                              IP address
                                                                                                                                                                              Type in the IPv4 Address of the host.


                                                                                                                                                                              AAAA
                                                                                                                                                                              1
                                                                                                                                                                              IPv6 address
                                                                                                                                                                              Type in the IPv6 Address of the host.


                                                                                                                                                                              PTR
                                                                                                                                                                              1
                                                                                                                                                                              Localization
                                                                                                                                                                              Type in the hostname that should be returned when the IP address is queried.


                                                                                                                                                                              CNAME
                                                                                                                                                                              1
                                                                                                                                                                              Hostname
                                                                                                                                                                              Type in the hostname.


                                                                                                                                                                              TXT
                                                                                                                                                                              1
                                                                                                                                                                              Text
                                                                                                                                                                              Type in the description of your choice (max. 255 characters including spaces).


                                                                                                                                                                              SRV
                                                                                                                                                                              1
                                                                                                                                                                              Priority
                                                                                                                                                                              Type a number, between 0 and 65535, to define which server has priority if there are several SRV RRs in the zone. The lowest the value has the priority over the other server(s).


                                                                                                                                                                              2
                                                                                                                                                                              Weight
                                                                                                                                                                              Type a number, between 0 and 65535, that defines the server weight. If two SRV RRs have the same priority, the weight defines which server is more used. The field gives priority to the SRV RR with the greatest weight value: the greater the value is, the more the server is solicited. If you type in 0, there is no weighting.


                                                                                                                                                                              3
                                                                                                                                                                              Ports
                                                                                                                                                                              Type in the port number that delivers the service to the target.


                                                                                                                                                                              4
                                                                                                                                                                              Target
                                                                                                                                                                              Type in the hostname of the server delivering the service.


                                                                                                                                                                              HINFO
                                                                                                                                                                              1
                                                                                                                                                                              CPU
                                                                                                                                                                              Type in the name of the CPU, either INTEL, AMD, SPARC, ALPHA, HPPA, POWERPC, MIPS, MOTOROLA or Other.


                                                                                                                                                                              2
                                                                                                                                                                              OS
                                                                                                                                                                              The name of the operating system, either AIX, FREEBSD, HPUX, IRIX, LINUX, OSF, OS/2, SOLARIS, SUNOS, VMS, WINDOWS, or Other.


                                                                                                                                                                              MINFO
                                                                                                                                                                              1
                                                                                                                                                                              Responsible email
                                                                                                                                                                              Type in the email address of the administrator of the mail list.


                                                                                                                                                                              2
                                                                                                                                                                              Error email
                                                                                                                                                                              Type in the email address that should receive the error messages regarding the mail list.


                                                                                                                                                                              DNAME
                                                                                                                                                                              1
                                                                                                                                                                              Domain
                                                                                                                                                                              Type in the domain name of a subdomain of the zone.


                                                                                                                                                                              AFSDB
                                                                                                                                                                              1
                                                                                                                                                                              Preference
                                                                                                                                                                              Type the version of AFS service used: 1 (AFS version 3.0) or 2 (OSF DCE/NCA version).


                                                                                                                                                                              2
                                                                                                                                                                              AFS server
                                                                                                                                                                              Type in the AFS hostname.


                                                                                                                                                                              NAPTR
                                                                                                                                                                              The record NAPTR is described in the RFC 3403, available on IETF website: http://tools.ietf.org/html/rfc3403.

                                                                                                                                                                              1
                                                                                                                                                                              Order
                                                                                                                                                                              Type a number, between 0 and 65535, to define which RR has priority if there are several NAPTR RRs in the zone. The lowest the value has the priority over the other record(s).


                                                                                                                                                                              2
                                                                                                                                                                              Preference
                                                                                                                                                                              Type a number, between 0 and 65535, to define which RR has priority if there are several NAPTR RRs have the same order in the zone. The lowest the value has the priority over the other record(s).


                                                                                                                                                                              2
                                                                                                                                                                              Flags
                                                                                                                                                                              Type in the string that corresponds to the action you want your client application to perform. The flag specified impacts the data expected in the field Services, Regex and/or Replace.


                                                                                                                                                                              3
                                                                                                                                                                              Services
                                                                                                                                                                              Type in the services parameters to which applies the action specified in the field Flags. You must respect your client application syntax.


                                                                                                                                                                              4
                                                                                                                                                                              Regex
                                                                                                                                                                              Type in the string that contains a substitution expression matching the format to which applies the action specified the field Flags.


                                                                                                                                                                              5
                                                                                                                                                                              Replace
                                                                                                                                                                              Type in an FQDN domain name to which applies the action specified the field Flags. You can specify no domain name if you type in . (dot) in the field.


                                                                                                                                                                              NSAP
                                                                                                                                                                              1
                                                                                                                                                                              Name
                                                                                                                                                                              Type in the NSAP address of the end system. It should start with 0x and not exceed 255 hexadecimal characters separated by dots.


                                                                                                                                                                              DS
                                                                                                                                                                              1
                                                                                                                                                                              Key Tag
                                                                                                                                                                              Type in the parent zone DS key tag.


                                                                                                                                                                              2
                                                                                                                                                                              Key Algorithm
                                                                                                                                                                              Type in the parent zone DS algorithm key.


                                                                                                                                                                              3
                                                                                                                                                                              Digest Type
                                                                                                                                                                              Type in the parent zone DS digest type.


                                                                                                                                                                              4
                                                                                                                                                                              Digest
                                                                                                                                                                              Type in the parent zone DS digest.


                                                                                                                                                                              DNSKEY
                                                                                                                                                                              1
                                                                                                                                                                              Flags
                                                                                                                                                                              Type in or paste the zone key flag.


                                                                                                                                                                              2
                                                                                                                                                                              Protocol
                                                                                                                                                                              Type in or paste the protocol value.


                                                                                                                                                                              3
                                                                                                                                                                              Algorithm
                                                                                                                                                                              Type in or paste the public key's cryptographic algorithm.


                                                                                                                                                                              4
                                                                                                                                                                              Key
                                                                                                                                                                              Type in or paste the public key material.


                                                                                                                                                                              WKS
                                                                                                                                                                              1
                                                                                                                                                                              IP address
                                                                                                                                                                              Type in the IPv4 Address of the host that contains the services listed in the Services field.


                                                                                                                                                                              2
                                                                                                                                                                              Protocol
                                                                                                                                                                              Type in TCP or UDP.


                                                                                                                                                                              3
                                                                                                                                                                              Services
                                                                                                                                                                              Type in the list of needed services.



                                                                                                                                                                              ", + "operationId": "dns_rr_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DNS resource record, a unique numeric key value automatically incremented when you add a DNS RR. Use the ID to specify the DNS RR of your choice.", + "explode": true, + "in": "query", + "name": "rr_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_rr_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a resource record", + "tags": [ + "dns" + ] + } + }, + "/dns/rr/list": { + "get": { + "description": "This service allows you to list the resource records.
                                                                                                                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.
                                                                                                                                                                              Adding some resource records requires to specify one or more values:


                                                                                                                                                                              Expected values for the DNS records
                                                                                                                                                                              TypeValuenumberRelated field(s)Description
                                                                                                                                                                              SOA1Name serverThe FQDN of the primary Master name server for the zone the record belongs to. Has a special meaning when used with Dynamic DNS (DDNS): called MNAME, it allows the DNS client to know on which DNS server it has to update itself with DDNS.
                                                                                                                                                                              2ResponsibleThe administrator email address for the zone the record belongs to.
                                                                                                                                                                              3Serial numberThe serial number for the zone the record belongs to. The serial number is automatically incremented for each zone change.
                                                                                                                                                                              4RefreshThe refresh delay for the zone the record belongs to, in seconds. When reached, it forces the slave name server(s) to read the SOA record. If this record is higher than the slave's one, a zone transfer will be triggered by the slave to get the latest version of the zone. Typical values are 3 to 24 hours.
                                                                                                                                                                              5RetryThe retry delay for the zone the record belongs to, in seconds. When reached, it forces the slave server to retry the request if it fails to reach the master server during a refresh cycle. Typical values are from 10 to 60 minutes.
                                                                                                                                                                              6ExpirationThe expiration time for the zone the record belongs to, in seconds. When reached, the zone records are considered to be no longer valid/authoritative. The DNS server then stops responding to queries for the zone. To avoid a major outage, the typical value is pretty high, between 1 to 3 weeks.
                                                                                                                                                                              7MinimumThe minimum time for the zone the record belongs to, in seconds. It defines the period of time that negative responses can be cached from the slave. For instance, if a request cannot be resolved, the server will answer with a NXDOMAIN result (No such domain). The server will continue returning this value until the Minimum value expires, then it will retry the resolution. This value has to be between 0 and 3 hours.
                                                                                                                                                                              NS1DNS serverThe DNS server hostname.
                                                                                                                                                                              MX1PreferenceA number, between 0 and 65535, to define which server has priority if there are several RRs in the zone. The lowest the value has the priority over the other server(s).
                                                                                                                                                                              2Mail serverThe SMTP (mail) server hostname.
                                                                                                                                                                              A1IP addressThe IPv4 Address of the host.
                                                                                                                                                                              AAAA1IPv6 addressThe IPv6 Address of the host.
                                                                                                                                                                              PTR1LocalizationThe hostname that should be returned when the IP address is queried.
                                                                                                                                                                              CNAME1HostnameThe hostname.
                                                                                                                                                                              TXT1TextThe description of your choice (max. 255 characters including spaces).
                                                                                                                                                                              SRV1PriorityA number, between 0 and 65535, to define which server has priority if there are several SRV RRs in the zone. The lowest the value has the priority over the other server(s).
                                                                                                                                                                              2WeightA number, between 0 and 65535, that defines the server weight. If two SRV RRs have the same priority, the weight defines which server is more used. The field gives priority to the SRV RR with the greatest weight value: the greater the value is, the more the server is solicited. If you type in , there is no weighting.
                                                                                                                                                                              3PortsThe port number that delivers the service to the target.
                                                                                                                                                                              4TargetThe hostname of the server delivering the service.
                                                                                                                                                                              HINFO1CPUThe name of the CPU, either , , , , , , , or .
                                                                                                                                                                              2OSThe name of the operating system, either , , , , , , , , , , , or .
                                                                                                                                                                              MINFO1ResponsibleemailThe email address of the administrator of the mail list.
                                                                                                                                                                              2Error emailThe email address that should receive the error messages regarding the mail list.
                                                                                                                                                                              DNAME1DomainThe domain name of a subdomain of the zone.
                                                                                                                                                                              AFSDB1PreferenceType the version of AFS service used: (AFS version 3.0) or (OSF DCE/NCA version).
                                                                                                                                                                              2AFS serverThe AFS hostname.
                                                                                                                                                                              NAPTR1OrderA number, between 0 and 65535, to define which RR has priority if there are several NAPTR RRs in the zone. The lowest the value has the priority over the other record(s).
                                                                                                                                                                              2PreferenceA number, between 0 and 65535, to define which RR has priority if there are several NAPTR RRs have the same order in the zone. The lowest the value has the priority over the other record(s).
                                                                                                                                                                              2FlagsThe string that corresponds to the action you want your client application to perform. The flag specified impacts the data expected in the field , and/or .
                                                                                                                                                                              3ServicesThe services parameters to which applies the action specified in the field . You must respect your client application syntax.
                                                                                                                                                                              4RegexThe string that contains a substitution expression matching the format to which applies the action specified the field .
                                                                                                                                                                              5ReplaceAn FQDN domain name to which applies the action specified the field . You can specify no domain name if you type in (dot) in the field.
                                                                                                                                                                              For more details, refer to available on IETF website at .
                                                                                                                                                                              NSAP1NameThe NSAP address of the end system. It should start with and not exceed 255 hexadecimal characters separated by dots.
                                                                                                                                                                              DS1Key TagThe parent zone DS key tag.
                                                                                                                                                                              2Key AlgorithmThe parent zone DS algorithm key.
                                                                                                                                                                              3Digest TypeThe parent zone DS digest type.
                                                                                                                                                                              4DigestThe parent zone DS digest.
                                                                                                                                                                              DNSKEY1FlagsThe zone key flag.
                                                                                                                                                                              2ProtocolThe protocol value.
                                                                                                                                                                              3AlgorithmThe public key's cryptographic algorithm.
                                                                                                                                                                              4KeyThe public key material.
                                                                                                                                                                              WKS1IP addressThe IPv4 Address of the host that contains the services listed in the Services field.
                                                                                                                                                                              2ProtocolThe communication protocol, either or .
                                                                                                                                                                              3ServicesThe list of needed services.


                                                                                                                                                                              ", + "operationId": "dns_rr_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                                                              .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_rr_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the resource records", + "tags": [ + "dns" + ] + } + }, + "/dns/server/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dns_server_info", + "parameters": [ + { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "explode": true, + "in": "query", + "name": "server_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_server_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DNS server", + "tags": [ + "dns" + ] + } + }, + "/dns/server/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dns_server_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                                                              .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_server_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DNS servers", + "tags": [ + "dns" + ] + } + }, + "/dns/view/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                                                                                              • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                Mandatory Parameters: (view_name && (server_id || server_name || server_hostaddr))", + "operationId": "dns_view_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_view_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_view_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_view_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a view", + "tags": [ + "dns" + ] + } + }, + "/dns/view/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                                                                                To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                Mandatory Parameters: (view_id || (view_name && (server_id || server_name || server_hostaddr)))", + "operationId": "dns_view_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "explode": true, + "in": "query", + "name": "server_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DNS server.", + "explode": true, + "in": "query", + "name": "server_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DNS view. Use the ID to specify the DNS view of your choice.", + "explode": true, + "in": "query", + "name": "view_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DNS view.", + "explode": true, + "in": "query", + "name": "view_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The IP address of the DNS server.", + "explode": true, + "in": "query", + "name": "server_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_view_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_view_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a view", + "tags": [ + "dns" + ] + } + }, + "/dns/view/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                                                                                                • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                  Mandatory Parameters: (view_id || (view_name && (server_id || server_name || server_hostaddr)))", + "operationId": "dns_view_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_view_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_view_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_view_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a view", + "tags": [ + "dns" + ] + } + }, + "/dns/view/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dns_view_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DNS view. Use the ID to specify the DNS view of your choice.", + "explode": true, + "in": "query", + "name": "view_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_view_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a view", + "tags": [ + "dns" + ] + } + }, + "/dns/view/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dns_view_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                                                                  .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_view_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the views", + "tags": [ + "dns" + ] + } + }, + "/dns/viewparam/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                                                                                                  • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                    Mandatory Parameters: (view_id && viewparam_key)", + "operationId": "dns_viewparam_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_viewparam_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_viewparam_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_viewparam_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a DNS option on a view", + "tags": [ + "dns" + ] + } + }, + "/dns/viewparam/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                                                                                    To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                    Mandatory Parameters: (view_id && viewparam_key)", + "operationId": "dns_viewparam_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the DNS view. Use the ID to specify the DNS view of your choice.", + "explode": true, + "in": "query", + "name": "view_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DNS option that you want to remove from the view: param_key=<option-name>.", + "explode": true, + "in": "query", + "name": "viewparam_key", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_viewparam_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_viewparam_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a DNS option from a view", + "tags": [ + "dns" + ] + } + }, + "/dns/viewparam/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                                                                                                    • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                      Mandatory Parameters: (view_id && viewparam_key)", + "operationId": "dns_viewparam_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_viewparam_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_viewparam_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_viewparam_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a DNS option on a view", + "tags": [ + "dns" + ] + } + }, + "/dns/viewparam/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dns_viewparam_info", + "parameters": [ + { + "description": "The database identifier (ID) of the DNS view. Use the ID to specify the DNS view of your choice.", + "explode": true, + "in": "query", + "name": "view_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_viewparam_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DNS option set on a view", + "tags": [ + "dns" + ] + } + }, + "/dns/viewparam/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dns_viewparam_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                                                                      .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_viewparam_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DNS options of a view", + "tags": [ + "dns" + ] + } + }, + "/dns/zone/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                                                                                                      • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                        Mandatory Parameters: (zone_name && zone_type && (view_id || view_name) && (server_id || server_name || server_hostaddr))", + "operationId": "dns_zone_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zone_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zone_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zone_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a zone", + "tags": [ + "dns" + ] + } + }, + "/dns/zone/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                                                                                        To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                        Mandatory Parameters: (zone_id || (zone_name && (view_id || (view_name && (server_id || server_name || server_hostaddr)))))", + "operationId": "dns_zone_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "explode": true, + "in": "query", + "name": "server_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DNS server.", + "explode": true, + "in": "query", + "name": "server_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DNS view the object belongs to.", + "explode": true, + "in": "query", + "name": "view_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DNS view the object belongs to.", + "explode": true, + "in": "query", + "name": "view_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DNS zone, a unique numeric key value automatically incremented when you add a DNS zone. Use the ID to specify the DNS zone of your choice.", + "explode": true, + "in": "query", + "name": "zone_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DNS zone the object belongs to.", + "explode": true, + "in": "query", + "name": "zone_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The IP address of the DNS server.", + "explode": true, + "in": "query", + "name": "server_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zone_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zone_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a zone", + "tags": [ + "dns" + ] + } + }, + "/dns/zone/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                                                                                                        • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                          Mandatory Parameters: (zone_id || (zone_name && (view_id || view_name) && (server_id || server_name || server_hostaddr)))", + "operationId": "dns_zone_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zone_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zone_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zone_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a zone", + "tags": [ + "dns" + ] + } + }, + "/dns/zone/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dns_zone_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DNS zone, a unique numeric key value automatically incremented when you add a DNS zone. Use the ID to specify the DNS zone of your choice.", + "explode": true, + "in": "query", + "name": "zone_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zone_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a zone", + "tags": [ + "dns" + ] + } + }, + "/dns/zone/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dns_zone_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                                                                          .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zone_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DNS options of a zone", + "tags": [ + "dns" + ] + } + }, + "/dns/zoneparam/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                                                                                                          • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                            Mandatory Parameters: (zone_id && zoneparam_key)", + "operationId": "dns_zoneparam_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zoneparam_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zoneparam_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zoneparam_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a DNS option on a zone", + "tags": [ + "dns" + ] + } + }, + "/dns/zoneparam/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                                                                                            To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                            Mandatory Parameters: (zone_id && zoneparam_key)", + "operationId": "dns_zoneparam_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the DNS zone, a unique numeric key value automatically incremented when you add a DNS zone. Use the ID to specify the DNS zone of your choice.", + "explode": true, + "in": "query", + "name": "zone_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the DNS option that you want to remove from the zone: param_key=<option-name>.", + "explode": true, + "in": "query", + "name": "zoneparam_key", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "explode": true, + "in": "query", + "name": "server_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zoneparam_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zoneparam_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a DNS option from a zone", + "tags": [ + "dns" + ] + } + }, + "/dns/zoneparam/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                                                                                                            • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                              Mandatory Parameters: (zone_id && zoneparam_key)", + "operationId": "dns_zoneparam_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zoneparam_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zoneparam_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zoneparam_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a DNS option on a zone", + "tags": [ + "dns" + ] + } + }, + "/dns/zoneparam/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dns_zoneparam_info", + "parameters": [ + { + "description": "The database identifier (ID) of the DNS zone, a unique numeric key value automatically incremented when you add a DNS zone. Use the ID to specify the DNS zone of your choice.", + "explode": true, + "in": "query", + "name": "zone_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zoneparam_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a DNS option set on a zone", + "tags": [ + "dns" + ] + } + }, + "/dns/zoneparam/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "dns_zoneparam_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                                                                              .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dns_zoneparam_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the DNS options of a zone", + "tags": [ + "dns" + ] + } + }, + "/ipam/address/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                                                                                                              • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                Mandatory Parameters: (address_hostaddr && (space_id || space_name))", + "operationId": "ipam_address_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add an IPv4 address", + "tags": [ + "ipam" + ] + } + }, + "/ipam/address/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                                                                                                To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                Mandatory Parameters: (address_id || (address_hostaddr && (space_id || space_name)))", + "operationId": "ipam_address_delete", + "parameters": [ + { + "description": "The IP address.", + "explode": true, + "in": "query", + "name": "address_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv4 address, a unique numeric key value automatically incremented when you add an IPv4 address. Use the ID to specify the IPv4 address of your choice.", + "explode": true, + "in": "query", + "name": "address_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "explode": true, + "in": "query", + "name": "space_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the space.", + "explode": true, + "in": "query", + "name": "space_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The name of the IPv4 address.", + "explode": true, + "in": "query", + "name": "address_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete an IPv4 address", + "tags": [ + "ipam" + ] + } + }, + "/ipam/address/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                                                                                                                • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                  Mandatory Parameters: (address_id || (address_hostaddr && (space_id || space_name)))", + "operationId": "ipam_address_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit an IPv4 address", + "tags": [ + "ipam" + ] + } + }, + "/ipam/address/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_address_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv4 address, a unique numeric key value automatically incremented when you add an IPv4 address. Use the ID to specify the IPv4 address of your choice.", + "explode": true, + "in": "query", + "name": "address_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of an IPv4 address", + "tags": [ + "ipam" + ] + } + }, + "/ipam/address/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_address_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                                                                                  .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the IPv4 addresses", + "tags": [ + "ipam" + ] + } + }, + "/ipam/address6/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                                                                                                                  • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                    Mandatory Parameters: (address6_hostaddr && (space_id || space_name))", + "operationId": "ipam_address6_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address6_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address6_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address6_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add an IPv6 address", + "tags": [ + "ipam" + ] + } + }, + "/ipam/address6/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                                                                                                    To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                    Mandatory Parameters: (address6_id || (address6_hostaddr && (space_id || space_name)))", + "operationId": "ipam_address6_delete", + "parameters": [ + { + "description": "The IP address.", + "explode": true, + "in": "query", + "name": "address6_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv6 address, a unique numeric key value automatically incremented when you add an IPv6 address. Use the ID to specify the IPv6 address of your choice.", + "explode": true, + "in": "query", + "name": "address6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "explode": true, + "in": "query", + "name": "space_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the space.", + "explode": true, + "in": "query", + "name": "space_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The name of the IPv6 address.", + "explode": true, + "in": "query", + "name": "address6_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address6_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address6_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete an IPv6 address", + "tags": [ + "ipam" + ] + } + }, + "/ipam/address6/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                                                                                                                    • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                      Mandatory Parameters: (address6_id || (address6_hostaddr && (space_id || space_name)))", + "operationId": "ipam_address6_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address6_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address6_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address6_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit an IPv6 address", + "tags": [ + "ipam" + ] + } + }, + "/ipam/address6/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_address6_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv6 address, a unique numeric key value automatically incremented when you add an IPv6 address. Use the ID to specify the IPv6 address of your choice.", + "explode": true, + "in": "query", + "name": "address6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of an IPv6 address", + "tags": [ + "ipam" + ] + } + }, + "/ipam/address6/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_address6_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                                                                                      .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_address6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the IPv6 addresses", + "tags": [ + "ipam" + ] + } + }, + "/ipam/alias/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                                                                                                                      • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                        Mandatory Parameters: (alias_name && (address_id || (address_hostaddr && (space_id || space_name))))", + "operationId": "ipam_alias_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add an IPv4 address alias", + "tags": [ + "ipam" + ] + } + }, + "/ipam/alias/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                                                                                                        To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                        Mandatory Parameters: (alias_id || (alias_name && (address_id || (address_hostaddr && (space_id || space_name)))))", + "operationId": "ipam_alias_delete", + "parameters": [ + { + "description": "The IP address.", + "explode": true, + "in": "query", + "name": "address_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv4 address, a unique numeric key value automatically incremented when you add an IPv4 address. Use the ID to specify the IPv4 address of your choice.", + "explode": true, + "in": "query", + "name": "address_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the IPv4 alias.", + "explode": true, + "in": "query", + "name": "alias_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv4 alias, a unique numeric key value automatically incremented when you add an IPv4 alias. Use the ID to specify the IPv4 alias to of your choice.", + "explode": true, + "in": "query", + "name": "alias_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "explode": true, + "in": "query", + "name": "space_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the space.", + "explode": true, + "in": "query", + "name": "space_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The type of the alias.", + "explode": true, + "in": "query", + "name": "alias_type", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete an IPv4 address alias", + "tags": [ + "ipam" + ] + } + }, + "/ipam/alias/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                                                                                                                        • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                          Mandatory Parameters: (alias_id || (alias_name && (address_id || (address_hostaddr && (space_id || space_name)))))", + "operationId": "ipam_alias_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit an IPv4 address alias", + "tags": [ + "ipam" + ] + } + }, + "/ipam/alias/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_alias_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                                                                                          .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv4 address, a unique numeric key value automatically incremented when you add an IPv4 address. Use the ID to specify the IPv4 address of your choice.", + "explode": true, + "in": "query", + "name": "address_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the aliases of an IPv4 address", + "tags": [ + "ipam" + ] + } + }, + "/ipam/alias6/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                                                                                                                          • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                            Mandatory Parameters: (alias6_name && (address6_id || (address6_hostaddr && (space_id || space_name))))", + "operationId": "ipam_alias6_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias6_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias6_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias6_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add an IPv6 address alias", + "tags": [ + "ipam" + ] + } + }, + "/ipam/alias6/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                                                                                                            To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                            Mandatory Parameters: (alias6_id || (alias6_name && (address6_id || (address6_hostaddr && (space_id || space_name)))))", + "operationId": "ipam_alias6_delete", + "parameters": [ + { + "description": "The IP address.", + "explode": true, + "in": "query", + "name": "address6_hostaddr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv6 address, a unique numeric key value automatically incremented when you add an IPv6 address. Use the ID to specify the IPv6 address of your choice.", + "explode": true, + "in": "query", + "name": "address6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the IPv6 address.", + "explode": true, + "in": "query", + "name": "alias6_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv6 alias, a unique numeric key value automatically incremented when you add an IPv6 alias. Use the ID to specify the IPv6 alias to of your choice.", + "explode": true, + "in": "query", + "name": "alias6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "explode": true, + "in": "query", + "name": "space_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the space.", + "explode": true, + "in": "query", + "name": "space_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The type of the alias.", + "explode": true, + "in": "query", + "name": "alias6_type", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias6_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias6_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete an IPv6 address alias", + "tags": [ + "ipam" + ] + } + }, + "/ipam/alias6/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                                                                                                                            • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                              Mandatory Parameters: (alias6_id || (alias6_name && (address6_id || (address6_hostaddr && (space_id || space_name)))))", + "operationId": "ipam_alias6_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias6_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias6_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias6_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit an IPv6 address alias", + "tags": [ + "ipam" + ] + } + }, + "/ipam/alias6/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_alias6_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                                                                                              .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv6 address, a unique numeric key value automatically incremented when you add an IPv6 address. Use the ID to specify the IPv6 address of your choice.", + "explode": true, + "in": "query", + "name": "address6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_alias6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the aliases of an IPv6 address", + "tags": [ + "ipam" + ] + } + }, + "/ipam/network/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                                                                                                                              • If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.Note that to add a block-type network, setting the input parameter subnet_level to 0 is mandatory.
                                                                                                                                                                                                                To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                                Mandatory Parameters: (network_addr && (network_end_addr || network_size || network_mask || network_prefix) && (space_id || space_name || parent_network_id))", + "operationId": "ipam_network_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add an IPv4 block/subnet-type network", + "tags": [ + "ipam" + ] + } + }, + "/ipam/network/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                                                                                                                To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                                Mandatory Parameters: (network_id || (network_addr && (network_end_addr || network_size || network_mask || network_prefix) && (space_id || space_name || parent_network_id)))", + "operationId": "ipam_network_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the parent IPv4 network. Use the ID to specify the parent IPv4 network of your choice.", + "explode": true, + "in": "query", + "name": "parent_network_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "explode": true, + "in": "query", + "name": "space_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the space.", + "explode": true, + "in": "query", + "name": "space_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The start IP address of the IPv4 network, its first IP address.", + "explode": true, + "in": "query", + "name": "network_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The end IP address of the IPv4 network, its last IP address.", + "explode": true, + "in": "query", + "name": "network_end_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv4 network, a unique numeric key value automatically incremented when you add an IPv4 network. Use the ID to specify the IPv4 network of your choice.", + "explode": true, + "in": "query", + "name": "network_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The netmask of the IPv4 network. It is expressed in dot-decimal notation and defines the number of addresses the network contains.", + "explode": true, + "in": "query", + "name": "network_mask", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The prefix of the IPv4 network, an integer that defines the number of addresses the network contains.", + "explode": true, + "in": "query", + "name": "network_prefix", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The size of the IPv4 network, the number of IP addresses it contains.", + "explode": true, + "in": "query", + "name": "network_size", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The position of the network within the hierarchy of networks of a VLSM organization. It calculates between 0 and n all the levels of the organization, its behavior depends on the value of the parameter use_reversed_relative_position:
                                                                                                                                                                                                                • use_reversed_relative_position=0 where 0 indicates a block-type network at the highest level possible, in a space-based organization, it belongs to the top space. The levels increment from 0 down to n, the lowest level you set up, within networks or spaces.
                                                                                                                                                                                                                • use_reversed_relative_position=1 where 1 indicates a network located at the lowest level of the organization, within networks or spaces. The levels increment from 0 up to n, the network at the highest level of the organization.
                                                                                                                                                                                                                ", + "explode": true, + "in": "query", + "name": "relative_position", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The level of the network within the space:
                                                                                                                                                                                                                • Set it to 0 for a block-type network.
                                                                                                                                                                                                                • Set it to a value between 1 and n for a subnet-type network.
                                                                                                                                                                                                                If you set a value between 2 and n, you are setting a network-based VLSM organization where non terminal subnet-type networks can contain other subnet-type networks.", + "explode": true, + "in": "query", + "name": "network_level", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the IPv4 network.", + "explode": true, + "in": "query", + "name": "network_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to determine if the calculation of the parameter relative_position should start from the top (0) or the bottom (1) of the VLSM organization.", + "explode": true, + "in": "query", + "name": "use_reversed_relative_position", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete an IPv4 block/subnet-type network", + "tags": [ + "ipam" + ] + } + }, + "/ipam/network/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                                                                                                                                • If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.Note that to add a block-type network, setting the input parameter subnet_level to 0 is mandatory.
                                                                                                                                                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                                  Mandatory Parameters: (network_id || (network_addr && (network_end_addr || network_size || network_mask || network_prefix) && (space_id || space_name || parent_network_id)))", + "operationId": "ipam_network_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit an IPv4 block/subnet-type network", + "tags": [ + "ipam" + ] + } + }, + "/ipam/network/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_network_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv4 network, a unique numeric key value automatically incremented when you add an IPv4 network. Use the ID to specify the IPv4 network of your choice.", + "explode": true, + "in": "query", + "name": "network_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of an IPv4 block/subnet-type network", + "tags": [ + "ipam" + ] + } + }, + "/ipam/network/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_network_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                                                                                                  .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the IPv4 block/subnet-type networks", + "tags": [ + "ipam" + ] + } + }, + "/ipam/network6/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                                                                                                                                  • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                                    Mandatory Parameters: (network6_addr && (network6_end_addr || network6_prefix) && (space_id || space_name || parent_network6_id))", + "operationId": "ipam_network6_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network6_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network6_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network6_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add an IPv6 block/subnet-type network", + "tags": [ + "ipam" + ] + } + }, + "/ipam/network6/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                                                                                                                    To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                                    Mandatory Parameters: (network6_id || (network6_addr && (network6_end_addr || network6_prefix) && (space_id || space_name || parent_network6_id)))", + "operationId": "ipam_network6_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the parent IPv6 network. Use the ID to specify the parent IPv6 network of your choice.", + "explode": true, + "in": "query", + "name": "parent_network6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "explode": true, + "in": "query", + "name": "space_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the space.", + "explode": true, + "in": "query", + "name": "space_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The start IP address of the IPv6 network, its first IP address.", + "explode": true, + "in": "query", + "name": "network6_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The end IP address of the IPv6 network, its last IP address.", + "explode": true, + "in": "query", + "name": "network6_end_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv6 network, a unique numeric key value automatically incremented when you add an IPv6 network. Use the ID to specify the IPv6 network of your choice.", + "explode": true, + "in": "query", + "name": "network6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The prefix of the IPv6 network, an integer that defines the number of address the network contains.", + "explode": true, + "in": "query", + "name": "network6_prefix", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The position of the network within the hierarchy of networks of a VLSM organization. It calculates between 0 and n all the levels of the organization, its behavior depends on the value of the parameter use_reversed_relative_position:
                                                                                                                                                                                                                    • use_reversed_relative_position=0 where 0 indicates a block-type network at the highest level possible, in a space-based organization, it belongs to the top space. The levels increment from 0 down to n, the lowest level you set up, within networks or spaces.
                                                                                                                                                                                                                    • use_reversed_relative_position=1 where 1 indicates a network located at the lowest level of the organization, within networks or spaces. The levels increment from 0 up to n, the network at the highest level of the organization.
                                                                                                                                                                                                                    ", + "explode": true, + "in": "query", + "name": "relative_position", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the IPv6 network.", + "explode": true, + "in": "query", + "name": "network6_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The level of the network within the space:
                                                                                                                                                                                                                    • Set it to 0 for a block-type network.
                                                                                                                                                                                                                    • Set it to a value between 1 and n for a subnet-type network.
                                                                                                                                                                                                                    If you set a value between 2 and n, you are setting a network-based VLSM organization where non terminal subnet-type networks can contain other subnet-type networks.", + "explode": true, + "in": "query", + "name": "network_level", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to determine if the calculation of the parameter relative_position should start from the top (0) or the bottom (1) of the VLSM organization.", + "explode": true, + "in": "query", + "name": "use_reversed_relative_position", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network6_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network6_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete an IPv6 block/subnet-type network", + "tags": [ + "ipam" + ] + } + }, + "/ipam/network6/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                                                                                                                                    • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                                      Mandatory Parameters: (network6_id || (network6_addr && (network6_end_addr || network6_prefix) && (space_id || space_name || parent_network6_id)))", + "operationId": "ipam_network6_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network6_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network6_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network6_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit an IPv6 block/subnet-type network", + "tags": [ + "ipam" + ] + } + }, + "/ipam/network6/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_network6_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv6 network, a unique numeric key value automatically incremented when you add an IPv6 network. Use the ID to specify the IPv6 network of your choice.", + "explode": true, + "in": "query", + "name": "network6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of an IPv6 block/subnet-type network", + "tags": [ + "ipam" + ] + } + }, + "/ipam/network6/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_network6_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                                                                                                      .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_network6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the IPv6 block/subnet-type networks", + "tags": [ + "ipam" + ] + } + }, + "/ipam/pool/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                                                                                                                                      • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                                        Mandatory Parameters: (pool_start_ip_addr && (pool_end_ip_addr || pool_size) && (network_id || space_id || space_name))", + "operationId": "ipam_pool_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add an IPv4 pool", + "tags": [ + "ipam" + ] + } + }, + "/ipam/pool/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                                                                                                                        To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                                        Mandatory Parameters: (pool_id || (pool_start_ip_addr && (pool_end_ip_addr || pool_size) && (network_id || space_id || space_name)))", + "operationId": "ipam_pool_delete", + "parameters": [ + { + "description": "The last IP address of the pool.", + "explode": true, + "in": "query", + "name": "pool_end_ip_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv4 pool, a unique numeric key value automatically incremented when you add an IPv4 pool. Use the ID to specify the IPv4 pool of your choice.", + "explode": true, + "in": "query", + "name": "pool_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The size of the pool, the number of IP addresses it contains.", + "explode": true, + "in": "query", + "name": "pool_size", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "explode": true, + "in": "query", + "name": "space_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the space.", + "explode": true, + "in": "query", + "name": "space_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The first IP address of the pool.", + "explode": true, + "in": "query", + "name": "pool_start_ip_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv4 network, a unique numeric key value automatically incremented when you add an IPv4 network. Use the ID to specify the IPv4 network of your choice.", + "explode": true, + "in": "query", + "name": "network_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete an IPv4 pool", + "tags": [ + "ipam" + ] + } + }, + "/ipam/pool/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                                                                                                                                        • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                                          Mandatory Parameters: (pool_id || (pool_start_ip_addr && (pool_end_ip_addr || pool_size) && (network_id || space_id || space_name)))", + "operationId": "ipam_pool_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit an IPv4 pool", + "tags": [ + "ipam" + ] + } + }, + "/ipam/pool/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_pool_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv4 pool, a unique numeric key value automatically incremented when you add an IPv4 pool. Use the ID to specify the IPv4 pool of your choice.", + "explode": true, + "in": "query", + "name": "pool_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of an IPv4 pool", + "tags": [ + "ipam" + ] + } + }, + "/ipam/pool/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_pool_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                                                                                                          .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the IPv4 pools", + "tags": [ + "ipam" + ] + } + }, + "/ipam/pool6/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                                                                                                                                          • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                                            Mandatory Parameters: (pool6_start_ip_addr && pool6_end_ip_addr && (network6_id || space_id || space_name))", + "operationId": "ipam_pool6_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool6_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool6_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool6_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add an IPv6 pool", + "tags": [ + "ipam" + ] + } + }, + "/ipam/pool6/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                                                                                                                            To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                                            Mandatory Parameters: (pool6_id || (pool6_start_ip_addr && pool6_end_ip_addr && (network6_id || space_id || space_name)))", + "operationId": "ipam_pool6_delete", + "parameters": [ + { + "description": "The last IP address of the pool.", + "explode": true, + "in": "query", + "name": "pool6_end_ip_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv6 pool, a unique numeric key value automatically incremented when you add an IPv6 pool. Use the ID to specify the IPv6 pool of your choice.", + "explode": true, + "in": "query", + "name": "pool6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "explode": true, + "in": "query", + "name": "space_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the space.", + "explode": true, + "in": "query", + "name": "space_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The first IP address of the pool.", + "explode": true, + "in": "query", + "name": "pool6_start_ip_addr", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv6 network, a unique numeric key value automatically incremented when you add an IPv6 network. Use the ID to specify the IPv6 network of your choice.", + "explode": true, + "in": "query", + "name": "network6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool6_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool6_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete an IPv6 pool", + "tags": [ + "ipam" + ] + } + }, + "/ipam/pool6/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                                                                                                                                            • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                                              Mandatory Parameters: (pool6_id || (pool6_start_ip_addr && pool6_end_ip_addr && (network6_id || space_id || space_name)))", + "operationId": "ipam_pool6_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool6_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool6_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool6_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit an IPv6 pool", + "tags": [ + "ipam" + ] + } + }, + "/ipam/pool6/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                                                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_pool6_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the IPv6 pool, a unique numeric key value automatically incremented when you add an IPv6 pool. Use the ID to specify the IPv6 pool of your choice.", + "explode": true, + "in": "query", + "name": "pool6_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of an IPv6 pool", + "tags": [ + "ipam" + ] + } + }, + "/ipam/pool6/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                                                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_pool6_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                                                                                                              .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_pool6_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the IPv6 pools", + "tags": [ + "ipam" + ] + } + }, + "/ipam/space/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                                                                                                                                              • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                                                Mandatory Parameters: space_name", + "operationId": "ipam_space_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_space_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_space_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_space_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a space", + "tags": [ + "ipam" + ] + } + }, + "/ipam/space/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                                                                                                                                To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                                                Mandatory Parameters: (space_id || space_name)", + "operationId": "ipam_space_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "explode": true, + "in": "query", + "name": "space_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the space.", + "explode": true, + "in": "query", + "name": "space_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_space_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_space_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a space", + "tags": [ + "ipam" + ] + } + }, + "/ipam/space/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                                                                                                                                                • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                                                  Mandatory Parameters: (space_id || space_name)", + "operationId": "ipam_space_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_space_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_space_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_space_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a space", + "tags": [ + "ipam" + ] + } + }, + "/ipam/space/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                                                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_space_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "explode": true, + "in": "query", + "name": "space_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_space_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a space", + "tags": [ + "ipam" + ] + } + }, + "/ipam/space/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                                                                                                                  To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "ipam_space_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                                                                                                                  .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ipam_space_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the spaces", + "tags": [ + "ipam" + ] + } + }, + "/vlan/domain/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                                                                                                                                                  • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                                                    Mandatory Parameters: domain_name", + "operationId": "vlan_domain_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_domain_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_domain_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_domain_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a VLAN domain", + "tags": [ + "vlan" + ] + } + }, + "/vlan/domain/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                                                                                                                                    To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                                                    Mandatory Parameters: (domain_id || domain_name)", + "operationId": "vlan_domain_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the VLAN domain, a unique numeric key value automatically incremented when you add a VLAN domain. Use the ID to specify the VLAN domain of your choice.", + "explode": true, + "in": "query", + "name": "domain_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the VLAN domain.", + "explode": true, + "in": "query", + "name": "domain_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_domain_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_domain_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a VLAN domain", + "tags": [ + "vlan" + ] + } + }, + "/vlan/domain/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                                                                                                                                                    • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                                                      Mandatory Parameters: (domain_id || domain_name)", + "operationId": "vlan_domain_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_domain_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_domain_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_domain_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a VLAN domain", + "tags": [ + "vlan" + ] + } + }, + "/vlan/domain/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                                                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "vlan_domain_info", + "parameters": [ + { + "description": "The database identifier (ID) of the VLAN domain, a unique numeric key value automatically incremented when you add a VLAN domain. Use the ID to specify the VLAN domain of your choice.", + "explode": true, + "in": "query", + "name": "domain_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_domain_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a VLAN domain", + "tags": [ + "vlan" + ] + } + }, + "/vlan/domain/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                                                                                                                      To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "vlan_domain_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                                                                                                                      .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_domain_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the VLAN domains", + "tags": [ + "vlan" + ] + } + }, + "/vlan/range/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                                                                                                                                                      • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                                                        Mandatory Parameters: (range_name && (domain_id || domain_name))", + "operationId": "vlan_range_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_range_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_range_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_range_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a VLAN range", + "tags": [ + "vlan" + ] + } + }, + "/vlan/range/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                                                                                                                                        To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                                                        Mandatory Parameters: (range_id || (range_name && (domain_id || domain_name)))", + "operationId": "vlan_range_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the VLAN domain, a unique numeric key value automatically incremented when you add a VLAN domain. Use the ID to specify the VLAN domain of your choice.", + "explode": true, + "in": "query", + "name": "domain_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the VLAN domain.", + "explode": true, + "in": "query", + "name": "domain_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the VLAN range, a unique numeric key value automatically incremented when you add a VLAN range. Use the ID to specify the VLAN range of your choice.", + "explode": true, + "in": "query", + "name": "range_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the VLAN range.", + "explode": true, + "in": "query", + "name": "range_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_range_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_range_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a VLAN range", + "tags": [ + "vlan" + ] + } + }, + "/vlan/range/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                                                                                                                                                        • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                                                          Mandatory Parameters: (range_id || (range_name && (domain_id || domain_name)))", + "operationId": "vlan_range_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_range_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_range_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_range_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a VLAN range", + "tags": [ + "vlan" + ] + } + }, + "/vlan/range/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                                                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "vlan_range_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the VLAN range, a unique numeric key value automatically incremented when you add a VLAN range. Use the ID to specify the VLAN range of your choice.", + "explode": true, + "in": "query", + "name": "range_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_range_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a VLAN range", + "tags": [ + "vlan" + ] + } + }, + "/vlan/range/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                                                                                                                          To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "vlan_range_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                                                                                                                          .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_range_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the VLAN ranges", + "tags": [ + "vlan" + ] + } + }, + "/vlan/vlan/add": { + "post": { + "description": "This service allows you to add objects. A call can only add one object.
                                                                                                                                                                                                                                          • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                                                            Mandatory Parameters: (vlan_vlan_id && (domain_id || domain_name))", + "operationId": "vlan_vlan_add", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_vlan_add_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_vlan_add_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_vlan_add_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Add a VLAN", + "tags": [ + "vlan" + ] + } + }, + "/vlan/vlan/delete": { + "delete": { + "description": "This service allows you to delete an object. A call can only delete one object.
                                                                                                                                                                                                                                            To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                                                            Mandatory Parameters: (vlan_id || (vlan_vlan_id && (domain_id || domain_name)))", + "operationId": "vlan_vlan_delete", + "parameters": [ + { + "description": "The database identifier (ID) of the VLAN domain, a unique numeric key value automatically incremented when you add a VLAN domain. Use the ID to specify the VLAN domain of your choice.", + "explode": true, + "in": "query", + "name": "domain_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the VLAN domain.", + "explode": true, + "in": "query", + "name": "domain_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the VLAN, a unique numeric key value automatically incremented when you add a VLAN. Use the ID to specify the VLAN of your choice.", + "explode": true, + "in": "query", + "name": "vlan_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The VLAN identifier (ID) of the VLAN, a unique numeric key value within a VLAN domain. Use the ID to specify the VLAN of your choice.", + "explode": true, + "in": "query", + "name": "vlan_vlan_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the VLAN range, a unique numeric key value automatically incremented when you add a VLAN range. Use the ID to specify the VLAN range of your choice.", + "explode": true, + "in": "query", + "name": "range_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The name of the VLAN range.", + "explode": true, + "in": "query", + "name": "range_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The name of the VLAN.", + "explode": true, + "in": "query", + "name": "vlan_name", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "explode": true, + "in": "query", + "name": "warnings", + "required": false, + "schema": { + "enum": [ + "accept" + ], + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_vlan_delete_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_vlan_delete_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Delete a VLAN", + "tags": [ + "vlan" + ] + } + }, + "/vlan/vlan/edit": { + "put": { + "description": "This service allows you to edit existing ones. A call can only edit one object.
                                                                                                                                                                                                                                            • If no identifier is specified, a new object is added.If an existing identifier is specified, the value of all the parameters specified in input edits the corresponding objects.To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.

                                                                                                                                                                                                                                              Mandatory Parameters: (vlan_id || (vlan_vlan_id && (domain_id || domain_name)))", + "operationId": "vlan_vlan_edit", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_vlan_edit_input" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_vlan_edit_success" + } + } + }, + "description": "successful object edition" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_vlan_edit_failed" + } + } + }, + "description": "error object edition" + } + }, + "summary": "Edit a VLAN", + "tags": [ + "vlan" + ] + } + }, + "/vlan/vlan/info": { + "get": { + "description": "This service allows you to display the properties of an object.
                                                                                                                                                                                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "vlan_vlan_info", + "parameters": [ + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The database identifier (ID) of the VLAN, a unique numeric key value automatically incremented when you add a VLAN. Use the ID to specify the VLAN of your choice.", + "explode": true, + "in": "query", + "name": "vlan_id", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_vlan_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "Display the properties of a VLAN", + "tags": [ + "vlan" + ] + } + }, + "/vlan/vlan/list": { + "get": { + "description": "This service allows you to list the objects.
                                                                                                                                                                                                                                              To execute this service, users must be granted the permission to use it. The rows returned to the user running the service depend on the resources granted to the group they belong to.", + "operationId": "vlan_vlan_list", + "parameters": [ + { + "description": "A clause that allows you to sort the result. You can include any output parameter of the service in this clause.To sort the result using class parameters, you must tag them first.You can add the optional keyword ASC (ascending) or DESC (descending) after each parameter. If not specified, ASC is used by default. The order of the parameters specified is set using their value's name or ordinal number. Each parameter value is compared from one row to the next. If all the parameters of the rows are equal, they are returned in an implementation-dependent order.", + "explode": true, + "in": "query", + "name": "orderby", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A statement that allows you to specify which column(s), i.e. parameter, is returned by the service.The statement can contain any output parameter of the service /list.If you specify several parameters they must be separated by a comma as follows: select=<param1>,<param2>,... .If the call includes the clause where, all the parameters it contains must be specified in the statement select.If the call includes the clause orderby, all the parameters it contains must be specified in the statement select.To include class parameters in the statement, you must tag them first.", + "explode": true, + "in": "query", + "name": "select", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "A clause that allows you to filter the result. You can include any output parameter of the service in this clause.To filter the result using class parameters, you must tag them first
                                                                                                                                                                                                                                              .The parameters and their value must be specified following the operators and syntax of the SQL standard, as in the following examples : <parameter>='<value>' or <parameter> IS NOT NULL. The clause is case insensitive and must be encoded in URL format.", + "explode": true, + "in": "query", + "name": "where", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + }, + { + "description": "The maximum number of results to be returned. Depending on the user resources and the database content, it can return less results than the value you have specified.The input parameter limit must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The number of rows to skip in the service output.The input parameter offset must be specified in lowercase.", + "explode": true, + "in": "query", + "name": "offset", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "A way to exclude the class parameter details of the parent of the object in the output parameter dedicated to its class parameters.", + "explode": true, + "in": "query", + "name": "no_parent_class_param", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "The list of class parameters to tag in the call, separated by a comma. Each parameter must be specified following the format ., e.g. site.decription .", + "explode": true, + "in": "query", + "name": "tags", + "required": false, + "schema": { + "type": "string" + }, + "style": "form" + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/vlan_vlan_data" + } + } + }, + "description": "successful operation" + }, + "400": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResponse" + } + } + }, + "description": "error executing the action" + } + }, + "summary": "List the VLANs", + "tags": [ + "vlan" + ] + } + } + }, + "components": { + "schemas": { + "dhcp_sharednetwork6_delete_success": { + "example": { + "data": [ + { + "sharednetwork6_id": "sharednetwork6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_sharednetwork6_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_scope6_data": { + "example": { + "data": [ + { + "scope6_delayed_time": "scope6_delayed_time", + "server6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_size": "scope6_size", + "server6_version": "server6_version", + "scope6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server6_name": "server6_name", + "scope6_prefix": "scope6_prefix", + "smart_parent_id": "smart_parent_id", + "scope6_sort_name": "scope6_sort_name", + "scope6_multistatus": "scope6_multistatus", + "failover6_name": "failover6_name", + "smart_parent_name": "smart_parent_name", + "smart_arch": "smart_arch", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "server6_type": "server6_type", + "scope6_space_name": "scope6_space_name", + "failover6_id": "failover6_id", + "server6_addr6": "server6_addr6", + "sharednetwork6_name": "sharednetwork6_name", + "server6_hostaddr": "server6_hostaddr", + "scope6_end_address6_addr": "scope6_end_address6_addr", + "server6_addr": "server6_addr", + "scope6_class_name": "scope6_class_name", + "scope6_name": "scope6_name", + "scope6_space_id": "scope6_space_id", + "scope6_id": "scope6_id", + "sharednetwork6_id": "sharednetwork6_id", + "scope6_start_address6_addr": "scope6_start_address6_addr" + }, + { + "scope6_delayed_time": "scope6_delayed_time", + "server6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_size": "scope6_size", + "server6_version": "server6_version", + "scope6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server6_name": "server6_name", + "scope6_prefix": "scope6_prefix", + "smart_parent_id": "smart_parent_id", + "scope6_sort_name": "scope6_sort_name", + "scope6_multistatus": "scope6_multistatus", + "failover6_name": "failover6_name", + "smart_parent_name": "smart_parent_name", + "smart_arch": "smart_arch", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "server6_type": "server6_type", + "scope6_space_name": "scope6_space_name", + "failover6_id": "failover6_id", + "server6_addr6": "server6_addr6", + "sharednetwork6_name": "sharednetwork6_name", + "server6_hostaddr": "server6_hostaddr", + "scope6_end_address6_addr": "scope6_end_address6_addr", + "server6_addr": "server6_addr", + "scope6_class_name": "scope6_class_name", + "scope6_name": "scope6_name", + "scope6_space_id": "scope6_space_id", + "scope6_id": "scope6_id", + "sharednetwork6_id": "sharednetwork6_id", + "scope6_start_address6_addr": "scope6_start_address6_addr" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_scope6_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_pool6_edit_input": { + "properties": { + "pool6_end_ip_addr": { + "description": "The last IP address of the pool.", + "type": "string" + }, + "pool6_id": { + "description": "The database identifier (ID) of the IPv6 pool, a unique numeric key value automatically incremented when you add an IPv6 pool. Use the ID to specify the IPv6 pool of your choice.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "pool6_start_ip_addr": { + "description": "The first IP address of the pool.", + "type": "string" + }, + "network6_id": { + "description": "The database identifier (ID) of the IPv6 network, a unique numeric key value automatically incremented when you add an IPv6 network. Use the ID to specify the IPv6 network of your choice.", + "type": "integer" + }, + "pool6_name": { + "description": "The name of the IPv6 pool, each IPv6 pool must have a unique name.", + "type": "string" + }, + "pool6_read_only": { + "description": "The reservation status of the IPv6 pool. If set 1, the IP addresses it contains cannot be assigned.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "pool6_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "pool6_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_data_inner_ipam_network_delete_success": { + "example": { + "network_id": "network_id" + }, + "properties": { + "network_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_ipam_network_delete_success", + "type": "object" + }, + "_data_inner_dhcp_range_data": { + "example": { + "range_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_name": "range_name", + "server_name": "server_name", + "range_lease_count": "range_lease_count", + "sharednetwork_id": "sharednetwork_id", + "server_class_name": "server_class_name", + "scope_start_address_addr": "scope_start_address_addr", + "server_version": "server_version", + "range_size": "range_size", + "scope_name": "scope_name", + "range_id": "range_id", + "range_lease_percent": "range_lease_percent", + "smart_parent_id": "smart_parent_id", + "scope_id": "scope_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope_if_name": "scope_if_name", + "smart_parent_name": "smart_parent_name", + "scope_size": "scope_size", + "range_delayed_create_time": "range_delayed_create_time", + "range_delayed_delete_time": "range_delayed_delete_time", + "server_comment": "server_comment", + "range_end_addr": "range_end_addr", + "scope_if_addr": "scope_if_addr", + "range_state": "range_state", + "sharednetwork_name": "sharednetwork_name", + "server_id": "server_id", + "server_addr": "server_addr", + "scope_net_mask": "scope_net_mask", + "server_hostaddr": "server_hostaddr", + "scope_net_addr": "scope_net_addr", + "server_addr6": "server_addr6", + "range_start_addr": "range_start_addr", + "range_class_name": "range_class_name", + "range_failover_name": "range_failover_name", + "scope_space_id": "scope_space_id", + "scope_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_multistatus": "range_multistatus", + "range_start_address_addr": "range_start_address_addr", + "range_end_address_addr": "range_end_address_addr", + "server_type": "server_type", + "range_acl": "range_acl", + "scope_class_name": "scope_class_name" + }, + "properties": { + "range_delayed_create_time": { + "description": "The delay of creation status. 1 indicates that the object is not created yet.", + "type": "string" + }, + "range_delayed_delete_time": { + "description": "The delay of deletion status. 1 indicates that the object is not deleted yet.", + "type": "string" + }, + "server_class_name": { + "description": "The name of the class applied to the DHCPv4 server the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "server_class_parameters": { + "description": "The class parameters applied to the DHCPv4 server the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "server_comment": { + "description": "The description of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_name": { + "description": "The name of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_type": { + "description": "The type of the DHCPv4 server the object belongs to:


                                                                                                                                                                                                                                              server_type possible values
                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                              ipmEfficientIP or EfficientIP Package server
                                                                                                                                                                                                                                              msrpcMicrosoft Windows DHCP server
                                                                                                                                                                                                                                              vdhcpEfficientIP DHCPv4 smart architecture


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "server_version": { + "description": "The version details of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "range_acl": { + "description": "The list of ACLs associated with the DHCPv4 range, as follows: <ACL_name>;<ACL_name>;... .", + "type": "string" + }, + "range_class_name": { + "description": "The name of the class applied to the DHCPv4 range, it can be preceded by the class directory.", + "type": "string" + }, + "range_class_parameters": { + "description": "The class parameters applied to the DHCPv4 range.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "range_end_addr": { + "description": "The last IP address of the DHCPv4 range.", + "type": "string" + }, + "range_end_address_addr": { + "description": "The last IP address of the DHCPv4 range, in hexadecimal format.", + "type": "string" + }, + "range_failover_name": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "range_id": { + "description": "The database identifier (ID) of the DHCPv4 range.", + "type": "string" + }, + "range_lease_count": { + "description": "The total number of leases currently delivered by the DHCPv4 range.", + "type": "string" + }, + "range_lease_percent": { + "description": "The percentage of leases currently delivered by the DHCPv4 range.", + "type": "string" + }, + "range_name": { + "description": "The start and end IP address of the DHCPv4 range, range_start_addr and range_end_addr, as follows: <start-ip>-<end-ip>.", + "type": "string" + }, + "range_size": { + "description": "The number of IP addresses the DHCPv4 range contains.", + "type": "string" + }, + "range_start_addr": { + "description": "The first IP address of the DHCPv4 range.", + "type": "string" + }, + "range_start_address_addr": { + "description": "The first IP address of the DHCPv4 range, in hexadecimal format.", + "type": "string" + }, + "range_state": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "scope_class_name": { + "description": "The name of the class applied to the DHCPv4 scope the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "scope_class_parameters": { + "description": "The class parameters applied to the DHCPv4 scope the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "scope_id": { + "description": "The database identifier (ID) of the DHCPv4 scope the object belongs to.", + "type": "string" + }, + "scope_if_addr": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "scope_if_name": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "scope_name": { + "description": "The name of the DHCPv4 scope the object belongs to.", + "type": "string" + }, + "scope_net_addr": { + "description": "The first IP address of the DHCPv4 scope the object belongs.", + "type": "string" + }, + "scope_net_mask": { + "description": "The netmask of the DHCPv4 scope the object belongs to. It is expressed in dot-decimal notation and defines the number of addresses the scope contains.", + "type": "string" + }, + "scope_space_id": { + "description": "The database identifier (ID) of the space associated with the DHCPv4 scope the object belongs to.", + "type": "string" + }, + "scope_size": { + "description": "The number of IP addresses the DHCPv4 scope the object belongs to contains.", + "type": "string" + }, + "scope_start_address_addr": { + "description": "The first IP address of the DHCPv4 scope the object belongs to, in hexadecimal format.", + "type": "string" + }, + "sharednetwork_id": { + "description": "The database identifier (ID) of the DHCPv4 shared network the object belongs to.", + "type": "string" + }, + "sharednetwork_name": { + "description": "The name of the DHCPv4 shared network the object belongs to.", + "type": "string" + }, + "server_hostaddr": { + "description": "The human readable version of the parameter server_addr or server_addr6.", + "type": "string" + }, + "server_addr6": { + "description": "The Management IP address of the DHCPv4 server the object belongs to, the IPv6 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "server_addr": { + "description": "The Management IP address of the DHCPv4 server the object belongs to, the IPv4 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "range_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                                                                                                                              Multi-status severity levels
                                                                                                                                                                                                                                              Message number Severity Description
                                                                                                                                                                                                                                              0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                                                                                                                              17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                                                                                                                              34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                                                                                                                              51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                                                                                                                              67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                                                                                                                              84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_name": { + "description": "The name of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. # indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_range_data", + "type": "object" + }, + "dhcp_sharednetwork_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_sharednetwork_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_ipam_address_add_success": { + "example": { + "address_id": "address_id" + }, + "properties": { + "address_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_ipam_address_add_success", + "type": "object" + }, + "ipam_pool_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_pool_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_ipam_network_edit_success": { + "example": { + "network_id": "network_id" + }, + "properties": { + "network_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_ipam_network_edit_success", + "type": "object" + }, + "_data_inner_vlan_domain_add_success": { + "example": { + "domain_id": "domain_id" + }, + "properties": { + "domain_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_vlan_domain_add_success", + "type": "object" + }, + "ipam_address_data": { + "example": { + "data": [ + { + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "address_alias": "address_alias", + "network_is_terminal": "network_is_terminal", + "pool_class_name": "pool_class_name", + "free_end_address_addr": "free_end_address_addr", + "address_class_name": "address_class_name", + "address_operation_details_last_updated_on": "address_operation_details_last_updated_on", + "space_class_name": "space_class_name", + "port_portnumber": "port_portnumber", + "network_start_hostaddr": "network_start_hostaddr", + "space_description": "space_description", + "parent_network_end_hostaddr": "parent_network_end_hostaddr", + "device_id": "device_id", + "network_size": "network_size", + "tag_container_dhcpstatic": "tag_container_dhcpstatic", + "port_ifvlan": "port_ifvlan", + "space_is_template": "space_is_template", + "address_id": "address_id", + "network_name": "network_name", + "parent_network_class_name": "parent_network_class_name", + "network_id": "network_id", + "address_operation_details_requested_by": "address_operation_details_requested_by", + "address_operation_details_added_by": "address_operation_details_added_by", + "space_name": "space_name", + "network_start_address_addr": "network_start_address_addr", + "pool_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "address_operation_details_added_on": "address_operation_details_added_on", + "network_class_name": "network_class_name", + "free_start_address_addr": "free_start_address_addr", + "address_hostaddr": "address_hostaddr", + "interface_name": "interface_name", + "pool_start_address_addr": "pool_start_address_addr", + "network_end_hostaddr": "network_end_hostaddr", + "address_multistatus": "address_multistatus", + "address_name": "address_name", + "port_slotnumber": "port_slotnumber", + "parent_network_name": "parent_network_name", + "free_scope_size": "free_scope_size", + "tag_pool_dhcprange": "tag_pool_dhcprange", + "address_operation_details_call_stack": "address_operation_details_call_stack", + "device_name": "device_name", + "parent_network_start_hostaddr": "parent_network_start_hostaddr", + "address_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "parent_network_size": "parent_network_size", + "pool_end_address_addr": "pool_end_address_addr", + "parent_vlsm_network_id": "parent_vlsm_network_id", + "dev_name": "dev_name", + "network_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "address_addr": "address_addr", + "network_lock_network_broadcast": "network_lock_network_broadcast", + "address_type": "address_type", + "address_operation_details_origin_module": "address_operation_details_origin_module", + "static_id": "static_id", + "pool_size": "pool_size", + "pool_read_only": "pool_read_only", + "address_mac_addr": "address_mac_addr", + "pool_id": "pool_id", + "address_mac_last_seen": "address_mac_last_seen", + "parent_network_start_address_addr": "parent_network_start_address_addr", + "pool_name": "pool_name", + "dev_id": "dev_id", + "port_name": "port_name", + "lease_end_time": "lease_end_time", + "interface_id": "interface_id", + "parent_network_id": "parent_network_id", + "space_id": "space_id", + "network_end_address_addr": "network_end_address_addr", + "lease_id": "lease_id", + "parent_network_end_address_addr": "parent_network_end_address_addr" + }, + { + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "address_alias": "address_alias", + "network_is_terminal": "network_is_terminal", + "pool_class_name": "pool_class_name", + "free_end_address_addr": "free_end_address_addr", + "address_class_name": "address_class_name", + "address_operation_details_last_updated_on": "address_operation_details_last_updated_on", + "space_class_name": "space_class_name", + "port_portnumber": "port_portnumber", + "network_start_hostaddr": "network_start_hostaddr", + "space_description": "space_description", + "parent_network_end_hostaddr": "parent_network_end_hostaddr", + "device_id": "device_id", + "network_size": "network_size", + "tag_container_dhcpstatic": "tag_container_dhcpstatic", + "port_ifvlan": "port_ifvlan", + "space_is_template": "space_is_template", + "address_id": "address_id", + "network_name": "network_name", + "parent_network_class_name": "parent_network_class_name", + "network_id": "network_id", + "address_operation_details_requested_by": "address_operation_details_requested_by", + "address_operation_details_added_by": "address_operation_details_added_by", + "space_name": "space_name", + "network_start_address_addr": "network_start_address_addr", + "pool_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "address_operation_details_added_on": "address_operation_details_added_on", + "network_class_name": "network_class_name", + "free_start_address_addr": "free_start_address_addr", + "address_hostaddr": "address_hostaddr", + "interface_name": "interface_name", + "pool_start_address_addr": "pool_start_address_addr", + "network_end_hostaddr": "network_end_hostaddr", + "address_multistatus": "address_multistatus", + "address_name": "address_name", + "port_slotnumber": "port_slotnumber", + "parent_network_name": "parent_network_name", + "free_scope_size": "free_scope_size", + "tag_pool_dhcprange": "tag_pool_dhcprange", + "address_operation_details_call_stack": "address_operation_details_call_stack", + "device_name": "device_name", + "parent_network_start_hostaddr": "parent_network_start_hostaddr", + "address_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "parent_network_size": "parent_network_size", + "pool_end_address_addr": "pool_end_address_addr", + "parent_vlsm_network_id": "parent_vlsm_network_id", + "dev_name": "dev_name", + "network_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "address_addr": "address_addr", + "network_lock_network_broadcast": "network_lock_network_broadcast", + "address_type": "address_type", + "address_operation_details_origin_module": "address_operation_details_origin_module", + "static_id": "static_id", + "pool_size": "pool_size", + "pool_read_only": "pool_read_only", + "address_mac_addr": "address_mac_addr", + "pool_id": "pool_id", + "address_mac_last_seen": "address_mac_last_seen", + "parent_network_start_address_addr": "parent_network_start_address_addr", + "pool_name": "pool_name", + "dev_id": "dev_id", + "port_name": "port_name", + "lease_end_time": "lease_end_time", + "interface_id": "interface_id", + "parent_network_id": "parent_network_id", + "space_id": "space_id", + "network_end_address_addr": "network_end_address_addr", + "lease_id": "lease_id", + "parent_network_end_address_addr": "parent_network_end_address_addr" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_address_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_static6_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_static6_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dhcp_server6_data": { + "example": { + "server6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server6_snmp_id": "server6_snmp_id", + "server6_version": "server6_version", + "smart_parent_arch": "smart_parent_arch", + "server6_state": "server6_state", + "smart_ref2_server6_id": "smart_ref2_server6_id", + "server6_stat_period": "server6_stat_period", + "server6_snmp_profile_id": "server6_snmp_profile_id", + "server6_multistatus": "server6_multistatus", + "server6_name": "server6_name", + "server6_stat_time": "server6_stat_time", + "server6_comment": "server6_comment", + "server6_snmp_timeout": "server6_snmp_timeout", + "smart_parent_id": "smart_parent_id", + "smart_parent_name": "smart_parent_name", + "smart_ref1_server6_id": "smart_ref1_server6_id", + "smart_arch": "smart_arch", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "server6_type": "server6_type", + "server6_snmp_port": "server6_snmp_port", + "server6_stat_niceness": "server6_stat_niceness", + "smart_ref1_server6_name": "smart_ref1_server6_name", + "smart_ref2_server6_name": "smart_ref2_server6_name", + "server6_synching": "server6_synching", + "server6_addr6": "server6_addr6", + "total_smart_members": "total_smart_members", + "server6_isolated": "server6_isolated", + "smart_param1": "smart_param1", + "server6_hostaddr": "server6_hostaddr", + "server6_last_refresh_time": "server6_last_refresh_time", + "server6_https_login": "server6_https_login", + "server6_uboottime": "server6_uboottime", + "server6_addr": "server6_addr", + "server6_snmp_retry": "server6_snmp_retry", + "smart_members_name": "smart_members_name", + "server6_snmp_use_tcp": "server6_snmp_use_tcp", + "connectionprofile_name": "connectionprofile_name", + "server6_is_package": "server6_is_package", + "reverse_proxy_conf": "reverse_proxy_conf", + "server6_stat_enabled": "server6_stat_enabled" + }, + "properties": { + "connectionprofile_name": { + "description": "The name of the connection profile used as connection method for the DHCPv6 server.", + "type": "string" + }, + "server6_class_name": { + "description": "The name of the class applied to the DHCPv6 server, it can be preceded by the class directory.", + "type": "string" + }, + "server6_class_parameters": { + "description": "The class parameters applied to the DHCPv6 server.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "server6_comment": { + "description": "The description of the DHCPv6 server.", + "type": "string" + }, + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server.", + "type": "string" + }, + "server6_last_refresh_time": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "server6_state": { + "description": "The status of the DHCPv6 server:


                                                                                                                                                                                                                                              server6_state possible values
                                                                                                                                                                                                                                              StatusDescription
                                                                                                                                                                                                                                              ERThe license used in SOLIDserver is not compliant with the added server: the license is invalid.
                                                                                                                                                                                                                                              ESThe server configuration could not be parsed properly.
                                                                                                                                                                                                                                              ETThe server does not answer anymore due to a scheduled configuration of the server.
                                                                                                                                                                                                                                              ISThere was a setting error during the server declaration. For instance, some settings were added to a server that does not support them or a smart architecture is not managing any physical server.
                                                                                                                                                                                                                                              ICThe SSL credentials are invalid
                                                                                                                                                                                                                                              IPThe account used to add the Microsoft Windows DHCP server does not have sufficient privileges to manage it.
                                                                                                                                                                                                                                              LSThe server configuration is not viable.
                                                                                                                                                                                                                                              NThe server does not have a status as it has not synchronized yet.
                                                                                                                                                                                                                                              YThe server is operational.


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "server6_synching": { + "description": "The synchronization status of the DHCPv6 server. 1 indicates that the server is currently being synchronized.", + "type": "string" + }, + "server6_type": { + "description": "The type of the DHCPv6 server:


                                                                                                                                                                                                                                              server6_type possible values
                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                              ipmEfficientIP or EfficientIP Package server
                                                                                                                                                                                                                                              vdhcpEfficientIP DHCPv6 smart architecture


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "server6_uboottime": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server6_version": { + "description": "The version details of the DHCPv6 server.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The human readable version of the parameter server6_addr or server6_addr6.", + "type": "string" + }, + "server6_addr6": { + "description": "The Management IP address of the DHCPv6 server, the IPv6 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "server6_addr": { + "description": "The Management IP address of the DHCPv6 server, the IPv4 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "server6_https_login": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server6_is_package": { + "description": "The DHCPv6 server package information. Y for an EfficientIP Package server, N for an appliance or virtual machine, U the package information is irrelevant. For servers with a server6_type set to ipm, U indicates either EfficientIP Packages or appliances/virtual machines.", + "type": "string" + }, + "server6_isolated": { + "description": "A way to determine if the server can update any other module (1).", + "type": "string" + }, + "server6_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                                                                                                                              Multi-status severity levels
                                                                                                                                                                                                                                              Message number Severity Description
                                                                                                                                                                                                                                              0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                                                                                                                              17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                                                                                                                              34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                                                                                                                              51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                                                                                                                              67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                                                                                                                              84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "reverse_proxy_conf": { + "description": "The URL of the HTTP(S) reverse proxy server that forwards client requests to the DHCPv6 server, if you configured one.", + "type": "string" + }, + "server6_snmp_id": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server6_snmp_port": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server6_snmp_profile_id": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server6_snmp_retry": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server6_snmp_timeout": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server6_snmp_use_tcp": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server6_stat_enabled": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server6_stat_niceness": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server6_stat_period": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server6_stat_time": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "total_smart_members": { + "description": "The total number of servers managed by the DHCPv6 smart architecture.", + "type": "string" + }, + "smart_arch": { + "description": "The type of the DHCPv6 smart architecture.


                                                                                                                                                                                                                                              smart_arch possible values
                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                              singleThe Single-Server smart architecture manages a single DHCPv6 server.
                                                                                                                                                                                                                                              splitscopeThe Split-Scope smart architecture sets a pair of DHCP servers in a configuration where the two scopes listen to the same subnet, but the range of addresses is divided.
                                                                                                                                                                                                                                              statelessThe Stateless smart architecture offers a limited number of options to the DHCP clients. The IP address is delivered thanks to the subnet gateway and it is impossible to create any ranges or statics or to retrieve any leases.


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "smart_members_name": { + "description": "The list of the servers managed by the DHCPv6 smart architecture, as follows: <dhcp6_name>,<dhcp6_name>,... .", + "type": "string" + }, + "smart_param1": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "smart_parent_arch": { + "description": "The type of the DHCPv6 smart architecture managing the DHCPv6 server. No value indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv6 smart architecture managing the DHCPv6 server. 0 indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_name": { + "description": "The name of the DHCPv6 smart architecture managing the DHCPv6 server. # indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_ref1_server6_id": { + "description": "The database identifier (ID) of the DHCPv6 smart architecture the server belongs to.", + "type": "string" + }, + "smart_ref1_server6_name": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "smart_ref2_server6_id": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "smart_ref2_server6_name": { + "description": "Internal use. Not documented.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_server6_data", + "type": "object" + }, + "dns_viewparam_edit_input": { + "properties": { + "view_id": { + "description": "The database identifier (ID) of the DNS view. Use the ID to specify the DNS view of your choice.", + "type": "integer" + }, + "viewparam_key": { + "description": "The name of the DNS option you want to add, edit or remove from the view. You can only set one option at a time.
                                                                                                                                                                                                                                              • To add or edit an option: specify its name in the parameter viewparam_key, as follows viewparam_key=<option-name>, and then specify its value in the parameter viewparam_value.
                                                                                                                                                                                                                                              • To remove an option, specify its name in the parameter viewparam_key and leave the parameter viewparam_value empty.
                                                                                                                                                                                                                                              To set several options, specify as many parameters (viewparam_key and viewparam_value) as you need.", + "type": "string" + }, + "viewparam_is_array": { + "description": "A way to determine is the DNS view option is an array (1).", + "type": "integer" + }, + "viewparam_value": { + "description": "The value of the DNS option specified in the input viewparam_key.
                                                                                                                                                                                                                                              • To add or edit an option value, specify its name in the parameter viewparam_key and set its value as follows: viewparam_value=<option-value> .
                                                                                                                                                                                                                                              • To remove an option value, specify its name in the parameter viewparam_key and leave viewparam_value empty: viewparam_value= .
                                                                                                                                                                                                                                              ", + "type": "string" + } + }, + "type": "object" + }, + "dns_acl_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_acl_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_alias_add_success": { + "example": { + "data": [ + { + "alias_id": "alias_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_alias_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_ipam_network6_add_success": { + "example": { + "network6_id": "network6_id" + }, + "properties": { + "network6_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_ipam_network6_add_success", + "type": "object" + }, + "ipam_address6_add_success": { + "example": { + "data": [ + { + "address6_id": "address6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_address6_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_scope_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_scope_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_static6_edit_input": { + "properties": { + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "type": "integer" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "static6_client_duid": { + "description": "The client DHCP Unique Identifier (DUID) associated with the DHCPv6 static.", + "type": "string" + }, + "static6_id": { + "description": "The database identifier (ID) of the DHCPv6 static, a unique numeric key value automatically incremented when you add a DHCPv6 static. Use the ID to specify the DHCPv6 static of your choice.", + "type": "integer" + }, + "static6_mac_addr": { + "description": "The MAC address you want to associate with the IPv6 static.", + "type": "string" + }, + "static6_name": { + "description": "The name of the DHCPv6 static, each DHCPv6 static must have a unique name.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "group6_id": { + "description": "The database identifier (ID) of the DHCPv6 group, a unique numeric key value automatically incremented when you add a DHCPv6 group. Use the ID to specify the DHCPv6 group of your choice.", + "type": "integer" + }, + "group6_name": { + "description": "The name of the DHCPv6 group.", + "type": "string" + }, + "static6_addr": { + "description": "The IP address associated with the DHCPv6 static.", + "type": "string" + }, + "static6_prefix6": { + "description": "The IP address of the delegated prefix of the DHCPv6 static.", + "type": "string" + }, + "static6_prefix6_addr": { + "description": "The prefix of the delegated prefix of the DHCPv6 static.", + "type": "string" + }, + "static6_prefix6_prefix": { + "description": "The IP address and prefix of the delegated prefix of the DHCPv6 static. You must specify them as follows: <IPv6-address>/<prefix>.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "static6_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "static6_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "vlan_domain_edit_input": { + "properties": { + "domain_id": { + "description": "The database identifier (ID) of the VLAN domain, a unique numeric key value automatically incremented when you add a VLAN domain. Use the ID to specify the VLAN domain of your choice.", + "type": "integer" + }, + "domain_name": { + "description": "The name of the VLAN domain, each VLAN domain must have a unique name.", + "type": "string" + }, + "domain_support_vxlan": { + "description": "The type of virtual network used by the domain. Set it to 1 to use VXLAN or 0 to use VLAN.", + "type": "integer" + }, + "domain_description": { + "description": "The description of the VLAN domain.", + "type": "string" + }, + "domain_end_vlan_id": { + "description": "The VLAN identifier (ID) of a VLAN, a numeric value between 1 and 4094. Use the ID to specify the last VLAN in the VLAN domain.", + "type": "integer" + }, + "domain_start_vlan_id": { + "description": "The VLAN identifier (ID) of a VLAN, a numeric value between 1 and 4094. Use the ID to specify the first VLAN in the VLAN domain.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "domain_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "domain_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "vlan_vlan_add_input": { + "properties": { + "domain_id": { + "description": "The database identifier (ID) of the VLAN domain, a unique numeric key value automatically incremented when you add a VLAN domain. Use the ID to specify the VLAN domain of your choice.", + "type": "integer" + }, + "domain_name": { + "description": "The name of the VLAN domain.", + "type": "string" + }, + "vlan_vlan_id": { + "description": "The VLAN identifier (ID) of the VLAN, a unique numeric key value within a VLAN domain. Use the ID to specify the VLAN of your choice.", + "type": "integer" + }, + "range_id": { + "description": "The database identifier (ID) of the VLAN range, a unique numeric key value automatically incremented when you add a VLAN range. Use the ID to specify the VLAN range of your choice.", + "type": "integer" + }, + "range_name": { + "description": "The name of the VLAN range.", + "type": "string" + }, + "vlan_name": { + "description": "The name of the VLAN, each VLAN must have a unique name.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "vlan_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "vlan_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dhcp_range_delete_success": { + "example": { + "data": [ + { + "range_id": "range_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_range_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_range6_edit_input": { + "properties": { + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "type": "integer" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "range6_end_addr": { + "description": "The last IP address of the DHCPv6 range.", + "type": "string" + }, + "range6_id": { + "description": "The database identifier (ID) of the DHCPv6 range, a unique numeric key value automatically incremented when you add a DHCPv6 range. Use the ID to specify the DHCPv6 range of your choice.", + "type": "integer" + }, + "range6_start_addr": { + "description": "The first IP address of the DHCPv6 range.", + "type": "string" + }, + "scope6_id": { + "description": "The database identifier (ID) of the DHCPv6 scope, a unique numeric key value automatically incremented when you add a DHCPv6 scope. Use the ID to specify the DHCPv6 scope of your choice.", + "type": "integer" + }, + "server6_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "range6_acl": { + "description": "The list of ACLs associated with the DHCPv6 range, as follows: <ACL_name>;<ACL_name>;... .", + "type": "string" + }, + "scope6_name": { + "description": "The name of the DHCPv6 scope.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "range6_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "range6_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "ipam_address6_add_input": { + "properties": { + "address6_hostaddr": { + "description": "The IP address.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "device_id": { + "description": "The database identifier (ID) of the Device Manager device you want to associate with the IP address.", + "type": "integer" + }, + "interface_id": { + "description": "The database identifier (ID) of the Device Manager interface you want to associate with the IP address.", + "type": "integer" + }, + "address6_mac_addr": { + "description": "The MAC address you want to associate with the IPv6 address.", + "type": "string" + }, + "address6_name": { + "description": "The name of the IPv6 address, each IPv6 address must have a unique name.", + "type": "string" + }, + "port_id": { + "description": "The database identifier (ID) of the NetChange port you want to associate with the IP address.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "address6_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "address6_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dhcp_range6_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_range6_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_group_data": { + "example": { + "data": [ + { + "server_name": "server_name", + "group_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "group_name": "group_name", + "server_class_name": "server_class_name", + "group_class_name": "group_class_name", + "group_multistatus": "group_multistatus", + "server_id": "server_id", + "server_version": "server_version", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "smart_parent_id": "smart_parent_id", + "group_id": "group_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "smart_parent_name": "smart_parent_name", + "group_delayed_create_time": "group_delayed_create_time", + "group_delayed_delete_time": "group_delayed_delete_time", + "server_type": "server_type" + }, + { + "server_name": "server_name", + "group_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "group_name": "group_name", + "server_class_name": "server_class_name", + "group_class_name": "group_class_name", + "group_multistatus": "group_multistatus", + "server_id": "server_id", + "server_version": "server_version", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "smart_parent_id": "smart_parent_id", + "group_id": "group_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "smart_parent_name": "smart_parent_name", + "group_delayed_create_time": "group_delayed_create_time", + "group_delayed_delete_time": "group_delayed_delete_time", + "server_type": "server_type" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_group_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_static6_edit_success": { + "example": { + "data": [ + { + "static6_id": "static6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_static6_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_scope6_add_success": { + "example": { + "data": [ + { + "scope6_id": "scope6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_scope6_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "vlan_range_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_vlan_range_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_ipam_network_add_success": { + "example": { + "network_id": "network_id" + }, + "properties": { + "network_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_ipam_network_add_success", + "type": "object" + }, + "ipam_alias6_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_alias6_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dns_acl_delete_success": { + "example": { + "acl_id": "acl_id" + }, + "properties": { + "acl_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_dns_acl_delete_success", + "type": "object" + }, + "dhcp_scope6_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_scope6_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_address6_edit_input": { + "properties": { + "address6_hostaddr": { + "description": "The IP address.", + "type": "string" + }, + "address6_id": { + "description": "The database identifier (ID) of the IPv6 address, a unique numeric key value automatically incremented when you add an IPv6 address. Use the ID to specify the IPv6 address of your choice.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "device_id": { + "description": "The database identifier (ID) of the Device Manager device you want to associate with the IP address.", + "type": "integer" + }, + "interface_id": { + "description": "The database identifier (ID) of the Device Manager interface you want to associate with the IP address.", + "type": "integer" + }, + "address6_mac_addr": { + "description": "The MAC address you want to associate with the IPv6 address.", + "type": "string" + }, + "address6_name": { + "description": "The name of the IPv6 address, each IPv6 address must have a unique name.", + "type": "string" + }, + "port_id": { + "description": "The database identifier (ID) of the NetChange port you want to associate with the IP address.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "address6_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "address6_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_data_inner_dhcp_static_data": { + "example": { + "server_name": "server_name", + "static_mac_vendor": "static_mac_vendor", + "sharednetwork_id": "sharednetwork_id", + "server_class_name": "server_class_name", + "group_class_name": "group_class_name", + "scope_start_address_addr": "scope_start_address_addr", + "server_version": "server_version", + "static_multistatus": "static_multistatus", + "scope_name": "scope_name", + "static_mac_addr": "static_mac_addr", + "static_delayed_create_time": "static_delayed_create_time", + "static_delayed_delete_time": "static_delayed_delete_time", + "smart_parent_id": "smart_parent_id", + "scope_id": "scope_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "smart_parent_name": "smart_parent_name", + "scope_size": "scope_size", + "static_last_seen": "static_last_seen", + "static_expire_time": "static_expire_time", + "scope_end_address_addr": "scope_end_address_addr", + "static_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "static_addr": "static_addr", + "group_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "group_name": "group_name", + "static_domain": "static_domain", + "static_id": "static_id", + "sharednetwork_name": "sharednetwork_name", + "static_class_name": "static_class_name", + "server_id": "server_id", + "scope_net_mask": "scope_net_mask", + "scope_net_addr": "scope_net_addr", + "group_id": "group_id", + "scope_space_id": "scope_space_id", + "scope_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "static_address_addr": "static_address_addr", + "static_name": "static_name", + "static_identifier": "static_identifier", + "server_type": "server_type", + "scope_class_name": "scope_class_name" + }, + "properties": { + "static_delayed_create_time": { + "description": "The delay of creation status. 1 indicates that the object is not created yet.", + "type": "string" + }, + "static_delayed_delete_time": { + "description": "The delay of deletion status. 1 indicates that the object is not deleted yet.", + "type": "string" + }, + "server_class_name": { + "description": "The name of the class applied to the DHCPv4 server the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "server_class_parameters": { + "description": "The class parameters applied to the DHCPv4 server the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_name": { + "description": "The name of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_type": { + "description": "The type of the DHCPv4 server the object belongs to:


                                                                                                                                                                                                                                              server_type possible values
                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                              ipmEfficientIP or EfficientIP Package server
                                                                                                                                                                                                                                              msrpcMicrosoft Windows DHCP server
                                                                                                                                                                                                                                              vdhcpEfficientIP DHCPv4 smart architecture


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "server_version": { + "description": "The version details of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "group_class_name": { + "description": "The name of the class applied to the DHCPv4 group the static belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "group_class_parameters": { + "description": "The class parameters applied to the DHCPv4 group the static belongs to,.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "group_id": { + "description": "The database identifier (ID) of the DHCPv4 group.", + "type": "string" + }, + "group_name": { + "description": "The name of the DHCPv4 group associated with the object.", + "type": "string" + }, + "static_addr": { + "description": "The IP address associated with the DHCPv4 static.", + "type": "string" + }, + "static_class_name": { + "description": "The name of the class applied to the DHCPv4 static, it can be preceded by the class directory.", + "type": "string" + }, + "static_class_parameters": { + "description": "The class parameters applied to the DHCPv4 static.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "static_domain": { + "description": "The domain name associated with the DHCPv4 static.", + "type": "string" + }, + "static_expire_time": { + "description": "The expiration time of the lease associated with the DHCPv4 static, in decimal UNIX date format.", + "type": "string" + }, + "static_id": { + "description": "The database identifier (ID) of the DHCPv4 static.", + "type": "string" + }, + "static_identifier": { + "description": "The host identifier of the DHCPv4 static, specified as follows: option <option-name> expected value.", + "type": "string" + }, + "static_address_addr": { + "description": "The IP address associated with the DHCPv4 static, in hexadecimal format.", + "type": "string" + }, + "static_last_seen": { + "description": "The last time the MAC address associated with the DHCPv4 static was seen on the network, in decimal UNIX date format.", + "type": "string" + }, + "static_mac_addr": { + "description": "The MAC address associated with the DHCPv4 static. It is composed of 7 sections, 00:11:22:33:44:55:66, where 00 is the MAC address type. The type 01 indicates Ethernet.", + "type": "string" + }, + "static_name": { + "description": "The name of the DHCPv4 static.", + "type": "string" + }, + "scope_class_name": { + "description": "The name of the class applied to the DHCPv4 scope the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "scope_class_parameters": { + "description": "The class parameters applied to the DHCPv4 scope the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "scope_end_address_addr": { + "description": "The last IP address of the DHCPv4 scope the object belongs to, in hexadecimal format.", + "type": "string" + }, + "scope_id": { + "description": "The database identifier (ID) of the DHCPv4 scope the object belongs to.", + "type": "string" + }, + "scope_name": { + "description": "The name of the DHCPv4 scope the object belongs to.", + "type": "string" + }, + "scope_net_addr": { + "description": "The first IP address of the DHCPv4 scope the object belongs.", + "type": "string" + }, + "scope_net_mask": { + "description": "The netmask of the DHCPv4 scope the object belongs to. It is expressed in dot-decimal notation and defines the number of addresses the scope contains.", + "type": "string" + }, + "scope_space_id": { + "description": "The database identifier (ID) of the space associated with the DHCPv4 scope the object belongs to.", + "type": "string" + }, + "scope_size": { + "description": "The number of IP addresses the DHCPv4 scope the object belongs to contains.", + "type": "string" + }, + "scope_start_address_addr": { + "description": "The first IP address of the DHCPv4 scope the object belongs to, in hexadecimal format.", + "type": "string" + }, + "sharednetwork_id": { + "description": "The database identifier (ID) of the DHCPv4 shared network the object belongs to.", + "type": "string" + }, + "sharednetwork_name": { + "description": "The name of the DHCPv4 shared network the object belongs to.", + "type": "string" + }, + "static_mac_vendor": { + "description": "The vendor details of the client associated with the DHCPv4 static.", + "type": "string" + }, + "static_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                                                                                                                              Multi-status severity levels
                                                                                                                                                                                                                                              Message number Severity Description
                                                                                                                                                                                                                                              0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                                                                                                                              17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                                                                                                                              34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                                                                                                                              51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                                                                                                                              67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                                                                                                                              84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_name": { + "description": "The name of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. # indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_static_data", + "type": "object" + }, + "ApiClassParameterInputEntry": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "ipam_address6_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_address6_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dhcp_server_data": { + "example": { + "server_stat_enabled": "server_stat_enabled", + "server_cisco_password": "server_cisco_password", + "server_uboottime": "server_uboottime", + "server_stat_time": "server_stat_time", + "server_ms_use_ssl": "server_ms_use_ssl", + "server_version": "server_version", + "server_stat_niceness": "server_stat_niceness", + "server_multistatus": "server_multistatus", + "service_address_addr": "service_address_addr", + "smart_parent_name": "smart_parent_name", + "server_localtime": "server_localtime", + "smart_ref2_server_id": "smart_ref2_server_id", + "cluster_ssh_keyring_id": "cluster_ssh_keyring_id", + "server_tcp_port": "server_tcp_port", + "server_snmp_timeout": "server_snmp_timeout", + "server_stat_period": "server_stat_period", + "server_windhcp_protocol": "server_windhcp_protocol", + "cluster_hb_hostaddr": "cluster_hb_hostaddr", + "server_ipmdhcp_protocol": "server_ipmdhcp_protocol", + "server_id": "server_id", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "connectionprofile_name": "connectionprofile_name", + "reverse_proxy_conf": "reverse_proxy_conf", + "cluster_peer_server_id": "cluster_peer_server_id", + "server_msrpc_login": "server_msrpc_login", + "cluster_vip_phys_hostaddr": "cluster_vip_phys_hostaddr", + "server_name": "server_name", + "smart_parent_arch": "smart_parent_arch", + "server_cisco_login": "server_cisco_login", + "server_class_name": "server_class_name", + "server_snmp_profile_id": "server_snmp_profile_id", + "smart_ref2_server_name": "smart_ref2_server_name", + "smart_ref1_server_name": "smart_ref1_server_name", + "server_snmp_use_tcp": "server_snmp_use_tcp", + "smart_parent_id": "smart_parent_id", + "server_cisco_use_ssh": "server_cisco_use_ssh", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_https_login": "server_https_login", + "server_cluster_role": "server_cluster_role", + "smart_arch": "smart_arch", + "server_cisco_root_password": "server_cisco_root_password", + "server_state": "server_state", + "server_comment": "server_comment", + "server_synching": "server_synching", + "smart_ref1_server_id": "smart_ref1_server_id", + "server_is_package": "server_is_package", + "server_snmp_port": "server_snmp_port", + "total_smart_members": "total_smart_members", + "server_isolated": "server_isolated", + "smart_param1": "smart_param1", + "server_msrpc_domain": "server_msrpc_domain", + "ref2_server_name": "ref2_server_name", + "server_snmp_retry": "server_snmp_retry", + "ref1_server_name": "ref1_server_name", + "server_snmp_id": "server_snmp_id", + "smart_members_name": "smart_members_name", + "server_type": "server_type" + }, + "properties": { + "server_cisco_login": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_cisco_password": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_cisco_root_password": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_cisco_use_ssh": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "cluster_hb_hostaddr": { + "description": "The IP address of the heartbeat of the server, a direct link between the servers of the cluster.", + "type": "string" + }, + "cluster_peer_server_id": { + "description": "The database identifier (ID) of the other server of the cluster.", + "type": "string" + }, + "server_cluster_role": { + "description": "The role of the server in the cluster, either active (M), passive (B) or N/A (#).", + "type": "string" + }, + "cluster_ssh_keyring_id": { + "description": "The database identifier (ID) of the SSH key dedicated to the cluster communication.", + "type": "string" + }, + "cluster_vip_phys_hostaddr": { + "description": "The local physical IP address of the VIP the cluster relies on.", + "type": "string" + }, + "connectionprofile_name": { + "description": "The name of the connection profile used as connection method for the DHCPv4 server.", + "type": "string" + }, + "server_class_name": { + "description": "The name of the class applied to the DHCPv4 server, it can be preceded by the class directory.", + "type": "string" + }, + "server_class_parameters": { + "description": "The class parameters applied to the DHCPv4 server.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "server_comment": { + "description": "The description of the DHCPv4 server.", + "type": "string" + }, + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server.", + "type": "string" + }, + "server_localtime": { + "description": "The local time on the DHCPv4 server, in decimal UNIX date format.", + "type": "string" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "server_state": { + "description": "The status of the DHCPv4 server:


                                                                                                                                                                                                                                              server_state possible values
                                                                                                                                                                                                                                              StatusDescription
                                                                                                                                                                                                                                              ERThe license used in SOLIDserver is not compliant with the added server: the license is invalid.
                                                                                                                                                                                                                                              ESThe server configuration could not be parsed properly.
                                                                                                                                                                                                                                              ETThe server does not answer anymore due to a scheduled configuration of the server.
                                                                                                                                                                                                                                              ISThere was a setting error during the server declaration. For instance, some settings were added to a server that does not support them or a smart architecture is not managing any physical server.
                                                                                                                                                                                                                                              ICThe SSL credentials are invalid
                                                                                                                                                                                                                                              IPThe account used to add the Microsoft Windows DHCP server does not have sufficient privileges to manage it.
                                                                                                                                                                                                                                              LSThe server configuration is not viable.
                                                                                                                                                                                                                                              NThe server does not have a status as it has not synchronized yet.
                                                                                                                                                                                                                                              YThe server is operational.


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "server_synching": { + "description": "The synchronization status of the DHCPv4 server. 1 indicates that the server is currently being synchronized.", + "type": "string" + }, + "server_type": { + "description": "The type of the DHCPv4 server:


                                                                                                                                                                                                                                              server_type possible values
                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                              ipmEfficientIP or EfficientIP Package server
                                                                                                                                                                                                                                              msrpcMicrosoft Windows DHCP server
                                                                                                                                                                                                                                              vdhcpEfficientIP DHCPv4 smart architecture


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "server_uboottime": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_version": { + "description": "The version details of the DHCPv4 server.", + "type": "string" + }, + "server_hostaddr": { + "description": "The human readable version of the parameter server_addr or server_addr6.", + "type": "string" + }, + "server_addr6": { + "description": "The Management IP address of the DHCPv4 server, the IPv6 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "server_addr": { + "description": "The Management IP address of the DHCPv4 server, the IPv4 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "server_https_login": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_is_package": { + "description": "The DHCPv4 server package information. Y for an EfficientIP Package server, N for an appliance or virtual machine, U the package information is irrelevant. For servers with a server_type set to ipm, U indicates either EfficientIP Packages or appliances/virtual machines.", + "type": "string" + }, + "server_ipmdhcp_protocol": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_isolated": { + "description": "A way to determine if the server can update any other module (1).", + "type": "string" + }, + "server_ms_use_ssl": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_msrpc_domain": { + "description": "The domain name of the Microsoft Windows DHCP server.", + "type": "string" + }, + "server_msrpc_login": { + "description": "The login of the Microsoft Windows DHCP server.", + "type": "string" + }, + "server_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                                                                                                                              Multi-status severity levels
                                                                                                                                                                                                                                              Message number Severity Description
                                                                                                                                                                                                                                              0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                                                                                                                              17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                                                                                                                              34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                                                                                                                              51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                                                                                                                              67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                                                                                                                              84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "ref1_server_name": { + "description": "The name of the Master or Single DHCPv4 server within the smart architecture.", + "type": "string" + }, + "ref2_server_name": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "reverse_proxy_conf": { + "description": "The URL of the HTTP(S) reverse proxy server that forwards client requests to the DHCPv4 server, if you configured one.", + "type": "string" + }, + "service_address_addr": { + "description": "The Service IP address of the DHCPv4 server, the IPv4 address configured when adding the server.", + "type": "string" + }, + "server_snmp_id": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_snmp_port": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_snmp_profile_id": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_snmp_retry": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_snmp_timeout": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_snmp_use_tcp": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_stat_enabled": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_stat_niceness": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_stat_period": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_stat_time": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_tcp_port": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "total_smart_members": { + "description": "The total number of servers managed by the DHCPv4 smart architecture.", + "type": "string" + }, + "smart_arch": { + "description": "The type of the DHCPv4 smart architecture:


                                                                                                                                                                                                                                              smart_arch possible values
                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                              masterslaveThe One-to-One smart architecture sets a pair of DHCP servers in a Master/Backup configuration.
                                                                                                                                                                                                                                              starThe One-to-Many smart architecture sets a multi-site failover configuration at the cost of n-servers+1.
                                                                                                                                                                                                                                              splitscopeThe Split-Scope smart architecture sets a pair of DHCP servers in a configuration where the two scopes listen to the same subnet, but the range of addresses is divided.
                                                                                                                                                                                                                                              singleThe Single-Server smart architecture manages a single DHCP server.


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "smart_members_name": { + "description": "The list of the servers managed by the DHCPv4 smart architecture, as follows: <dhcp_name>,<dhcp_name>,... .", + "type": "string" + }, + "smart_param1": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "smart_parent_arch": { + "description": "The type of the DHCPv4 smart architecture managing the DHCPv4 server. No value indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv4 smart architecture managing the DHCPv4 server. 0 indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_name": { + "description": "The name of the DHCPv4 smart architecture managing the DHCPv4 server. # indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_ref1_server_id": { + "description": "The database identifier (ID) of the DHCPv4 smart architecture the server belongs to.", + "type": "string" + }, + "smart_ref1_server_name": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "smart_ref2_server_id": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "smart_ref2_server_name": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_windhcp_protocol": { + "description": "Internal use. Not documented.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_server_data", + "type": "object" + }, + "_data_inner_dhcp_scope6_edit_success": { + "example": { + "scope6_id": "scope6_id" + }, + "properties": { + "scope6_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_scope6_edit_success", + "type": "object" + }, + "dhcp_sharednetwork_data": { + "example": { + "data": [ + { + "server_name": "server_name", + "smart_parent_id": "smart_parent_id", + "sharednetwork_multistatus": "sharednetwork_multistatus", + "sharednetwork_id": "sharednetwork_id", + "sharednetwork_name": "sharednetwork_name", + "server_id": "server_id", + "sharednetwork_delayed_create_time": "sharednetwork_delayed_create_time", + "sharednetwork_delayed_delete_time": "sharednetwork_delayed_delete_time", + "server_type": "server_type" + }, + { + "server_name": "server_name", + "smart_parent_id": "smart_parent_id", + "sharednetwork_multistatus": "sharednetwork_multistatus", + "sharednetwork_id": "sharednetwork_id", + "sharednetwork_name": "sharednetwork_name", + "server_id": "server_id", + "sharednetwork_delayed_create_time": "sharednetwork_delayed_create_time", + "sharednetwork_delayed_delete_time": "sharednetwork_delayed_delete_time", + "server_type": "server_type" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_sharednetwork_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dhcp_lease_data": { + "example": { + "range_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_name": "range_name", + "server_name": "server_name", + "lease_mac_addr": "lease_mac_addr", + "sharednetwork_id": "sharednetwork_id", + "server_class_name": "server_class_name", + "lease_vendor_id": "lease_vendor_id", + "server_version": "server_version", + "lease_addr": "lease_addr", + "percent": "percent", + "scope_name": "scope_name", + "range_id": "range_id", + "lease_name": "lease_name", + "smart_parent_id": "smart_parent_id", + "parameter_request_list": "parameter_request_list", + "scope_id": "scope_id", + "lease_circuit_id": "lease_circuit_id", + "lease_time": "lease_time", + "smart_parent_name": "smart_parent_name", + "server_cluster_role": "server_cluster_role", + "scope_size": "scope_size", + "lease_fingerbank_os": "lease_fingerbank_os", + "lease_address_addr": "lease_address_addr", + "lease_remote_id": "lease_remote_id", + "lease_first_time": "lease_first_time", + "lease_giaddr": "lease_giaddr", + "range_end_addr": "range_end_addr", + "time_to_expire": "time_to_expire", + "sharednetwork_name": "sharednetwork_name", + "lease_multistatus": "lease_multistatus", + "server_id": "server_id", + "server_addr": "server_addr", + "lease_clientname": "lease_clientname", + "lease_period": "lease_period", + "server_hostaddr": "server_hostaddr", + "scope_net_addr": "scope_net_addr", + "server_addr6": "server_addr6", + "lease_domain": "lease_domain", + "lease_end_time": "lease_end_time", + "range_start_addr": "range_start_addr", + "range_class_name": "range_class_name", + "range_failover_name": "range_failover_name", + "lease_mac_vendor": "lease_mac_vendor", + "lease_client_ident": "lease_client_ident", + "lease_id": "lease_id", + "server_type": "server_type", + "scope_class_name": "scope_class_name" + }, + "properties": { + "server_cluster_role": { + "description": "The role of the server the object belongs to in the cluster, either active (M), passive (B) or N/A (#).", + "type": "string" + }, + "server_class_name": { + "description": "The name of the class applied to the DHCPv4 server the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_name": { + "description": "The name of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_type": { + "description": "The type of the DHCPv4 server the object belongs to:


                                                                                                                                                                                                                                              server_type possible values
                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                              ipmEfficientIP or EfficientIP Package server
                                                                                                                                                                                                                                              msrpcMicrosoft Windows DHCP server
                                                                                                                                                                                                                                              vdhcpEfficientIP DHCPv4 smart architecture


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "server_version": { + "description": "The version details of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "lease_addr": { + "description": "The IP address associated with the DHCPv4 lease.", + "type": "string" + }, + "lease_circuit_id": { + "description": "The circuit identifier (ID) of the relay agent associated with the DHCPv4 lease.", + "type": "string" + }, + "lease_client_ident": { + "description": "The client identifier (ID) of the client associated with the DHCPv4 lease.", + "type": "string" + }, + "lease_clientname": { + "description": "The name of the client associated with the DHCPv4 lease.", + "type": "string" + }, + "lease_domain": { + "description": "The domain name associated with the DHCPv4 lease.", + "type": "string" + }, + "lease_end_time": { + "description": "The expiration time of the lease, in decimal UNIX date format.", + "type": "string" + }, + "lease_fingerbank_os": { + "description": "The operating system details of the client associated with the DHCPv4 lease.", + "type": "string" + }, + "lease_first_time": { + "description": "The first time the DHCPv4 lease has been attributed to the client, in decimal UNIX date format.", + "type": "string" + }, + "lease_giaddr": { + "description": "The gateway IP address of the relay agent of the DHCPv4 lease.", + "type": "string" + }, + "lease_id": { + "description": "The database identifier (ID) of the DHCPv4 lease.", + "type": "string" + }, + "lease_address_addr": { + "description": "The IP address associated with the DHCPv4 lease, in hexadecimal format.", + "type": "string" + }, + "lease_mac_addr": { + "description": "The MAC address associated with the IPv4 lease.", + "type": "string" + }, + "lease_name": { + "description": "The name of the DHCPv4 lease.", + "type": "string" + }, + "lease_period": { + "description": "The duration time (time to live) of the DHCPv4 lease, in seconds.", + "type": "string" + }, + "lease_remote_id": { + "description": "The remote identifier (ID) of the relay agent associated with the DHCPv4 lease.", + "type": "string" + }, + "lease_time": { + "description": "The last time the DHCPv4 lease has been attributed to the client, in decimal UNIX date format.", + "type": "string" + }, + "lease_vendor_id": { + "description": "The vendor class identifier (ID) of the client associated with the DHCPv4 lease.", + "type": "string" + }, + "range_class_name": { + "description": "The name of the class applied to the DHCPv4 range the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "range_class_parameters": { + "description": "The class parameters applied to the DHCPv4 range the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "range_end_addr": { + "description": "The last IP address of the DHCPv4 range the lease belongs to.", + "type": "string" + }, + "range_failover_name": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "range_id": { + "description": "The database identifier (ID) of the DHCPv4 range the object belongs to.", + "type": "string" + }, + "range_name": { + "description": "The start and end IP address of the DHCPv4 range the object belongs to, range_start_addr and range_end_addr, as follows: <start-ip>-<end-ip>.", + "type": "string" + }, + "range_start_addr": { + "description": "The first IP address of the DHCPv4 range the lease belongs to.", + "type": "string" + }, + "scope_class_name": { + "description": "The name of the class applied to the DHCPv4 scope the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "scope_id": { + "description": "The database identifier (ID) of the DHCPv4 scope the object belongs to.", + "type": "string" + }, + "scope_name": { + "description": "The name of the DHCPv4 scope the object belongs to.", + "type": "string" + }, + "scope_net_addr": { + "description": "The first IP address of the DHCPv4 scope the object belongs to.", + "type": "string" + }, + "scope_size": { + "description": "The number of IP addresses the DHCPv4 scope the object belongs to contains.", + "type": "string" + }, + "sharednetwork_id": { + "description": "The database identifier (ID) of the DHCPv4 shared network the object belongs to.", + "type": "string" + }, + "sharednetwork_name": { + "description": "The name of the DHCPv4 shared network the object belongs to.", + "type": "string" + }, + "server_hostaddr": { + "description": "The human readable version of the parameter server_addr or server_addr6.", + "type": "string" + }, + "server_addr6": { + "description": "The Management IP address of the DHCPv4 server the object belongs to, the IPv6 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "server_addr": { + "description": "The Management IP address of the DHCPv4 server the object belongs to, the IPv4 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "lease_mac_vendor": { + "description": "The vendor details of the client associated with the DHCPv4 lease.", + "type": "string" + }, + "lease_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                                                                                                                              Multi-status severity levels
                                                                                                                                                                                                                                              Message number Severity Description
                                                                                                                                                                                                                                              0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                                                                                                                              17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                                                                                                                              34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                                                                                                                              51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                                                                                                                              67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                                                                                                                              84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "parameter_request_list": { + "description": "The list of parameters requested with the DHCPv4 lease returned by the server, integers separated by a comma.", + "type": "string" + }, + "percent": { + "description": "The percentage of time the lease has really been in use.", + "type": "string" + }, + "time_to_expire": { + "description": "The time left to the lease before it expires, in seconds.", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_name": { + "description": "The name of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. # indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_lease_data", + "type": "object" + }, + "dhcp_scope_edit_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "scope_id": { + "description": "The database identifier (ID) of the DHCPv4 scope, a unique numeric key value automatically incremented when you add a DHCPv4 scope. Use the ID to specify the DHCPv4 scope of your choice.", + "type": "integer" + }, + "scope_net_addr": { + "description": "The first IP address of the DHCPv4 scope.", + "type": "string" + }, + "scope_net_mask": { + "description": "The netmask of the DHCPv4 scope. It is expressed in dot-decimal notation and defines the number of addresses the scope contains.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "failover_id": { + "description": "The database identifier (ID) of the DHCPv4 failover channel, a unique numeric key value automatically incremented when you add a DHCPv4 failover channel. Use the ID to specify the DHCPv4 failover channel of your choice.", + "type": "integer" + }, + "failover_name": { + "description": "The name of the DHCPv4 failover channel.", + "type": "string" + }, + "scope_name": { + "description": "The name of the DHCPv4 scope, each DHCPv4 scope must have a unique name.", + "type": "string" + }, + "scope_space_id": { + "description": "The database identifier (ID) of an existing space you want to associate with the DHCPv4 scope.", + "type": "integer" + }, + "scope_space_name": { + "description": "The name of an existing space you want to associate with the DHCPv4 scope.", + "type": "string" + }, + "sharednetwork_id": { + "description": "The database identifier (ID) of the DHCPv4 shared network, a unique numeric key value automatically incremented when you add a DHCPv4 shared network. Use the ID to specify the DHCPv4 shared network of your choice.", + "type": "integer" + }, + "sharednetwork_name": { + "description": "The name of the DHCPv4 shared network.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "scope_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "scope_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_data_inner_dhcp_static_add_success": { + "example": { + "static_id": "static_id" + }, + "properties": { + "static_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_static_add_success", + "type": "object" + }, + "ipam_pool6_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_pool6_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "vlan_vlan_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_vlan_vlan_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_sharednetwork6_add_success": { + "example": { + "data": [ + { + "sharednetwork6_id": "sharednetwork6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_sharednetwork6_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_group_delete_success": { + "example": { + "data": [ + { + "group_id": "group_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_group_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_network6_edit_input": { + "properties": { + "parent_network6_id": { + "description": "The database identifier (ID) of an existing IPv6 network you want to set as the parent of the IPv6 network you are editing. You can specify a subnet-type network to set up a network-based VLSM organization.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "network6_addr": { + "description": "The start IP address of the IPv6 network, its first IP address.", + "type": "string" + }, + "network6_end_addr": { + "description": "The end IP address of the IPv6 network, its last IP address.", + "type": "string" + }, + "network6_id": { + "description": "The database identifier (ID) of the IPv6 network, a unique numeric key value automatically incremented when you add an IPv6 network. Use the ID to specify the IPv6 network of your choice.", + "type": "integer" + }, + "network6_prefix": { + "description": "The prefix of the IPv6 network, an integer that defines the number of address the network contains.", + "type": "string" + }, + "allow_block6_creation": { + "description": "Internal use. Not documented.", + "type": "integer" + }, + "allow_tree_reparenting": { + "description": "A way to allow (1) or prevent (0) changing the parent of the network you are adding. Upon editing of the network, this parameter decides if you can associate it with a different parent network.", + "type": "integer" + }, + "network6_is_terminal": { + "description": "A way to determine if a network can contain other networks. If set to 1, the network is terminal and cannot contain other subnet-type networks. By essence, block-type networks are non-terminal and are always set to 0.", + "type": "integer" + }, + "network6_lock_network_broadcast": { + "description": "A way to prevent (1) users from assigning the broadcast IP address and network IP address of the network.", + "type": "integer" + }, + "permit_invalid": { + "description": "A way to authorize (1) IPv6 networks overlapping within a space.", + "type": "integer" + }, + "permit_no_block6": { + "description": "A way to force the creation of an IPv6 subnet-type network. If set to 1, you can create a subnet-type network even if no block-type network matching the start address exists.", + "type": "integer" + }, + "relative_position": { + "description": "The position of the network within the hierarchy of networks of a VLSM organization. It calculates between 0 and n all the levels of the organization, its behavior depends on the value of the parameter use_reversed_relative_position:
                                                                                                                                                                                                                                              • use_reversed_relative_position=0 where 0 indicates a block-type network at the highest level possible, in a space-based organization, it belongs to the top space. The levels increment from 0 down to n, the lowest level you set up, within networks or spaces.
                                                                                                                                                                                                                                              • use_reversed_relative_position=1 where 1 indicates a network located at the lowest level of the organization, within networks or spaces. The levels increment from 0 up to n, the network at the highest level of the organization.
                                                                                                                                                                                                                                              ", + "type": "integer" + }, + "row_state": { + "description": "The object activation status.
                                                                                                                                                                                                                                              • If set to 0, the object is present in the database but ignored, i.e. it cannot be managed, counted or listed. This status is applied on objects deleted from the GUI.
                                                                                                                                                                                                                                              • If set to 1, the object is enabled and managed.
                                                                                                                                                                                                                                              • If set to 2, the object is unmanaged, disabled or both depending on the context.
                                                                                                                                                                                                                                              By default, row_state is set to 1 when an object is created.", + "enum": [ + "1", + "2" + ], + "type": "string" + }, + "network6_name": { + "description": "The name of the IPv6 network, each IPv6 network must have a unique name.", + "type": "string" + }, + "network_level": { + "description": "The level of the network within the space:
                                                                                                                                                                                                                                              • Set it to 0 for a block-type network.
                                                                                                                                                                                                                                              • Set it to a value between 1 and n for a subnet-type network.
                                                                                                                                                                                                                                              If you set a value between 2 and n, you are setting a network-based VLSM organization where non terminal subnet-type networks can contain other subnet-type networks.", + "type": "integer" + }, + "use_reversed_relative_position": { + "description": "A way to determine if the calculation of the parameter relative_position should start from the top (0) or the bottom (1) of the VLSM organization.", + "type": "integer" + }, + "vlan_id": { + "description": "The database identifier (ID) of the VLAN you want to associate with the network.", + "type": "integer" + }, + "vlsm_space_id": { + "description": "The database identifier (ID) of a VLSM child space of the space specified in space_id. If you specify an ID, the subnet-type network you are editing is duplicated as a VLSM block-type network in the child space, with the same name but a different ID. This parameter serves the same purpose as vlsm_space_name.", + "type": "integer" + }, + "vlsm_space_name": { + "description": "The name of a VLSM child space of the space specified in space_id. If you specify a name, the subnet-type network you are editing is duplicated as a VLSM block-type network in the child space, with the same name but a different ID. This parameter serves the same purpose as vlsm_space_id.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "network6_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "network6_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dns_rr_data": { + "example": { + "data": [ + { + "rr_id": "rr_id", + "rr_value_ip4_addr": "rr_value_ip4_addr", + "server_version": "server_version", + "rr_auth_gsstsig": "rr_auth_gsstsig", + "rr_ttl": "rr_ttl", + "smart_parent_name": "smart_parent_name", + "rr_full_name_utf": "rr_full_name_utf", + "zone_space_name": "zone_space_name", + "zone_type": "zone_type", + "rr_all_value": "rr_all_value", + "view_class_name": "view_class_name", + "rr_type_id": "rr_type_id", + "rr_value1": "rr_value1", + "rr_value_id": "rr_value_id", + "server_id": "server_id", + "rr_glue_id": "rr_glue_id", + "rr_glue": "rr_glue", + "rr_name_id": "rr_name_id", + "rr_delayed_delete_time": "rr_delayed_delete_time", + "rr_last_update_time": "rr_last_update_time", + "zone_masters": "zone_masters", + "zone_is_reverse": "zone_is_reverse", + "view_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "rr_full_name": "rr_full_name", + "rr_last_update_days": "rr_last_update_days", + "server_name": "server_name", + "zone_sort_zone": "zone_sort_zone", + "zone_forwarders": "zone_forwarders", + "server_class_name": "server_class_name", + "zone_class_name": "zone_class_name", + "zone_name": "zone_name", + "rr_name_address_addr": "rr_name_address_addr", + "rr_value7": "rr_value7", + "zone_id": "zone_id", + "rr_value6": "rr_value6", + "rr_delayed_time": "rr_delayed_time", + "rr_class_name": "rr_class_name", + "smart_parent_id": "smart_parent_id", + "rr_value3": "rr_value3", + "rr_value2": "rr_value2", + "rr_value5": "rr_value5", + "rr_value4": "rr_value4", + "rr_type": "rr_type", + "server_cloud": "server_cloud", + "view_name": "view_name", + "server_comment": "server_comment", + "rr_value_address_addr": "rr_value_address_addr", + "view_id": "view_id", + "zone_is_rpz": "zone_is_rpz", + "rr_multistatus": "rr_multistatus", + "rr_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "zone_name_utf": "zone_name_utf", + "rr_name_ip4_addr": "rr_name_ip4_addr", + "rr_delayed_create_time": "rr_delayed_create_time", + "server_type": "server_type" + }, + { + "rr_id": "rr_id", + "rr_value_ip4_addr": "rr_value_ip4_addr", + "server_version": "server_version", + "rr_auth_gsstsig": "rr_auth_gsstsig", + "rr_ttl": "rr_ttl", + "smart_parent_name": "smart_parent_name", + "rr_full_name_utf": "rr_full_name_utf", + "zone_space_name": "zone_space_name", + "zone_type": "zone_type", + "rr_all_value": "rr_all_value", + "view_class_name": "view_class_name", + "rr_type_id": "rr_type_id", + "rr_value1": "rr_value1", + "rr_value_id": "rr_value_id", + "server_id": "server_id", + "rr_glue_id": "rr_glue_id", + "rr_glue": "rr_glue", + "rr_name_id": "rr_name_id", + "rr_delayed_delete_time": "rr_delayed_delete_time", + "rr_last_update_time": "rr_last_update_time", + "zone_masters": "zone_masters", + "zone_is_reverse": "zone_is_reverse", + "view_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "rr_full_name": "rr_full_name", + "rr_last_update_days": "rr_last_update_days", + "server_name": "server_name", + "zone_sort_zone": "zone_sort_zone", + "zone_forwarders": "zone_forwarders", + "server_class_name": "server_class_name", + "zone_class_name": "zone_class_name", + "zone_name": "zone_name", + "rr_name_address_addr": "rr_name_address_addr", + "rr_value7": "rr_value7", + "zone_id": "zone_id", + "rr_value6": "rr_value6", + "rr_delayed_time": "rr_delayed_time", + "rr_class_name": "rr_class_name", + "smart_parent_id": "smart_parent_id", + "rr_value3": "rr_value3", + "rr_value2": "rr_value2", + "rr_value5": "rr_value5", + "rr_value4": "rr_value4", + "rr_type": "rr_type", + "server_cloud": "server_cloud", + "view_name": "view_name", + "server_comment": "server_comment", + "rr_value_address_addr": "rr_value_address_addr", + "view_id": "view_id", + "zone_is_rpz": "zone_is_rpz", + "rr_multistatus": "rr_multistatus", + "rr_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "zone_name_utf": "zone_name_utf", + "rr_name_ip4_addr": "rr_name_ip4_addr", + "rr_delayed_create_time": "rr_delayed_create_time", + "server_type": "server_type" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_rr_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_static6_delete_success": { + "example": { + "data": [ + { + "static6_id": "static6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_static6_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_lease_data": { + "example": { + "data": [ + { + "range_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_name": "range_name", + "server_name": "server_name", + "lease_mac_addr": "lease_mac_addr", + "sharednetwork_id": "sharednetwork_id", + "server_class_name": "server_class_name", + "lease_vendor_id": "lease_vendor_id", + "server_version": "server_version", + "lease_addr": "lease_addr", + "percent": "percent", + "scope_name": "scope_name", + "range_id": "range_id", + "lease_name": "lease_name", + "smart_parent_id": "smart_parent_id", + "parameter_request_list": "parameter_request_list", + "scope_id": "scope_id", + "lease_circuit_id": "lease_circuit_id", + "lease_time": "lease_time", + "smart_parent_name": "smart_parent_name", + "server_cluster_role": "server_cluster_role", + "scope_size": "scope_size", + "lease_fingerbank_os": "lease_fingerbank_os", + "lease_address_addr": "lease_address_addr", + "lease_remote_id": "lease_remote_id", + "lease_first_time": "lease_first_time", + "lease_giaddr": "lease_giaddr", + "range_end_addr": "range_end_addr", + "time_to_expire": "time_to_expire", + "sharednetwork_name": "sharednetwork_name", + "lease_multistatus": "lease_multistatus", + "server_id": "server_id", + "server_addr": "server_addr", + "lease_clientname": "lease_clientname", + "lease_period": "lease_period", + "server_hostaddr": "server_hostaddr", + "scope_net_addr": "scope_net_addr", + "server_addr6": "server_addr6", + "lease_domain": "lease_domain", + "lease_end_time": "lease_end_time", + "range_start_addr": "range_start_addr", + "range_class_name": "range_class_name", + "range_failover_name": "range_failover_name", + "lease_mac_vendor": "lease_mac_vendor", + "lease_client_ident": "lease_client_ident", + "lease_id": "lease_id", + "server_type": "server_type", + "scope_class_name": "scope_class_name" + }, + { + "range_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_name": "range_name", + "server_name": "server_name", + "lease_mac_addr": "lease_mac_addr", + "sharednetwork_id": "sharednetwork_id", + "server_class_name": "server_class_name", + "lease_vendor_id": "lease_vendor_id", + "server_version": "server_version", + "lease_addr": "lease_addr", + "percent": "percent", + "scope_name": "scope_name", + "range_id": "range_id", + "lease_name": "lease_name", + "smart_parent_id": "smart_parent_id", + "parameter_request_list": "parameter_request_list", + "scope_id": "scope_id", + "lease_circuit_id": "lease_circuit_id", + "lease_time": "lease_time", + "smart_parent_name": "smart_parent_name", + "server_cluster_role": "server_cluster_role", + "scope_size": "scope_size", + "lease_fingerbank_os": "lease_fingerbank_os", + "lease_address_addr": "lease_address_addr", + "lease_remote_id": "lease_remote_id", + "lease_first_time": "lease_first_time", + "lease_giaddr": "lease_giaddr", + "range_end_addr": "range_end_addr", + "time_to_expire": "time_to_expire", + "sharednetwork_name": "sharednetwork_name", + "lease_multistatus": "lease_multistatus", + "server_id": "server_id", + "server_addr": "server_addr", + "lease_clientname": "lease_clientname", + "lease_period": "lease_period", + "server_hostaddr": "server_hostaddr", + "scope_net_addr": "scope_net_addr", + "server_addr6": "server_addr6", + "lease_domain": "lease_domain", + "lease_end_time": "lease_end_time", + "range_start_addr": "range_start_addr", + "range_class_name": "range_class_name", + "range_failover_name": "range_failover_name", + "lease_mac_vendor": "lease_mac_vendor", + "lease_client_ident": "lease_client_ident", + "lease_id": "lease_id", + "server_type": "server_type", + "scope_class_name": "scope_class_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_lease_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_alias6_delete_success": { + "example": { + "data": [ + { + "alias6_id": "alias6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_alias6_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_sharednetwork6_edit_input": { + "properties": { + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "type": "integer" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "sharednetwork6_id": { + "description": "The database identifier (ID) of the DHCPv6 shared network, a unique numeric key value automatically incremented when you add a DHCPv6 shared network. Use the ID to specify the DHCPv6 shared network of your choice.", + "type": "integer" + }, + "sharednetwork6_name": { + "description": "The name of the DHCPv6 shared network.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "ipam_space_edit_success": { + "example": { + "data": [ + { + "space_id": "space_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_space_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dns_viewparam_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_viewparam_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_alias_edit_success": { + "example": { + "data": [ + { + "alias_id": "alias_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_alias_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_vlan_range_delete_success": { + "example": { + "range_id": "range_id" + }, + "properties": { + "range_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_vlan_range_delete_success", + "type": "object" + }, + "_data_inner_dhcp_static_edit_success": { + "example": { + "static_id": "static_id" + }, + "properties": { + "static_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_static_edit_success", + "type": "object" + }, + "ipam_alias6_add_input": { + "properties": { + "address6_hostaddr": { + "description": "The IP address.", + "type": "string" + }, + "address6_id": { + "description": "The database identifier (ID) of the IPv6 address, a unique numeric key value automatically incremented when you add an IPv6 address. Use the ID to specify the IPv6 address of your choice.", + "type": "integer" + }, + "alias6_name": { + "description": "The name of the IPv6 address.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "alias6_type": { + "description": "The type of the alias.", + "enum": [ + "AAAA", + "aaaa", + "CNAME", + "cname" + ], + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dns_view_edit_success": { + "example": { + "data": [ + { + "view_id": "view_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_view_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "vlan_vlan_delete_success": { + "example": { + "data": [ + { + "vlan_id": "vlan_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_vlan_vlan_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "vlan_range_edit_success": { + "example": { + "data": [ + { + "range_id": "range_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_vlan_range_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dns_rr_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_rr_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_scope_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_scope_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_space_add_input": { + "properties": { + "space_name": { + "description": "The name of the space, each space must have a unique name.", + "type": "string" + }, + "parent_space_id": { + "description": "The database identifier (ID) of an existing space you want to set as the VLSM parent of the space you are adding. This sets up a space-based VLSM organization.", + "type": "integer" + }, + "parent_space_name": { + "description": "The name of an existing space you want to set as the VLSM parent of the space you are adding. This sets up a space-based VLSM organization.", + "type": "string" + }, + "space_description": { + "description": "The description of the space.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "space_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "space_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dns_view_delete_success": { + "example": { + "data": [ + { + "view_id": "view_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_view_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_network_data": { + "example": { + "data": [ + { + "range_name": "range_name", + "network_address_used_size": "network_address_used_size", + "vlan_id": "vlan_id", + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "vlsm_space_id": "vlsm_space_id", + "vlan_vlan_id": "vlan_vlan_id", + "network_is_terminal": "network_is_terminal", + "vlan_name": "vlan_name", + "parent_network_level": "parent_network_level", + "domain_id": "domain_id", + "vlsm_space_name": "vlsm_space_name", + "domain_name": "domain_name", + "network_ripe_waiting_status": "network_ripe_waiting_status", + "network_operation_details_call_stack": "network_operation_details_call_stack", + "network_operation_details_added_by": "network_operation_details_added_by", + "space_class_name": "space_class_name", + "network_start_hostaddr": "network_start_hostaddr", + "parent_space_id": "parent_space_id", + "space_description": "space_description", + "parent_network_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "network_address_used_percent": "network_address_used_percent", + "network_level": "network_level", + "network_size": "network_size", + "space_parent_space_id": "space_parent_space_id", + "space_is_template": "space_is_template", + "network_name": "network_name", + "parent_network_is_terminal": "parent_network_is_terminal", + "network_operation_details_requested_by": "network_operation_details_requested_by", + "network_operation_details_added_on": "network_operation_details_added_on", + "network_operation_details_origin_module": "network_operation_details_origin_module", + "parent_network_class_name": "parent_network_class_name", + "network_start_ip_addr": "network_start_ip_addr", + "network_address_free_size": "network_address_free_size", + "network_id": "network_id", + "space_name": "space_name", + "network_is_valid": "network_is_valid", + "parent_network_path": "parent_network_path", + "network_allocated_percent": "network_allocated_percent", + "parent_network_start_ip_addr": "parent_network_start_ip_addr", + "network_end_ip_addr": "network_end_ip_addr", + "network_class_name": "network_class_name", + "network_path": "network_path", + "network_end_hostaddr": "network_end_hostaddr", + "network_operation_details_last_updated_on": "network_operation_details_last_updated_on", + "vlsm_network_id": "vlsm_network_id", + "parent_network_name": "parent_network_name", + "range_id": "range_id", + "parent_network_size": "parent_network_size", + "network_used_size": "network_used_size", + "network_ripe_waiting_state": "network_ripe_waiting_state", + "parent_network_end_ip_addr": "parent_network_end_ip_addr", + "parent_vlsm_network_id": "parent_vlsm_network_id", + "parent_space_name": "parent_space_name", + "network_used_percent": "network_used_percent", + "network_is_in_orphan": "network_is_in_orphan", + "network_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "network_lock_network_broadcast": "network_lock_network_broadcast", + "network_multistatus": "network_multistatus", + "parent_network_id": "parent_network_id", + "vlsm_block_id": "vlsm_block_id", + "space_id": "space_id", + "network_allocated_size": "network_allocated_size" + }, + { + "range_name": "range_name", + "network_address_used_size": "network_address_used_size", + "vlan_id": "vlan_id", + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "vlsm_space_id": "vlsm_space_id", + "vlan_vlan_id": "vlan_vlan_id", + "network_is_terminal": "network_is_terminal", + "vlan_name": "vlan_name", + "parent_network_level": "parent_network_level", + "domain_id": "domain_id", + "vlsm_space_name": "vlsm_space_name", + "domain_name": "domain_name", + "network_ripe_waiting_status": "network_ripe_waiting_status", + "network_operation_details_call_stack": "network_operation_details_call_stack", + "network_operation_details_added_by": "network_operation_details_added_by", + "space_class_name": "space_class_name", + "network_start_hostaddr": "network_start_hostaddr", + "parent_space_id": "parent_space_id", + "space_description": "space_description", + "parent_network_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "network_address_used_percent": "network_address_used_percent", + "network_level": "network_level", + "network_size": "network_size", + "space_parent_space_id": "space_parent_space_id", + "space_is_template": "space_is_template", + "network_name": "network_name", + "parent_network_is_terminal": "parent_network_is_terminal", + "network_operation_details_requested_by": "network_operation_details_requested_by", + "network_operation_details_added_on": "network_operation_details_added_on", + "network_operation_details_origin_module": "network_operation_details_origin_module", + "parent_network_class_name": "parent_network_class_name", + "network_start_ip_addr": "network_start_ip_addr", + "network_address_free_size": "network_address_free_size", + "network_id": "network_id", + "space_name": "space_name", + "network_is_valid": "network_is_valid", + "parent_network_path": "parent_network_path", + "network_allocated_percent": "network_allocated_percent", + "parent_network_start_ip_addr": "parent_network_start_ip_addr", + "network_end_ip_addr": "network_end_ip_addr", + "network_class_name": "network_class_name", + "network_path": "network_path", + "network_end_hostaddr": "network_end_hostaddr", + "network_operation_details_last_updated_on": "network_operation_details_last_updated_on", + "vlsm_network_id": "vlsm_network_id", + "parent_network_name": "parent_network_name", + "range_id": "range_id", + "parent_network_size": "parent_network_size", + "network_used_size": "network_used_size", + "network_ripe_waiting_state": "network_ripe_waiting_state", + "parent_network_end_ip_addr": "parent_network_end_ip_addr", + "parent_vlsm_network_id": "parent_vlsm_network_id", + "parent_space_name": "parent_space_name", + "network_used_percent": "network_used_percent", + "network_is_in_orphan": "network_is_in_orphan", + "network_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "network_lock_network_broadcast": "network_lock_network_broadcast", + "network_multistatus": "network_multistatus", + "parent_network_id": "parent_network_id", + "vlsm_block_id": "vlsm_block_id", + "space_id": "space_id", + "network_allocated_size": "network_allocated_size" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_network_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_acl_delete_success": { + "example": { + "data": [ + { + "acl_id": "acl_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_acl_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dns_viewparam_data": { + "example": { + "data": [ + { + "server_name": "server_name", + "viewparam_key": "viewparam_key", + "viewparam_delayed_delete_time": "viewparam_delayed_delete_time", + "viewparam_delayed_create_time": "viewparam_delayed_create_time", + "viewparam_value": "viewparam_value", + "view_id": "view_id", + "oid": "oid", + "server_id": "server_id", + "view_name": "view_name" + }, + { + "server_name": "server_name", + "viewparam_key": "viewparam_key", + "viewparam_delayed_delete_time": "viewparam_delayed_delete_time", + "viewparam_delayed_create_time": "viewparam_delayed_create_time", + "viewparam_value": "viewparam_value", + "view_id": "view_id", + "oid": "oid", + "server_id": "server_id", + "view_name": "view_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_viewparam_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_view_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_view_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "vlan_range_add_success": { + "example": { + "data": [ + { + "range_id": "range_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_vlan_range_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dns_viewparam_delete_success": { + "example": { + "viewparam_id": "viewparam_id" + }, + "properties": { + "viewparam_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_dns_viewparam_delete_success", + "type": "object" + }, + "_data_inner_ipam_alias_edit_success": { + "example": { + "alias_id": "alias_id" + }, + "properties": { + "alias_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_ipam_alias_edit_success", + "type": "object" + }, + "vlan_range_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_vlan_range_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dhcp_group6_data": { + "example": { + "server6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server6_version": "server6_version", + "server6_addr6": "server6_addr6", + "group6_name": "group6_name", + "server6_hostaddr": "server6_hostaddr", + "group6_multistatus": "group6_multistatus", + "group6_delayed_time": "group6_delayed_time", + "group6_id": "group6_id", + "server6_name": "server6_name", + "server6_addr": "server6_addr", + "smart_parent_id": "smart_parent_id", + "smart_parent_name": "smart_parent_name", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "server6_type": "server6_type", + "group6_class_name": "group6_class_name", + "group6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ] + }, + "properties": { + "group6_delayed_time": { + "description": "The delay of creation/deletion status. 1 indicates that the object is not created/deleted yet.", + "type": "string" + }, + "server6_class_name": { + "description": "The name of the class applied to the DHCPv6 server the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "server6_class_parameters": { + "description": "The class parameters applied to the DHCPv6 server the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_name": { + "description": "The name of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_type": { + "description": "The type of the DHCPv6 server the object belongs to:


                                                                                                                                                                                                                                              server6_type possible values
                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                              ipmEfficientIP or EfficientIP Package server
                                                                                                                                                                                                                                              vdhcpEfficientIP DHCPv6 smart architecture


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "server6_version": { + "description": "The version details of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "group6_class_name": { + "description": "The name of the class applied to the DHCPv6 group, it can be preceded by the class directory.", + "type": "string" + }, + "group6_class_parameters": { + "description": "The class parameters applied to the DHCPv6 group.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "group6_id": { + "description": "The database identifier (ID) of the DHCPv6 group.", + "type": "string" + }, + "group6_name": { + "description": "The name of the DHCPv6 group.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The human readable version of the parameter server6_addr or server6_addr6.", + "type": "string" + }, + "server6_addr6": { + "description": "The Management IP address of the DHCPv6 server the object belongs to, the IPv6 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "server6_addr": { + "description": "The Management IP address of the DHCPv6 server the object belongs to, the IPv4 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "group6_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                                                                                                                              Multi-status severity levels
                                                                                                                                                                                                                                              Message number Severity Description
                                                                                                                                                                                                                                              0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                                                                                                                              17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                                                                                                                              34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                                                                                                                              51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                                                                                                                              67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                                                                                                                              84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv6 smart architecture managing the DHCPv6 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_name": { + "description": "The name of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. # indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_group6_data", + "type": "object" + }, + "vlan_domain_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_vlan_domain_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_zone_add_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "view_id": { + "description": "The database identifier (ID) of the DNS view the object belongs to.", + "type": "integer" + }, + "view_name": { + "description": "The name of the DNS view the object belongs to.", + "type": "string" + }, + "zone_name": { + "description": "The name of the DNS zone, each DNS zone must have a unique name. For hint zones (zone_type: hint), you must type in . (dot) as zone_name.", + "type": "string" + }, + "zone_type": { + "description": "The type of the DNS zone, either master, slave, forward, stub, hint or delegation-only.", + "enum": [ + "master", + "slave", + "hint", + "stub", + "forward", + "delegation-only" + ], + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DNS server.", + "type": "string" + }, + "server_ddns_scavenging": { + "description": "The DDNS scavenging status of the zone. Set it to 1 to enable the scavenging and automatically delete the stale resource records dynamically added via GSS-TSIG. DDNS scavenging is only effective if the parameters zone_use_update_policy and gss_enabled are set to 1, and the rule 416 is enabled in the GUI.", + "type": "integer" + }, + "zone_ad_integrated": { + "description": "The AD integrated status of the DNS zone. Set it to 1 to indicate that the DNS zone belongs to an Active Directory integrated Microsoft Windows DNS server.", + "type": "integer" + }, + "zone_allow_query": { + "description": "The ACL values associated with the allow-query configuration of the DNS zone, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "zone_allow_transfer": { + "description": "The ACL values associated with the allow-transfer configuration of the DNS zone, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "zone_allow_update": { + "description": "The ACL values associated with the allow-update configuration of the DNS zone, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "zone_also_notify": { + "description": "The IP address and port of the DNS server managing the smart architecture the DNS zone belongs to. If the parameter zone_notify is set to yes or explicit, the server specified is instantly notified of any slave zones updates.", + "type": "string" + }, + "zone_forward": { + "description": "The forwarding mode of the DNS zone.


                                                                                                                                                                                                                                              zone_forward possible values
                                                                                                                                                                                                                                              StatusDescription
                                                                                                                                                                                                                                              firstThe zone sends the queries to the forwarder(s). If no answer is returned, it attempts to answer the queries on its own.
                                                                                                                                                                                                                                              onlyThe zone only forwards the queries to the forwarder(s). Required by some reverse forward zones (e.g., in the case of private addresses).


                                                                                                                                                                                                                                              If the parameter has no value, it indicates that the forwarding is disabled.", + "enum": [ + "none", + "first", + "only", + "default" + ], + "type": "string" + }, + "zone_forwarders": { + "description": "The IP address(es) of the forwarder(s) associated with the DNS zone. It lists the DNS servers to which any unknown query on this zone should be sent, as follows: <ip_address1>;<ip_address2>;... .", + "type": "string" + }, + "zone_is_rpz": { + "description": "The RPZ status of the DNS zone. Set it to 1 to indicate that the DNS zone is a Response Policy Zone.", + "type": "integer" + }, + "zone_masters": { + "description": "For slave DNS zones, the IP address of the DNS server and, if relevant, the name of the DNS view that contain the master DNS zone, as follows: <ip_addr>; or <ip_addr> key <dnsview_name>; .", + "type": "string" + }, + "zone_notify": { + "description": "The notify status of the DNS zone.


                                                                                                                                                                                                                                              zone_notify possible values
                                                                                                                                                                                                                                              StatusDescription
                                                                                                                                                                                                                                              noNo notify message is sent.
                                                                                                                                                                                                                                              yesA notify message is sent to the name servers defined in the NS records of the zone and to the IP address(es) specified in the parameter .
                                                                                                                                                                                                                                              explicitA notify message is sent only to the IP address(es) specified in the parameter .


                                                                                                                                                                                                                                              The notify message is not sent to the server itself or to the primary server defined in the SOA record of the zone.", + "enum": [ + "yes", + "no", + "explicit" + ], + "type": "string" + }, + "zone_order": { + "description": "The level of the RPZ zone, where 0 represents the highest level in the views hierarchy. The RPZ rules of each zone are reviewed following this order. For non-RPZ zones, that have their parameter zone_is_rpz set to 0, you do not need to set this parameter.", + "type": "integer" + }, + "zone_response_policy": { + "description": "The response policy of the DNS zone. All the zones can be set with the policy given, only RPZ zones can be set with other policies.


                                                                                                                                                                                                                                              zone_response_policy possible values
                                                                                                                                                                                                                                              PolicyDescription
                                                                                                                                                                                                                                              givenAll the rules specified in the RPZ zone are applied normally.
                                                                                                                                                                                                                                              disabledThe RPZ zone rules configuration is not applied. All the rules it contains are ignored.
                                                                                                                                                                                                                                              passthruThe rules specified in the RPZ matching the listed RR names are ignored, no matter the RPZ zone they belong to.
                                                                                                                                                                                                                                              nxdomainThe rules specified in the RPZ return an NXDOMAIN response.
                                                                                                                                                                                                                                              nodataThe rules specified in the RPZ return a NODATA response.
                                                                                                                                                                                                                                              cname All the rules specified in the RPZ are redirected toward the specified domain name.


                                                                                                                                                                                                                                              You can only add RPZ zones on EfficientIP or BIND DNS servers.", + "type": "string" + }, + "zone_rpz_log": { + "description": "The RPZ logging status, if zone_is_rpz is set to 1 or yes. It allows you to log all the operations triggered by the RPZ rules of the zone.", + "type": "integer" + }, + "zone_rpz_max_policy_ttl": { + "description": "A way to set the number of seconds of the max policy Time To Live of the zone. By default, the parameter is empty, and the Server max policy TTL of the zone is of 5 seconds. It overrides the same option set at server level.", + "type": "integer" + }, + "zone_rpz_recursive_only": { + "description": "A way to Enable recursive-only on the server for the zone. By default it is enabled (1) and, for this zone, the server only processes policies on recursive queries. It overrides the same option set at server level.", + "type": "integer" + }, + "zone_space_id": { + "description": "The database identifier (ID) of the space associated with the DNS zone the record belongs to.", + "type": "integer" + }, + "zone_space_name": { + "description": "The name of the space associated with the DNS zone the record belongs to.", + "type": "string" + }, + "row_state": { + "description": "The object activation status.
                                                                                                                                                                                                                                              • If set to 0, the object is present in the database but ignored, i.e. it cannot be managed, counted or listed. This status is applied on objects deleted from the GUI.
                                                                                                                                                                                                                                              • If set to 1, the object is enabled and managed.
                                                                                                                                                                                                                                              • If set to 2, the object is unmanaged, disabled or both depending on the context.
                                                                                                                                                                                                                                              By default, row_state is set to 1 when an object is created.", + "type": "integer" + }, + "zone_use_update_policy": { + "description": "The update policy status of the DNS zone. Set it to 1 to indicate that the DNS zone uses a specific GSS-TSIG/update-policy. You can only configure the zone update policy if the parameter gss_enabled is set to 1.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "zone_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "zone_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dns_acl_add_success": { + "example": { + "data": [ + { + "acl_id": "acl_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_acl_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_alias_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_alias_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_pool6_add_input": { + "properties": { + "pool6_end_ip_addr": { + "description": "The last IP address of the pool.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "pool6_start_ip_addr": { + "description": "The first IP address of the pool.", + "type": "string" + }, + "network6_id": { + "description": "The database identifier (ID) of the IPv6 network, a unique numeric key value automatically incremented when you add an IPv6 network. Use the ID to specify the IPv6 network of your choice.", + "type": "integer" + }, + "pool6_name": { + "description": "The name of the IPv6 pool, each IPv6 pool must have a unique name.", + "type": "string" + }, + "pool6_read_only": { + "description": "The reservation status of the IPv6 pool. If set 1, the IP addresses it contains cannot be assigned.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "pool6_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "pool6_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dhcp_static6_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_static6_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_ipam_alias_delete_success": { + "example": { + "alias_id": "alias_id" + }, + "properties": { + "alias_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_ipam_alias_delete_success", + "type": "object" + }, + "_data_inner_dhcp_sharednetwork_add_success": { + "example": { + "sharednetwork_id": "sharednetwork_id" + }, + "properties": { + "sharednetwork_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_sharednetwork_add_success", + "type": "object" + }, + "_data_inner_dns_view_edit_success": { + "example": { + "view_id": "view_id" + }, + "properties": { + "view_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_dns_view_edit_success", + "type": "object" + }, + "_data_inner_dhcp_aclentry6_data": { + "example": { + "aclentry6_value": "aclentry6_value", + "smart_parent_id": "smart_parent_id", + "aclentry6_delayed_time": "aclentry6_delayed_time", + "acl6_id": "acl6_id", + "server_cluster_role": "server_cluster_role", + "aclentry6_id": "aclentry6_id", + "acl6_name": "acl6_name", + "server6_id": "server6_id", + "server6_type": "server6_type", + "server6_name": "server6_name" + }, + "properties": { + "server_cluster_role": { + "description": "The role of the server the object belongs to in the cluster, either active (M), passive (B) or N/A (#).", + "type": "string" + }, + "aclentry6_delayed_time": { + "description": "The delay of creation/deletion status. 1 indicates that the object is not created/deleted yet.", + "type": "string" + }, + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_name": { + "description": "The name of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_type": { + "description": "The type of the DHCPv6 server the object belongs to:


                                                                                                                                                                                                                                              server6_type possible values
                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                              ipmEfficientIP or EfficientIP Package server
                                                                                                                                                                                                                                              vdhcpEfficientIP DHCPv6 smart architecture


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "acl6_id": { + "description": "The database identifier (ID) of the DHCPv6 ACL.", + "type": "string" + }, + "acl6_name": { + "description": "The name of the DHCPv6 ACL.", + "type": "string" + }, + "aclentry6_id": { + "description": "The database identifier (ID) of the DHCPv6 ACL entry.", + "type": "string" + }, + "aclentry6_value": { + "description": "The value of the DHCPv6 ACL entry.", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv6 smart architecture managing the DHCPv6 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_aclentry6_data", + "type": "object" + }, + "ipam_alias_edit_input": { + "properties": { + "address_hostaddr": { + "description": "The IP address.", + "type": "string" + }, + "address_id": { + "description": "The database identifier (ID) of the IPv4 address, a unique numeric key value automatically incremented when you add an IPv4 address. Use the ID to specify the IPv4 address of your choice.", + "type": "integer" + }, + "alias_name": { + "description": "The name of the IPv4 alias.", + "type": "string" + }, + "alias_id": { + "description": "The database identifier (ID) of the IPv4 alias, a unique numeric key value automatically incremented when you add an IPv4 alias. Use the ID to specify the IPv4 alias of your choice.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "alias_type": { + "description": "The type of the alias.", + "enum": [ + "A", + "a", + "CNAME", + "cname" + ], + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_data_inner_ipam_pool6_delete_success": { + "example": { + "pool6_id": "pool6_id" + }, + "properties": { + "pool6_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_ipam_pool6_delete_success", + "type": "object" + }, + "ipam_address6_delete_success": { + "example": { + "data": [ + { + "address6_id": "address6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_address6_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_ipam_address6_data": { + "example": { + "parent_network6_class_name": "parent_network6_class_name", + "pool6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "address6_operation_details_added_on": "address6_operation_details_added_on", + "address6_multistatus": "address6_multistatus", + "address6_operation_details_added_by": "address6_operation_details_added_by", + "parent_network6_prefix": "parent_network6_prefix", + "space_class_name": "space_class_name", + "space_description": "space_description", + "address6_alias": "address6_alias", + "free_start_address6_addr": "free_start_address6_addr", + "address6_operation_details_call_stack": "address6_operation_details_call_stack", + "parent_network6_end_hostaddr": "parent_network6_end_hostaddr", + "network6_start_address6_addr": "network6_start_address6_addr", + "pool6_size": "pool6_size", + "parent_vlsm_network6_id": "parent_vlsm_network6_id", + "device_id": "device_id", + "network_size": "network_size", + "network6_is_terminal": "network6_is_terminal", + "vlsm_network6_id": "vlsm_network6_id", + "address6_type": "address6_type", + "pool6_id": "pool6_id", + "pool6_name": "pool6_name", + "space_name": "space_name", + "network6_id": "network6_id", + "network6_start_hostaddr": "network6_start_hostaddr", + "address6_operation_details_requested_by": "address6_operation_details_requested_by", + "pool6_end_address6_addr": "pool6_end_address6_addr", + "interface_name": "interface_name", + "network6_end_hostaddr": "network6_end_hostaddr", + "parent_network6_id": "parent_network6_id", + "network6_name": "network6_name", + "free_scope_size": "free_scope_size", + "free_end_address6_addr": "free_end_address6_addr", + "device_name": "device_name", + "address6_name": "address6_name", + "parent_network6_start_address6_addr": "parent_network6_start_address6_addr", + "parent_network6_start_hostaddr": "parent_network6_start_hostaddr", + "pool6_read_only": "pool6_read_only", + "pool6_class_name": "pool6_class_name", + "network6_end_address6_addr": "network6_end_address6_addr", + "address6_mac_addr": "address6_mac_addr", + "parent_space_name": "parent_space_name", + "network6_prefix": "network6_prefix", + "address6_id": "address6_id", + "network6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "parent_network6_size": "parent_network6_size", + "parent_network6_name": "parent_network6_name", + "parent_network6_end_address6_addr": "parent_network6_end_address6_addr", + "network6_lock_network_broadcast": "network6_lock_network_broadcast", + "address6_operation_details_last_updated_on": "address6_operation_details_last_updated_on", + "network6_size": "network6_size", + "interface_id": "interface_id", + "address6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "network6_class_name": "network6_class_name", + "address6_operation_details_origin_module": "address6_operation_details_origin_module", + "address6_addr": "address6_addr", + "address6_hostaddr": "address6_hostaddr", + "space_id": "space_id", + "address6_class_name": "address6_class_name", + "pool6_start_address6_addr": "pool6_start_address6_addr" + }, + "properties": { + "free_end_address6_addr": { + "description": "An IP address in hexadecimal format. For addresses In use (typeip6), it returns the IP address itself.For free addresses (typefree), it returns the last IP address of a range of IPv6 addresses that are not assigned yet. The first address in that range is returned in free_start_address6_addr.", + "type": "string" + }, + "free_scope_size": { + "description": "The number of IP addresses that are not assigned yet (typefree) between free_start_address6_addr and free_end_address6_addr.", + "type": "string" + }, + "free_start_address6_addr": { + "description": "An IP address in hexadecimal format. For addresses In use (typeip6), it returns the IP address itself.For free addresses (typefree), it returns the first IP address of a range of IPv6 addresses that are not assigned yet. The last address in that range is returned in free_end_address6_addr.", + "type": "string" + }, + "address6_hostaddr": { + "description": "The human readable version of the parameter address6_addr.", + "type": "string" + }, + "device_id": { + "description": "The database identifier (ID) of the Device Manager device associated with the IP address.", + "type": "string" + }, + "device_name": { + "description": "The name of the Device Manager device associated with the IP address.", + "type": "string" + }, + "interface_id": { + "description": "The database identifier (ID) of the Device Manager interface associated with the IP address.", + "type": "string" + }, + "interface_name": { + "description": "The name of the Device Manager interface associated with the IP address.", + "type": "string" + }, + "address6_addr": { + "description": "The IPv6 address itself.", + "type": "string" + }, + "address6_alias": { + "description": "The name of the IPv6 alias(es) associated with the IPv6 address.", + "type": "string" + }, + "address6_class_name": { + "description": "The name of the class applied to the IPv6 address, it can be preceded by the class directory.", + "type": "string" + }, + "address6_class_parameters": { + "description": "The class parameters applied to the IPv6 address.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "address6_id": { + "description": "The database identifier (ID) of the IPv6 address.", + "type": "string" + }, + "address6_mac_addr": { + "description": "The MAC address associated with the IPv6 address.", + "type": "string" + }, + "address6_name": { + "description": "The name of the IPv6 address.", + "type": "string" + }, + "network6_lock_network_broadcast": { + "description": "A way to prevent (1) users from assigning the broadcast IP address and network IP address of the network the IP address belongs to.", + "type": "string" + }, + "address6_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                                                                                                                              Multi-status severity levels
                                                                                                                                                                                                                                              Message number Severity Description
                                                                                                                                                                                                                                              0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                                                                                                                              17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                                                                                                                              34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                                                                                                                              51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                                                                                                                              67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                                                                                                                              84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "parent_space_name": { + "description": "The name of the space where is located the parent of the network the IPv6 address belongs to. # indicates that the network the IPv6 address belongs to has no parent network.", + "type": "string" + }, + "parent_network6_class_name": { + "description": "The name of the class applied to the parent of the IPv6 network the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "parent_network6_end_hostaddr": { + "description": "The human readable version of the parameter parent_network6_end_address6_addr.", + "type": "string" + }, + "parent_network6_end_address6_addr": { + "description": "The last IP address of the parent of the IPv6 network the IP address belongs to.", + "type": "string" + }, + "parent_network6_id": { + "description": "The database identifier (ID) of the parent IPv6 network. It identifies the parent of the IPv6 network the object belongs to. 0 indicates that the network the object belongs to has no parent network.", + "type": "string" + }, + "parent_network6_name": { + "description": "The name of the parent IPv6 network. # indicates that the network the object belongs to has no parent network.", + "type": "string" + }, + "parent_network6_prefix": { + "description": "The prefix of the parent of the IPv6 network the object belongs to.", + "type": "string" + }, + "parent_network6_size": { + "description": "The number of IP addresses of the network parent, in hexadecimal format.", + "type": "string" + }, + "parent_network6_start_hostaddr": { + "description": "The human readable version of the parameter parent_network6_start_address6_addr.", + "type": "string" + }, + "parent_network6_start_address6_addr": { + "description": "The first IP address of the parent of the IPv6 network the IP address belongs to.", + "type": "string" + }, + "parent_vlsm_network6_id": { + "description": "The database identifier (ID) of the IPv6 subnet-type network, located in the VLSM parent space, from which the parent of the network the IP address belongs to was duplicated. 0 indicates that the parent of the network the IP address belongs to is not a VLSM block-type network duplicated from a parent space.", + "type": "string" + }, + "pool6_class_name": { + "description": "The name of the class applied to the IPv6 pool the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "pool6_class_parameters": { + "description": "The class parameters applied to the IPv6 pool the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "pool6_end_address6_addr": { + "description": "The last IP address of the IPv6 pool the IP address belongs to.", + "type": "string" + }, + "pool6_id": { + "description": "The database identifier (ID) of the IPv6 pool the object belongs to.", + "type": "string" + }, + "pool6_name": { + "description": "The name of the IPv6 pool the object belongs to.", + "type": "string" + }, + "pool6_read_only": { + "description": "The reservation status of the pool the IPv6 address belongs to. If set 1, the pool is reserved and you cannot assign the IP address.", + "type": "string" + }, + "pool6_size": { + "description": "The number of IP addresses that contains the pool the IPv6 address belongs to.", + "type": "string" + }, + "pool6_start_address6_addr": { + "description": "The first IP address of the IPv6 pool the IP address belongs to.", + "type": "string" + }, + "space_class_name": { + "description": "The name of the class applied to the space the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "space_class_parameters": { + "description": "The class parameters applied to the space the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "space_description": { + "description": "The description of the space the object belongs to.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space the object belongs to, a unique numeric key value automatically incremented when you add a space.", + "type": "string" + }, + "space_name": { + "description": "The name of the space the object belongs to.", + "type": "string" + }, + "network6_class_name": { + "description": "The name of the class applied to the IPv6 network the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "network6_class_parameters": { + "description": "The class parameters applied to the IPv6 network the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "network6_end_hostaddr": { + "description": "The human readable version of the parameter network6_end_address6_addr.", + "type": "string" + }, + "network6_end_address6_addr": { + "description": "The last IP address of the IPv6 network the object belongs to.", + "type": "string" + }, + "network6_id": { + "description": "The database identifier (ID) of the IPv6 network the object belongs to.", + "type": "string" + }, + "network6_is_terminal": { + "description": "A way to determine if the network the IP address belongs to is terminal (1) or non-terminal (0).", + "type": "string" + }, + "network6_name": { + "description": "The name of the IPv6 network the object belongs to.", + "type": "string" + }, + "network6_prefix": { + "description": "The prefix of the IPv6 network the object belongs to.", + "type": "string" + }, + "network6_size": { + "description": "The number of IP addresses the network the object belongs to contains.", + "type": "string" + }, + "network6_start_hostaddr": { + "description": "The human readable version of the parameter network6_start_address6_addr.", + "type": "string" + }, + "network6_start_address6_addr": { + "description": "The first IP address of the IPv6 network the object belongs to.", + "type": "string" + }, + "network_size": { + "description": "The number of IP addresses the network the object belongs to contains.", + "type": "string" + }, + "address6_operation_details_added_on": { + "description": "The creation date of the IPv6 address, in decimal UNIX date format.", + "type": "string" + }, + "address6_operation_details_call_stack": { + "description": "The call stack of the IPv6 address operation details, as follows: <service1>&<service2>&<service3>... .", + "type": "string" + }, + "address6_operation_details_origin_module": { + "description": "The name of the module where the IPv6 address addition originated.", + "type": "string" + }, + "address6_operation_details_requested_by": { + "description": "The login of the user who requested the IPv6 address.", + "type": "string" + }, + "address6_operation_details_added_by": { + "description": "The login of the user who added the IPv6 address.", + "type": "string" + }, + "address6_operation_details_last_updated_on": { + "description": "The last time the IPv6 address was updated, in decimal UNIX date format.", + "type": "string" + }, + "address6_type": { + "description": "A way to determine if you can assign the IP address (free) or if it is In use (ip6).", + "type": "string" + }, + "vlsm_network6_id": { + "description": "The database identifier (ID) of the IPv6 subnet-type network, located in the VLSM parent space, from which the network the IP address belongs to was duplicated. 0 indicates the network the IP address belongs to is not a VLSM block-type network duplicated from a parent space.", + "type": "string" + } + }, + "title": "_data_inner_ipam_address6_data", + "type": "object" + }, + "dns_zoneparam_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_zoneparam_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_space_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_space_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_zoneparam_add_success": { + "example": { + "data": [ + { + "zoneparam_id": "zoneparam_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_zoneparam_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_range_data": { + "example": { + "data": [ + { + "range_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_name": "range_name", + "server_name": "server_name", + "range_lease_count": "range_lease_count", + "sharednetwork_id": "sharednetwork_id", + "server_class_name": "server_class_name", + "scope_start_address_addr": "scope_start_address_addr", + "server_version": "server_version", + "range_size": "range_size", + "scope_name": "scope_name", + "range_id": "range_id", + "range_lease_percent": "range_lease_percent", + "smart_parent_id": "smart_parent_id", + "scope_id": "scope_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope_if_name": "scope_if_name", + "smart_parent_name": "smart_parent_name", + "scope_size": "scope_size", + "range_delayed_create_time": "range_delayed_create_time", + "range_delayed_delete_time": "range_delayed_delete_time", + "server_comment": "server_comment", + "range_end_addr": "range_end_addr", + "scope_if_addr": "scope_if_addr", + "range_state": "range_state", + "sharednetwork_name": "sharednetwork_name", + "server_id": "server_id", + "server_addr": "server_addr", + "scope_net_mask": "scope_net_mask", + "server_hostaddr": "server_hostaddr", + "scope_net_addr": "scope_net_addr", + "server_addr6": "server_addr6", + "range_start_addr": "range_start_addr", + "range_class_name": "range_class_name", + "range_failover_name": "range_failover_name", + "scope_space_id": "scope_space_id", + "scope_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_multistatus": "range_multistatus", + "range_start_address_addr": "range_start_address_addr", + "range_end_address_addr": "range_end_address_addr", + "server_type": "server_type", + "range_acl": "range_acl", + "scope_class_name": "scope_class_name" + }, + { + "range_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_name": "range_name", + "server_name": "server_name", + "range_lease_count": "range_lease_count", + "sharednetwork_id": "sharednetwork_id", + "server_class_name": "server_class_name", + "scope_start_address_addr": "scope_start_address_addr", + "server_version": "server_version", + "range_size": "range_size", + "scope_name": "scope_name", + "range_id": "range_id", + "range_lease_percent": "range_lease_percent", + "smart_parent_id": "smart_parent_id", + "scope_id": "scope_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope_if_name": "scope_if_name", + "smart_parent_name": "smart_parent_name", + "scope_size": "scope_size", + "range_delayed_create_time": "range_delayed_create_time", + "range_delayed_delete_time": "range_delayed_delete_time", + "server_comment": "server_comment", + "range_end_addr": "range_end_addr", + "scope_if_addr": "scope_if_addr", + "range_state": "range_state", + "sharednetwork_name": "sharednetwork_name", + "server_id": "server_id", + "server_addr": "server_addr", + "scope_net_mask": "scope_net_mask", + "server_hostaddr": "server_hostaddr", + "scope_net_addr": "scope_net_addr", + "server_addr6": "server_addr6", + "range_start_addr": "range_start_addr", + "range_class_name": "range_class_name", + "range_failover_name": "range_failover_name", + "scope_space_id": "scope_space_id", + "scope_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_multistatus": "range_multistatus", + "range_start_address_addr": "range_start_address_addr", + "range_end_address_addr": "range_end_address_addr", + "server_type": "server_type", + "range_acl": "range_acl", + "scope_class_name": "scope_class_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_range_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_ipam_address_delete_success": { + "example": { + "address_id": "address_id" + }, + "properties": { + "address_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_ipam_address_delete_success", + "type": "object" + }, + "ipam_network_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_network_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_range_add_success": { + "example": { + "data": [ + { + "range_id": "range_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_range_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "vlan_range_edit_input": { + "properties": { + "domain_id": { + "description": "The database identifier (ID) of the VLAN domain, a unique numeric key value automatically incremented when you add a VLAN domain. Use the ID to specify the VLAN domain of your choice.", + "type": "integer" + }, + "domain_name": { + "description": "The name of the VLAN domain.", + "type": "string" + }, + "range_id": { + "description": "The database identifier (ID) of the VLAN range, a unique numeric key value automatically incremented when you add a VLAN range. Use the ID to specify the VLAN range of your choice.", + "type": "integer" + }, + "range_name": { + "description": "The name of the VLAN range, each VLAN range must have a unique name.", + "type": "string" + }, + "range_description": { + "description": "The description of the VLAN range.", + "type": "string" + }, + "range_disable_overlapping": { + "description": "The overlapping restriction status of the VLAN range. Set it to 1 to prevent VLAN ID overlapping in the range.", + "type": "integer" + }, + "range_end_vlan_id": { + "description": "The VLAN identifier (ID) of an existing VLAN you want to set as the last VLAN in the VLAN range.", + "type": "integer" + }, + "range_start_vlan_id": { + "description": "The VLAN identifier (ID) of an existing VLAN you want to set as the first VLAN in the VLAN range.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "range_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "range_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "ipam_address6_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_address6_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dhcp_range6_data": { + "example": { + "server6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_size": "scope6_size", + "server6_version": "server6_version", + "range6_state": "range6_state", + "scope6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range6_failover_name": "range6_failover_name", + "server6_name": "server6_name", + "range6_end_address6_addr": "range6_end_address6_addr", + "scope6_prefix": "scope6_prefix", + "server6_comment": "server6_comment", + "smart_parent_id": "smart_parent_id", + "smart_parent_name": "smart_parent_name", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "server6_type": "server6_type", + "range6_delayed_time": "range6_delayed_time", + "range6_acl": "range6_acl", + "range6_id": "range6_id", + "range6_name": "range6_name", + "range6_start_address6_addr": "range6_start_address6_addr", + "server6_addr6": "server6_addr6", + "sharednetwork6_name": "sharednetwork6_name", + "range6_multistatus": "range6_multistatus", + "server6_hostaddr": "server6_hostaddr", + "scope6_end_address6_addr": "scope6_end_address6_addr", + "server6_addr": "server6_addr", + "range6_size": "range6_size", + "scope6_class_name": "scope6_class_name", + "scope6_name": "scope6_name", + "scope6_space_id": "scope6_space_id", + "range6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_id": "scope6_id", + "range6_lease_count": "range6_lease_count", + "sharednetwork6_id": "sharednetwork6_id", + "scope6_start_address6_addr": "scope6_start_address6_addr", + "range6_class_name": "range6_class_name" + }, + "properties": { + "range6_delayed_time": { + "description": "The delay of creation/deletion status. 1 indicates that the object is not created/deleted yet.", + "type": "string" + }, + "server6_class_name": { + "description": "The name of the class applied to the DHCPv6 server the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "server6_class_parameters": { + "description": "The class parameters applied to the DHCPv6 server the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "server6_comment": { + "description": "The description of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_name": { + "description": "The name of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_type": { + "description": "The type of the DHCPv6 server the object belongs to:


                                                                                                                                                                                                                                              server6_type possible values
                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                              ipmEfficientIP or EfficientIP Package server
                                                                                                                                                                                                                                              vdhcpEfficientIP DHCPv6 smart architecture


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "server6_version": { + "description": "The version details of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "range6_acl": { + "description": "The list of ACLs associated with the DHCPv6 range, as follows: <ACL_name>;<ACL_name>;... .", + "type": "string" + }, + "range6_class_name": { + "description": "The name of the class applied to the DHCPv6 range, it can be preceded by the class directory.", + "type": "string" + }, + "range6_class_parameters": { + "description": "The class parameters applied to the DHCPv6 range.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "range6_end_address6_addr": { + "description": "The last IP address of the DHCPv6 range, in hexadecimal format.", + "type": "string" + }, + "range6_failover_name": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "range6_id": { + "description": "The database identifier (ID) of the DHCPv6 range.", + "type": "string" + }, + "range6_lease_count": { + "description": "The total number of leases currently delivered by the DHCPv6 range.", + "type": "string" + }, + "range6_name": { + "description": "The start and end IP address of the DHCPv6 range, range6_start_address6_addr and range6_end_address6_addr, in compressed format as follows: <start-ip> - <end-ip>.", + "type": "string" + }, + "range6_size": { + "description": "The number of IP addresses the DHCPv6 range contains.", + "type": "string" + }, + "range6_start_address6_addr": { + "description": "The first IP address of the DHCPv6 range, in hexadecimal format.", + "type": "string" + }, + "range6_state": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "scope6_class_name": { + "description": "The name of the class applied to the DHCPv6 scope the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "scope6_class_parameters": { + "description": "The class parameters applied to the DHCPv6 scope the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "scope6_end_address6_addr": { + "description": "The last IP address of the DHCPv6 scope the object belongs to, in hexadecimal format.", + "type": "string" + }, + "scope6_id": { + "description": "The database identifier (ID) of the DHCPv6 scope the object belongs to.", + "type": "string" + }, + "scope6_name": { + "description": "The name of the DHCPv6 scope the object belongs to.", + "type": "string" + }, + "scope6_prefix": { + "description": "The prefix of the DHCPv6 scope the object belongs to.", + "type": "string" + }, + "scope6_space_id": { + "description": "The database identifier (ID) of the space associated with the DHCPv6 scope the object belongs to.", + "type": "string" + }, + "scope6_size": { + "description": "The number of IP addresses the DHCPv6 scope the object belongs to contains.", + "type": "string" + }, + "scope6_start_address6_addr": { + "description": "The first IP address of the DHCPv6 scope the object belongs to, in hexadecimal format.", + "type": "string" + }, + "sharednetwork6_id": { + "description": "The database identifier (ID) of the DHCPv6 shared network the object belongs to.", + "type": "string" + }, + "sharednetwork6_name": { + "description": "The name of the DHCPv6 shared network the object belongs to.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The human readable version of the parameter server6_addr or server6_addr6.", + "type": "string" + }, + "server6_addr6": { + "description": "The Management IP address of the DHCPv6 server the object belongs to, the IPv6 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "server6_addr": { + "description": "The Management IP address of the DHCPv6 server the object belongs to, the IPv4 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "range6_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                                                                                                                              Multi-status severity levels
                                                                                                                                                                                                                                              Message number Severity Description
                                                                                                                                                                                                                                              0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                                                                                                                              17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                                                                                                                              34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                                                                                                                              51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                                                                                                                              67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                                                                                                                              84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv6 smart architecture managing the DHCPv6 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_name": { + "description": "The name of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. # indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_range6_data", + "type": "object" + }, + "vlan_domain_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_vlan_domain_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_ipam_network_data": { + "example": { + "range_name": "range_name", + "network_address_used_size": "network_address_used_size", + "vlan_id": "vlan_id", + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "vlsm_space_id": "vlsm_space_id", + "vlan_vlan_id": "vlan_vlan_id", + "network_is_terminal": "network_is_terminal", + "vlan_name": "vlan_name", + "parent_network_level": "parent_network_level", + "domain_id": "domain_id", + "vlsm_space_name": "vlsm_space_name", + "domain_name": "domain_name", + "network_ripe_waiting_status": "network_ripe_waiting_status", + "network_operation_details_call_stack": "network_operation_details_call_stack", + "network_operation_details_added_by": "network_operation_details_added_by", + "space_class_name": "space_class_name", + "network_start_hostaddr": "network_start_hostaddr", + "parent_space_id": "parent_space_id", + "space_description": "space_description", + "parent_network_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "network_address_used_percent": "network_address_used_percent", + "network_level": "network_level", + "network_size": "network_size", + "space_parent_space_id": "space_parent_space_id", + "space_is_template": "space_is_template", + "network_name": "network_name", + "parent_network_is_terminal": "parent_network_is_terminal", + "network_operation_details_requested_by": "network_operation_details_requested_by", + "network_operation_details_added_on": "network_operation_details_added_on", + "network_operation_details_origin_module": "network_operation_details_origin_module", + "parent_network_class_name": "parent_network_class_name", + "network_start_ip_addr": "network_start_ip_addr", + "network_address_free_size": "network_address_free_size", + "network_id": "network_id", + "space_name": "space_name", + "network_is_valid": "network_is_valid", + "parent_network_path": "parent_network_path", + "network_allocated_percent": "network_allocated_percent", + "parent_network_start_ip_addr": "parent_network_start_ip_addr", + "network_end_ip_addr": "network_end_ip_addr", + "network_class_name": "network_class_name", + "network_path": "network_path", + "network_end_hostaddr": "network_end_hostaddr", + "network_operation_details_last_updated_on": "network_operation_details_last_updated_on", + "vlsm_network_id": "vlsm_network_id", + "parent_network_name": "parent_network_name", + "range_id": "range_id", + "parent_network_size": "parent_network_size", + "network_used_size": "network_used_size", + "network_ripe_waiting_state": "network_ripe_waiting_state", + "parent_network_end_ip_addr": "parent_network_end_ip_addr", + "parent_vlsm_network_id": "parent_vlsm_network_id", + "parent_space_name": "parent_space_name", + "network_used_percent": "network_used_percent", + "network_is_in_orphan": "network_is_in_orphan", + "network_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "network_lock_network_broadcast": "network_lock_network_broadcast", + "network_multistatus": "network_multistatus", + "parent_network_id": "parent_network_id", + "vlsm_block_id": "vlsm_block_id", + "space_id": "space_id", + "network_allocated_size": "network_allocated_size" + }, + "properties": { + "network_end_hostaddr": { + "description": "The human readable version of the parameter network_end_ip_addr.", + "type": "string" + }, + "network_end_ip_addr": { + "description": "The last IP address of the IPv4 network, in hexadecimal format.", + "type": "string" + }, + "network_is_in_orphan": { + "description": "A way to determine if the network has a parent (0) or if it belongs to a container Orphan networks (1).", + "type": "string" + }, + "network_is_terminal": { + "description": "A way to determine if a network can contain other networks. If set to 1, the network is terminal and cannot contain other subnet-type networks. Block-type networks are always set to 0.", + "type": "string" + }, + "network_lock_network_broadcast": { + "description": "A way to prevent (1) users from assigning the broadcast IP address and network IP address of the network.", + "type": "string" + }, + "network_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                                                                                                                              Multi-status severity levels
                                                                                                                                                                                                                                              Message number Severity Description
                                                                                                                                                                                                                                              0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                                                                                                                              17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                                                                                                                              34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                                                                                                                              51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                                                                                                                              67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                                                                                                                              84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "parent_network_end_ip_addr": { + "description": "The last IP address of the parent IPv4 network, in hexadecimal format.", + "type": "string" + }, + "parent_network_is_terminal": { + "description": "A way to determine if the parent network is terminal (1) or non-terminal (0).", + "type": "string" + }, + "parent_space_id": { + "description": "The database identifier (ID) of the space where is located the parent network. 0 indicates that the network has no parent network.", + "type": "string" + }, + "parent_space_name": { + "description": "The name of the space where is located the parent network. # indicates that the network has no parent network.", + "type": "string" + }, + "parent_network_start_ip_addr": { + "description": "The first IP address of the parent IPv4 network, in hexadecimal format.", + "type": "string" + }, + "parent_network_class_name": { + "description": "The name of the class applied to the parent IPv4 network, it can be preceded by the class directory.", + "type": "string" + }, + "parent_network_class_parameters": { + "description": "The class parameters applied to the parent IPv4 network and their value: <class-parameter1>=<value1>&<class-parameter2>=<value2>&... .", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "parent_network_id": { + "description": "The database identifier (ID) of the parent IPv4 network. 0 indicates that the network has no parent network.", + "type": "string" + }, + "parent_network_level": { + "description": "The level of the parent network within the space. It returns values between 0 (block-type network) and n (subnet-type network). A value higher than 1 indicates a VLSM organization where a block-type network can belong to another subnet-type network.", + "type": "string" + }, + "parent_network_name": { + "description": "The name of the parent IPv4 network:
                                                                                                                                                                                                                                              • # indicates that the network has no parent network.
                                                                                                                                                                                                                                              • Default indicates that the network belongs to an orphan network.
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "parent_network_path": { + "description": "The path toward the parent network in the database. # indicates the network has no parent network.", + "type": "string" + }, + "parent_network_size": { + "description": "The number of IP addresses of the network parent.", + "type": "string" + }, + "parent_vlsm_network_id": { + "description": "The database identifier (ID) of the IPv4 subnet-type network, located in the VLSM parent space, from which the parent network was duplicated. 0 indicates that the parent network is not a VLSM block-type network duplicated from a parent space.", + "type": "string" + }, + "space_class_name": { + "description": "The name of the class applied to the space the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "space_class_parameters": { + "description": "The class parameters applied to the space the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "space_description": { + "description": "The description of the space the object belongs to.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space the object belongs to, a unique numeric key value automatically incremented when you add a space.", + "type": "string" + }, + "space_is_template": { + "description": "The template status of the space the object belongs to. If the space is used as template (1), all the IPv4 networks, pools and IP addresses it contains are also used as template.", + "type": "string" + }, + "space_name": { + "description": "The name of the space the object belongs to.", + "type": "string" + }, + "space_parent_space_id": { + "description": "The database identifier (ID) of the VLSM parent of the space where is located the network. 0 indicates that the space where is located the network has no parent space.", + "type": "string" + }, + "network_start_hostaddr": { + "description": "The human readable version of the parameter network_start_ip_addr.", + "type": "string" + }, + "network_start_ip_addr": { + "description": "The first IP address of the IPv4 network, in hexadecimal format.", + "type": "string" + }, + "network_allocated_percent": { + "description": "The percentage of subnet-type networks the non-terminal network contains.", + "type": "string" + }, + "network_allocated_size": { + "description": "The sum of the size of all the subnet-type networks that belong to the block-type network.", + "type": "string" + }, + "network_class_name": { + "description": "The name of the class applied to the IPv4 network, it can be preceded by the class directory.", + "type": "string" + }, + "network_class_parameters": { + "description": "The class parameters applied to the IPv4 network.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "network_id": { + "description": "The database identifier (ID) of the IPv4 network.", + "type": "string" + }, + "network_address_free_size": { + "description": "The total number of free addresses, for terminal networks only. It excludes the network and broadcast IP address.", + "type": "string" + }, + "network_address_used_percent": { + "description": "The percentage of IP addresses In use in terminal networks.", + "type": "string" + }, + "network_address_used_size": { + "description": "The number of IP addresses In use in terminal networks.", + "type": "string" + }, + "network_is_valid": { + "description": "The network validity. A valid network (1) has a size, prefix and/or netmask that match.", + "type": "string" + }, + "network_level": { + "description": "The level of the network within the space. It returns values between 0 (block-type network) and n (subnet-type network). A value higher than 1 indicates a VLSM organization where a block-type network can belong to another subnet-type network.", + "type": "string" + }, + "network_name": { + "description": "The name of the IPv4 network. Default indicates that the network is an orphan network.", + "type": "string" + }, + "network_path": { + "description": "The path toward the network in the database from the containing block-type network down to the subnet-type network: <block-network-start-IP>#<block-network-ID>#<subnet-network-start-IP>#<subnet-network-ID>. The IP address is returned in hexadecimal format.
                                                                                                                                                                                                                                              • In network-based VLSM organizations, the path includes all the subnet-type networks there are from the containing block-type network down to the subnet-type network specified in network_id.
                                                                                                                                                                                                                                              • In space-based VLSM organizations, the path includes the block-type network of the top parent space and all the subnet-type networks there are until the network specified in network_id. Only one block-type network is returned.
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "network_size": { + "description": "The number of IP addresses the IPv4 network contains.", + "type": "string" + }, + "network_used_percent": { + "description": "The percentage of terminal networks the non-terminal network contains.", + "type": "string" + }, + "network_used_size": { + "description": "The sum of the size of all the terminal networks within the block-type network. This sum includes the terminal networks that might belong to non-terminal subnet-type networks.", + "type": "string" + }, + "network_operation_details_added_on": { + "description": "The creation date of the IPv4 network, in decimal UNIX date format.", + "type": "string" + }, + "network_operation_details_call_stack": { + "description": "The call stack of the IPv4 network operation details, as follows: <service1>&<service2>&<service3>... .", + "type": "string" + }, + "network_operation_details_origin_module": { + "description": "The name of the module where the IPv4 network addition originated.", + "type": "string" + }, + "network_operation_details_requested_by": { + "description": "The login of the user who requested the IPv4 network.", + "type": "string" + }, + "network_operation_details_added_by": { + "description": "The login of the user who added the IPv4 network.", + "type": "string" + }, + "network_operation_details_last_updated_on": { + "description": "The last time the IPv4 network was updated, in decimal UNIX date format.", + "type": "string" + }, + "domain_id": { + "description": "The database identifier (ID) of the VLAN domain associated with the network.", + "type": "string" + }, + "domain_name": { + "description": "The name of the VLAN domain associated with the network.", + "type": "string" + }, + "range_id": { + "description": "The database identifier (ID) of the VLAN range associated with the network.", + "type": "string" + }, + "range_name": { + "description": "The name of the VLAN range associated with the network.", + "type": "string" + }, + "vlan_id": { + "description": "The database identifier (ID) of the VLAN associated with the network.", + "type": "string" + }, + "vlan_name": { + "description": "The name of the VLAN associated with the network.", + "type": "string" + }, + "vlan_vlan_id": { + "description": "The VLAN identifier (ID) of the VLAN associated with the network.", + "type": "string" + }, + "vlsm_block_id": { + "description": "The database identifier (ID) of the IPv4 VLSM block-type network duplicated, in a VLSM child space, from the network. 0 indicates that the network is not duplicated as a VLSM block-type network in a child space.", + "type": "string" + }, + "vlsm_space_id": { + "description": "The database identifier (ID) of the VLSM child space where the network is duplicated as a VLSM block-type network. 0 indicates that the network is not duplicated as a VLSM block-type network in a child space.", + "type": "string" + }, + "vlsm_space_name": { + "description": "The name of the VLSM child space where the network is duplicated as a VLSM block-type network. 0 indicates that the network is not duplicated as a VLSM block-type network in a child space.", + "type": "string" + }, + "vlsm_network_id": { + "description": "The database identifier (ID) of the IPv4 subnet-type network, located in the VLSM parent space, from which the network was duplicated. 0 indicates that the network is not a VLSM block-type network duplicated from a parent space.", + "type": "string" + }, + "network_ripe_waiting_state": { + "description": "The state of the exchange between SOLIDserver and the RIPE for the assigned network:


                                                                                                                                                                                                                                              network_ripe_waiting_state possible values
                                                                                                                                                                                                                                              StatusDescription
                                                                                                                                                                                                                                              must_send_mail_addAn email must be sent to the RIPE to notify them of a subnet-type network creation.
                                                                                                                                                                                                                                              wait_mail_addA network creation email was sent to the RIPE, no reply has been received yet.
                                                                                                                                                                                                                                              must_send_mail_delAn email must be sent to the RIPE to notify them of a subnet-type network deletion.
                                                                                                                                                                                                                                              wait_mail_delA network deletion email was sent to the RIPE, no reply has been received yet.
                                                                                                                                                                                                                                              wait_aw_confirmThe number of IP addresses of the assigned network exceeds the Assignment Window declared during your RIPE configuration.


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "network_ripe_waiting_status": { + "description": "The status of a RIPE assigned network within SOLIDserver until it is confirmed that you can create or delete it. If set to 1, it is about to be created. If set to 2, it is about to be deleted.", + "type": "string" + } + }, + "title": "_data_inner_ipam_network_data", + "type": "object" + }, + "dhcp_scope_add_success": { + "example": { + "data": [ + { + "scope_id": "scope_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_scope_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dhcp_static6_data": { + "example": { + "server6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_size": "scope6_size", + "static6_address6_addr": "static6_address6_addr", + "server6_version": "server6_version", + "static6_prefix6": "static6_prefix6", + "scope6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "static6_prefix6_prefix": "static6_prefix6_prefix", + "static6_mac_vendor": "static6_mac_vendor", + "group6_id": "group6_id", + "server6_name": "server6_name", + "smart_parent_id": "smart_parent_id", + "static6_class_name": "static6_class_name", + "smart_parent_name": "smart_parent_name", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "static6_time": "static6_time", + "static6_prefix6_addr": "static6_prefix6_addr", + "server6_type": "server6_type", + "static6_name": "static6_name", + "static6_client_duid": "static6_client_duid", + "sharednetwork6_name": "sharednetwork6_name", + "group6_name": "group6_name", + "static6_id": "static6_id", + "static6_end_time": "static6_end_time", + "scope6_end_address6_addr": "scope6_end_address6_addr", + "static6_domain": "static6_domain", + "scope6_class_name": "scope6_class_name", + "scope6_name": "scope6_name", + "scope6_space_id": "scope6_space_id", + "static6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_id": "scope6_id", + "static6_multistatus": "static6_multistatus", + "static6_mac_addr": "static6_mac_addr", + "sharednetwork6_id": "sharednetwork6_id", + "group6_class_name": "group6_class_name", + "static6_state": "static6_state", + "scope6_start_address6_addr": "scope6_start_address6_addr", + "static6_delayed_time": "static6_delayed_time", + "group6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ] + }, + "properties": { + "static6_delayed_time": { + "description": "The delay of creation/deletion status. 1 indicates that the object is not created/deleted yet.", + "type": "string" + }, + "server6_class_name": { + "description": "The name of the class applied to the DHCPv6 server the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "server6_class_parameters": { + "description": "The class parameters applied to the DHCPv6 server the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_name": { + "description": "The name of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_type": { + "description": "The type of the DHCPv6 server the object belongs to:


                                                                                                                                                                                                                                              server6_type possible values
                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                              ipmEfficientIP or EfficientIP Package server
                                                                                                                                                                                                                                              vdhcpEfficientIP DHCPv6 smart architecture


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "server6_version": { + "description": "The version details of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "group6_class_name": { + "description": "The name of the class applied to the DHCPv6 group the static belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "group6_class_parameters": { + "description": "The class parameters applied to the DHCPv6 group the static belongs to,.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "group6_id": { + "description": "The database identifier (ID) of the DHCPv6 group.", + "type": "string" + }, + "group6_name": { + "description": "The name of the DHCPv6 group associated with the object.", + "type": "string" + }, + "static6_class_name": { + "description": "The name of the class applied to the DHCPv6static, it can be preceded by the class directory.", + "type": "string" + }, + "static6_class_parameters": { + "description": "The class parameters applied to the DHCPv6 static.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "static6_client_duid": { + "description": "The client DHCP Unique Identifier (DUID) associated with the DHCPv6 static.", + "type": "string" + }, + "static6_domain": { + "description": "The domain name associated with the DHCPv6 static.", + "type": "string" + }, + "static6_end_time": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "static6_id": { + "description": "The database identifier (ID) of the DHCPv6 static.", + "type": "string" + }, + "static6_address6_addr": { + "description": "The IP address associated with the DHCPv6 static, in hexadecimal format.", + "type": "string" + }, + "static6_mac_addr": { + "description": "The MAC address associated with the DHCPv6 static.", + "type": "string" + }, + "static6_name": { + "description": "The name of the DHCPv6 static.", + "type": "string" + }, + "static6_prefix6": { + "description": "The IP address and prefix of the delegated prefix of the DHCPv6 static, in hexadecimal format as follows: <IPv6-address>/<prefix>.", + "type": "string" + }, + "static6_prefix6_addr": { + "description": "The IP address of the delegated prefix of the DHCPv6 static, in hexadecimal format.", + "type": "string" + }, + "static6_prefix6_prefix": { + "description": "The prefix of the delegated prefix of the DHCPv6 static.", + "type": "string" + }, + "static6_state": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "static6_time": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "scope6_class_name": { + "description": "The name of the class applied to the DHCPv6 scope the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "scope6_class_parameters": { + "description": "The class parameters applied to the DHCPv6 scope the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "scope6_end_address6_addr": { + "description": "The last IP address of the DHCPv6 scope the object belongs to, in hexadecimal format.", + "type": "string" + }, + "scope6_id": { + "description": "The database identifier (ID) of the DHCPv6 scope the object belongs to.", + "type": "string" + }, + "scope6_name": { + "description": "The name of the DHCPv6 scope the object belongs to.", + "type": "string" + }, + "scope6_space_id": { + "description": "The database identifier (ID) of the space associated with the DHCPv6 scope the object belongs to.", + "type": "string" + }, + "scope6_size": { + "description": "The number of IP addresses the DHCPv6 scope the object belongs to contains.", + "type": "string" + }, + "scope6_start_address6_addr": { + "description": "The first IP address of the DHCPv6 scope the object belongs to, in hexadecimal format.", + "type": "string" + }, + "sharednetwork6_id": { + "description": "The database identifier (ID) of the DHCPv6 shared network the object belongs to.", + "type": "string" + }, + "sharednetwork6_name": { + "description": "The name of the DHCPv6 shared network the object belongs to.", + "type": "string" + }, + "static6_mac_vendor": { + "description": "The vendor details of the client associated with the DHCPv6 static.", + "type": "string" + }, + "static6_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                                                                                                                              Multi-status severity levels
                                                                                                                                                                                                                                              Message number Severity Description
                                                                                                                                                                                                                                              0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                                                                                                                              17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                                                                                                                              34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                                                                                                                              51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                                                                                                                              67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                                                                                                                              84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv6 smart architecture managing the DHCPv6 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_name": { + "description": "The name of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. # indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_static6_data", + "type": "object" + }, + "_data_inner_ipam_space_data": { + "example": { + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_name": "space_name", + "parent_space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_class_name": "space_class_name", + "space_is_template": "space_is_template", + "space_multistatus": "space_multistatus", + "parent_space_id": "parent_space_id", + "space_description": "space_description", + "parent_space_class_name": "parent_space_class_name", + "space_id": "space_id", + "parent_space_name": "parent_space_name" + }, + "properties": { + "space_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                                                                                                                              Multi-status severity levels
                                                                                                                                                                                                                                              Message number Severity Description
                                                                                                                                                                                                                                              0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                                                                                                                              17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                                                                                                                              34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                                                                                                                              51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                                                                                                                              67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                                                                                                                              84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "parent_space_class_name": { + "description": "The name of the class applied to the VLSM parent space, it can be preceded by the class directory.", + "type": "string" + }, + "parent_space_class_parameters": { + "description": "The class parameters applied to the VLSM parent space and their value: <class-parameter1>=<value1>&<class-parameter2>=<value2>&... .", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "parent_space_id": { + "description": "The database identifier (ID) of the VLSM parent space. 0 indicates that space has no parent space.", + "type": "string" + }, + "parent_space_name": { + "description": "The name of the VLSM parent space. # indicates that space has no parent space.", + "type": "string" + }, + "space_class_name": { + "description": "The name of the class applied to the space, it can be preceded by the class directory.", + "type": "string" + }, + "space_class_parameters": { + "description": "The class parameters applied to the space.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "space_description": { + "description": "The description of the space.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space.", + "type": "string" + }, + "space_is_template": { + "description": "The template status of the space. If the space is used as template (1), all the IPv4 networks, pools and IP addresses it contains are also used as template.", + "type": "string" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + } + }, + "title": "_data_inner_ipam_space_data", + "type": "object" + }, + "_data_inner_dns_view_data": { + "example": { + "server_name": "server_name", + "view_order": "view_order", + "server_class_name": "server_class_name", + "server_gss_keytab_id": "server_gss_keytab_id", + "server_version": "server_version", + "view_allow_transfer": "view_allow_transfer", + "view_delayed_create_time": "view_delayed_create_time", + "view_delayed_delete_time": "view_delayed_delete_time", + "view_recursion": "view_recursion", + "smart_parent_id": "smart_parent_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "smart_parent_name": "smart_parent_name", + "server_cloud": "server_cloud", + "view_name": "view_name", + "server_comment": "server_comment", + "view_class_name": "view_class_name", + "view_key_name": "view_key_name", + "view_id": "view_id", + "server_id": "server_id", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "view_multistatus": "view_multistatus", + "view_match_clients": "view_match_clients", + "view_match_to": "view_match_to", + "view_allow_recursion": "view_allow_recursion", + "view_allow_query": "view_allow_query", + "view_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_type": "server_type" + }, + "properties": { + "view_delayed_create_time": { + "description": "The delay of creation status. 1 indicates that the object is not created yet.", + "type": "string" + }, + "view_delayed_delete_time": { + "description": "The delay of deletion status. 1 indicates that the object is not deleted yet.", + "type": "string" + }, + "server_class_name": { + "description": "The name of the class applied to the DNS server the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "server_class_parameters": { + "description": "The class parameters applied to the DNS server the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "server_cloud": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_comment": { + "description": "The description of the DNS server the object belongs to.", + "type": "string" + }, + "server_id": { + "description": "The database identifier (ID) of the DNS server the object belongs to.", + "type": "string" + }, + "server_name": { + "description": "The name of the DNS server the object belongs to.", + "type": "string" + }, + "server_type": { + "description": "The type of the DNS server the object belongs to.


                                                                                                                                                                                                                                              server_type possible values
                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                              ipmEfficientIP or EfficientIP Package server
                                                                                                                                                                                                                                              msdaemonMicrosoft Windows DNS server
                                                                                                                                                                                                                                              awsAmazon Route 53 server
                                                                                                                                                                                                                                              otherGeneric DNS server
                                                                                                                                                                                                                                              vdnsEfficientIP DNS smart architecture


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "server_version": { + "description": "The version details of the DNS server the object belongs to.", + "type": "string" + }, + "view_allow_query": { + "description": "The ACL values associated with the allow-query configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_allow_recursion": { + "description": "The ACL values associated with the allow-recursion configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_allow_transfer": { + "description": "The ACL values associated with the allow-transfer configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_class_name": { + "description": "The name of the class applied to the DNS view, it can be preceded by the class directory.", + "type": "string" + }, + "view_class_parameters": { + "description": "The class parameters applied to the DNS view.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "view_id": { + "description": "The database identifier (ID) of the DNS view.", + "type": "string" + }, + "view_key_name": { + "description": "The name of the DNS TSIG key associated with the DNS view.", + "type": "string" + }, + "view_match_clients": { + "description": "The ACL values associated with the match clients configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_match_to": { + "description": "The ACL values associated with the match destination configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_name": { + "description": "The name of the DNS view.", + "type": "string" + }, + "view_order": { + "description": "The level of the DNS view, where 0 represents the highest level in the views hierarchy. The parameters dnsview_match_client and view_match_to of each view in a server are reviewed following this order.", + "type": "string" + }, + "view_recursion": { + "description": "The recursion status of the DNS view:


                                                                                                                                                                                                                                              view_recursion possible values
                                                                                                                                                                                                                                              StatusDescription
                                                                                                                                                                                                                                              noThe view only provides iterative query behavior - normally resulting in a referral. If the answer to the query already exists in the cache it will be returned whatever the value of this statement.
                                                                                                                                                                                                                                              yesThe view always provides recursive query behavior if requested by the client.


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "server_gss_keytab_id": { + "description": "The database identifier (ID) of the DNS GSS-TSIG keytab.", + "type": "string" + }, + "server_hostaddr": { + "description": "The human readable version of the parameter server_addr or server_addr6.", + "type": "string" + }, + "server_addr6": { + "description": "The IPv6 address of the DNS server the object belongs to, in hexadecimal format.", + "type": "string" + }, + "server_addr": { + "description": "The IPv4 address of the DNS server the object belongs to, in hexadecimal format.", + "type": "string" + }, + "view_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                                                                                                                              Multi-status severity levels
                                                                                                                                                                                                                                              Message number Severity Description
                                                                                                                                                                                                                                              0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                                                                                                                              17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                                                                                                                              34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                                                                                                                              51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                                                                                                                              67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                                                                                                                              84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DNS smart architecture managing the DNS server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_name": { + "description": "The name of the DNS smart architecture managing the DNS server the object belongs to. # indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dns_view_data", + "type": "object" + }, + "_data_inner_dhcp_range_add_success": { + "example": { + "range_id": "range_id" + }, + "properties": { + "range_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_range_add_success", + "type": "object" + }, + "ipam_space_edit_input": { + "properties": { + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space, each space must have a unique name.", + "type": "string" + }, + "parent_space_id": { + "description": "The database identifier (ID) of an existing space you want to set as the VLSM parent of the space you are editing. This sets up a space-based VLSM organization.", + "type": "integer" + }, + "parent_space_name": { + "description": "The name of an existing space you want to set as the VLSM parent of the space you are editing. This sets up a space-based VLSM organization.", + "type": "string" + }, + "space_description": { + "description": "The description of the space.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "space_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "space_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_data_inner_dhcp_scope6_data": { + "example": { + "scope6_delayed_time": "scope6_delayed_time", + "server6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_size": "scope6_size", + "server6_version": "server6_version", + "scope6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server6_name": "server6_name", + "scope6_prefix": "scope6_prefix", + "smart_parent_id": "smart_parent_id", + "scope6_sort_name": "scope6_sort_name", + "scope6_multistatus": "scope6_multistatus", + "failover6_name": "failover6_name", + "smart_parent_name": "smart_parent_name", + "smart_arch": "smart_arch", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "server6_type": "server6_type", + "scope6_space_name": "scope6_space_name", + "failover6_id": "failover6_id", + "server6_addr6": "server6_addr6", + "sharednetwork6_name": "sharednetwork6_name", + "server6_hostaddr": "server6_hostaddr", + "scope6_end_address6_addr": "scope6_end_address6_addr", + "server6_addr": "server6_addr", + "scope6_class_name": "scope6_class_name", + "scope6_name": "scope6_name", + "scope6_space_id": "scope6_space_id", + "scope6_id": "scope6_id", + "sharednetwork6_id": "sharednetwork6_id", + "scope6_start_address6_addr": "scope6_start_address6_addr" + }, + "properties": { + "scope6_delayed_time": { + "description": "The delay of creation/deletion status. 1 indicates that the object is not created/deleted yet.", + "type": "string" + }, + "server6_class_name": { + "description": "The name of the class applied to the DHCPv6 server the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "server6_class_parameters": { + "description": "The class parameters applied to the DHCPv6 server the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_name": { + "description": "The name of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_type": { + "description": "The type of the DHCPv6 server the object belongs to:


                                                                                                                                                                                                                                              server6_type possible values
                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                              ipmEfficientIP or EfficientIP Package server
                                                                                                                                                                                                                                              vdhcpEfficientIP DHCPv6 smart architecture


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "server6_version": { + "description": "The version details of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "failover6_id": { + "description": "The database identifier (ID) of the DHCPv6 failover channel associated with the object.", + "type": "string" + }, + "failover6_name": { + "description": "The name of the DHCPv6 failover channel associated with the object.", + "type": "string" + }, + "scope6_class_name": { + "description": "The name of the class applied to the DHCPv6 scope, it can be preceded by the class directory.", + "type": "string" + }, + "scope6_class_parameters": { + "description": "The class parameters applied to the DHCPv6 scope.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "scope6_end_address6_addr": { + "description": "The last IP address of the DHCPv6 scope, in hexadecimal format.", + "type": "string" + }, + "scope6_id": { + "description": "The database identifier (ID) of the DHCPv6 scope.", + "type": "string" + }, + "scope6_name": { + "description": "The name of the DHCPv6 scope.", + "type": "string" + }, + "scope6_prefix": { + "description": "The prefix of the DHCPv6 scope.", + "type": "string" + }, + "scope6_space_id": { + "description": "The database identifier (ID) of the space associated with the DHCPv6 scope.", + "type": "string" + }, + "scope6_space_name": { + "description": "The name of the space associated with the DHCPv6 scope.", + "type": "string" + }, + "scope6_size": { + "description": "The number of IP addresses the DHCPv6 scope contains.", + "type": "string" + }, + "scope6_sort_name": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "scope6_start_address6_addr": { + "description": "The first IP address of the DHCPv6 scope, in hexadecimal format.", + "type": "string" + }, + "sharednetwork6_id": { + "description": "The database identifier (ID) of the DHCPv6 shared network the object belongs to.", + "type": "string" + }, + "sharednetwork6_name": { + "description": "The name of the DHCPv6 shared network the object belongs to.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The human readable version of the parameter server6_addr or server6_addr6.", + "type": "string" + }, + "server6_addr6": { + "description": "The Management IP address of the DHCPv6 server the object belongs to, the IPv6 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "server6_addr": { + "description": "The Management IP address of the DHCPv6 server the object belongs to, the IPv4 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "scope6_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                                                                                                                              Multi-status severity levels
                                                                                                                                                                                                                                              Message number Severity Description
                                                                                                                                                                                                                                              0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                                                                                                                              17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                                                                                                                              34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                                                                                                                              51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                                                                                                                              67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                                                                                                                              84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "smart_arch": { + "description": "The type of the DHCPv6 smart architecture the object belongs to.


                                                                                                                                                                                                                                              smart_arch possible values
                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                              singleThe Single-Server smart architecture manages a single DHCPv6 server.
                                                                                                                                                                                                                                              splitscopeThe Split-Scope smart architecture sets a pair of DHCP servers in a configuration where the two scopes listen to the same subnet, but the range of addresses is divided.
                                                                                                                                                                                                                                              statelessThe Stateless smart architecture offers a limited number of options to the DHCP clients. The IP address is delivered thanks to the subnet gateway and it is impossible to create any ranges or statics or to retrieve any leases.


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv6 smart architecture managing the DHCPv6 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_name": { + "description": "The name of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. # indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_scope6_data", + "type": "object" + }, + "dns_acl_add_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "acl_name": { + "description": "The name of the DNS ACL, each DNS ACL must have a unique name.", + "type": "string" + }, + "acl_value": { + "description": "The values of the DNS ACL in order of priority, as follows: <value_1>;<value_2>... .", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DNS server.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dhcp_scope_delete_success": { + "example": { + "data": [ + { + "scope_id": "scope_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_scope_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dhcp_aclentry_data": { + "example": { + "aclentry_id": "aclentry_id", + "server_name": "server_name", + "aclentry_leaselimit": "aclentry_leaselimit", + "smart_parent_id": "smart_parent_id", + "acl_name": "acl_name", + "server_cluster_role": "server_cluster_role", + "aclentry_delayed_delete_time": "aclentry_delayed_delete_time", + "aclentry_value": "aclentry_value", + "aclentry_delayed_create_time": "aclentry_delayed_create_time", + "acl_id": "acl_id", + "server_id": "server_id", + "server_type": "server_type" + }, + "properties": { + "server_cluster_role": { + "description": "The role of the server the object belongs to in the cluster, either active (M), passive (B) or N/A (#).", + "type": "string" + }, + "aclentry_delayed_create_time": { + "description": "The delay of creation status. 1 indicates that the object is not created yet.", + "type": "string" + }, + "aclentry_delayed_delete_time": { + "description": "The delay of deletion status. 1 indicates that the object is not deleted yet.", + "type": "string" + }, + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_name": { + "description": "The name of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_type": { + "description": "The type of the DHCPv4 server the object belongs to:


                                                                                                                                                                                                                                              server_type possible values
                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                              ipmEfficientIP or EfficientIP Package server
                                                                                                                                                                                                                                              msrpcMicrosoft Windows DHCP server
                                                                                                                                                                                                                                              vdhcpEfficientIP DHCPv4 smart architecture


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "acl_id": { + "description": "The database identifier (ID) of the DHCPv4 ACL.", + "type": "string" + }, + "acl_name": { + "description": "The name of the DHCPv4 ACL.", + "type": "string" + }, + "aclentry_id": { + "description": "The database identifier (ID) of the DHCPv4 ACL entry.", + "type": "string" + }, + "aclentry_leaselimit": { + "description": "The lease limit of the DHCPv4 ACL entry.", + "type": "string" + }, + "aclentry_value": { + "description": "The value of the DHCPv4 ACL entry.", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_aclentry_data", + "type": "object" + }, + "_data_inner_dhcp_range6_delete_success": { + "example": { + "range6_id": "range6_id" + }, + "properties": { + "range6_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_range6_delete_success", + "type": "object" + }, + "dns_zone_add_success": { + "example": { + "data": [ + { + "zone_id": "zone_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_zone_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dns_zone_edit_success": { + "example": { + "data": [ + { + "zone_id": "zone_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_zone_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_scope6_edit_success": { + "example": { + "data": [ + { + "scope6_id": "scope6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_scope6_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_ipam_space_delete_success": { + "example": { + "space_id": "space_id" + }, + "properties": { + "space_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_ipam_space_delete_success", + "type": "object" + }, + "dns_rr_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_rr_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dhcp_group_delete_success": { + "example": { + "group_id": "group_id" + }, + "properties": { + "group_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_group_delete_success", + "type": "object" + }, + "_data_inner_ipam_address6_delete_success": { + "example": { + "address6_id": "address6_id" + }, + "properties": { + "address6_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_ipam_address6_delete_success", + "type": "object" + }, + "_data_inner_dhcp_static6_edit_success": { + "example": { + "static6_id": "static6_id" + }, + "properties": { + "static6_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_static6_edit_success", + "type": "object" + }, + "ApiResponse": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_zoneparam_edit_success": { + "example": { + "data": [ + { + "zoneparam_id": "zoneparam_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_zoneparam_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dhcp_acl_data": { + "example": { + "server_name": "server_name", + "acl_spawnwith": "acl_spawnwith", + "server_id": "server_id", + "acl_leaselimit": "acl_leaselimit", + "acl_statement": "acl_statement", + "smart_parent_id": "smart_parent_id", + "acl_name": "acl_name", + "acl_delayed_create_time": "acl_delayed_create_time", + "server_cluster_role": "server_cluster_role", + "acl_delayed_delete_time": "acl_delayed_delete_time", + "acl_id": "acl_id", + "acl_match": "acl_match", + "server_type": "server_type" + }, + "properties": { + "server_cluster_role": { + "description": "The role of the server the object belongs to in the cluster, either active (M), passive (B) or N/A (#).", + "type": "string" + }, + "acl_delayed_create_time": { + "description": "The delay of creation status. 1 indicates that the object is not created yet.", + "type": "string" + }, + "acl_delayed_delete_time": { + "description": "The delay of deletion status. 1 indicates that the object is not deleted yet.", + "type": "string" + }, + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_name": { + "description": "The name of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_type": { + "description": "The type of the DHCPv4 server the object belongs to:


                                                                                                                                                                                                                                              server_type possible values
                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                              ipmEfficientIP or EfficientIP Package server
                                                                                                                                                                                                                                              msrpcMicrosoft Windows DHCP server
                                                                                                                                                                                                                                              vdhcpEfficientIP DHCPv4 smart architecture


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "acl_id": { + "description": "The database identifier (ID) of the DHCPv4 ACL.", + "type": "string" + }, + "acl_leaselimit": { + "description": "The lease limit of the DHCPv4 ACL.", + "type": "string" + }, + "acl_match": { + "description": "The ACL rule associated with the DHCPv4 ACL, as follows: <match if (substring(option agent.remote-id,0,6) = dslam1);>", + "type": "string" + }, + "acl_name": { + "description": "The name of the DHCPv4 ACL.", + "type": "string" + }, + "acl_spawnwith": { + "description": "The spawning class associated with the DHCPv4 ACL.", + "type": "string" + }, + "acl_statement": { + "description": "The statement associated with the DHCPv4 ACL.", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_acl_data", + "type": "object" + }, + "dhcp_range_edit_success": { + "example": { + "data": [ + { + "range_id": "range_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_range_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dns_zone_add_success": { + "example": { + "zone_id": "zone_id" + }, + "properties": { + "zone_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_dns_zone_add_success", + "type": "object" + }, + "_data_inner_dhcp_static6_delete_success": { + "example": { + "static6_id": "static6_id" + }, + "properties": { + "static6_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_static6_delete_success", + "type": "object" + }, + "_data_inner_vlan_domain_data": { + "example": { + "domain_id": "domain_id", + "domain_name": "domain_name", + "domain_end_vlan_id": "domain_end_vlan_id", + "domain_start_vlan_id": "domain_start_vlan_id", + "domain_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "domain_description": "domain_description", + "domain_support_vxlan": "domain_support_vxlan", + "domain_class_name": "domain_class_name" + }, + "properties": { + "domain_support_vxlan": { + "description": "The type of virtual network used by the domain, VXLAN (1) or VLAN (0).", + "type": "string" + }, + "domain_class_name": { + "description": "The name of the class applied to the VLAN domain, it can be preceded by the class directory.", + "type": "string" + }, + "domain_class_parameters": { + "description": "The class parameters applied to the VLAN domain.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "domain_description": { + "description": "The description of the VLAN domain.", + "type": "string" + }, + "domain_end_vlan_id": { + "description": "The VLAN identifier (ID) of the last VLAN in the VLAN domain.", + "type": "string" + }, + "domain_id": { + "description": "The database identifier (ID) of the VLAN domain.", + "type": "string" + }, + "domain_name": { + "description": "The name of the VLAN domain.", + "type": "string" + }, + "domain_start_vlan_id": { + "description": "The VLAN identifier (ID) of the first VLAN in the VLAN domain.", + "type": "string" + } + }, + "title": "_data_inner_vlan_domain_data", + "type": "object" + }, + "dhcp_sharednetwork_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_sharednetwork_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "vlan_vlan_add_success": { + "example": { + "data": [ + { + "vlan_id": "vlan_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_vlan_vlan_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_network_add_input": { + "properties": { + "parent_network_id": { + "description": "The database identifier (ID) of an existing IPv4 network you want to set as the parent of the IPv4 network you are adding. You can specify a subnet-type network to set up a network-based VLSM organization.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "network_addr": { + "description": "The start IP address of the IPv4 network, its first IP address.", + "type": "string" + }, + "network_end_addr": { + "description": "The end IP address of the IPv4 network, its last IP address.", + "type": "string" + }, + "network_mask": { + "description": "The netmask of the IPv4 network. It is expressed in dot-decimal notation and defines the number of addresses the network contains.", + "type": "string" + }, + "network_prefix": { + "description": "The prefix of the IPv4 network, an integer that defines the number of addresses the network contains.", + "type": "string" + }, + "network_size": { + "description": "The size of the IPv4 network, the number of IP addresses it contains.", + "type": "integer" + }, + "allow_block_creation": { + "description": "Internal use. Not documented.", + "type": "integer" + }, + "allow_tree_reparenting": { + "description": "A way to allow (1) or prevent (0) changing the parent of the network you are adding. Upon editing of the network, this parameter decides if you can associate it with a different parent network.", + "type": "integer" + }, + "network_is_terminal": { + "description": "A way to determine if a network can contain other networks. If set to 1, the network is terminal and cannot contain other subnet-type networks. By essence, block-type networks are non-terminal and are always set to 0.", + "type": "integer" + }, + "network_lock_network_broadcast": { + "description": "A way to prevent (1) users from assigning the broadcast IP address and network IP address of the network.", + "type": "integer" + }, + "permit_invalid": { + "description": "A way to authorize (1) IPv4 networks overlapping within a space.", + "type": "integer" + }, + "permit_no_block": { + "description": "A way to force the creation of an IPv4 subnet-type network. If set to 1, you can create a subnet-type network even if no block-type network matching the start address exists.", + "type": "integer" + }, + "relative_position": { + "description": "The position of the network within the hierarchy of networks of a VLSM organization. It calculates between 0 and n all the levels of the organization, its behavior depends on the value of the parameter use_reversed_relative_position:
                                                                                                                                                                                                                                              • use_reversed_relative_position=0 where 0 indicates a block-type network at the highest level possible, in a space-based organization, it belongs to the top space. The levels increment from 0 down to n, the lowest level you set up, within networks or spaces.
                                                                                                                                                                                                                                              • use_reversed_relative_position=1 where 1 indicates a network located at the lowest level of the organization, within networks or spaces. The levels increment from 0 up to n, the network at the highest level of the organization.
                                                                                                                                                                                                                                              ", + "type": "integer" + }, + "row_state": { + "description": "The object activation status.
                                                                                                                                                                                                                                              • If set to 0, the object is present in the database but ignored, i.e. it cannot be managed, counted or listed. This status is applied on objects deleted from the GUI.
                                                                                                                                                                                                                                              • If set to 1, the object is enabled and managed.
                                                                                                                                                                                                                                              • If set to 2, the object is unmanaged, disabled or both depending on the context.
                                                                                                                                                                                                                                              By default, row_state is set to 1 when an object is created.", + "enum": [ + "1", + "2" + ], + "type": "string" + }, + "network_level": { + "description": "The level of the network within the space:
                                                                                                                                                                                                                                              • Set it to 0 for a block-type network.
                                                                                                                                                                                                                                              • Set it to a value between 1 and n for a subnet-type network.
                                                                                                                                                                                                                                              If you set a value between 2 and n, you are setting a network-based VLSM organization where non terminal subnet-type networks can contain other subnet-type networks.", + "type": "integer" + }, + "network_name": { + "description": "The name of the IPv4 network, each IPv4 network must have a unique name.", + "type": "string" + }, + "use_reversed_relative_position": { + "description": "A way to determine if the calculation of the parameter relative_position should start from the top (0) or the bottom (1) of the VLSM organization.", + "type": "integer" + }, + "vlan_id": { + "description": "The database identifier (ID) of the VLAN you want to associate with the network.", + "type": "integer" + }, + "vlsm_space_id": { + "description": "The database identifier (ID) of a VLSM child space of the space specified in space_id. If you specify an ID, the subnet-type network you are adding is duplicated as a VLSM block-type network in the child space, with the same name but a different ID. This parameter serves the same purpose as vlsm_space_name.", + "type": "integer" + }, + "vlsm_space_name": { + "description": "The name of a VLSM child space of the space specified in space_id. If you specify a name, the subnet-type network you are adding is duplicated as a VLSM block-type network in the child space, with the same name but a different ID. This parameter serves the same purpose as vlsm_space_id.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "network_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "network_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dns_zoneparam_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_zoneparam_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_vlan_domain_delete_success": { + "example": { + "domain_id": "domain_id" + }, + "properties": { + "domain_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_vlan_domain_delete_success", + "type": "object" + }, + "vlan_vlan_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_vlan_vlan_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_ipam_network6_data": { + "example": { + "range_name": "range_name", + "vlsm_block6_id": "vlsm_block6_id", + "end_address6_addr": "end_address6_addr", + "parent_network6_class_name": "parent_network6_class_name", + "parent_network6_is_terminal": "parent_network6_is_terminal", + "vlan_id": "vlan_id", + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "vlsm_space_id": "vlsm_space_id", + "vlan_vlan_id": "vlan_vlan_id", + "network6_operation_details_requested_by": "network6_operation_details_requested_by", + "vlan_name": "vlan_name", + "parent_network_level": "parent_network_level", + "domain_id": "domain_id", + "vlsm_space_name": "vlsm_space_name", + "domain_name": "domain_name", + "percent_allocated": "percent_allocated", + "parent_network6_prefix": "parent_network6_prefix", + "space_class_name": "space_class_name", + "network6_operation_details_last_updated_on": "network6_operation_details_last_updated_on", + "parent_space_id": "parent_space_id", + "space_description": "space_description", + "network_level": "network_level", + "parent_vlsm_network6_id": "parent_vlsm_network6_id", + "network_size": "network_size", + "space_parent_space_id": "space_parent_space_id", + "space_is_template": "space_is_template", + "network6_ripe_waiting_state": "network6_ripe_waiting_state", + "network6_is_terminal": "network6_is_terminal", + "vlsm_network6_id": "vlsm_network6_id", + "network6_ripe_waiting_status": "network6_ripe_waiting_status", + "percent_used": "percent_used", + "space_name": "space_name", + "network6_id": "network6_id", + "parent_network_path": "parent_network_path", + "network6_start_hostaddr": "network6_start_hostaddr", + "parent_network6_percent_allocated": "parent_network6_percent_allocated", + "network6_is_valid": "network6_is_valid", + "parent_end_address6_addr": "parent_end_address6_addr", + "parent_start_address6_addr": "parent_start_address6_addr", + "network_path": "network_path", + "network6_end_hostaddr": "network6_end_hostaddr", + "parent_network6_id": "parent_network6_id", + "network6_name": "network6_name", + "range_id": "range_id", + "network6_operation_details_added_by": "network6_operation_details_added_by", + "start_address6_addr": "start_address6_addr", + "parent_network_size": "parent_network_size", + "network6_operation_details_added_on": "network6_operation_details_added_on", + "parent_space_name": "parent_space_name", + "network6_prefix": "network6_prefix", + "parent_network6_percent_used": "parent_network6_percent_used", + "network6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "network6_operation_details_origin_module": "network6_operation_details_origin_module", + "network6_multistatus": "network6_multistatus", + "parent_network6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "parent_network6_name": "parent_network6_name", + "network6_lock_network_broadcast": "network6_lock_network_broadcast", + "network6_class_name": "network6_class_name", + "network6_is_in_orphan": "network6_is_in_orphan", + "network6_operation_details_call_stack": "network6_operation_details_call_stack", + "space_id": "space_id" + }, + "properties": { + "network6_end_hostaddr": { + "description": "The human readable version of the parameter end_address6_addr.", + "type": "string" + }, + "end_address6_addr": { + "description": "The last IP address of the IPv6 network, in hexadecimal format.", + "type": "string" + }, + "network6_is_in_orphan": { + "description": "A way to determine if the network has a parent (0) or if it belongs to a container Orphan networks (1).", + "type": "string" + }, + "network6_is_terminal": { + "description": "A way to determine if a network can contain other networks. If set to 1, the network is terminal and cannot contain other subnet-type networks. Block-type networks are always set to 0.", + "type": "string" + }, + "network6_lock_network_broadcast": { + "description": "A way to prevent (1) users from assigning the broadcast IP address and network IP address of the network.", + "type": "string" + }, + "network6_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                                                                                                                              Multi-status severity levels
                                                                                                                                                                                                                                              Message number Severity Description
                                                                                                                                                                                                                                              0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                                                                                                                              17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                                                                                                                              34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                                                                                                                              51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                                                                                                                              67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                                                                                                                              84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "parent_end_address6_addr": { + "description": "The last IP address of the parent IPv6 network, in hexadecimal format.", + "type": "string" + }, + "parent_network6_is_terminal": { + "description": "A way to determine if the parent network is terminal (1) or non-terminal (0).", + "type": "string" + }, + "parent_network6_percent_allocated": { + "description": "The percentage of subnet-type networks the parent network contains.", + "type": "string" + }, + "parent_network6_percent_used": { + "description": "The percentage of terminal networks the parent network contains.", + "type": "string" + }, + "parent_space_id": { + "description": "The database identifier (ID) of the space where is located the parent network. 0 indicates that the network has no parent network.", + "type": "string" + }, + "parent_space_name": { + "description": "The name of the space where is located the parent network. # indicates that the network has no parent network.", + "type": "string" + }, + "parent_start_address6_addr": { + "description": "The first IP address of the parent IPv6 network, in hexadecimal format.", + "type": "string" + }, + "parent_network6_class_name": { + "description": "The name of the class applied to the parent IPv6 network, it can be preceded by the class directory.", + "type": "string" + }, + "parent_network6_class_parameters": { + "description": "The class parameters applied to the parent IPv6 network and their value: <class-parameter1>=<value1>&<class-parameter2>=<value2>&... .", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "parent_network6_id": { + "description": "The database identifier (ID) of the parent IPv6 network. 0 indicates that the network has no parent network.", + "type": "string" + }, + "parent_network6_name": { + "description": "The name of the parent IPv6 network. # indicates that the network has no parent network.", + "type": "string" + }, + "parent_network6_prefix": { + "description": "The prefix of the parent of the IPv6 network the object belongs to.", + "type": "string" + }, + "parent_network_level": { + "description": "The level of the parent network within the space. It returns values between 0 (block-type network) and n (subnet-type network). A value higher than 1 indicates a VLSM organization where a block-type network can belong to another subnet-type network.", + "type": "string" + }, + "parent_network_path": { + "description": "The path toward the parent network in the database. # indicates the network has no parent network.", + "type": "string" + }, + "parent_network_size": { + "description": "The number of IP addresses of the network parent, in hexadecimal format.", + "type": "string" + }, + "parent_vlsm_network6_id": { + "description": "The database identifier (ID) of the IPv6 subnet-type network, located in the VLSM parent space, from which the parent network was duplicated. 0 indicates that the parent network is not a VLSM block-type network duplicated from a parent space.", + "type": "string" + }, + "percent_allocated": { + "description": "The percentage of subnet-type networks the non-terminal network contains.", + "type": "string" + }, + "percent_used": { + "description": "The percentage of terminal networks the non-terminal network contains.", + "type": "string" + }, + "space_class_name": { + "description": "The name of the class applied to the space the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "space_class_parameters": { + "description": "The class parameters applied to the space the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "space_description": { + "description": "The description of the space the object belongs to.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space the object belongs to, a unique numeric key value automatically incremented when you add a space.", + "type": "string" + }, + "space_is_template": { + "description": "The template status of the space the object belongs to. If the space is used as template (1), all the IPv4 networks, pools and IP addresses it contains are also used as template.", + "type": "string" + }, + "space_name": { + "description": "The name of the space the object belongs to.", + "type": "string" + }, + "space_parent_space_id": { + "description": "The database identifier (ID) of the VLSM parent of the space where is located the network. 0 indicates that the space where is located the network has no parent space.", + "type": "string" + }, + "network6_start_hostaddr": { + "description": "The human readable version of the parameter start_address6_addr.", + "type": "string" + }, + "start_address6_addr": { + "description": "The first IP address of the IPv6 network, in hexadecimal format.", + "type": "string" + }, + "network6_class_name": { + "description": "The name of the class applied to the IPv6 network, it can be preceded by the class directory.", + "type": "string" + }, + "network6_class_parameters": { + "description": "The class parameters applied to the IPv6 network.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "network6_id": { + "description": "The database identifier (ID) of the IPv6 network.", + "type": "string" + }, + "network6_is_valid": { + "description": "The network validity. A valid network (1) has a prefix and last IP address that match.", + "type": "string" + }, + "network6_name": { + "description": "The name of the IPv6 network.", + "type": "string" + }, + "network6_prefix": { + "description": "The prefix of the IPv6 network.", + "type": "string" + }, + "network_level": { + "description": "The level of the network within the space. It returns values between 0 (block-type network) and n (subnet-type network). A value higher than 1 indicates a VLSM organization where a block-type network can belong to another subnet-type network.", + "type": "string" + }, + "network_path": { + "description": "The path toward the network in the database from the containing block-type network down to the subnet-type network: <block-network-start-IP>#<block-network-ID>#<subnet-network-start-IP>#<subnet-network-ID>. The IP address is returned in hexadecimal format.
                                                                                                                                                                                                                                              • In network-based VLSM organizations, the path includes all the subnet-type networks there are from the containing block-type network down to the subnet-type network specified in subnet_id.
                                                                                                                                                                                                                                              • In space-based VLSM organizations, the path includes the block-type network of the top parent space and all the subnet-type networks there are until the network specified in subnet_id. Only one block-type network is returned.
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "network_size": { + "description": "The number of IP addresses the IPv6 network contains.", + "type": "string" + }, + "network6_operation_details_added_on": { + "description": "The creation date of the IPv6 network, in decimal UNIX date format.", + "type": "string" + }, + "network6_operation_details_call_stack": { + "description": "The call stack of the IPv6 network operation details, as follows: <service1>&<service2>&<service3>... .", + "type": "string" + }, + "network6_operation_details_origin_module": { + "description": "The name of the module where the IPv6 network addition originated.", + "type": "string" + }, + "network6_operation_details_requested_by": { + "description": "The login of the user who requested the IPv6 network.", + "type": "string" + }, + "network6_operation_details_added_by": { + "description": "The login of the user who added the IPv6 network.", + "type": "string" + }, + "network6_operation_details_last_updated_on": { + "description": "The last time the IPv6 network was updated, in decimal UNIX date format.", + "type": "string" + }, + "domain_id": { + "description": "The database identifier (ID) of the VLAN domain associated with the network.", + "type": "string" + }, + "domain_name": { + "description": "The name of the VLAN domain associated with the network.", + "type": "string" + }, + "range_id": { + "description": "The database identifier (ID) of the VLAN range associated with the network.", + "type": "string" + }, + "range_name": { + "description": "The name of the VLAN range associated with the network.", + "type": "string" + }, + "vlan_id": { + "description": "The database identifier (ID) of the VLAN associated with the network.", + "type": "string" + }, + "vlan_name": { + "description": "The name of the VLAN associated with the network.", + "type": "string" + }, + "vlan_vlan_id": { + "description": "The VLAN identifier (ID) of the VLAN associated with the network.", + "type": "string" + }, + "vlsm_block6_id": { + "description": "The database identifier (ID) of the IPv6 VLSM block-type network duplicated, in a VLSM child space, from the network. 0 indicates that the network is not duplicated as a VLSM block-type network in a child space.", + "type": "string" + }, + "vlsm_space_id": { + "description": "The database identifier (ID) of the VLSM child space where the network is duplicated as a VLSM block-type network. 0 indicates that the network is not duplicated as a VLSM block-type network in a child space.", + "type": "string" + }, + "vlsm_space_name": { + "description": "The name of the VLSM child space where the network is duplicated as a VLSM block-type network. 0 indicates that the network is not duplicated as a VLSM block-type network in a child space.", + "type": "string" + }, + "vlsm_network6_id": { + "description": "The database identifier (ID) of the IPv6 subnet-type network, located in the VLSM parent space, from which the network was duplicated. 0 indicates that the network is not a VLSM block-type network duplicated from a parent space.", + "type": "string" + }, + "network6_ripe_waiting_state": { + "description": "The state of the exchange between SOLIDserver and the RIPE for the assigned network:


                                                                                                                                                                                                                                              network6_ripe_waiting_state possible values
                                                                                                                                                                                                                                              StatusDescription
                                                                                                                                                                                                                                              must_send_mail_addAn email must be sent to the RIPE to notify them of a subnet-type network creation.
                                                                                                                                                                                                                                              wait_mail_addA network creation email was sent to the RIPE, no reply has been received yet.
                                                                                                                                                                                                                                              must_send_mail_delAn email must be sent to the RIPE to notify them of a subnet-type network deletion.
                                                                                                                                                                                                                                              wait_mail_delA network deletion email was sent to the RIPE, no reply has been received yet.
                                                                                                                                                                                                                                              wait_aw_confirmThe number of IP addresses of the assigned network exceeds the Assignment Window declared during your RIPE configuration.


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "network6_ripe_waiting_status": { + "description": "The status of a RIPE assigned network within SOLIDserver until it is confirmed that you can create or delete it. If set to 1, it is about to be created. If set to 2, it is about to be deleted.", + "type": "string" + } + }, + "title": "_data_inner_ipam_network6_data", + "type": "object" + }, + "dhcp_group_edit_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "group_id": { + "description": "The database identifier (ID) of the DHCPv4 group, a unique numeric key value automatically incremented when you add a DHCPv4 group. Use the ID to specify the DHCPv4 group of your choice.", + "type": "integer" + }, + "group_name": { + "description": "The name of the DHCPv4 group, each DHCPv4 group must have a unique name.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "group_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "group_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dhcp_static_add_success": { + "example": { + "data": [ + { + "static_id": "static_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_static_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_sharednetwork_edit_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "sharednetwork_id": { + "description": "The database identifier (ID) of the DHCPv4 shared network, a unique numeric key value automatically incremented when you add a DHCPv4 shared network. Use the ID to specify the DHCPv4 shared network of your choice.", + "type": "integer" + }, + "sharednetwork_name": { + "description": "The name of the DHCPv4 shared network, each DHCPv4 shared network must have a unique name.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "vlan_domain_add_input": { + "properties": { + "domain_name": { + "description": "The name of the VLAN domain, each VLAN domain must have a unique name.", + "type": "string" + }, + "domain_support_vxlan": { + "description": "The type of virtual network used by the domain. Set it to 1 to use VXLAN or 0 to use VLAN.", + "type": "integer" + }, + "domain_description": { + "description": "The description of the VLAN domain.", + "type": "string" + }, + "domain_end_vlan_id": { + "description": "The VLAN identifier (ID) of a VLAN, a numeric value between 1 and 4094. Use the ID to specify the last VLAN in the VLAN domain.", + "type": "integer" + }, + "domain_start_vlan_id": { + "description": "The VLAN identifier (ID) of a VLAN, a numeric value between 1 and 4094. Use the ID to specify the first VLAN in the VLAN domain.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "domain_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "domain_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_data_inner_dns_acl_add_success": { + "example": { + "acl_id": "acl_id" + }, + "properties": { + "acl_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_dns_acl_add_success", + "type": "object" + }, + "dns_zoneparam_edit_input": { + "properties": { + "zone_id": { + "description": "The database identifier (ID) of the DNS zone, a unique numeric key value automatically incremented when you add a DNS zone. Use the ID to specify the DNS zone of your choice.", + "type": "integer" + }, + "zoneparam_key": { + "description": "The name of the DNS option you want to add, edit or remove from the zone. You can only set one option at a time.
                                                                                                                                                                                                                                              • To add or edit an option: specify its name in the parameter zoneparam_key, as follows zoneparam_key=<option-name>, and then specify its value in the parameter zoneparam_value.
                                                                                                                                                                                                                                              • To remove an option, specify its name in the parameter zoneparam_key and leave the parameter zoneparam_value empty.
                                                                                                                                                                                                                                              To set several options, specify as many parameters (zoneparam_key and zoneparam_value) as you need.", + "type": "string" + }, + "zoneparam_is_array": { + "description": "A way to determine is the DNS zone option is an array (1).", + "type": "integer" + }, + "zoneparam_value": { + "description": "The value of the DNS option specified in the input zoneparam_key.
                                                                                                                                                                                                                                              • To add or edit an option value, specify its name in the parameter zoneparam_key and set its value as follows: zoneparam_value=<option-value> .
                                                                                                                                                                                                                                              • To remove an option value, specify its name in the parameter zoneparam_key and leave zoneparam_value empty: zoneparam_value= .
                                                                                                                                                                                                                                              ", + "type": "string" + } + }, + "type": "object" + }, + "dhcp_scope_add_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "scope_net_addr": { + "description": "The first IP address of the DHCPv4 scope.", + "type": "string" + }, + "scope_net_mask": { + "description": "The netmask of the DHCPv4 scope. It is expressed in dot-decimal notation and defines the number of addresses the scope contains.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "failover_id": { + "description": "The database identifier (ID) of the DHCPv4 failover channel, a unique numeric key value automatically incremented when you add a DHCPv4 failover channel. Use the ID to specify the DHCPv4 failover channel of your choice.", + "type": "integer" + }, + "failover_name": { + "description": "The name of the DHCPv4 failover channel.", + "type": "string" + }, + "scope_name": { + "description": "The name of the DHCPv4 scope, each DHCPv4 scope must have a unique name.", + "type": "string" + }, + "scope_space_id": { + "description": "The database identifier (ID) of an existing space you want to associate with the DHCPv4 scope.", + "type": "integer" + }, + "scope_space_name": { + "description": "The name of an existing space you want to associate with the DHCPv4 scope.", + "type": "string" + }, + "sharednetwork_id": { + "description": "The database identifier (ID) of the DHCPv4 shared network, a unique numeric key value automatically incremented when you add a DHCPv4 shared network. Use the ID to specify the DHCPv4 shared network of your choice.", + "type": "integer" + }, + "sharednetwork_name": { + "description": "The name of the DHCPv4 shared network.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "scope_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "scope_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dns_viewparam_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_viewparam_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_pool6_edit_success": { + "example": { + "data": [ + { + "pool6_id": "pool6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_pool6_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_range6_add_input": { + "properties": { + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "type": "integer" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "range6_end_addr": { + "description": "The last IP address of the DHCPv6 range.", + "type": "string" + }, + "range6_start_addr": { + "description": "The first IP address of the DHCPv6 range.", + "type": "string" + }, + "scope6_id": { + "description": "The database identifier (ID) of the DHCPv6 scope, a unique numeric key value automatically incremented when you add a DHCPv6 scope. Use the ID to specify the DHCPv6 scope of your choice.", + "type": "integer" + }, + "server6_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "range6_acl": { + "description": "The list of ACLs associated with the DHCPv6 range, as follows: <ACL_name>;<ACL_name>;... .", + "type": "string" + }, + "scope6_name": { + "description": "The name of the DHCPv6 scope.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "range6_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "range6_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_data_inner_dhcp_scope_add_success": { + "example": { + "scope_id": "scope_id" + }, + "properties": { + "scope_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_scope_add_success", + "type": "object" + }, + "dhcp_static6_add_success": { + "example": { + "data": [ + { + "static6_id": "static6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_static6_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dns_viewparam_data": { + "example": { + "server_name": "server_name", + "viewparam_key": "viewparam_key", + "viewparam_delayed_delete_time": "viewparam_delayed_delete_time", + "viewparam_delayed_create_time": "viewparam_delayed_create_time", + "viewparam_value": "viewparam_value", + "view_id": "view_id", + "oid": "oid", + "server_id": "server_id", + "view_name": "view_name" + }, + "properties": { + "viewparam_value": { + "description": "The value of the DNS option set on the view.", + "type": "string" + }, + "viewparam_delayed_create_time": { + "description": "The delay of creation status. 1 indicates that the object is not created yet.", + "type": "string" + }, + "viewparam_delayed_delete_time": { + "description": "The delay of deletion status. 1 indicates that the object is not deleted yet.", + "type": "string" + }, + "server_id": { + "description": "The database identifier (ID) of the DNS server the object belongs to.", + "type": "string" + }, + "server_name": { + "description": "The name of the DNS server the object belongs to.", + "type": "string" + }, + "view_id": { + "description": "The database identifier (ID) of the DNS view.", + "type": "string" + }, + "view_name": { + "description": "The name of the DNS view.", + "type": "string" + }, + "oid": { + "description": "The database identifier (ID) of the DNS view param the object belongs to.", + "type": "string" + }, + "viewparam_key": { + "description": "The name of the DNS option set on the view.", + "type": "string" + } + }, + "title": "_data_inner_dns_viewparam_data", + "type": "object" + }, + "_data_inner_ipam_alias6_data": { + "example": { + "address6_id": "address6_id", + "device_id": "device_id", + "alias_name": "alias_name", + "pool6_id": "pool6_id", + "interface_id": "interface_id", + "address6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "address6_name": "address6_name", + "space_name": "space_name", + "network6_id": "network6_id", + "space_class_name": "space_class_name", + "alias6_type": "alias6_type", + "port_id": "port_id", + "address6_addr": "address6_addr", + "alias6_id": "alias6_id", + "address6_mac_addr": "address6_mac_addr", + "space_id": "space_id", + "address6_class_name": "address6_class_name" + }, + "properties": { + "alias_name": { + "description": "The name of the alias.", + "type": "string" + }, + "device_id": { + "description": "The database identifier (ID) of the Device Manager device associated with the IP address.", + "type": "string" + }, + "interface_id": { + "description": "The database identifier (ID) of the Device Manager interface associated with the IP address.", + "type": "string" + }, + "address6_addr": { + "description": "The IPv6 alias itself.", + "type": "string" + }, + "address6_class_name": { + "description": "The name of the class applied to the object, it can be preceded by the class directory.", + "type": "string" + }, + "address6_class_parameters": { + "description": "The class parameters applied to the IPv6 alias.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "address6_id": { + "description": "The database identifier (ID) of the IPv6 address associated with the alias.", + "type": "string" + }, + "address6_mac_addr": { + "description": "The MAC address associated with the IPv6 alias.", + "type": "string" + }, + "address6_name": { + "description": "The name of the IPv6 address associated with the alias.", + "type": "string" + }, + "alias6_id": { + "description": "The database identifier (ID) of the IPv6 alias.", + "type": "string" + }, + "alias6_type": { + "description": "The type of the alias, either CNAME or AAAA.", + "type": "string" + }, + "port_id": { + "description": "The database identifier (ID) of the NetChange port associated with the IP address.", + "type": "string" + }, + "pool6_id": { + "description": "The database identifier (ID) of the IPv6 pool the object belongs to.", + "type": "string" + }, + "space_class_name": { + "description": "The name of the class applied to the space the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space the object belongs to, a unique numeric key value automatically incremented when you add a space.", + "type": "string" + }, + "space_name": { + "description": "The name of the space the object belongs to.", + "type": "string" + }, + "network6_id": { + "description": "The database identifier (ID) of the IPv6 network the object belongs to.", + "type": "string" + } + }, + "title": "_data_inner_ipam_alias6_data", + "type": "object" + }, + "_data_inner_ipam_pool_edit_success": { + "example": { + "pool_id": "pool_id" + }, + "properties": { + "pool_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_ipam_pool_edit_success", + "type": "object" + }, + "dns_acl_edit_success": { + "example": { + "data": [ + { + "acl_id": "acl_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_acl_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_sharednetwork_add_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "sharednetwork_name": { + "description": "The name of the DHCPv4 shared network, each DHCPv4 shared network must have a unique name.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dns_view_data": { + "example": { + "data": [ + { + "server_name": "server_name", + "view_order": "view_order", + "server_class_name": "server_class_name", + "server_gss_keytab_id": "server_gss_keytab_id", + "server_version": "server_version", + "view_allow_transfer": "view_allow_transfer", + "view_delayed_create_time": "view_delayed_create_time", + "view_delayed_delete_time": "view_delayed_delete_time", + "view_recursion": "view_recursion", + "smart_parent_id": "smart_parent_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "smart_parent_name": "smart_parent_name", + "server_cloud": "server_cloud", + "view_name": "view_name", + "server_comment": "server_comment", + "view_class_name": "view_class_name", + "view_key_name": "view_key_name", + "view_id": "view_id", + "server_id": "server_id", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "view_multistatus": "view_multistatus", + "view_match_clients": "view_match_clients", + "view_match_to": "view_match_to", + "view_allow_recursion": "view_allow_recursion", + "view_allow_query": "view_allow_query", + "view_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_type": "server_type" + }, + { + "server_name": "server_name", + "view_order": "view_order", + "server_class_name": "server_class_name", + "server_gss_keytab_id": "server_gss_keytab_id", + "server_version": "server_version", + "view_allow_transfer": "view_allow_transfer", + "view_delayed_create_time": "view_delayed_create_time", + "view_delayed_delete_time": "view_delayed_delete_time", + "view_recursion": "view_recursion", + "smart_parent_id": "smart_parent_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "smart_parent_name": "smart_parent_name", + "server_cloud": "server_cloud", + "view_name": "view_name", + "server_comment": "server_comment", + "view_class_name": "view_class_name", + "view_key_name": "view_key_name", + "view_id": "view_id", + "server_id": "server_id", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "view_multistatus": "view_multistatus", + "view_match_clients": "view_match_clients", + "view_match_to": "view_match_to", + "view_allow_recursion": "view_allow_recursion", + "view_allow_query": "view_allow_query", + "view_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_type": "server_type" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_view_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_ipam_address6_add_success": { + "example": { + "address6_id": "address6_id" + }, + "properties": { + "address6_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_ipam_address6_add_success", + "type": "object" + }, + "dns_view_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_view_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_server_data": { + "example": { + "data": [ + { + "server_ipm_protocol": "server_ipm_protocol", + "server_aws_role_arn": "server_aws_role_arn", + "server_stat_enabled": "server_stat_enabled", + "server_dnssec_validation": "server_dnssec_validation", + "server_ipm_type": "server_ipm_type", + "server_stat_time": "server_stat_time", + "server_gss_keytab_id": "server_gss_keytab_id", + "server_ldap_domain": "server_ldap_domain", + "server_version": "server_version", + "server_stat_niceness": "server_stat_niceness", + "server_recursion": "server_recursion", + "server_multistatus": "server_multistatus", + "smart_parent_name": "smart_parent_name", + "server_allow_recursion": "server_allow_recursion", + "server_az_tenantid": "server_az_tenantid", + "server_key_name": "server_key_name", + "server_aws_use_role": "server_aws_use_role", + "server_key_proto": "server_key_proto", + "server_also_notify": "server_also_notify", + "server_allow_query_cache": "server_allow_query_cache", + "server_notify": "server_notify", + "server_rpz_max_policy_ttl": "server_rpz_max_policy_ttl", + "server_stat_period": "server_stat_period", + "server_aws_role_external_id": "server_aws_role_external_id", + "server_id": "server_id", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "server_rpz_qname_wait_recurse": "server_rpz_qname_wait_recurse", + "server_gslb_supported": "server_gslb_supported", + "server_vpc_list": "server_vpc_list", + "server_forward": "server_forward", + "server_aws_role_session_name": "server_aws_role_session_name", + "connectionprofile_name": "connectionprofile_name", + "server_role": "server_role", + "reverse_proxy_conf": "reverse_proxy_conf", + "server_aws_delegation_set": "server_aws_delegation_set", + "server_querylog_state": "server_querylog_state", + "server_name": "server_name", + "smart_parent_arch": "smart_parent_arch", + "server_gss_enabled": "server_gss_enabled", + "server_class_name": "server_class_name", + "server_guardian_stats_only_supported": "server_guardian_stats_only_supported", + "server_forwarders": "server_forwarders", + "server_hybrid": "server_hybrid", + "server_guardian_gui_management_supported": "server_guardian_gui_management_supported", + "server_rpz_break_dnssec": "server_rpz_break_dnssec", + "smart_parent_id": "smart_parent_id", + "server_blast_status": "server_blast_status", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_ipm_is_package": "server_ipm_is_package", + "smart_arch": "smart_arch", + "server_aws_keyid": "server_aws_keyid", + "server_rpz_min_ns_dots": "server_rpz_min_ns_dots", + "server_ipm_login": "server_ipm_login", + "server_az_group": "server_az_group", + "server_state": "server_state", + "server_cloud": "server_cloud", + "server_cloud_private": "server_cloud_private", + "server_blast_enabled": "server_blast_enabled", + "server_az_subscriptionid": "server_az_subscriptionid", + "server_comment": "server_comment", + "server_synching": "server_synching", + "total_smart_members": "total_smart_members", + "server_isolated": "server_isolated", + "server_windns_port": "server_windns_port", + "server_az_keyid": "server_az_keyid", + "server_force_hybrid": "server_force_hybrid", + "smart_public_ns_list": "smart_public_ns_list", + "server_key_value": "server_key_value", + "server_snmp_id": "server_snmp_id", + "server_rpz_recursive_only": "server_rpz_recursive_only", + "smart_members_name": "smart_members_name", + "server_allow_query": "server_allow_query", + "server_ldap_user": "server_ldap_user", + "server_guardian_push_status": "server_guardian_push_status", + "server_guardian_supported": "server_guardian_supported", + "server_windns_protocol": "server_windns_protocol", + "server_allow_transfer": "server_allow_transfer", + "server_windns_use_ssl": "server_windns_use_ssl", + "server_type": "server_type" + }, + { + "server_ipm_protocol": "server_ipm_protocol", + "server_aws_role_arn": "server_aws_role_arn", + "server_stat_enabled": "server_stat_enabled", + "server_dnssec_validation": "server_dnssec_validation", + "server_ipm_type": "server_ipm_type", + "server_stat_time": "server_stat_time", + "server_gss_keytab_id": "server_gss_keytab_id", + "server_ldap_domain": "server_ldap_domain", + "server_version": "server_version", + "server_stat_niceness": "server_stat_niceness", + "server_recursion": "server_recursion", + "server_multistatus": "server_multistatus", + "smart_parent_name": "smart_parent_name", + "server_allow_recursion": "server_allow_recursion", + "server_az_tenantid": "server_az_tenantid", + "server_key_name": "server_key_name", + "server_aws_use_role": "server_aws_use_role", + "server_key_proto": "server_key_proto", + "server_also_notify": "server_also_notify", + "server_allow_query_cache": "server_allow_query_cache", + "server_notify": "server_notify", + "server_rpz_max_policy_ttl": "server_rpz_max_policy_ttl", + "server_stat_period": "server_stat_period", + "server_aws_role_external_id": "server_aws_role_external_id", + "server_id": "server_id", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "server_rpz_qname_wait_recurse": "server_rpz_qname_wait_recurse", + "server_gslb_supported": "server_gslb_supported", + "server_vpc_list": "server_vpc_list", + "server_forward": "server_forward", + "server_aws_role_session_name": "server_aws_role_session_name", + "connectionprofile_name": "connectionprofile_name", + "server_role": "server_role", + "reverse_proxy_conf": "reverse_proxy_conf", + "server_aws_delegation_set": "server_aws_delegation_set", + "server_querylog_state": "server_querylog_state", + "server_name": "server_name", + "smart_parent_arch": "smart_parent_arch", + "server_gss_enabled": "server_gss_enabled", + "server_class_name": "server_class_name", + "server_guardian_stats_only_supported": "server_guardian_stats_only_supported", + "server_forwarders": "server_forwarders", + "server_hybrid": "server_hybrid", + "server_guardian_gui_management_supported": "server_guardian_gui_management_supported", + "server_rpz_break_dnssec": "server_rpz_break_dnssec", + "smart_parent_id": "smart_parent_id", + "server_blast_status": "server_blast_status", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_ipm_is_package": "server_ipm_is_package", + "smart_arch": "smart_arch", + "server_aws_keyid": "server_aws_keyid", + "server_rpz_min_ns_dots": "server_rpz_min_ns_dots", + "server_ipm_login": "server_ipm_login", + "server_az_group": "server_az_group", + "server_state": "server_state", + "server_cloud": "server_cloud", + "server_cloud_private": "server_cloud_private", + "server_blast_enabled": "server_blast_enabled", + "server_az_subscriptionid": "server_az_subscriptionid", + "server_comment": "server_comment", + "server_synching": "server_synching", + "total_smart_members": "total_smart_members", + "server_isolated": "server_isolated", + "server_windns_port": "server_windns_port", + "server_az_keyid": "server_az_keyid", + "server_force_hybrid": "server_force_hybrid", + "smart_public_ns_list": "smart_public_ns_list", + "server_key_value": "server_key_value", + "server_snmp_id": "server_snmp_id", + "server_rpz_recursive_only": "server_rpz_recursive_only", + "smart_members_name": "smart_members_name", + "server_allow_query": "server_allow_query", + "server_ldap_user": "server_ldap_user", + "server_guardian_push_status": "server_guardian_push_status", + "server_guardian_supported": "server_guardian_supported", + "server_windns_protocol": "server_windns_protocol", + "server_allow_transfer": "server_allow_transfer", + "server_windns_use_ssl": "server_windns_use_ssl", + "server_type": "server_type" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_server_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dns_view_add_success": { + "example": { + "view_id": "view_id" + }, + "properties": { + "view_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_dns_view_add_success", + "type": "object" + }, + "ipam_space_add_success": { + "example": { + "data": [ + { + "space_id": "space_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_space_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_network6_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_network6_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dns_zoneparam_data": { + "example": { + "server_name": "server_name", + "zone_id": "zone_id", + "zoneparam_key": "zoneparam_key", + "zoneparam_delayed_delete_time": "zoneparam_delayed_delete_time", + "zoneparam_delayed_create_time": "zoneparam_delayed_create_time", + "zoneparam_value": "zoneparam_value", + "zone_name": "zone_name", + "oid": "oid", + "server_id": "server_id" + }, + "properties": { + "zoneparam_value": { + "description": "The value of the DNS option set on the zone.", + "type": "string" + }, + "zoneparam_delayed_create_time": { + "description": "The delay of creation status. 1 indicates that the object is not created yet.", + "type": "string" + }, + "zoneparam_delayed_delete_time": { + "description": "The delay of deletion status. 1 indicates that the object is not deleted yet.", + "type": "string" + }, + "server_id": { + "description": "The database identifier (ID) of the DNS server the object belongs to.", + "type": "string" + }, + "server_name": { + "description": "The name of the DNS server the object belongs to.", + "type": "string" + }, + "zone_id": { + "description": "The database identifier (ID) of the DNS zone.", + "type": "string" + }, + "zone_name": { + "description": "The name of the DNS zone.", + "type": "string" + }, + "oid": { + "description": "The database identifier (ID) of the DNS zone param the object belongs to.", + "type": "string" + }, + "zoneparam_key": { + "description": "The name of the DNS option set on the zone.", + "type": "string" + } + }, + "title": "_data_inner_dns_zoneparam_data", + "type": "object" + }, + "dns_acl_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_acl_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dhcp_range_delete_success": { + "example": { + "range_id": "range_id" + }, + "properties": { + "range_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_range_delete_success", + "type": "object" + }, + "ipam_pool6_data": { + "example": { + "data": [ + { + "vlsm_block6_id": "vlsm_block6_id", + "end_address6_addr": "end_address6_addr", + "parent_network6_class_name": "parent_network6_class_name", + "pool6_operation_details_requested_by": "pool6_operation_details_requested_by", + "pool6_end_address6_addr": "pool6_end_address6_addr", + "pool6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "parent_network6_id": "parent_network6_id", + "network6_name": "network6_name", + "pool6_operation_details_last_updated_on": "pool6_operation_details_last_updated_on", + "parent_network6_prefix": "parent_network6_prefix", + "space_class_name": "space_class_name", + "start_address6_addr": "start_address6_addr", + "space_description": "space_description", + "pool6_read_only": "pool6_read_only", + "pool6_class_name": "pool6_class_name", + "network6_end_address6_addr": "network6_end_address6_addr", + "network6_prefix": "network6_prefix", + "pool6_operation_details_call_stack": "pool6_operation_details_call_stack", + "network6_start_address6_addr": "network6_start_address6_addr", + "pool6_size": "pool6_size", + "pool6_start_hostaddr": "pool6_start_hostaddr", + "pool6_operation_details_origin_module": "pool6_operation_details_origin_module", + "network6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_is_template": "space_is_template", + "pool6_operation_details_added_on": "pool6_operation_details_added_on", + "vlsm_network6_id": "vlsm_network6_id", + "parent_network6_name": "parent_network6_name", + "pool6_id": "pool6_id", + "pool6_multistatus": "pool6_multistatus", + "pool6_operation_details_added_by": "pool6_operation_details_added_by", + "pool6_name": "pool6_name", + "space_name": "space_name", + "network6_id": "network6_id", + "network6_class_name": "network6_class_name", + "pool6_end_hostaddr": "pool6_end_hostaddr", + "space_id": "space_id", + "pool6_start_address6_addr": "pool6_start_address6_addr" + }, + { + "vlsm_block6_id": "vlsm_block6_id", + "end_address6_addr": "end_address6_addr", + "parent_network6_class_name": "parent_network6_class_name", + "pool6_operation_details_requested_by": "pool6_operation_details_requested_by", + "pool6_end_address6_addr": "pool6_end_address6_addr", + "pool6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "parent_network6_id": "parent_network6_id", + "network6_name": "network6_name", + "pool6_operation_details_last_updated_on": "pool6_operation_details_last_updated_on", + "parent_network6_prefix": "parent_network6_prefix", + "space_class_name": "space_class_name", + "start_address6_addr": "start_address6_addr", + "space_description": "space_description", + "pool6_read_only": "pool6_read_only", + "pool6_class_name": "pool6_class_name", + "network6_end_address6_addr": "network6_end_address6_addr", + "network6_prefix": "network6_prefix", + "pool6_operation_details_call_stack": "pool6_operation_details_call_stack", + "network6_start_address6_addr": "network6_start_address6_addr", + "pool6_size": "pool6_size", + "pool6_start_hostaddr": "pool6_start_hostaddr", + "pool6_operation_details_origin_module": "pool6_operation_details_origin_module", + "network6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_is_template": "space_is_template", + "pool6_operation_details_added_on": "pool6_operation_details_added_on", + "vlsm_network6_id": "vlsm_network6_id", + "parent_network6_name": "parent_network6_name", + "pool6_id": "pool6_id", + "pool6_multistatus": "pool6_multistatus", + "pool6_operation_details_added_by": "pool6_operation_details_added_by", + "pool6_name": "pool6_name", + "space_name": "space_name", + "network6_id": "network6_id", + "network6_class_name": "network6_class_name", + "pool6_end_hostaddr": "pool6_end_hostaddr", + "space_id": "space_id", + "pool6_start_address6_addr": "pool6_start_address6_addr" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_pool6_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_scope_data": { + "example": { + "data": [ + { + "server_name": "server_name", + "sharednetwork_id": "sharednetwork_id", + "server_class_name": "server_class_name", + "scope_start_address_addr": "scope_start_address_addr", + "server_version": "server_version", + "scope_space_name": "scope_space_name", + "scope_name": "scope_name", + "scope_delayed_create_time": "scope_delayed_create_time", + "smart_parent_id": "smart_parent_id", + "scope_multistatus": "scope_multistatus", + "scope_id": "scope_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "smart_parent_name": "smart_parent_name", + "scope_size": "scope_size", + "smart_arch": "smart_arch", + "scope_end_address_addr": "scope_end_address_addr", + "failover_name": "failover_name", + "sharednetwork_name": "sharednetwork_name", + "scope_delayed_delete_time": "scope_delayed_delete_time", + "server_id": "server_id", + "server_addr": "server_addr", + "scope_net_mask": "scope_net_mask", + "server_hostaddr": "server_hostaddr", + "scope_net_addr": "scope_net_addr", + "server_addr6": "server_addr6", + "scope_space_id": "scope_space_id", + "scope_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_type": "server_type", + "failover_id": "failover_id", + "scope_class_name": "scope_class_name" + }, + { + "server_name": "server_name", + "sharednetwork_id": "sharednetwork_id", + "server_class_name": "server_class_name", + "scope_start_address_addr": "scope_start_address_addr", + "server_version": "server_version", + "scope_space_name": "scope_space_name", + "scope_name": "scope_name", + "scope_delayed_create_time": "scope_delayed_create_time", + "smart_parent_id": "smart_parent_id", + "scope_multistatus": "scope_multistatus", + "scope_id": "scope_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "smart_parent_name": "smart_parent_name", + "scope_size": "scope_size", + "smart_arch": "smart_arch", + "scope_end_address_addr": "scope_end_address_addr", + "failover_name": "failover_name", + "sharednetwork_name": "sharednetwork_name", + "scope_delayed_delete_time": "scope_delayed_delete_time", + "server_id": "server_id", + "server_addr": "server_addr", + "scope_net_mask": "scope_net_mask", + "server_hostaddr": "server_hostaddr", + "scope_net_addr": "scope_net_addr", + "server_addr6": "server_addr6", + "scope_space_id": "scope_space_id", + "scope_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_type": "server_type", + "failover_id": "failover_id", + "scope_class_name": "scope_class_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_scope_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_pool6_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_pool6_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_vlan_range_data": { + "example": { + "range_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_name": "range_name", + "domain_end_vlan_id": "domain_end_vlan_id", + "range_end_vlan_id": "range_end_vlan_id", + "domain_start_vlan_id": "domain_start_vlan_id", + "domain_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_start_vlan_id": "range_start_vlan_id", + "domain_description": "domain_description", + "range_id": "range_id", + "domain_id": "domain_id", + "domain_name": "domain_name", + "range_disable_overlapping": "range_disable_overlapping", + "range_class_name": "range_class_name", + "range_description": "range_description", + "domain_support_vxlan": "domain_support_vxlan", + "domain_class_name": "domain_class_name" + }, + "properties": { + "domain_support_vxlan": { + "description": "The type of virtual network used by the domain the range belongs to, VXLAN (1) or VLAN (0).", + "type": "string" + }, + "domain_class_name": { + "description": "The name of the class applied to the VLAN domain the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "domain_class_parameters": { + "description": "The class parameters applied to the VLAN domain the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "domain_description": { + "description": "The description of the VLAN domain the object belongs to.", + "type": "string" + }, + "domain_end_vlan_id": { + "description": "The VLAN identifier (ID) of the last VLAN in the VLAN domain the object belongs to.", + "type": "string" + }, + "domain_id": { + "description": "The database identifier (ID) of the VLAN domain the object belongs to.", + "type": "string" + }, + "domain_name": { + "description": "The name of the VLAN domain the object belongs to.", + "type": "string" + }, + "domain_start_vlan_id": { + "description": "The VLAN identifier (ID) of the first VLAN in the VLAN domain the object belongs to.", + "type": "string" + }, + "range_class_name": { + "description": "The name of the class applied to the VLAN range, it can be preceded by the class directory.", + "type": "string" + }, + "range_class_parameters": { + "description": "The class parameters applied to the VLAN range.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "range_description": { + "description": "The description of the VLAN range.", + "type": "string" + }, + "range_disable_overlapping": { + "description": "The overlapping restriction status of the VLAN range. 1 indicates that when creating VLANs in the range, their IDs should not overlap.", + "type": "string" + }, + "range_end_vlan_id": { + "description": "The VLAN identifier (ID) of the last VLAN in the VLAN range.", + "type": "string" + }, + "range_id": { + "description": "The database identifier (ID) of the VLAN range.", + "type": "string" + }, + "range_name": { + "description": "The name of the VLAN range.", + "type": "string" + }, + "range_start_vlan_id": { + "description": "The VLAN identifier (ID) of the first VLAN in the VLAN range.", + "type": "string" + } + }, + "title": "_data_inner_vlan_range_data", + "type": "object" + }, + "vlan_domain_add_success": { + "example": { + "data": [ + { + "domain_id": "domain_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_vlan_domain_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_address_add_input": { + "properties": { + "address_hostaddr": { + "description": "The IP address.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "check_is_server_ip": { + "description": "A way to force a validity check, if you configured the IPAM to DHCP replication. If the check is enabled (1), the configuration of the IP address you are adding must be valid as well for the DHCP.", + "type": "integer" + }, + "static_id": { + "description": "The database identifier (ID) of the DHCP static you want to associate with the IP address.", + "type": "integer" + }, + "lease_id": { + "description": "The database identifier (ID) of the DHCP lease you want to associate with the IP address.", + "type": "integer" + }, + "device_id": { + "description": "The database identifier (ID) of the Device Manager device you want to associate with the IP address.", + "type": "integer" + }, + "interface_id": { + "description": "The database identifier (ID) of the Device Manager interface you want to associate with the IP address.", + "type": "integer" + }, + "port_id": { + "description": "The database identifier (ID) of the NetChange port you want to associate with the IP address.", + "type": "integer" + }, + "address_mac_addr": { + "description": "The MAC address you want to associate with the IPv4 address.", + "type": "string" + }, + "address_name": { + "description": "The name of the IPv4 address, each IPv4 address must have a unique name.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "address_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "address_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dns_viewparam_add_input": { + "properties": { + "view_id": { + "description": "The database identifier (ID) of the DNS view. Use the ID to specify the DNS view of your choice.", + "type": "integer" + }, + "viewparam_key": { + "description": "The name of the DNS option you want to add, edit or remove from the view. You can only set one option at a time.
                                                                                                                                                                                                                                              • To add or edit an option: specify its name in the parameter viewparam_key, as follows viewparam_key=<option-name>, and then specify its value in the parameter viewparam_value.
                                                                                                                                                                                                                                              • To remove an option, specify its name in the parameter viewparam_key and leave the parameter viewparam_value empty.
                                                                                                                                                                                                                                              To set several options, specify as many parameters (viewparam_key and viewparam_value) as you need.", + "type": "string" + }, + "viewparam_is_array": { + "description": "A way to determine is the DNS view option is an array (1).", + "type": "integer" + }, + "viewparam_value": { + "description": "The value of the DNS option specified in the input viewparam_key.
                                                                                                                                                                                                                                              • To add or edit an option value, specify its name in the parameter viewparam_key and set its value as follows: viewparam_value=<option-value> .
                                                                                                                                                                                                                                              • To remove an option value, specify its name in the parameter viewparam_key and leave viewparam_value empty: viewparam_value= .
                                                                                                                                                                                                                                              ", + "type": "string" + } + }, + "type": "object" + }, + "dns_zone_edit_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "view_id": { + "description": "The database identifier (ID) of the DNS view the object belongs to.", + "type": "integer" + }, + "view_name": { + "description": "The name of the DNS view the object belongs to.", + "type": "string" + }, + "zone_id": { + "description": "The database identifier (ID) of the DNS zone, a unique numeric key value automatically incremented when you add a DNS zone. Use the ID to specify the DNS zone of your choice.", + "type": "integer" + }, + "zone_name": { + "description": "The name of the DNS zone, each DNS zone must have a unique name. For hint zones (zone_type: hint), you must type in . (dot) as zone_name.", + "type": "string" + }, + "zone_type": { + "description": "The type of the DNS zone, either master, slave, forward, stub, hint or delegation-only.", + "enum": [ + "master", + "slave", + "hint", + "stub", + "forward", + "delegation-only" + ], + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DNS server.", + "type": "string" + }, + "server_ddns_scavenging": { + "description": "The DDNS scavenging status of the zone. Set it to 1 to enable the scavenging and automatically delete the stale resource records dynamically added via GSS-TSIG. DDNS scavenging is only effective if the parameters zone_use_update_policy and gss_enabled are set to 1, and the rule 416 is enabled in the GUI.", + "type": "integer" + }, + "zone_ad_integrated": { + "description": "The AD integrated status of the DNS zone. Set it to 1 to indicate that the DNS zone belongs to an Active Directory integrated Microsoft Windows DNS server.", + "type": "integer" + }, + "zone_allow_query": { + "description": "The ACL values associated with the allow-query configuration of the DNS zone, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "zone_allow_transfer": { + "description": "The ACL values associated with the allow-transfer configuration of the DNS zone, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "zone_allow_update": { + "description": "The ACL values associated with the allow-update configuration of the DNS zone, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "zone_also_notify": { + "description": "The IP address and port of the DNS server managing the smart architecture the DNS zone belongs to. If the parameter zone_notify is set to yes or explicit, the server specified is instantly notified of any slave zones updates.", + "type": "string" + }, + "zone_forward": { + "description": "The forwarding mode of the DNS zone.


                                                                                                                                                                                                                                              zone_forward possible values
                                                                                                                                                                                                                                              StatusDescription
                                                                                                                                                                                                                                              firstThe zone sends the queries to the forwarder(s). If no answer is returned, it attempts to answer the queries on its own.
                                                                                                                                                                                                                                              onlyThe zone only forwards the queries to the forwarder(s). Required by some reverse forward zones (e.g., in the case of private addresses).


                                                                                                                                                                                                                                              If the parameter has no value, it indicates that the forwarding is disabled.", + "enum": [ + "none", + "first", + "only", + "default" + ], + "type": "string" + }, + "zone_forwarders": { + "description": "The IP address(es) of the forwarder(s) associated with the DNS zone. It lists the DNS servers to which any unknown query on this zone should be sent, as follows: <ip_address1>;<ip_address2>;... .", + "type": "string" + }, + "zone_is_rpz": { + "description": "The RPZ status of the DNS zone. Set it to 1 to indicate that the DNS zone is a Response Policy Zone.", + "type": "integer" + }, + "zone_masters": { + "description": "For slave DNS zones, the IP address of the DNS server and, if relevant, the name of the DNS view that contain the master DNS zone, as follows: <ip_addr>; or <ip_addr> key <dnsview_name>; .", + "type": "string" + }, + "zone_notify": { + "description": "The notify status of the DNS zone.


                                                                                                                                                                                                                                              zone_notify possible values
                                                                                                                                                                                                                                              StatusDescription
                                                                                                                                                                                                                                              noNo notify message is sent.
                                                                                                                                                                                                                                              yesA notify message is sent to the name servers defined in the NS records of the zone and to the IP address(es) specified in the parameter .
                                                                                                                                                                                                                                              explicitA notify message is sent only to the IP address(es) specified in the parameter .


                                                                                                                                                                                                                                              The notify message is not sent to the server itself or to the primary server defined in the SOA record of the zone.", + "enum": [ + "yes", + "no", + "explicit" + ], + "type": "string" + }, + "zone_order": { + "description": "The level of the RPZ zone, where 0 represents the highest level in the views hierarchy. The RPZ rules of each zone are reviewed following this order. For non-RPZ zones, that have their parameter zone_is_rpz set to 0, you do not need to set this parameter.", + "type": "integer" + }, + "zone_response_policy": { + "description": "The response policy of the DNS zone. All the zones can be set with the policy given, only RPZ zones can be set with other policies.


                                                                                                                                                                                                                                              zone_response_policy possible values
                                                                                                                                                                                                                                              PolicyDescription
                                                                                                                                                                                                                                              givenAll the rules specified in the RPZ zone are applied normally.
                                                                                                                                                                                                                                              disabledThe RPZ zone rules configuration is not applied. All the rules it contains are ignored.
                                                                                                                                                                                                                                              passthruThe rules specified in the RPZ matching the listed RR names are ignored, no matter the RPZ zone they belong to.
                                                                                                                                                                                                                                              nxdomainThe rules specified in the RPZ return an NXDOMAIN response.
                                                                                                                                                                                                                                              nodataThe rules specified in the RPZ return a NODATA response.
                                                                                                                                                                                                                                              cname All the rules specified in the RPZ are redirected toward the specified domain name.


                                                                                                                                                                                                                                              You can only add RPZ zones on EfficientIP or BIND DNS servers.", + "type": "string" + }, + "zone_rpz_log": { + "description": "The RPZ logging status, if zone_is_rpz is set to 1 or yes. It allows you to log all the operations triggered by the RPZ rules of the zone.", + "type": "integer" + }, + "zone_rpz_max_policy_ttl": { + "description": "A way to set the number of seconds of the max policy Time To Live of the zone. By default, the parameter is empty, and the Server max policy TTL of the zone is of 5 seconds. It overrides the same option set at server level.", + "type": "integer" + }, + "zone_rpz_recursive_only": { + "description": "A way to Enable recursive-only on the server for the zone. By default it is enabled (1) and, for this zone, the server only processes policies on recursive queries. It overrides the same option set at server level.", + "type": "integer" + }, + "zone_space_id": { + "description": "The database identifier (ID) of the space associated with the DNS zone the record belongs to.", + "type": "integer" + }, + "zone_space_name": { + "description": "The name of the space associated with the DNS zone the record belongs to.", + "type": "string" + }, + "row_state": { + "description": "The object activation status.
                                                                                                                                                                                                                                              • If set to 0, the object is present in the database but ignored, i.e. it cannot be managed, counted or listed. This status is applied on objects deleted from the GUI.
                                                                                                                                                                                                                                              • If set to 1, the object is enabled and managed.
                                                                                                                                                                                                                                              • If set to 2, the object is unmanaged, disabled or both depending on the context.
                                                                                                                                                                                                                                              By default, row_state is set to 1 when an object is created.", + "type": "integer" + }, + "zone_use_update_policy": { + "description": "The update policy status of the DNS zone. Set it to 1 to indicate that the DNS zone uses a specific GSS-TSIG/update-policy. You can only configure the zone update policy if the parameter gss_enabled is set to 1.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "zone_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "zone_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_data_inner_vlan_range_add_success": { + "example": { + "range_id": "range_id" + }, + "properties": { + "range_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_vlan_range_add_success", + "type": "object" + }, + "_data_inner_dhcp_acl6_data": { + "example": { + "acl6_statement": "acl6_statement", + "smart_parent_id": "smart_parent_id", + "acl6_id": "acl6_id", + "acl6_match": "acl6_match", + "server_cluster_role": "server_cluster_role", + "acl6_spawnwith": "acl6_spawnwith", + "acl6_name": "acl6_name", + "server6_id": "server6_id", + "acl6_delayed_time": "acl6_delayed_time", + "server6_type": "server6_type", + "server6_name": "server6_name" + }, + "properties": { + "server_cluster_role": { + "description": "The role of the server the object belongs to in the cluster, either active (M), passive (B) or N/A (#).", + "type": "string" + }, + "acl6_delayed_time": { + "description": "The delay of creation/deletion status. 1 indicates that the object is not created/deleted yet.", + "type": "string" + }, + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_name": { + "description": "The name of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_type": { + "description": "The type of the DHCPv6 server the object belongs to:


                                                                                                                                                                                                                                              server6_type possible values
                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                              ipmEfficientIP or EfficientIP Package server
                                                                                                                                                                                                                                              vdhcpEfficientIP DHCPv6 smart architecture


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "acl6_id": { + "description": "The database identifier (ID) of the DHCPv6 ACL.", + "type": "string" + }, + "acl6_match": { + "description": "The ACL rule associated with the DHCPv6 ACL, as follows: <match if (substring(option agent.remote-id,0,6) = dslam1);>", + "type": "string" + }, + "acl6_name": { + "description": "The name of the DHCPv6 ACL.", + "type": "string" + }, + "acl6_spawnwith": { + "description": "The spawning class associated with the DHCPv6 ACL.", + "type": "string" + }, + "acl6_statement": { + "description": "The statement associated with the DHCPv6 ACL.", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv6 smart architecture managing the DHCPv6 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_acl6_data", + "type": "object" + }, + "dns_view_add_success": { + "example": { + "data": [ + { + "view_id": "view_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_view_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_sharednetwork_add_success": { + "example": { + "data": [ + { + "sharednetwork_id": "sharednetwork_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_sharednetwork_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dns_view_edit_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "view_id": { + "description": "The database identifier (ID) of the DNS view, a unique numeric key value automatically incremented when you add a DNS view. Use the ID to specify the DNS view of your choice.", + "type": "integer" + }, + "view_name": { + "description": "The name of the DNS view, each DNS view must have a unique name.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DNS server.", + "type": "string" + }, + "view_allow_query": { + "description": "The ACL values associated with the allow-query configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_allow_recursion": { + "description": "The ACL values associated with the allow-recursion configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_allow_transfer": { + "description": "The ACL values associated with the allow-transfer configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_match_clients": { + "description": "The ACL values associated with the match clients configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_match_to": { + "description": "The ACL values associated with the match destination configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_order": { + "description": "The level of the DNS view, where 0 represents the highest level in the views hierarchy. The parameters dnsview_match_client and view_match_to of each view in a server are reviewed following this order.", + "type": "integer" + }, + "view_recursion": { + "description": "The recursion status of the DNS view:


                                                                                                                                                                                                                                              view_recursion possible values
                                                                                                                                                                                                                                              StatusDescription
                                                                                                                                                                                                                                              noThe view only provides iterative query behavior - normally resulting in a referral. If the answer to the query already exists in the cache it will be returned whatever the value of this statement.
                                                                                                                                                                                                                                              yesThe view always provides recursive query behavior if requested by the client.


                                                                                                                                                                                                                                              ", + "enum": [ + "yes", + "no" + ], + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "view_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "view_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dns_rr_add_success": { + "example": { + "data": [ + { + "rr_id": "rr_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_rr_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "vlan_range_data": { + "example": { + "data": [ + { + "range_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_name": "range_name", + "domain_end_vlan_id": "domain_end_vlan_id", + "range_end_vlan_id": "range_end_vlan_id", + "domain_start_vlan_id": "domain_start_vlan_id", + "domain_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_start_vlan_id": "range_start_vlan_id", + "domain_description": "domain_description", + "range_id": "range_id", + "domain_id": "domain_id", + "domain_name": "domain_name", + "range_disable_overlapping": "range_disable_overlapping", + "range_class_name": "range_class_name", + "range_description": "range_description", + "domain_support_vxlan": "domain_support_vxlan", + "domain_class_name": "domain_class_name" + }, + { + "range_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_name": "range_name", + "domain_end_vlan_id": "domain_end_vlan_id", + "range_end_vlan_id": "range_end_vlan_id", + "domain_start_vlan_id": "domain_start_vlan_id", + "domain_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_start_vlan_id": "range_start_vlan_id", + "domain_description": "domain_description", + "range_id": "range_id", + "domain_id": "domain_id", + "domain_name": "domain_name", + "range_disable_overlapping": "range_disable_overlapping", + "range_class_name": "range_class_name", + "range_description": "range_description", + "domain_support_vxlan": "domain_support_vxlan", + "domain_class_name": "domain_class_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_vlan_range_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "vlan_range_delete_success": { + "example": { + "data": [ + { + "range_id": "range_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_vlan_range_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dns_acl_data": { + "example": { + "data": [ + { + "acl_value": "acl_value", + "acl_name": "acl_name", + "acl_id": "acl_id", + "server_id": "server_id" + }, + { + "acl_value": "acl_value", + "acl_name": "acl_name", + "acl_id": "acl_id", + "server_id": "server_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_acl_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_zoneparam_data": { + "example": { + "data": [ + { + "server_name": "server_name", + "zone_id": "zone_id", + "zoneparam_key": "zoneparam_key", + "zoneparam_delayed_delete_time": "zoneparam_delayed_delete_time", + "zoneparam_delayed_create_time": "zoneparam_delayed_create_time", + "zoneparam_value": "zoneparam_value", + "zone_name": "zone_name", + "oid": "oid", + "server_id": "server_id" + }, + { + "server_name": "server_name", + "zone_id": "zone_id", + "zoneparam_key": "zoneparam_key", + "zoneparam_delayed_delete_time": "zoneparam_delayed_delete_time", + "zoneparam_delayed_create_time": "zoneparam_delayed_create_time", + "zoneparam_value": "zoneparam_value", + "zone_name": "zone_name", + "oid": "oid", + "server_id": "server_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_zoneparam_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_aclentry6_data": { + "example": { + "data": [ + { + "aclentry6_value": "aclentry6_value", + "smart_parent_id": "smart_parent_id", + "aclentry6_delayed_time": "aclentry6_delayed_time", + "acl6_id": "acl6_id", + "server_cluster_role": "server_cluster_role", + "aclentry6_id": "aclentry6_id", + "acl6_name": "acl6_name", + "server6_id": "server6_id", + "server6_type": "server6_type", + "server6_name": "server6_name" + }, + { + "aclentry6_value": "aclentry6_value", + "smart_parent_id": "smart_parent_id", + "aclentry6_delayed_time": "aclentry6_delayed_time", + "acl6_id": "acl6_id", + "server_cluster_role": "server_cluster_role", + "aclentry6_id": "aclentry6_id", + "acl6_name": "acl6_name", + "server6_id": "server6_id", + "server6_type": "server6_type", + "server6_name": "server6_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_aclentry6_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dns_zone_delete_success": { + "example": { + "zone_id": "zone_id" + }, + "properties": { + "zone_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_dns_zone_delete_success", + "type": "object" + }, + "ApiClassParameterOutputEntry": { + "example": { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + }, + "source": { + "type": "string" + } + }, + "type": "object" + }, + "ipam_pool6_delete_success": { + "example": { + "data": [ + { + "pool6_id": "pool6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_pool6_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_static6_data": { + "example": { + "data": [ + { + "server6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_size": "scope6_size", + "static6_address6_addr": "static6_address6_addr", + "server6_version": "server6_version", + "static6_prefix6": "static6_prefix6", + "scope6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "static6_prefix6_prefix": "static6_prefix6_prefix", + "static6_mac_vendor": "static6_mac_vendor", + "group6_id": "group6_id", + "server6_name": "server6_name", + "smart_parent_id": "smart_parent_id", + "static6_class_name": "static6_class_name", + "smart_parent_name": "smart_parent_name", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "static6_time": "static6_time", + "static6_prefix6_addr": "static6_prefix6_addr", + "server6_type": "server6_type", + "static6_name": "static6_name", + "static6_client_duid": "static6_client_duid", + "sharednetwork6_name": "sharednetwork6_name", + "group6_name": "group6_name", + "static6_id": "static6_id", + "static6_end_time": "static6_end_time", + "scope6_end_address6_addr": "scope6_end_address6_addr", + "static6_domain": "static6_domain", + "scope6_class_name": "scope6_class_name", + "scope6_name": "scope6_name", + "scope6_space_id": "scope6_space_id", + "static6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_id": "scope6_id", + "static6_multistatus": "static6_multistatus", + "static6_mac_addr": "static6_mac_addr", + "sharednetwork6_id": "sharednetwork6_id", + "group6_class_name": "group6_class_name", + "static6_state": "static6_state", + "scope6_start_address6_addr": "scope6_start_address6_addr", + "static6_delayed_time": "static6_delayed_time", + "group6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ] + }, + { + "server6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_size": "scope6_size", + "static6_address6_addr": "static6_address6_addr", + "server6_version": "server6_version", + "static6_prefix6": "static6_prefix6", + "scope6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "static6_prefix6_prefix": "static6_prefix6_prefix", + "static6_mac_vendor": "static6_mac_vendor", + "group6_id": "group6_id", + "server6_name": "server6_name", + "smart_parent_id": "smart_parent_id", + "static6_class_name": "static6_class_name", + "smart_parent_name": "smart_parent_name", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "static6_time": "static6_time", + "static6_prefix6_addr": "static6_prefix6_addr", + "server6_type": "server6_type", + "static6_name": "static6_name", + "static6_client_duid": "static6_client_duid", + "sharednetwork6_name": "sharednetwork6_name", + "group6_name": "group6_name", + "static6_id": "static6_id", + "static6_end_time": "static6_end_time", + "scope6_end_address6_addr": "scope6_end_address6_addr", + "static6_domain": "static6_domain", + "scope6_class_name": "scope6_class_name", + "scope6_name": "scope6_name", + "scope6_space_id": "scope6_space_id", + "static6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_id": "scope6_id", + "static6_multistatus": "static6_multistatus", + "static6_mac_addr": "static6_mac_addr", + "sharednetwork6_id": "sharednetwork6_id", + "group6_class_name": "group6_class_name", + "static6_state": "static6_state", + "scope6_start_address6_addr": "scope6_start_address6_addr", + "static6_delayed_time": "static6_delayed_time", + "group6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ] + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_static6_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_range6_delete_success": { + "example": { + "data": [ + { + "range6_id": "range6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_range6_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_ipam_alias_add_success": { + "example": { + "alias_id": "alias_id" + }, + "properties": { + "alias_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_ipam_alias_add_success", + "type": "object" + }, + "ipam_pool_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_pool_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_pool6_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_pool6_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "vlan_range_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_vlan_range_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dhcp_range_edit_success": { + "example": { + "range_id": "range_id" + }, + "properties": { + "range_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_range_edit_success", + "type": "object" + }, + "_data_inner_dns_zoneparam_delete_success": { + "example": { + "zoneparam_id": "zoneparam_id" + }, + "properties": { + "zoneparam_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_dns_zoneparam_delete_success", + "type": "object" + }, + "ipam_network_add_success": { + "example": { + "data": [ + { + "network_id": "network_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_network_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_network_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_network_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_network6_data": { + "example": { + "data": [ + { + "range_name": "range_name", + "vlsm_block6_id": "vlsm_block6_id", + "end_address6_addr": "end_address6_addr", + "parent_network6_class_name": "parent_network6_class_name", + "parent_network6_is_terminal": "parent_network6_is_terminal", + "vlan_id": "vlan_id", + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "vlsm_space_id": "vlsm_space_id", + "vlan_vlan_id": "vlan_vlan_id", + "network6_operation_details_requested_by": "network6_operation_details_requested_by", + "vlan_name": "vlan_name", + "parent_network_level": "parent_network_level", + "domain_id": "domain_id", + "vlsm_space_name": "vlsm_space_name", + "domain_name": "domain_name", + "percent_allocated": "percent_allocated", + "parent_network6_prefix": "parent_network6_prefix", + "space_class_name": "space_class_name", + "network6_operation_details_last_updated_on": "network6_operation_details_last_updated_on", + "parent_space_id": "parent_space_id", + "space_description": "space_description", + "network_level": "network_level", + "parent_vlsm_network6_id": "parent_vlsm_network6_id", + "network_size": "network_size", + "space_parent_space_id": "space_parent_space_id", + "space_is_template": "space_is_template", + "network6_ripe_waiting_state": "network6_ripe_waiting_state", + "network6_is_terminal": "network6_is_terminal", + "vlsm_network6_id": "vlsm_network6_id", + "network6_ripe_waiting_status": "network6_ripe_waiting_status", + "percent_used": "percent_used", + "space_name": "space_name", + "network6_id": "network6_id", + "parent_network_path": "parent_network_path", + "network6_start_hostaddr": "network6_start_hostaddr", + "parent_network6_percent_allocated": "parent_network6_percent_allocated", + "network6_is_valid": "network6_is_valid", + "parent_end_address6_addr": "parent_end_address6_addr", + "parent_start_address6_addr": "parent_start_address6_addr", + "network_path": "network_path", + "network6_end_hostaddr": "network6_end_hostaddr", + "parent_network6_id": "parent_network6_id", + "network6_name": "network6_name", + "range_id": "range_id", + "network6_operation_details_added_by": "network6_operation_details_added_by", + "start_address6_addr": "start_address6_addr", + "parent_network_size": "parent_network_size", + "network6_operation_details_added_on": "network6_operation_details_added_on", + "parent_space_name": "parent_space_name", + "network6_prefix": "network6_prefix", + "parent_network6_percent_used": "parent_network6_percent_used", + "network6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "network6_operation_details_origin_module": "network6_operation_details_origin_module", + "network6_multistatus": "network6_multistatus", + "parent_network6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "parent_network6_name": "parent_network6_name", + "network6_lock_network_broadcast": "network6_lock_network_broadcast", + "network6_class_name": "network6_class_name", + "network6_is_in_orphan": "network6_is_in_orphan", + "network6_operation_details_call_stack": "network6_operation_details_call_stack", + "space_id": "space_id" + }, + { + "range_name": "range_name", + "vlsm_block6_id": "vlsm_block6_id", + "end_address6_addr": "end_address6_addr", + "parent_network6_class_name": "parent_network6_class_name", + "parent_network6_is_terminal": "parent_network6_is_terminal", + "vlan_id": "vlan_id", + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "vlsm_space_id": "vlsm_space_id", + "vlan_vlan_id": "vlan_vlan_id", + "network6_operation_details_requested_by": "network6_operation_details_requested_by", + "vlan_name": "vlan_name", + "parent_network_level": "parent_network_level", + "domain_id": "domain_id", + "vlsm_space_name": "vlsm_space_name", + "domain_name": "domain_name", + "percent_allocated": "percent_allocated", + "parent_network6_prefix": "parent_network6_prefix", + "space_class_name": "space_class_name", + "network6_operation_details_last_updated_on": "network6_operation_details_last_updated_on", + "parent_space_id": "parent_space_id", + "space_description": "space_description", + "network_level": "network_level", + "parent_vlsm_network6_id": "parent_vlsm_network6_id", + "network_size": "network_size", + "space_parent_space_id": "space_parent_space_id", + "space_is_template": "space_is_template", + "network6_ripe_waiting_state": "network6_ripe_waiting_state", + "network6_is_terminal": "network6_is_terminal", + "vlsm_network6_id": "vlsm_network6_id", + "network6_ripe_waiting_status": "network6_ripe_waiting_status", + "percent_used": "percent_used", + "space_name": "space_name", + "network6_id": "network6_id", + "parent_network_path": "parent_network_path", + "network6_start_hostaddr": "network6_start_hostaddr", + "parent_network6_percent_allocated": "parent_network6_percent_allocated", + "network6_is_valid": "network6_is_valid", + "parent_end_address6_addr": "parent_end_address6_addr", + "parent_start_address6_addr": "parent_start_address6_addr", + "network_path": "network_path", + "network6_end_hostaddr": "network6_end_hostaddr", + "parent_network6_id": "parent_network6_id", + "network6_name": "network6_name", + "range_id": "range_id", + "network6_operation_details_added_by": "network6_operation_details_added_by", + "start_address6_addr": "start_address6_addr", + "parent_network_size": "parent_network_size", + "network6_operation_details_added_on": "network6_operation_details_added_on", + "parent_space_name": "parent_space_name", + "network6_prefix": "network6_prefix", + "parent_network6_percent_used": "parent_network6_percent_used", + "network6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "network6_operation_details_origin_module": "network6_operation_details_origin_module", + "network6_multistatus": "network6_multistatus", + "parent_network6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "parent_network6_name": "parent_network6_name", + "network6_lock_network_broadcast": "network6_lock_network_broadcast", + "network6_class_name": "network6_class_name", + "network6_is_in_orphan": "network6_is_in_orphan", + "network6_operation_details_call_stack": "network6_operation_details_call_stack", + "space_id": "space_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_network6_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_failover_data": { + "example": { + "data": [ + { + "server_name": "server_name", + "failover_mclt": "failover_mclt", + "failover_peer_port": "failover_peer_port", + "failover_state": "failover_state", + "failover_name": "failover_name", + "failover_delayed_create_time": "failover_delayed_create_time", + "server_id": "server_id", + "failover_peer_addr": "failover_peer_addr", + "failover_split": "failover_split", + "failover_delayed_delete_time": "failover_delayed_delete_time", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "smart_parent_id": "smart_parent_id", + "failover_addr": "failover_addr", + "failover_type": "failover_type", + "failover_auto_partner_down": "failover_auto_partner_down", + "server_cluster_role": "server_cluster_role", + "peer_server_id": "peer_server_id", + "failover_multistatus": "failover_multistatus", + "server_state": "server_state", + "server_type": "server_type", + "failover_id": "failover_id", + "failover_port": "failover_port" + }, + { + "server_name": "server_name", + "failover_mclt": "failover_mclt", + "failover_peer_port": "failover_peer_port", + "failover_state": "failover_state", + "failover_name": "failover_name", + "failover_delayed_create_time": "failover_delayed_create_time", + "server_id": "server_id", + "failover_peer_addr": "failover_peer_addr", + "failover_split": "failover_split", + "failover_delayed_delete_time": "failover_delayed_delete_time", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "smart_parent_id": "smart_parent_id", + "failover_addr": "failover_addr", + "failover_type": "failover_type", + "failover_auto_partner_down": "failover_auto_partner_down", + "server_cluster_role": "server_cluster_role", + "peer_server_id": "peer_server_id", + "failover_multistatus": "failover_multistatus", + "server_state": "server_state", + "server_type": "server_type", + "failover_id": "failover_id", + "failover_port": "failover_port" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_failover_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "vlan_vlan_data": { + "example": { + "data": [ + { + "range_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_name": "range_name", + "vlan_id": "vlan_id", + "domain_end_vlan_id": "domain_end_vlan_id", + "range_end_vlan_id": "range_end_vlan_id", + "domain_start_vlan_id": "domain_start_vlan_id", + "vlan_vlan_id": "vlan_vlan_id", + "domain_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_start_vlan_id": "range_start_vlan_id", + "free_start_vlan_id": "free_start_vlan_id", + "domain_description": "domain_description", + "vlan_name": "vlan_name", + "range_id": "range_id", + "domain_id": "domain_id", + "domain_name": "domain_name", + "vlan_class_name": "vlan_class_name", + "range_class_name": "range_class_name", + "vlan_type": "vlan_type", + "free_end_vlan_id": "free_end_vlan_id", + "range_description": "range_description", + "domain_support_vxlan": "domain_support_vxlan", + "vlan_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "domain_class_name": "domain_class_name" + }, + { + "range_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_name": "range_name", + "vlan_id": "vlan_id", + "domain_end_vlan_id": "domain_end_vlan_id", + "range_end_vlan_id": "range_end_vlan_id", + "domain_start_vlan_id": "domain_start_vlan_id", + "vlan_vlan_id": "vlan_vlan_id", + "domain_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_start_vlan_id": "range_start_vlan_id", + "free_start_vlan_id": "free_start_vlan_id", + "domain_description": "domain_description", + "vlan_name": "vlan_name", + "range_id": "range_id", + "domain_id": "domain_id", + "domain_name": "domain_name", + "vlan_class_name": "vlan_class_name", + "range_class_name": "range_class_name", + "vlan_type": "vlan_type", + "free_end_vlan_id": "free_end_vlan_id", + "range_description": "range_description", + "domain_support_vxlan": "domain_support_vxlan", + "vlan_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "domain_class_name": "domain_class_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_vlan_vlan_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_sharednetwork_edit_success": { + "example": { + "data": [ + { + "sharednetwork_id": "sharednetwork_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_sharednetwork_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "vlan_vlan_edit_success": { + "example": { + "data": [ + { + "vlan_id": "vlan_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_vlan_vlan_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_alias6_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_alias6_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dns_viewparam_edit_success": { + "example": { + "viewparam_id": "viewparam_id" + }, + "properties": { + "viewparam_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_dns_viewparam_edit_success", + "type": "object" + }, + "dhcp_static_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_static_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_rr_edit_success": { + "example": { + "data": [ + { + "rr_id": "rr_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_rr_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_vlan_vlan_data": { + "example": { + "range_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_name": "range_name", + "vlan_id": "vlan_id", + "domain_end_vlan_id": "domain_end_vlan_id", + "range_end_vlan_id": "range_end_vlan_id", + "domain_start_vlan_id": "domain_start_vlan_id", + "vlan_vlan_id": "vlan_vlan_id", + "domain_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range_start_vlan_id": "range_start_vlan_id", + "free_start_vlan_id": "free_start_vlan_id", + "domain_description": "domain_description", + "vlan_name": "vlan_name", + "range_id": "range_id", + "domain_id": "domain_id", + "domain_name": "domain_name", + "vlan_class_name": "vlan_class_name", + "range_class_name": "range_class_name", + "vlan_type": "vlan_type", + "free_end_vlan_id": "free_end_vlan_id", + "range_description": "range_description", + "domain_support_vxlan": "domain_support_vxlan", + "vlan_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "domain_class_name": "domain_class_name" + }, + "properties": { + "free_end_vlan_id": { + "description": "For free VLAN IDs (typefree), it returns the last VLAN of a range of VLANs that are not assigned yet. The first VLAN in that range is returned in the parameter free_start_vlan_id.", + "type": "string" + }, + "free_start_vlan_id": { + "description": "For free VLAN IDs (typefree), it returns the first VLAN of the range of VLANs that are not assigned yet. The last VLAN in that range is returned in the parameter free_end_vlan_id.", + "type": "string" + }, + "domain_support_vxlan": { + "description": "The type of virtual network used by the domain the VLAN belongs to, VXLAN (1) or VLAN (0).", + "type": "string" + }, + "vlan_type": { + "description": "The type of the VLAN (free or used).", + "type": "string" + }, + "domain_class_name": { + "description": "The name of the class applied to the VLAN domain the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "domain_class_parameters": { + "description": "The class parameters of the domain the VLAN belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "domain_description": { + "description": "The description of the VLAN domain the object belongs to.", + "type": "string" + }, + "domain_end_vlan_id": { + "description": "The VLAN identifier (ID) of the last VLAN in the VLAN domain the object belongs to.", + "type": "string" + }, + "domain_id": { + "description": "The database identifier (ID) of the VLAN domain the object belongs to.", + "type": "string" + }, + "domain_name": { + "description": "The name of the VLAN domain the object belongs to.", + "type": "string" + }, + "domain_start_vlan_id": { + "description": "The VLAN identifier (ID) of the first VLAN in the VLAN domain the object belongs to.", + "type": "string" + }, + "range_class_name": { + "description": "The name of the class applied to the VLAN range the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "range_class_parameters": { + "description": "The class parameters of the range the VLAN belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "range_description": { + "description": "The description of the VLAN range the object belongs to.", + "type": "string" + }, + "range_end_vlan_id": { + "description": "The VLAN identifier (ID) of the last VLAN in the VLAN range the object belongs to.", + "type": "string" + }, + "range_id": { + "description": "The database identifier (ID) of the VLAN range the object belongs to.", + "type": "string" + }, + "range_name": { + "description": "The name of the VLAN range the object belongs to.", + "type": "string" + }, + "range_start_vlan_id": { + "description": "The VLAN identifier (ID) of the first VLAN in the VLAN range the object belongs to.", + "type": "string" + }, + "vlan_class_name": { + "description": "The name of the class applied to the object, it can be preceded by the class directory.", + "type": "string" + }, + "vlan_class_parameters": { + "description": "The class parameters of the VLAN.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "vlan_id": { + "description": "The database identifier (ID) of the VLAN.", + "type": "string" + }, + "vlan_name": { + "description": "The name of the VLAN.", + "type": "string" + }, + "vlan_vlan_id": { + "description": "The VLAN identifier (ID) of the VLAN.", + "type": "string" + } + }, + "title": "_data_inner_vlan_vlan_data", + "type": "object" + }, + "dhcp_scope6_add_input": { + "properties": { + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "type": "integer" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "scope6_end_addr": { + "description": "The last IP address of the DHCPv6 scope.", + "type": "string" + }, + "scope6_prefix": { + "description": "The prefix of the DHCPv6 scope, an integer that defines the number of address the scope contains.", + "type": "string" + }, + "scope6_start_addr": { + "description": "The first IP address of the DHCPv6 scope.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "failover6_id": { + "description": "The database identifier (ID) of the DHCPv6 failover channel, a unique numeric key value automatically incremented when you add a DHCPv6 failover channel. Use the ID to specify the DHCPv6 failover channel of your choice.", + "type": "integer" + }, + "failover6_name": { + "description": "The name of the DHCPv6 failover channel.", + "type": "string" + }, + "scope6_name": { + "description": "The name of the DHCPv6 scope, each DHCPv6 scope must have a unique name.", + "type": "string" + }, + "scope6_space_id": { + "description": "The database identifier (ID) of an existing space you want to associate with the DHCPv6 scope.", + "type": "integer" + }, + "scope6_space_name": { + "description": "The name of an existing space you want to associate with the DHCPv6 scope.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "scope6_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "scope6_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_data_inner_dhcp_lease6_data": { + "example": { + "scope6_size": "scope6_size", + "lease6_multistatus": "lease6_multistatus", + "server6_version": "server6_version", + "lease6_id": "lease6_id", + "lease6_address6_addr": "lease6_address6_addr", + "range6_failover_name": "range6_failover_name", + "server6_name": "server6_name", + "lease6_end_time": "lease6_end_time", + "lease6_first_time": "lease6_first_time", + "lease6_period": "lease6_period", + "range6_end_address6_addr": "range6_end_address6_addr", + "scope6_prefix": "scope6_prefix", + "smart_parent_id": "smart_parent_id", + "smart_parent_name": "smart_parent_name", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "lease6_clientname": "lease6_clientname", + "server6_type": "server6_type", + "lease6_mac_vendor": "lease6_mac_vendor", + "lease6_domain": "lease6_domain", + "range6_id": "range6_id", + "range6_start_address6_addr": "range6_start_address6_addr", + "server6_addr6": "server6_addr6", + "lease6_time": "lease6_time", + "sharednetwork6_name": "sharednetwork6_name", + "lease6_client_duid": "lease6_client_duid", + "server6_hostaddr": "server6_hostaddr", + "lease6_percent": "lease6_percent", + "server6_addr": "server6_addr", + "lease6_mac_addr": "lease6_mac_addr", + "scope6_class_name": "scope6_class_name", + "scope6_name": "scope6_name", + "range6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_id": "scope6_id", + "sharednetwork6_id": "sharednetwork6_id", + "lease6_giaddr": "lease6_giaddr", + "lease6_time_to_expire": "lease6_time_to_expire", + "lease6_name": "lease6_name", + "scope6_start_address6_addr": "scope6_start_address6_addr", + "range6_class_name": "range6_class_name" + }, + "properties": { + "server6_class_name": { + "description": "The name of the class applied to the DHCPv6 server the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_name": { + "description": "The name of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_type": { + "description": "The type of the DHCPv6 server the object belongs to:


                                                                                                                                                                                                                                              server6_type possible values
                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                              ipmEfficientIP or EfficientIP Package server
                                                                                                                                                                                                                                              vdhcpEfficientIP DHCPv6 smart architecture


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "server6_version": { + "description": "The version details of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "lease6_client_duid": { + "description": "The client DHCP Unique Identifier (DUID) associated with the DHCPv6 lease.", + "type": "string" + }, + "lease6_clientname": { + "description": "The name of the client associated with the DHCPv6 lease.", + "type": "string" + }, + "lease6_domain": { + "description": "The domain name associated with the DHCPv6 lease.", + "type": "string" + }, + "lease6_end_time": { + "description": "The expiration time of the lease, in decimal UNIX date format.", + "type": "string" + }, + "lease6_first_time": { + "description": "The first time the DHCPv6 lease has been attributed to the client, in decimal UNIX date format.", + "type": "string" + }, + "lease6_giaddr": { + "description": "The gateway IP address of the relay agent of the DHCPv6 lease.", + "type": "string" + }, + "lease6_id": { + "description": "The database identifier (ID) of the DHCPv6 lease.", + "type": "string" + }, + "lease6_address6_addr": { + "description": "The IP address associated with the DHCPv6 lease, in hexadecimal format.", + "type": "string" + }, + "lease6_mac_addr": { + "description": "The MAC address associated with the DHCPv6 lease.", + "type": "string" + }, + "lease6_name": { + "description": "The name of the DHCPv6 lease.", + "type": "string" + }, + "lease6_period": { + "description": "The duration time (time to live) of the DHCPv6 lease, in seconds.", + "type": "string" + }, + "lease6_time": { + "description": "The last time the DHCPv6 lease has been attributed to the client, in decimal UNIX date format.", + "type": "string" + }, + "range6_class_name": { + "description": "The name of the class applied to the DHCPv6 range the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "range6_class_parameters": { + "description": "The class parameters applied to the DHCPv6 range the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "range6_end_address6_addr": { + "description": "The last IP address of the DHCPv6 range the object belongs to, in hexadecimal format.", + "type": "string" + }, + "range6_failover_name": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "range6_id": { + "description": "The database identifier (ID) of the DHCPv6 range the object belongs to.", + "type": "string" + }, + "range6_start_address6_addr": { + "description": "The first IP address of the DHCPv6 range the object belongs to, in hexadecimal format.", + "type": "string" + }, + "scope6_class_name": { + "description": "The name of the class applied to the DHCPv6 scope the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "scope6_id": { + "description": "The database identifier (ID) of the DHCPv6 scope the object belongs to.", + "type": "string" + }, + "scope6_name": { + "description": "The name of the DHCPv6 scope the object belongs to.", + "type": "string" + }, + "scope6_prefix": { + "description": "The prefix of the DHCPv6 scope the object belongs to.", + "type": "string" + }, + "scope6_size": { + "description": "The number of IP addresses the DHCPv6 scope the object belongs to contains.", + "type": "string" + }, + "scope6_start_address6_addr": { + "description": "The first IP address of the DHCPv6 scope the object belongs to, in hexadecimal format.", + "type": "string" + }, + "sharednetwork6_id": { + "description": "The database identifier (ID) of the DHCPv6 shared network the object belongs to.", + "type": "string" + }, + "sharednetwork6_name": { + "description": "The name of the DHCPv6 shared network the object belongs to.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The human readable version of the parameter server6_addr or server6_addr6.", + "type": "string" + }, + "server6_addr6": { + "description": "The Management IP address of the DHCPv6 server the object belongs to, the IPv6 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "server6_addr": { + "description": "The Management IP address of the DHCPv6 server the object belongs to, the IPv4 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "lease6_mac_vendor": { + "description": "The vendor details of the client associated with the DHCPv6 lease.", + "type": "string" + }, + "lease6_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                                                                                                                              Multi-status severity levels
                                                                                                                                                                                                                                              Message number Severity Description
                                                                                                                                                                                                                                              0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                                                                                                                              17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                                                                                                                              34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                                                                                                                              51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                                                                                                                              67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                                                                                                                              84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "lease6_percent": { + "description": "The percentage of time the lease has really been in use.", + "type": "string" + }, + "lease6_time_to_expire": { + "description": "The time left to the lease before it expires, in seconds.", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv6 smart architecture managing the DHCPv6 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_name": { + "description": "The name of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. # indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_lease6_data", + "type": "object" + }, + "dns_zone_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_zone_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_static_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_static_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_pool_edit_input": { + "properties": { + "pool_end_ip_addr": { + "description": "The last IP address of the pool.", + "type": "string" + }, + "pool_id": { + "description": "The database identifier (ID) of the IPv4 pool, a unique numeric key value automatically incremented when you add an IPv4 pool. Use the ID to specify the IPv4 pool of your choice.", + "type": "integer" + }, + "pool_size": { + "description": "The size of the pool, the number of IP addresses it contains.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "pool_start_ip_addr": { + "description": "The first IP address of the pool.", + "type": "string" + }, + "network_id": { + "description": "The database identifier (ID) of the IPv4 network, a unique numeric key value automatically incremented when you add an IPv4 network. Use the ID to specify the IPv4 network of your choice.", + "type": "integer" + }, + "pool_name": { + "description": "The name of the IPv4 pool, each IPv4 pool must have a unique name.", + "type": "string" + }, + "pool_read_only": { + "description": "The reservation status of the IPv4 pool. If set 1, the IP addresses it contains cannot be assigned.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "pool_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "pool_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dhcp_range6_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_range6_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_address_delete_success": { + "example": { + "data": [ + { + "address_id": "address_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_address_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_static_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_static_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_pool_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_pool_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_zoneparam_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_zoneparam_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dhcp_scope_edit_success": { + "example": { + "scope_id": "scope_id" + }, + "properties": { + "scope_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_scope_edit_success", + "type": "object" + }, + "dhcp_sharednetwork6_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_sharednetwork6_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_acl_data": { + "example": { + "data": [ + { + "server_name": "server_name", + "acl_spawnwith": "acl_spawnwith", + "server_id": "server_id", + "acl_leaselimit": "acl_leaselimit", + "acl_statement": "acl_statement", + "smart_parent_id": "smart_parent_id", + "acl_name": "acl_name", + "acl_delayed_create_time": "acl_delayed_create_time", + "server_cluster_role": "server_cluster_role", + "acl_delayed_delete_time": "acl_delayed_delete_time", + "acl_id": "acl_id", + "acl_match": "acl_match", + "server_type": "server_type" + }, + { + "server_name": "server_name", + "acl_spawnwith": "acl_spawnwith", + "server_id": "server_id", + "acl_leaselimit": "acl_leaselimit", + "acl_statement": "acl_statement", + "smart_parent_id": "smart_parent_id", + "acl_name": "acl_name", + "acl_delayed_create_time": "acl_delayed_create_time", + "server_cluster_role": "server_cluster_role", + "acl_delayed_delete_time": "acl_delayed_delete_time", + "acl_id": "acl_id", + "acl_match": "acl_match", + "server_type": "server_type" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_acl_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_group_edit_success": { + "example": { + "data": [ + { + "group_id": "group_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_group_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_pool_add_input": { + "properties": { + "pool_end_ip_addr": { + "description": "The last IP address of the pool.", + "type": "string" + }, + "pool_size": { + "description": "The size of the pool, the number of IP addresses it contains.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "pool_start_ip_addr": { + "description": "The first IP address of the pool.", + "type": "string" + }, + "network_id": { + "description": "The database identifier (ID) of the IPv4 network, a unique numeric key value automatically incremented when you add an IPv4 network. Use the ID to specify the IPv4 network of your choice.", + "type": "integer" + }, + "pool_name": { + "description": "The name of the IPv4 pool, each IPv4 pool must have a unique name.", + "type": "string" + }, + "pool_read_only": { + "description": "The reservation status of the IPv4 pool. If set 1, the IP addresses it contains cannot be assigned.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "pool_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "pool_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dhcp_group_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_group_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_range6_add_success": { + "example": { + "data": [ + { + "range6_id": "range6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_range6_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dns_view_delete_success": { + "example": { + "view_id": "view_id" + }, + "properties": { + "view_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_dns_view_delete_success", + "type": "object" + }, + "dns_zone_delete_success": { + "example": { + "data": [ + { + "zone_id": "zone_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_zone_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_sharednetwork6_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_sharednetwork6_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_scope6_edit_input": { + "properties": { + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "type": "integer" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "scope6_end_addr": { + "description": "The last IP address of the DHCPv6 scope.", + "type": "string" + }, + "scope6_id": { + "description": "The database identifier (ID) of the DHCPv6 scope, a unique numeric key value automatically incremented when you add a DHCPv6 scope. Use the ID to specify the DHCPv6 scope of your choice.", + "type": "integer" + }, + "scope6_prefix": { + "description": "The prefix of the DHCPv6 scope, an integer that defines the number of address the scope contains.", + "type": "string" + }, + "scope6_start_addr": { + "description": "The first IP address of the DHCPv6 scope.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "failover6_id": { + "description": "The database identifier (ID) of the DHCPv6 failover channel, a unique numeric key value automatically incremented when you add a DHCPv6 failover channel. Use the ID to specify the DHCPv6 failover channel of your choice.", + "type": "integer" + }, + "failover6_name": { + "description": "The name of the DHCPv6 failover channel.", + "type": "string" + }, + "scope6_name": { + "description": "The name of the DHCPv6 scope, each DHCPv6 scope must have a unique name.", + "type": "string" + }, + "scope6_space_id": { + "description": "The database identifier (ID) of an existing space you want to associate with the DHCPv6 scope.", + "type": "integer" + }, + "scope6_space_name": { + "description": "The name of an existing space you want to associate with the DHCPv6 scope.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "scope6_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "scope6_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dhcp_aclentry_data": { + "example": { + "data": [ + { + "aclentry_id": "aclentry_id", + "server_name": "server_name", + "aclentry_leaselimit": "aclentry_leaselimit", + "smart_parent_id": "smart_parent_id", + "acl_name": "acl_name", + "server_cluster_role": "server_cluster_role", + "aclentry_delayed_delete_time": "aclentry_delayed_delete_time", + "aclentry_value": "aclentry_value", + "aclentry_delayed_create_time": "aclentry_delayed_create_time", + "acl_id": "acl_id", + "server_id": "server_id", + "server_type": "server_type" + }, + { + "aclentry_id": "aclentry_id", + "server_name": "server_name", + "aclentry_leaselimit": "aclentry_leaselimit", + "smart_parent_id": "smart_parent_id", + "acl_name": "acl_name", + "server_cluster_role": "server_cluster_role", + "aclentry_delayed_delete_time": "aclentry_delayed_delete_time", + "aclentry_value": "aclentry_value", + "aclentry_delayed_create_time": "aclentry_delayed_create_time", + "acl_id": "acl_id", + "server_id": "server_id", + "server_type": "server_type" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_aclentry_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_alias6_edit_input": { + "properties": { + "address6_hostaddr": { + "description": "The IP address.", + "type": "string" + }, + "address6_id": { + "description": "The database identifier (ID) of the IPv6 address, a unique numeric key value automatically incremented when you add an IPv6 address. Use the ID to specify the IPv6 address of your choice.", + "type": "integer" + }, + "alias6_name": { + "description": "The name of the IPv6 address.", + "type": "string" + }, + "alias6_id": { + "description": "The database identifier (ID) of the IPv6 alias, a unique numeric key value automatically incremented when you add an IPv6 alias. Use the ID to specify the IPv6 alias of your choice.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "alias6_type": { + "description": "The type of the alias.", + "enum": [ + "AAAA", + "aaaa", + "CNAME", + "cname" + ], + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dhcp_range6_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_range6_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dhcp_range6_edit_success": { + "example": { + "range6_id": "range6_id" + }, + "properties": { + "range6_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_range6_edit_success", + "type": "object" + }, + "_data_inner_dhcp_scope6_delete_success": { + "example": { + "scope6_id": "scope6_id" + }, + "properties": { + "scope6_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_scope6_delete_success", + "type": "object" + }, + "dhcp_server6_data": { + "example": { + "data": [ + { + "server6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server6_snmp_id": "server6_snmp_id", + "server6_version": "server6_version", + "smart_parent_arch": "smart_parent_arch", + "server6_state": "server6_state", + "smart_ref2_server6_id": "smart_ref2_server6_id", + "server6_stat_period": "server6_stat_period", + "server6_snmp_profile_id": "server6_snmp_profile_id", + "server6_multistatus": "server6_multistatus", + "server6_name": "server6_name", + "server6_stat_time": "server6_stat_time", + "server6_comment": "server6_comment", + "server6_snmp_timeout": "server6_snmp_timeout", + "smart_parent_id": "smart_parent_id", + "smart_parent_name": "smart_parent_name", + "smart_ref1_server6_id": "smart_ref1_server6_id", + "smart_arch": "smart_arch", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "server6_type": "server6_type", + "server6_snmp_port": "server6_snmp_port", + "server6_stat_niceness": "server6_stat_niceness", + "smart_ref1_server6_name": "smart_ref1_server6_name", + "smart_ref2_server6_name": "smart_ref2_server6_name", + "server6_synching": "server6_synching", + "server6_addr6": "server6_addr6", + "total_smart_members": "total_smart_members", + "server6_isolated": "server6_isolated", + "smart_param1": "smart_param1", + "server6_hostaddr": "server6_hostaddr", + "server6_last_refresh_time": "server6_last_refresh_time", + "server6_https_login": "server6_https_login", + "server6_uboottime": "server6_uboottime", + "server6_addr": "server6_addr", + "server6_snmp_retry": "server6_snmp_retry", + "smart_members_name": "smart_members_name", + "server6_snmp_use_tcp": "server6_snmp_use_tcp", + "connectionprofile_name": "connectionprofile_name", + "server6_is_package": "server6_is_package", + "reverse_proxy_conf": "reverse_proxy_conf", + "server6_stat_enabled": "server6_stat_enabled" + }, + { + "server6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server6_snmp_id": "server6_snmp_id", + "server6_version": "server6_version", + "smart_parent_arch": "smart_parent_arch", + "server6_state": "server6_state", + "smart_ref2_server6_id": "smart_ref2_server6_id", + "server6_stat_period": "server6_stat_period", + "server6_snmp_profile_id": "server6_snmp_profile_id", + "server6_multistatus": "server6_multistatus", + "server6_name": "server6_name", + "server6_stat_time": "server6_stat_time", + "server6_comment": "server6_comment", + "server6_snmp_timeout": "server6_snmp_timeout", + "smart_parent_id": "smart_parent_id", + "smart_parent_name": "smart_parent_name", + "smart_ref1_server6_id": "smart_ref1_server6_id", + "smart_arch": "smart_arch", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "server6_type": "server6_type", + "server6_snmp_port": "server6_snmp_port", + "server6_stat_niceness": "server6_stat_niceness", + "smart_ref1_server6_name": "smart_ref1_server6_name", + "smart_ref2_server6_name": "smart_ref2_server6_name", + "server6_synching": "server6_synching", + "server6_addr6": "server6_addr6", + "total_smart_members": "total_smart_members", + "server6_isolated": "server6_isolated", + "smart_param1": "smart_param1", + "server6_hostaddr": "server6_hostaddr", + "server6_last_refresh_time": "server6_last_refresh_time", + "server6_https_login": "server6_https_login", + "server6_uboottime": "server6_uboottime", + "server6_addr": "server6_addr", + "server6_snmp_retry": "server6_snmp_retry", + "smart_members_name": "smart_members_name", + "server6_snmp_use_tcp": "server6_snmp_use_tcp", + "connectionprofile_name": "connectionprofile_name", + "server6_is_package": "server6_is_package", + "reverse_proxy_conf": "reverse_proxy_conf", + "server6_stat_enabled": "server6_stat_enabled" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_server6_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dhcp_group_data": { + "example": { + "server_name": "server_name", + "group_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "group_name": "group_name", + "server_class_name": "server_class_name", + "group_class_name": "group_class_name", + "group_multistatus": "group_multistatus", + "server_id": "server_id", + "server_version": "server_version", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "smart_parent_id": "smart_parent_id", + "group_id": "group_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "smart_parent_name": "smart_parent_name", + "group_delayed_create_time": "group_delayed_create_time", + "group_delayed_delete_time": "group_delayed_delete_time", + "server_type": "server_type" + }, + "properties": { + "group_delayed_create_time": { + "description": "The delay of creation status. 1 indicates that the object is not created yet.", + "type": "string" + }, + "group_delayed_delete_time": { + "description": "The delay of deletion status. 1 indicates that the object is not deleted yet.", + "type": "string" + }, + "server_class_name": { + "description": "The name of the class applied to the DHCPv4 server the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "server_class_parameters": { + "description": "The class parameters applied to the DHCPv4 server the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_name": { + "description": "The name of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_type": { + "description": "The type of the DHCPv4 server the object belongs to:


                                                                                                                                                                                                                                              server_type possible values
                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                              ipmEfficientIP or EfficientIP Package server
                                                                                                                                                                                                                                              msrpcMicrosoft Windows DHCP server
                                                                                                                                                                                                                                              vdhcpEfficientIP DHCPv4 smart architecture


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "server_version": { + "description": "The version details of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "group_class_name": { + "description": "The name of the class applied to the DHCPv4 group, it can be preceded by the class directory.", + "type": "string" + }, + "group_class_parameters": { + "description": "The class parameters applied to the DHCPv4 group.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "group_id": { + "description": "The database identifier (ID) of the DHCPv4 group.", + "type": "string" + }, + "group_name": { + "description": "The name of the DHCPv4 group.", + "type": "string" + }, + "server_hostaddr": { + "description": "The human readable version of the parameter server_addr or server_addr6.", + "type": "string" + }, + "server_addr6": { + "description": "The Management IP address of the DHCPv4 server the object belongs to, the IPv6 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "server_addr": { + "description": "The Management IP address of the DHCPv4 server the object belongs to, the IPv4 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "group_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                                                                                                                              Multi-status severity levels
                                                                                                                                                                                                                                              Message number Severity Description
                                                                                                                                                                                                                                              0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                                                                                                                              17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                                                                                                                              34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                                                                                                                              51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                                                                                                                              67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                                                                                                                              84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_name": { + "description": "The name of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. # indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_group_data", + "type": "object" + }, + "_data_inner_dhcp_sharednetwork6_add_success": { + "example": { + "sharednetwork6_id": "sharednetwork6_id" + }, + "properties": { + "sharednetwork6_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_sharednetwork6_add_success", + "type": "object" + }, + "_data_inner_dns_rr_delete_success": { + "example": { + "rr_id": "rr_id" + }, + "properties": { + "rr_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_dns_rr_delete_success", + "type": "object" + }, + "_data_inner_ipam_address_data": { + "example": { + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "address_alias": "address_alias", + "network_is_terminal": "network_is_terminal", + "pool_class_name": "pool_class_name", + "free_end_address_addr": "free_end_address_addr", + "address_class_name": "address_class_name", + "address_operation_details_last_updated_on": "address_operation_details_last_updated_on", + "space_class_name": "space_class_name", + "port_portnumber": "port_portnumber", + "network_start_hostaddr": "network_start_hostaddr", + "space_description": "space_description", + "parent_network_end_hostaddr": "parent_network_end_hostaddr", + "device_id": "device_id", + "network_size": "network_size", + "tag_container_dhcpstatic": "tag_container_dhcpstatic", + "port_ifvlan": "port_ifvlan", + "space_is_template": "space_is_template", + "address_id": "address_id", + "network_name": "network_name", + "parent_network_class_name": "parent_network_class_name", + "network_id": "network_id", + "address_operation_details_requested_by": "address_operation_details_requested_by", + "address_operation_details_added_by": "address_operation_details_added_by", + "space_name": "space_name", + "network_start_address_addr": "network_start_address_addr", + "pool_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "address_operation_details_added_on": "address_operation_details_added_on", + "network_class_name": "network_class_name", + "free_start_address_addr": "free_start_address_addr", + "address_hostaddr": "address_hostaddr", + "interface_name": "interface_name", + "pool_start_address_addr": "pool_start_address_addr", + "network_end_hostaddr": "network_end_hostaddr", + "address_multistatus": "address_multistatus", + "address_name": "address_name", + "port_slotnumber": "port_slotnumber", + "parent_network_name": "parent_network_name", + "free_scope_size": "free_scope_size", + "tag_pool_dhcprange": "tag_pool_dhcprange", + "address_operation_details_call_stack": "address_operation_details_call_stack", + "device_name": "device_name", + "parent_network_start_hostaddr": "parent_network_start_hostaddr", + "address_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "parent_network_size": "parent_network_size", + "pool_end_address_addr": "pool_end_address_addr", + "parent_vlsm_network_id": "parent_vlsm_network_id", + "dev_name": "dev_name", + "network_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "address_addr": "address_addr", + "network_lock_network_broadcast": "network_lock_network_broadcast", + "address_type": "address_type", + "address_operation_details_origin_module": "address_operation_details_origin_module", + "static_id": "static_id", + "pool_size": "pool_size", + "pool_read_only": "pool_read_only", + "address_mac_addr": "address_mac_addr", + "pool_id": "pool_id", + "address_mac_last_seen": "address_mac_last_seen", + "parent_network_start_address_addr": "parent_network_start_address_addr", + "pool_name": "pool_name", + "dev_id": "dev_id", + "port_name": "port_name", + "lease_end_time": "lease_end_time", + "interface_id": "interface_id", + "parent_network_id": "parent_network_id", + "space_id": "space_id", + "network_end_address_addr": "network_end_address_addr", + "lease_id": "lease_id", + "parent_network_end_address_addr": "parent_network_end_address_addr" + }, + "properties": { + "static_id": { + "description": "The database identifier (ID) of the DHCP static associated with the IP address.", + "type": "string" + }, + "lease_end_time": { + "description": "The expiration time of the lease, if the IP address was imported from the DHCP, in decimal UNIX date format.", + "type": "string" + }, + "lease_id": { + "description": "The database identifier (ID) of the DHCP lease associated with the IP address.", + "type": "string" + }, + "free_end_address_addr": { + "description": "An IP address in hexadecimal format. For addresses In use (typeip), it returns the IP address itself.For free addresses (typefree), it returns the last IP address of a range of IPv4 addresses that are not assigned yet. The first address in that range is returned in free_start_address_addr.", + "type": "string" + }, + "free_scope_size": { + "description": "The number of IP addresses that are not assigned yet (typefree) between free_start_address_addr and free_end_address_addr.", + "type": "string" + }, + "free_start_address_addr": { + "description": "An IP address in hexadecimal format. For addresses In use (typeip), it returns the IP address itself.For free addresses (typefree), it returns the first IP address of a range of IPv4 addresses that are not assigned yet. The last address in that range is returned in free_end_address_addr.", + "type": "string" + }, + "address_hostaddr": { + "description": "The human readable version of the parameter address_addr.", + "type": "string" + }, + "device_id": { + "description": "The database identifier (ID) of the Device Manager device associated with the IP address.", + "type": "string" + }, + "device_name": { + "description": "The name of the Device Manager device associated with the IP address.", + "type": "string" + }, + "interface_id": { + "description": "The database identifier (ID) of the Device Manager interface associated with the IP address.", + "type": "string" + }, + "interface_name": { + "description": "The name of the Device Manager interface associated with the IP address.", + "type": "string" + }, + "address_addr": { + "description": "The IPv4 address itself, in hexadecimal format.", + "type": "string" + }, + "address_alias": { + "description": "The name of the IPv4 alias(es) associated with the IPv4 address.", + "type": "string" + }, + "address_class_name": { + "description": "The name of the class applied to the IPv4 address, it can be preceded by the class directory.", + "type": "string" + }, + "address_class_parameters": { + "description": "The class parameters applied to the IPv4 address.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "address_id": { + "description": "The database identifier (ID) of the IPv4 address.", + "type": "string" + }, + "dev_id": { + "description": "The database identifier (ID) of the NetChange network device associated with the IP address.", + "type": "string" + }, + "dev_name": { + "description": "The name of the NetChange network device associated with the IP address.", + "type": "string" + }, + "port_ifvlan": { + "description": "The VLAN identifier (ID) of the NetChange port, for IP addresses which MAC addresses is imported from NetChange.", + "type": "string" + }, + "port_name": { + "description": "The name of the NetChange port associated with the IP address.", + "type": "string" + }, + "port_portnumber": { + "description": "The number of the port, for IP addresses which MAC addresses is imported from NetChange.", + "type": "string" + }, + "port_slotnumber": { + "description": "The slot number of the port, for IP addresses which MAC addresses is imported from NetChange.", + "type": "string" + }, + "address_mac_last_seen": { + "description": "The last time the MAC address associated with the IP address was seen on the network, in decimal UNIX date format.", + "type": "string" + }, + "network_lock_network_broadcast": { + "description": "A way to prevent (1) users from assigning the broadcast IP address and network IP address of the network the IP address belongs to.", + "type": "string" + }, + "address_mac_addr": { + "description": "The MAC address associated with the IPv4 address.", + "type": "string" + }, + "address_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                                                                                                                              Multi-status severity levels
                                                                                                                                                                                                                                              Message number Severity Description
                                                                                                                                                                                                                                              0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                                                                                                                              17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                                                                                                                              34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                                                                                                                              51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                                                                                                                              67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                                                                                                                              84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "address_name": { + "description": "The name of the IPv4 address.", + "type": "string" + }, + "parent_network_class_name": { + "description": "The name of the class applied to the parent of the IPv4 network the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "parent_network_end_hostaddr": { + "description": "The human readable version of the parameter parent_network_end_address_addr.", + "type": "string" + }, + "parent_network_end_address_addr": { + "description": "The last IP address of the parent of the IPv4 network the IP address belongs to.", + "type": "string" + }, + "parent_network_id": { + "description": "The database identifier (ID) of the parent IPv4 network. It identifies the parent of the IPv4 network the object belongs to. 0 indicates that the network the object belongs to has no parent network.", + "type": "string" + }, + "parent_network_name": { + "description": "The name of the parent IPv4 network:
                                                                                                                                                                                                                                              • # indicates that the network the object belongs to has no parent network.
                                                                                                                                                                                                                                              • Default indicates that the network the object belongs to is in an orphan network.
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "parent_network_size": { + "description": "The number of IP addresses of the parent of the network the object belongs to.", + "type": "string" + }, + "parent_network_start_hostaddr": { + "description": "The human readable version of the parameter parent_network_start_address_addr.", + "type": "string" + }, + "parent_network_start_address_addr": { + "description": "The first IP address of the parent of the IPv4 network the IP address belongs to.", + "type": "string" + }, + "parent_vlsm_network_id": { + "description": "The database identifier (ID) of the IPv4 subnet-type network, located in the VLSM parent space, from which the parent of the network the IP address belongs to was duplicated. 0 indicates that the parent of the network the IP address belongs to is not a VLSM block-type network duplicated from a parent space.", + "type": "string" + }, + "pool_class_name": { + "description": "The name of the class applied to the IPv4 pool the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "pool_class_parameters": { + "description": "The class parameters applied to the IPv4 pool the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "pool_end_address_addr": { + "description": "The last IP address of the IPv4 pool the IP address belongs to.", + "type": "string" + }, + "pool_id": { + "description": "The database identifier (ID) of the IPv4 pool the object belongs to.", + "type": "string" + }, + "pool_name": { + "description": "The name of the IPv4 pool the object belongs to.", + "type": "string" + }, + "pool_read_only": { + "description": "The reservation status of the pool the IPv4 address belongs to. If set 1, the pool is reserved and you cannot assign the IP address.", + "type": "string" + }, + "pool_size": { + "description": "The number of IP addresses that contains the pool the IPv4 address belongs to.", + "type": "string" + }, + "pool_start_address_addr": { + "description": "The first IP address of the IPv4 pool the IP address belongs to.", + "type": "string" + }, + "space_class_name": { + "description": "The name of the class applied to the space the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "space_class_parameters": { + "description": "The class parameters applied to the space the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "space_description": { + "description": "The description of the space the object belongs to.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space the object belongs to, a unique numeric key value automatically incremented when you add a space.", + "type": "string" + }, + "space_is_template": { + "description": "The template status of the space the object belongs to. If the space is used as template (1), all the IPv4 networks, pools and IP addresses it contains are also used as template.", + "type": "string" + }, + "space_name": { + "description": "The name of the space the object belongs to.", + "type": "string" + }, + "network_class_name": { + "description": "The name of the class applied to the IPv4 network the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "network_class_parameters": { + "description": "The class parameters applied to the IPv4 network the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "network_end_hostaddr": { + "description": "The human readable version of the parameter network_end_address_addr.", + "type": "string" + }, + "network_end_address_addr": { + "description": "The last IP address of the IPv4 network the object belongs to.", + "type": "string" + }, + "network_id": { + "description": "The database identifier (ID) of the IPv4 network the object belongs to.", + "type": "string" + }, + "network_is_terminal": { + "description": "A way to determine if the network the IP address belongs to is terminal (1) or non-terminal (0).", + "type": "string" + }, + "network_name": { + "description": "The name of the IPv4 network the object belongs to. Default indicates that the network the object belongs to is an orphan network.", + "type": "string" + }, + "network_size": { + "description": "The number of IP addresses the network the object belongs to contains.", + "type": "string" + }, + "network_start_hostaddr": { + "description": "The human readable version of the parameter network_start_address_addr.", + "type": "string" + }, + "network_start_address_addr": { + "description": "The first IP address of the IPv4 network the object belongs to.", + "type": "string" + }, + "tag_container_dhcpstatic": { + "description": "A way to determine if the terminal network or pool the IP address belongs to is configured to Add a DHCP static (1) or not (0).", + "type": "string" + }, + "tag_pool_dhcprange": { + "description": "A way to determine if the pool the IP address belongs to is configured to Create DHCP range (1) or not (0).", + "type": "string" + }, + "address_operation_details_added_on": { + "description": "The creation date of the IPv4 address, in decimal UNIX date format.", + "type": "string" + }, + "address_operation_details_call_stack": { + "description": "The call stack of the IPv4 address operation details, as follows: <service1>&<service2>&<service3>... .", + "type": "string" + }, + "address_operation_details_origin_module": { + "description": "The name of the module where the IPv4 address addition originated.", + "type": "string" + }, + "address_operation_details_requested_by": { + "description": "The login of the user who requested the IPv4 address.", + "type": "string" + }, + "address_operation_details_added_by": { + "description": "The login of the user who added the IPv4 address.", + "type": "string" + }, + "address_operation_details_last_updated_on": { + "description": "The last time the IPv4 address was updated, in decimal UNIX date format.", + "type": "string" + }, + "address_type": { + "description": "A way to determine if you can assign the IP address (free) or if it is In use (ip).", + "type": "string" + } + }, + "title": "_data_inner_ipam_address_data", + "type": "object" + }, + "dhcp_range_edit_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "range_end_addr": { + "description": "The last IP address of the DHCPv4 range.", + "type": "string" + }, + "range_id": { + "description": "The database identifier (ID) of the DHCPv4 range, a unique numeric key value automatically incremented when you add a DHCPv4 range. Use the ID to specify the DHCPv4 range of your choice.", + "type": "integer" + }, + "range_start_addr": { + "description": "The first IP address of the DHCPv4 range.", + "type": "string" + }, + "scope_id": { + "description": "The database identifier (ID) of the DHCPv4 scope, a unique numeric key value automatically incremented when you add a DHCPv4 scope. Use the ID to specify the DHCPv4 scope of your choice.", + "type": "integer" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "range_acl": { + "description": "The list of ACLs associated with the DHCPv4 range, as follows: <ACL_name>;<ACL_name>;... .", + "type": "string" + }, + "range_name": { + "description": "The start and end IP address of the DHCPv4 range, as follows: <start-ip>-<end-ip>.", + "type": "string" + }, + "scope_name": { + "description": "The name of the DHCPv4 scope.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "range_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "range_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "ipam_alias_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_alias_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_network6_add_input": { + "properties": { + "parent_network6_id": { + "description": "The database identifier (ID) of an existing IPv6 network you want to set as the parent of the IPv6 network you are adding. You can specify a subnet-type network to set up a network-based VLSM organization.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "network6_addr": { + "description": "The start IP address of the IPv6 network, its first IP address.", + "type": "string" + }, + "network6_end_addr": { + "description": "The end IP address of the IPv6 network, its last IP address.", + "type": "string" + }, + "network6_prefix": { + "description": "The prefix of the IPv6 network, an integer that defines the number of address the network contains.", + "type": "string" + }, + "allow_block6_creation": { + "description": "Internal use. Not documented.", + "type": "integer" + }, + "allow_tree_reparenting": { + "description": "A way to allow (1) or prevent (0) changing the parent of the network you are adding. Upon editing of the network, this parameter decides if you can associate it with a different parent network.", + "type": "integer" + }, + "network6_is_terminal": { + "description": "A way to determine if a network can contain other networks. If set to 1, the network is terminal and cannot contain other subnet-type networks. By essence, block-type networks are non-terminal and are always set to 0.", + "type": "integer" + }, + "network6_lock_network_broadcast": { + "description": "A way to prevent (1) users from assigning the broadcast IP address and network IP address of the network.", + "type": "integer" + }, + "permit_invalid": { + "description": "A way to authorize (1) IPv6 networks overlapping within a space.", + "type": "integer" + }, + "permit_no_block6": { + "description": "A way to force the creation of an IPv6 subnet-type network. If set to 1, you can create a subnet-type network even if no block-type network matching the start address exists.", + "type": "integer" + }, + "relative_position": { + "description": "The position of the network within the hierarchy of networks of a VLSM organization. It calculates between 0 and n all the levels of the organization, its behavior depends on the value of the parameter use_reversed_relative_position:
                                                                                                                                                                                                                                              • use_reversed_relative_position=0 where 0 indicates a block-type network at the highest level possible, in a space-based organization, it belongs to the top space. The levels increment from 0 down to n, the lowest level you set up, within networks or spaces.
                                                                                                                                                                                                                                              • use_reversed_relative_position=1 where 1 indicates a network located at the lowest level of the organization, within networks or spaces. The levels increment from 0 up to n, the network at the highest level of the organization.
                                                                                                                                                                                                                                              ", + "type": "integer" + }, + "row_state": { + "description": "The object activation status.
                                                                                                                                                                                                                                              • If set to 0, the object is present in the database but ignored, i.e. it cannot be managed, counted or listed. This status is applied on objects deleted from the GUI.
                                                                                                                                                                                                                                              • If set to 1, the object is enabled and managed.
                                                                                                                                                                                                                                              • If set to 2, the object is unmanaged, disabled or both depending on the context.
                                                                                                                                                                                                                                              By default, row_state is set to 1 when an object is created.", + "enum": [ + "1", + "2" + ], + "type": "string" + }, + "network6_name": { + "description": "The name of the IPv6 network, each IPv6 network must have a unique name.", + "type": "string" + }, + "network_level": { + "description": "The level of the network within the space:
                                                                                                                                                                                                                                              • Set it to 0 for a block-type network.
                                                                                                                                                                                                                                              • Set it to a value between 1 and n for a subnet-type network.
                                                                                                                                                                                                                                              If you set a value between 2 and n, you are setting a network-based VLSM organization where non terminal subnet-type networks can contain other subnet-type networks.", + "type": "integer" + }, + "use_reversed_relative_position": { + "description": "A way to determine if the calculation of the parameter relative_position should start from the top (0) or the bottom (1) of the VLSM organization.", + "type": "integer" + }, + "vlan_id": { + "description": "The database identifier (ID) of the VLAN you want to associate with the network.", + "type": "integer" + }, + "vlsm_space_id": { + "description": "The database identifier (ID) of a VLSM child space of the space specified in space_id. If you specify an ID, the subnet-type network you are adding is duplicated as a VLSM block-type network in the child space, with the same name but a different ID. This parameter serves the same purpose as vlsm_space_name.", + "type": "integer" + }, + "vlsm_space_name": { + "description": "The name of a VLSM child space of the space specified in space_id. If you specify a name, the subnet-type network you are adding is duplicated as a VLSM block-type network in the child space, with the same name but a different ID. This parameter serves the same purpose as vlsm_space_id.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "network6_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "network6_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dhcp_sharednetwork_delete_success": { + "example": { + "data": [ + { + "sharednetwork_id": "sharednetwork_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_sharednetwork_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dns_zone_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_zone_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_vlan_vlan_delete_success": { + "example": { + "vlan_id": "vlan_id" + }, + "properties": { + "vlan_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_vlan_vlan_delete_success", + "type": "object" + }, + "ipam_address6_edit_success": { + "example": { + "data": [ + { + "address6_id": "address6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_address6_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_range_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_range_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_scope6_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_scope6_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_network6_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_network6_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_static_data": { + "example": { + "data": [ + { + "server_name": "server_name", + "static_mac_vendor": "static_mac_vendor", + "sharednetwork_id": "sharednetwork_id", + "server_class_name": "server_class_name", + "group_class_name": "group_class_name", + "scope_start_address_addr": "scope_start_address_addr", + "server_version": "server_version", + "static_multistatus": "static_multistatus", + "scope_name": "scope_name", + "static_mac_addr": "static_mac_addr", + "static_delayed_create_time": "static_delayed_create_time", + "static_delayed_delete_time": "static_delayed_delete_time", + "smart_parent_id": "smart_parent_id", + "scope_id": "scope_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "smart_parent_name": "smart_parent_name", + "scope_size": "scope_size", + "static_last_seen": "static_last_seen", + "static_expire_time": "static_expire_time", + "scope_end_address_addr": "scope_end_address_addr", + "static_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "static_addr": "static_addr", + "group_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "group_name": "group_name", + "static_domain": "static_domain", + "static_id": "static_id", + "sharednetwork_name": "sharednetwork_name", + "static_class_name": "static_class_name", + "server_id": "server_id", + "scope_net_mask": "scope_net_mask", + "scope_net_addr": "scope_net_addr", + "group_id": "group_id", + "scope_space_id": "scope_space_id", + "scope_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "static_address_addr": "static_address_addr", + "static_name": "static_name", + "static_identifier": "static_identifier", + "server_type": "server_type", + "scope_class_name": "scope_class_name" + }, + { + "server_name": "server_name", + "static_mac_vendor": "static_mac_vendor", + "sharednetwork_id": "sharednetwork_id", + "server_class_name": "server_class_name", + "group_class_name": "group_class_name", + "scope_start_address_addr": "scope_start_address_addr", + "server_version": "server_version", + "static_multistatus": "static_multistatus", + "scope_name": "scope_name", + "static_mac_addr": "static_mac_addr", + "static_delayed_create_time": "static_delayed_create_time", + "static_delayed_delete_time": "static_delayed_delete_time", + "smart_parent_id": "smart_parent_id", + "scope_id": "scope_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "smart_parent_name": "smart_parent_name", + "scope_size": "scope_size", + "static_last_seen": "static_last_seen", + "static_expire_time": "static_expire_time", + "scope_end_address_addr": "scope_end_address_addr", + "static_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "static_addr": "static_addr", + "group_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "group_name": "group_name", + "static_domain": "static_domain", + "static_id": "static_id", + "sharednetwork_name": "sharednetwork_name", + "static_class_name": "static_class_name", + "server_id": "server_id", + "scope_net_mask": "scope_net_mask", + "scope_net_addr": "scope_net_addr", + "group_id": "group_id", + "scope_space_id": "scope_space_id", + "scope_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "static_address_addr": "static_address_addr", + "static_name": "static_name", + "static_identifier": "static_identifier", + "server_type": "server_type", + "scope_class_name": "scope_class_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_static_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_rr_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_rr_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dns_acl_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_acl_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_address_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_address_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_server_data": { + "example": { + "data": [ + { + "server_stat_enabled": "server_stat_enabled", + "server_cisco_password": "server_cisco_password", + "server_uboottime": "server_uboottime", + "server_stat_time": "server_stat_time", + "server_ms_use_ssl": "server_ms_use_ssl", + "server_version": "server_version", + "server_stat_niceness": "server_stat_niceness", + "server_multistatus": "server_multistatus", + "service_address_addr": "service_address_addr", + "smart_parent_name": "smart_parent_name", + "server_localtime": "server_localtime", + "smart_ref2_server_id": "smart_ref2_server_id", + "cluster_ssh_keyring_id": "cluster_ssh_keyring_id", + "server_tcp_port": "server_tcp_port", + "server_snmp_timeout": "server_snmp_timeout", + "server_stat_period": "server_stat_period", + "server_windhcp_protocol": "server_windhcp_protocol", + "cluster_hb_hostaddr": "cluster_hb_hostaddr", + "server_ipmdhcp_protocol": "server_ipmdhcp_protocol", + "server_id": "server_id", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "connectionprofile_name": "connectionprofile_name", + "reverse_proxy_conf": "reverse_proxy_conf", + "cluster_peer_server_id": "cluster_peer_server_id", + "server_msrpc_login": "server_msrpc_login", + "cluster_vip_phys_hostaddr": "cluster_vip_phys_hostaddr", + "server_name": "server_name", + "smart_parent_arch": "smart_parent_arch", + "server_cisco_login": "server_cisco_login", + "server_class_name": "server_class_name", + "server_snmp_profile_id": "server_snmp_profile_id", + "smart_ref2_server_name": "smart_ref2_server_name", + "smart_ref1_server_name": "smart_ref1_server_name", + "server_snmp_use_tcp": "server_snmp_use_tcp", + "smart_parent_id": "smart_parent_id", + "server_cisco_use_ssh": "server_cisco_use_ssh", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_https_login": "server_https_login", + "server_cluster_role": "server_cluster_role", + "smart_arch": "smart_arch", + "server_cisco_root_password": "server_cisco_root_password", + "server_state": "server_state", + "server_comment": "server_comment", + "server_synching": "server_synching", + "smart_ref1_server_id": "smart_ref1_server_id", + "server_is_package": "server_is_package", + "server_snmp_port": "server_snmp_port", + "total_smart_members": "total_smart_members", + "server_isolated": "server_isolated", + "smart_param1": "smart_param1", + "server_msrpc_domain": "server_msrpc_domain", + "ref2_server_name": "ref2_server_name", + "server_snmp_retry": "server_snmp_retry", + "ref1_server_name": "ref1_server_name", + "server_snmp_id": "server_snmp_id", + "smart_members_name": "smart_members_name", + "server_type": "server_type" + }, + { + "server_stat_enabled": "server_stat_enabled", + "server_cisco_password": "server_cisco_password", + "server_uboottime": "server_uboottime", + "server_stat_time": "server_stat_time", + "server_ms_use_ssl": "server_ms_use_ssl", + "server_version": "server_version", + "server_stat_niceness": "server_stat_niceness", + "server_multistatus": "server_multistatus", + "service_address_addr": "service_address_addr", + "smart_parent_name": "smart_parent_name", + "server_localtime": "server_localtime", + "smart_ref2_server_id": "smart_ref2_server_id", + "cluster_ssh_keyring_id": "cluster_ssh_keyring_id", + "server_tcp_port": "server_tcp_port", + "server_snmp_timeout": "server_snmp_timeout", + "server_stat_period": "server_stat_period", + "server_windhcp_protocol": "server_windhcp_protocol", + "cluster_hb_hostaddr": "cluster_hb_hostaddr", + "server_ipmdhcp_protocol": "server_ipmdhcp_protocol", + "server_id": "server_id", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "connectionprofile_name": "connectionprofile_name", + "reverse_proxy_conf": "reverse_proxy_conf", + "cluster_peer_server_id": "cluster_peer_server_id", + "server_msrpc_login": "server_msrpc_login", + "cluster_vip_phys_hostaddr": "cluster_vip_phys_hostaddr", + "server_name": "server_name", + "smart_parent_arch": "smart_parent_arch", + "server_cisco_login": "server_cisco_login", + "server_class_name": "server_class_name", + "server_snmp_profile_id": "server_snmp_profile_id", + "smart_ref2_server_name": "smart_ref2_server_name", + "smart_ref1_server_name": "smart_ref1_server_name", + "server_snmp_use_tcp": "server_snmp_use_tcp", + "smart_parent_id": "smart_parent_id", + "server_cisco_use_ssh": "server_cisco_use_ssh", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_https_login": "server_https_login", + "server_cluster_role": "server_cluster_role", + "smart_arch": "smart_arch", + "server_cisco_root_password": "server_cisco_root_password", + "server_state": "server_state", + "server_comment": "server_comment", + "server_synching": "server_synching", + "smart_ref1_server_id": "smart_ref1_server_id", + "server_is_package": "server_is_package", + "server_snmp_port": "server_snmp_port", + "total_smart_members": "total_smart_members", + "server_isolated": "server_isolated", + "smart_param1": "smart_param1", + "server_msrpc_domain": "server_msrpc_domain", + "ref2_server_name": "ref2_server_name", + "server_snmp_retry": "server_snmp_retry", + "ref1_server_name": "ref1_server_name", + "server_snmp_id": "server_snmp_id", + "smart_members_name": "smart_members_name", + "server_type": "server_type" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_server_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_alias6_data": { + "example": { + "data": [ + { + "address6_id": "address6_id", + "device_id": "device_id", + "alias_name": "alias_name", + "pool6_id": "pool6_id", + "interface_id": "interface_id", + "address6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "address6_name": "address6_name", + "space_name": "space_name", + "network6_id": "network6_id", + "space_class_name": "space_class_name", + "alias6_type": "alias6_type", + "port_id": "port_id", + "address6_addr": "address6_addr", + "alias6_id": "alias6_id", + "address6_mac_addr": "address6_mac_addr", + "space_id": "space_id", + "address6_class_name": "address6_class_name" + }, + { + "address6_id": "address6_id", + "device_id": "device_id", + "alias_name": "alias_name", + "pool6_id": "pool6_id", + "interface_id": "interface_id", + "address6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "address6_name": "address6_name", + "space_name": "space_name", + "network6_id": "network6_id", + "space_class_name": "space_class_name", + "alias6_type": "alias6_type", + "port_id": "port_id", + "address6_addr": "address6_addr", + "alias6_id": "alias6_id", + "address6_mac_addr": "address6_mac_addr", + "space_id": "space_id", + "address6_class_name": "address6_class_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_alias6_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_static_edit_success": { + "example": { + "data": [ + { + "static_id": "static_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_static_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dns_zone_data": { + "example": { + "data": [ + { + "server_ipm_protocol": "server_ipm_protocol", + "zone_space_id": "zone_space_id", + "zone_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_ipm_type": "server_ipm_type", + "server_gss_keytab_id": "server_gss_keytab_id", + "server_version": "server_version", + "smart_parent_name": "smart_parent_name", + "zone_response_policy": "zone_response_policy", + "zone_rpz_log": "zone_rpz_log", + "zone_space_name": "zone_space_name", + "zone_type": "zone_type", + "zone_allow_update": "zone_allow_update", + "zone_rev_sort_zone": "zone_rev_sort_zone", + "zone_ad_integrated": "zone_ad_integrated", + "zone_forward": "zone_forward", + "view_class_name": "view_class_name", + "zone_allow_transfer": "zone_allow_transfer", + "zone_also_notify": "zone_also_notify", + "zone_synching": "zone_synching", + "zone_rpz_recursive_only": "zone_rpz_recursive_only", + "zone_use_update_policy": "zone_use_update_policy", + "server_id": "server_id", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "server_vpc_list": "server_vpc_list", + "zone_xfer_done": "zone_xfer_done", + "zone_masters": "zone_masters", + "zone_is_reverse": "zone_is_reverse", + "zone_notify": "zone_notify", + "server_aws_delegation_set": "server_aws_delegation_set", + "view_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_name": "server_name", + "zone_num_keys": "zone_num_keys", + "server_gss_enabled": "server_gss_enabled", + "zone_sort_zone": "zone_sort_zone", + "zone_forwarders": "zone_forwarders", + "server_class_name": "server_class_name", + "zone_class_name": "zone_class_name", + "zone_name": "zone_name", + "zone_order": "zone_order", + "zone_delayed_create_time": "zone_delayed_create_time", + "zone_id": "zone_id", + "smart_parent_id": "smart_parent_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "zone_ds": "zone_ds", + "server_state": "server_state", + "server_cloud": "server_cloud", + "view_name": "view_name", + "server_comment": "server_comment", + "view_id": "view_id", + "zone_delayed_delete_time": "zone_delayed_delete_time", + "zone_is_rpz": "zone_is_rpz", + "server_force_hybrid": "server_force_hybrid", + "zone_rpz_max_policy_ttl": "zone_rpz_max_policy_ttl", + "server_ddns_scavenging": "server_ddns_scavenging", + "zone_name_utf": "zone_name_utf", + "zone_allow_query": "zone_allow_query", + "zone_multistatus": "zone_multistatus", + "server_type": "server_type" + }, + { + "server_ipm_protocol": "server_ipm_protocol", + "zone_space_id": "zone_space_id", + "zone_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_ipm_type": "server_ipm_type", + "server_gss_keytab_id": "server_gss_keytab_id", + "server_version": "server_version", + "smart_parent_name": "smart_parent_name", + "zone_response_policy": "zone_response_policy", + "zone_rpz_log": "zone_rpz_log", + "zone_space_name": "zone_space_name", + "zone_type": "zone_type", + "zone_allow_update": "zone_allow_update", + "zone_rev_sort_zone": "zone_rev_sort_zone", + "zone_ad_integrated": "zone_ad_integrated", + "zone_forward": "zone_forward", + "view_class_name": "view_class_name", + "zone_allow_transfer": "zone_allow_transfer", + "zone_also_notify": "zone_also_notify", + "zone_synching": "zone_synching", + "zone_rpz_recursive_only": "zone_rpz_recursive_only", + "zone_use_update_policy": "zone_use_update_policy", + "server_id": "server_id", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "server_vpc_list": "server_vpc_list", + "zone_xfer_done": "zone_xfer_done", + "zone_masters": "zone_masters", + "zone_is_reverse": "zone_is_reverse", + "zone_notify": "zone_notify", + "server_aws_delegation_set": "server_aws_delegation_set", + "view_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_name": "server_name", + "zone_num_keys": "zone_num_keys", + "server_gss_enabled": "server_gss_enabled", + "zone_sort_zone": "zone_sort_zone", + "zone_forwarders": "zone_forwarders", + "server_class_name": "server_class_name", + "zone_class_name": "zone_class_name", + "zone_name": "zone_name", + "zone_order": "zone_order", + "zone_delayed_create_time": "zone_delayed_create_time", + "zone_id": "zone_id", + "smart_parent_id": "smart_parent_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "zone_ds": "zone_ds", + "server_state": "server_state", + "server_cloud": "server_cloud", + "view_name": "view_name", + "server_comment": "server_comment", + "view_id": "view_id", + "zone_delayed_delete_time": "zone_delayed_delete_time", + "zone_is_rpz": "zone_is_rpz", + "server_force_hybrid": "server_force_hybrid", + "zone_rpz_max_policy_ttl": "zone_rpz_max_policy_ttl", + "server_ddns_scavenging": "server_ddns_scavenging", + "zone_name_utf": "zone_name_utf", + "zone_allow_query": "zone_allow_query", + "zone_multistatus": "zone_multistatus", + "server_type": "server_type" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_zone_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_network6_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_network6_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_range6_edit_success": { + "example": { + "data": [ + { + "range6_id": "range6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_range6_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dns_viewparam_add_success": { + "example": { + "viewparam_id": "viewparam_id" + }, + "properties": { + "viewparam_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_dns_viewparam_add_success", + "type": "object" + }, + "_data_inner_dhcp_sharednetwork_data": { + "example": { + "server_name": "server_name", + "smart_parent_id": "smart_parent_id", + "sharednetwork_multistatus": "sharednetwork_multistatus", + "sharednetwork_id": "sharednetwork_id", + "sharednetwork_name": "sharednetwork_name", + "server_id": "server_id", + "sharednetwork_delayed_create_time": "sharednetwork_delayed_create_time", + "sharednetwork_delayed_delete_time": "sharednetwork_delayed_delete_time", + "server_type": "server_type" + }, + "properties": { + "sharednetwork_delayed_create_time": { + "description": "The delay of creation status. 1 indicates that the object is not created yet.", + "type": "string" + }, + "sharednetwork_delayed_delete_time": { + "description": "The delay of deletion status. 1 indicates that the object is not deleted yet.", + "type": "string" + }, + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_name": { + "description": "The name of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_type": { + "description": "The type of the DHCPv4 server the object belongs to:


                                                                                                                                                                                                                                              server_type possible values
                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                              ipmEfficientIP or EfficientIP Package server
                                                                                                                                                                                                                                              msrpcMicrosoft Windows DHCP server
                                                                                                                                                                                                                                              vdhcpEfficientIP DHCPv4 smart architecture


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "sharednetwork_id": { + "description": "The database identifier (ID) of the DHCPv4 shared network.", + "type": "string" + }, + "sharednetwork_name": { + "description": "The name of the DHCPv4 shared network.", + "type": "string" + }, + "sharednetwork_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                                                                                                                              Multi-status severity levels
                                                                                                                                                                                                                                              Message number Severity Description
                                                                                                                                                                                                                                              0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                                                                                                                              17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                                                                                                                              34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                                                                                                                              51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                                                                                                                              67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                                                                                                                              84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_sharednetwork_data", + "type": "object" + }, + "vlan_domain_data": { + "example": { + "data": [ + { + "domain_id": "domain_id", + "domain_name": "domain_name", + "domain_end_vlan_id": "domain_end_vlan_id", + "domain_start_vlan_id": "domain_start_vlan_id", + "domain_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "domain_description": "domain_description", + "domain_support_vxlan": "domain_support_vxlan", + "domain_class_name": "domain_class_name" + }, + { + "domain_id": "domain_id", + "domain_name": "domain_name", + "domain_end_vlan_id": "domain_end_vlan_id", + "domain_start_vlan_id": "domain_start_vlan_id", + "domain_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "domain_description": "domain_description", + "domain_support_vxlan": "domain_support_vxlan", + "domain_class_name": "domain_class_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_vlan_domain_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_address6_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_address6_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dns_acl_edit_success": { + "example": { + "acl_id": "acl_id" + }, + "properties": { + "acl_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_dns_acl_edit_success", + "type": "object" + }, + "ipam_address_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_address_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_pool_delete_success": { + "example": { + "data": [ + { + "pool_id": "pool_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_pool_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "vlan_vlan_edit_input": { + "properties": { + "domain_id": { + "description": "The database identifier (ID) of the VLAN domain, a unique numeric key value automatically incremented when you add a VLAN domain. Use the ID to specify the VLAN domain of your choice.", + "type": "integer" + }, + "domain_name": { + "description": "The name of the VLAN domain.", + "type": "string" + }, + "vlan_id": { + "description": "The database identifier (ID) of the VLAN, a unique numeric key value automatically incremented when you add a VLAN. Use the ID to specify the VLAN of your choice.", + "type": "integer" + }, + "vlan_vlan_id": { + "description": "The VLAN identifier (ID) of the VLAN, a unique numeric key value within a VLAN domain. Use the ID to specify the VLAN of your choice.", + "type": "integer" + }, + "range_id": { + "description": "The database identifier (ID) of the VLAN range, a unique numeric key value automatically incremented when you add a VLAN range. Use the ID to specify the VLAN range of your choice.", + "type": "integer" + }, + "range_name": { + "description": "The name of the VLAN range.", + "type": "string" + }, + "vlan_name": { + "description": "The name of the VLAN, each VLAN must have a unique name.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "vlan_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "vlan_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dns_viewparam_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_viewparam_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_network_edit_success": { + "example": { + "data": [ + { + "network_id": "network_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_network_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_static6_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_static6_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_address6_data": { + "example": { + "data": [ + { + "parent_network6_class_name": "parent_network6_class_name", + "pool6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "address6_operation_details_added_on": "address6_operation_details_added_on", + "address6_multistatus": "address6_multistatus", + "address6_operation_details_added_by": "address6_operation_details_added_by", + "parent_network6_prefix": "parent_network6_prefix", + "space_class_name": "space_class_name", + "space_description": "space_description", + "address6_alias": "address6_alias", + "free_start_address6_addr": "free_start_address6_addr", + "address6_operation_details_call_stack": "address6_operation_details_call_stack", + "parent_network6_end_hostaddr": "parent_network6_end_hostaddr", + "network6_start_address6_addr": "network6_start_address6_addr", + "pool6_size": "pool6_size", + "parent_vlsm_network6_id": "parent_vlsm_network6_id", + "device_id": "device_id", + "network_size": "network_size", + "network6_is_terminal": "network6_is_terminal", + "vlsm_network6_id": "vlsm_network6_id", + "address6_type": "address6_type", + "pool6_id": "pool6_id", + "pool6_name": "pool6_name", + "space_name": "space_name", + "network6_id": "network6_id", + "network6_start_hostaddr": "network6_start_hostaddr", + "address6_operation_details_requested_by": "address6_operation_details_requested_by", + "pool6_end_address6_addr": "pool6_end_address6_addr", + "interface_name": "interface_name", + "network6_end_hostaddr": "network6_end_hostaddr", + "parent_network6_id": "parent_network6_id", + "network6_name": "network6_name", + "free_scope_size": "free_scope_size", + "free_end_address6_addr": "free_end_address6_addr", + "device_name": "device_name", + "address6_name": "address6_name", + "parent_network6_start_address6_addr": "parent_network6_start_address6_addr", + "parent_network6_start_hostaddr": "parent_network6_start_hostaddr", + "pool6_read_only": "pool6_read_only", + "pool6_class_name": "pool6_class_name", + "network6_end_address6_addr": "network6_end_address6_addr", + "address6_mac_addr": "address6_mac_addr", + "parent_space_name": "parent_space_name", + "network6_prefix": "network6_prefix", + "address6_id": "address6_id", + "network6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "parent_network6_size": "parent_network6_size", + "parent_network6_name": "parent_network6_name", + "parent_network6_end_address6_addr": "parent_network6_end_address6_addr", + "network6_lock_network_broadcast": "network6_lock_network_broadcast", + "address6_operation_details_last_updated_on": "address6_operation_details_last_updated_on", + "network6_size": "network6_size", + "interface_id": "interface_id", + "address6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "network6_class_name": "network6_class_name", + "address6_operation_details_origin_module": "address6_operation_details_origin_module", + "address6_addr": "address6_addr", + "address6_hostaddr": "address6_hostaddr", + "space_id": "space_id", + "address6_class_name": "address6_class_name", + "pool6_start_address6_addr": "pool6_start_address6_addr" + }, + { + "parent_network6_class_name": "parent_network6_class_name", + "pool6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "address6_operation_details_added_on": "address6_operation_details_added_on", + "address6_multistatus": "address6_multistatus", + "address6_operation_details_added_by": "address6_operation_details_added_by", + "parent_network6_prefix": "parent_network6_prefix", + "space_class_name": "space_class_name", + "space_description": "space_description", + "address6_alias": "address6_alias", + "free_start_address6_addr": "free_start_address6_addr", + "address6_operation_details_call_stack": "address6_operation_details_call_stack", + "parent_network6_end_hostaddr": "parent_network6_end_hostaddr", + "network6_start_address6_addr": "network6_start_address6_addr", + "pool6_size": "pool6_size", + "parent_vlsm_network6_id": "parent_vlsm_network6_id", + "device_id": "device_id", + "network_size": "network_size", + "network6_is_terminal": "network6_is_terminal", + "vlsm_network6_id": "vlsm_network6_id", + "address6_type": "address6_type", + "pool6_id": "pool6_id", + "pool6_name": "pool6_name", + "space_name": "space_name", + "network6_id": "network6_id", + "network6_start_hostaddr": "network6_start_hostaddr", + "address6_operation_details_requested_by": "address6_operation_details_requested_by", + "pool6_end_address6_addr": "pool6_end_address6_addr", + "interface_name": "interface_name", + "network6_end_hostaddr": "network6_end_hostaddr", + "parent_network6_id": "parent_network6_id", + "network6_name": "network6_name", + "free_scope_size": "free_scope_size", + "free_end_address6_addr": "free_end_address6_addr", + "device_name": "device_name", + "address6_name": "address6_name", + "parent_network6_start_address6_addr": "parent_network6_start_address6_addr", + "parent_network6_start_hostaddr": "parent_network6_start_hostaddr", + "pool6_read_only": "pool6_read_only", + "pool6_class_name": "pool6_class_name", + "network6_end_address6_addr": "network6_end_address6_addr", + "address6_mac_addr": "address6_mac_addr", + "parent_space_name": "parent_space_name", + "network6_prefix": "network6_prefix", + "address6_id": "address6_id", + "network6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "parent_network6_size": "parent_network6_size", + "parent_network6_name": "parent_network6_name", + "parent_network6_end_address6_addr": "parent_network6_end_address6_addr", + "network6_lock_network_broadcast": "network6_lock_network_broadcast", + "address6_operation_details_last_updated_on": "address6_operation_details_last_updated_on", + "network6_size": "network6_size", + "interface_id": "interface_id", + "address6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "network6_class_name": "network6_class_name", + "address6_operation_details_origin_module": "address6_operation_details_origin_module", + "address6_addr": "address6_addr", + "address6_hostaddr": "address6_hostaddr", + "space_id": "space_id", + "address6_class_name": "address6_class_name", + "pool6_start_address6_addr": "pool6_start_address6_addr" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_address6_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_static6_add_input": { + "properties": { + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "type": "integer" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "static6_client_duid": { + "description": "The client DHCP Unique Identifier (DUID) associated with the DHCPv6 static.", + "type": "string" + }, + "static6_mac_addr": { + "description": "The MAC address you want to associate with the IPv6 static.", + "type": "string" + }, + "static6_name": { + "description": "The name of the DHCPv6 static, each DHCPv6 static must have a unique name.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "group6_id": { + "description": "The database identifier (ID) of the DHCPv6 group, a unique numeric key value automatically incremented when you add a DHCPv6 group. Use the ID to specify the DHCPv6 group of your choice.", + "type": "integer" + }, + "group6_name": { + "description": "The name of the DHCPv6 group.", + "type": "string" + }, + "static6_addr": { + "description": "The IP address associated with the DHCPv6 static.", + "type": "string" + }, + "static6_prefix6": { + "description": "The IP address of the delegated prefix of the DHCPv6 static.", + "type": "string" + }, + "static6_prefix6_addr": { + "description": "The prefix of the delegated prefix of the DHCPv6 static.", + "type": "string" + }, + "static6_prefix6_prefix": { + "description": "The IP address and prefix of the delegated prefix of the DHCPv6 static. You must specify them as follows: <IPv6-address>/<prefix>.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "static6_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "static6_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_data_inner_dns_rr_add_success": { + "example": { + "rr_id": "rr_id" + }, + "properties": { + "rr_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_dns_rr_add_success", + "type": "object" + }, + "dhcp_static_delete_success": { + "example": { + "data": [ + { + "static_id": "static_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_static_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "vlan_vlan_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_vlan_vlan_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "vlan_domain_edit_success": { + "example": { + "data": [ + { + "domain_id": "domain_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_vlan_domain_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_vlan_vlan_add_success": { + "example": { + "vlan_id": "vlan_id" + }, + "properties": { + "vlan_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_vlan_vlan_add_success", + "type": "object" + }, + "_data_inner_dhcp_sharednetwork_edit_success": { + "example": { + "sharednetwork_id": "sharednetwork_id" + }, + "properties": { + "sharednetwork_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_sharednetwork_edit_success", + "type": "object" + }, + "ipam_alias6_add_success": { + "example": { + "data": [ + { + "alias6_id": "alias6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_alias6_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_range_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_range_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_network_delete_success": { + "example": { + "data": [ + { + "network_id": "network_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_network_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_ipam_pool6_add_success": { + "example": { + "pool6_id": "pool6_id" + }, + "properties": { + "pool6_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_ipam_pool6_add_success", + "type": "object" + }, + "dhcp_range6_data": { + "example": { + "data": [ + { + "server6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_size": "scope6_size", + "server6_version": "server6_version", + "range6_state": "range6_state", + "scope6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range6_failover_name": "range6_failover_name", + "server6_name": "server6_name", + "range6_end_address6_addr": "range6_end_address6_addr", + "scope6_prefix": "scope6_prefix", + "server6_comment": "server6_comment", + "smart_parent_id": "smart_parent_id", + "smart_parent_name": "smart_parent_name", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "server6_type": "server6_type", + "range6_delayed_time": "range6_delayed_time", + "range6_acl": "range6_acl", + "range6_id": "range6_id", + "range6_name": "range6_name", + "range6_start_address6_addr": "range6_start_address6_addr", + "server6_addr6": "server6_addr6", + "sharednetwork6_name": "sharednetwork6_name", + "range6_multistatus": "range6_multistatus", + "server6_hostaddr": "server6_hostaddr", + "scope6_end_address6_addr": "scope6_end_address6_addr", + "server6_addr": "server6_addr", + "range6_size": "range6_size", + "scope6_class_name": "scope6_class_name", + "scope6_name": "scope6_name", + "scope6_space_id": "scope6_space_id", + "range6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_id": "scope6_id", + "range6_lease_count": "range6_lease_count", + "sharednetwork6_id": "sharednetwork6_id", + "scope6_start_address6_addr": "scope6_start_address6_addr", + "range6_class_name": "range6_class_name" + }, + { + "server6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_size": "scope6_size", + "server6_version": "server6_version", + "range6_state": "range6_state", + "scope6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "range6_failover_name": "range6_failover_name", + "server6_name": "server6_name", + "range6_end_address6_addr": "range6_end_address6_addr", + "scope6_prefix": "scope6_prefix", + "server6_comment": "server6_comment", + "smart_parent_id": "smart_parent_id", + "smart_parent_name": "smart_parent_name", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "server6_type": "server6_type", + "range6_delayed_time": "range6_delayed_time", + "range6_acl": "range6_acl", + "range6_id": "range6_id", + "range6_name": "range6_name", + "range6_start_address6_addr": "range6_start_address6_addr", + "server6_addr6": "server6_addr6", + "sharednetwork6_name": "sharednetwork6_name", + "range6_multistatus": "range6_multistatus", + "server6_hostaddr": "server6_hostaddr", + "scope6_end_address6_addr": "scope6_end_address6_addr", + "server6_addr": "server6_addr", + "range6_size": "range6_size", + "scope6_class_name": "scope6_class_name", + "scope6_name": "scope6_name", + "scope6_space_id": "scope6_space_id", + "range6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_id": "scope6_id", + "range6_lease_count": "range6_lease_count", + "sharednetwork6_id": "sharednetwork6_id", + "scope6_start_address6_addr": "scope6_start_address6_addr", + "range6_class_name": "range6_class_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_range6_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_scope_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_scope_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_pool6_add_success": { + "example": { + "data": [ + { + "pool6_id": "pool6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_pool6_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_sharednetwork6_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_sharednetwork6_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_network6_delete_success": { + "example": { + "data": [ + { + "network6_id": "network6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_network6_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dns_view_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_view_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dhcp_group_edit_success": { + "example": { + "group_id": "group_id" + }, + "properties": { + "group_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_group_edit_success", + "type": "object" + }, + "dhcp_group_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_group_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_static_add_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "static_addr": { + "description": "The IP address associated with the DHCPv4 static.", + "type": "string" + }, + "static_identifier": { + "description": "The host identifier you want to associate with the IPv4 static. An option and value to look for to identify clients and assign them the static, specified as follows: option <option-name> expected value.", + "type": "string" + }, + "static_mac_addr": { + "description": "The MAC address you want to associate with the IPv4 static, it must include the MAC address type. The address has 7 sections, 00:11:22:33:44:55:66 , where 00 indicates the type. For Ethernet, type in 01.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "group_id": { + "description": "The database identifier (ID) of the DHCPv4 group, a unique numeric key value automatically incremented when you add a DHCPv4 group. Use the ID to specify the DHCPv4 group of your choice.", + "type": "integer" + }, + "group_name": { + "description": "The name of the DHCPv4 group.", + "type": "string" + }, + "static_name": { + "description": "The name of the DHCPv4 static, each DHCPv4 static must have a unique name.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "static_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "static_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_data_inner_ipam_pool_data": { + "example": { + "pool_start_hostaddr": "pool_start_hostaddr", + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "pool_operation_details_added_on": "pool_operation_details_added_on", + "pool_operation_details_call_stack": "pool_operation_details_call_stack", + "pool_start_address_addr": "pool_start_address_addr", + "vlsm_network_id": "vlsm_network_id", + "parent_network_name": "parent_network_name", + "pool_class_name": "pool_class_name", + "space_class_name": "space_class_name", + "parent_network_size": "parent_network_size", + "space_description": "space_description", + "pool_end_ip_addr": "pool_end_ip_addr", + "pool_end_address_addr": "pool_end_address_addr", + "pool_operation_details_added_by": "pool_operation_details_added_by", + "pool_start_ip_addr": "pool_start_ip_addr", + "pool_operation_details_last_updated_on": "pool_operation_details_last_updated_on", + "network_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "network_size": "network_size", + "pool_size": "pool_size", + "space_is_template": "space_is_template", + "network_name": "network_name", + "pool_operation_details_requested_by": "pool_operation_details_requested_by", + "pool_read_only": "pool_read_only", + "pool_id": "pool_id", + "pool_multistatus": "pool_multistatus", + "parent_network_class_name": "parent_network_class_name", + "pool_name": "pool_name", + "pool_operation_details_origin_module": "pool_operation_details_origin_module", + "pool_end_hostaddr": "pool_end_hostaddr", + "network_id": "network_id", + "space_name": "space_name", + "parent_network_id": "parent_network_id", + "network_start_address_addr": "network_start_address_addr", + "pool_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "vlsm_block_id": "vlsm_block_id", + "space_id": "space_id", + "network_end_address_addr": "network_end_address_addr", + "network_class_name": "network_class_name" + }, + "properties": { + "pool_end_hostaddr": { + "description": "The human readable version of the parameter pool_end_ip_addr.", + "type": "string" + }, + "pool_end_ip_addr": { + "description": "The last IP address of the IPv4 pool, in hexadecimal format.", + "type": "string" + }, + "pool_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                                                                                                                              Multi-status severity levels
                                                                                                                                                                                                                                              Message number Severity Description
                                                                                                                                                                                                                                              0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                                                                                                                              17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                                                                                                                              34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                                                                                                                              51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                                                                                                                              67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                                                                                                                              84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "parent_network_class_name": { + "description": "The name of the class applied to the parent of the IPv4 network the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "parent_network_id": { + "description": "The database identifier (ID) of the parent IPv4 network. It identifies the parent of the IPv4 network the object belongs to. 0 indicates that the network the object belongs to has no parent network.", + "type": "string" + }, + "parent_network_name": { + "description": "The name of the parent IPv4 network:
                                                                                                                                                                                                                                              • # indicates that the network the object belongs to has no parent network.
                                                                                                                                                                                                                                              • Default indicates that the network the object belongs to is in an orphan network.
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "parent_network_size": { + "description": "The number of IP addresses of the parent of the network the object belongs to.", + "type": "string" + }, + "pool_class_name": { + "description": "The name of the class applied to the IPv4 pool, it can be preceded by the class directory.", + "type": "string" + }, + "pool_class_parameters": { + "description": "The class parameters applied to the IPv4 pool.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "pool_end_address_addr": { + "description": "The last IP address of the IPv4 pool, in hexadecimal format.", + "type": "string" + }, + "pool_id": { + "description": "The database identifier (ID) of the IPv4 pool.", + "type": "string" + }, + "pool_name": { + "description": "The name of the IPv4 pool.", + "type": "string" + }, + "pool_read_only": { + "description": "The reservation status of the IPv4 pool. If set 1, the IP addresses it contains cannot be assigned.", + "type": "string" + }, + "pool_size": { + "description": "The number of IP addresses the IPv4 pool contains.", + "type": "string" + }, + "pool_start_address_addr": { + "description": "The first IP address of the IPv4 pool, in hexadecimal format.", + "type": "string" + }, + "space_class_name": { + "description": "The name of the class applied to the space the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "space_class_parameters": { + "description": "The class parameters applied to the space the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "space_description": { + "description": "The description of the space the object belongs to.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space the object belongs to, a unique numeric key value automatically incremented when you add a space.", + "type": "string" + }, + "space_is_template": { + "description": "The template status of the space the object belongs to. If the space is used as template (1), all the IPv4 networks, pools and IP addresses it contains are also used as template.", + "type": "string" + }, + "space_name": { + "description": "The name of the space the object belongs to.", + "type": "string" + }, + "pool_start_hostaddr": { + "description": "The human readable version of the parameter pool_start_ip_addr.", + "type": "string" + }, + "pool_start_ip_addr": { + "description": "The first IP address of the IPv4 pool, in hexadecimal format.", + "type": "string" + }, + "network_class_name": { + "description": "The name of the class applied to the IPv4 network the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "network_class_parameters": { + "description": "The class parameters applied to the IPv4 network the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "network_end_address_addr": { + "description": "The last IP address of the IPv4 network the object belongs to.", + "type": "string" + }, + "network_id": { + "description": "The database identifier (ID) of the IPv4 network the object belongs to.", + "type": "string" + }, + "network_name": { + "description": "The name of the IPv4 network the object belongs to. Default indicates that the network the object belongs to is an orphan network.", + "type": "string" + }, + "network_size": { + "description": "The number of IP addresses the network the object belongs to contains.", + "type": "string" + }, + "network_start_address_addr": { + "description": "The first IP address of the IPv4 network the object belongs to.", + "type": "string" + }, + "pool_operation_details_added_on": { + "description": "The creation date of the IPv4 pool, in decimal UNIX date format.", + "type": "string" + }, + "pool_operation_details_call_stack": { + "description": "The call stack of the IPv4 pool operation details, as follows: <service1>&<service2>&<service3>... .", + "type": "string" + }, + "pool_operation_details_origin_module": { + "description": "The name of the module where the IPv4 pool addition originated.", + "type": "string" + }, + "pool_operation_details_requested_by": { + "description": "The login of the user who requested the IPv4 pool.", + "type": "string" + }, + "pool_operation_details_added_by": { + "description": "The login of the user who added the IPv4 pool.", + "type": "string" + }, + "pool_operation_details_last_updated_on": { + "description": "The last time the IPv4 pool was updated, in decimal UNIX date format.", + "type": "string" + }, + "vlsm_block_id": { + "description": "The database identifier (ID) of the IPv4 VLSM block-type network duplicated, in a VLSM child space, from the network the pool belongs to. 0 indicates that the parent of the network the pool belongs to is not duplicated as a VLSM block-type network in a child space.", + "type": "string" + }, + "vlsm_network_id": { + "description": "The database identifier (ID) of the IPv4 subnet-type network, located in the VLSM parent space, from which the parent of the network the pool belongs to was duplicated. 0 indicates that the parent of the network the pool belongs to is not a VLSM block-type network duplicated from a parent space.", + "type": "string" + } + }, + "title": "_data_inner_ipam_pool_data", + "type": "object" + }, + "_data_inner_ipam_alias_data": { + "example": { + "device_id": "device_id", + "address_addr": "address_addr", + "address_type": "address_type", + "static_id": "static_id", + "alias_id": "alias_id", + "address_id": "address_id", + "address_name": "address_name", + "alias_name": "alias_name", + "address_mac_addr": "address_mac_addr", + "pool_id": "pool_id", + "alias_type": "alias_type", + "network_id": "network_id", + "interface_id": "interface_id", + "address_class_name": "address_class_name", + "address_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_name": "space_name", + "space_class_name": "space_class_name", + "port_id": "port_id", + "space_id": "space_id", + "lease_id": "lease_id" + }, + "properties": { + "alias_name": { + "description": "The name of the alias.", + "type": "string" + }, + "static_id": { + "description": "The database identifier (ID) of the DHCP static associated with the IP address.", + "type": "string" + }, + "lease_id": { + "description": "The database identifier (ID) of the DHCP lease associated with the IP address.", + "type": "string" + }, + "device_id": { + "description": "The database identifier (ID) of the Device Manager device associated with the IP address.", + "type": "string" + }, + "interface_id": { + "description": "The database identifier (ID) of the Device Manager interface associated with the IP address.", + "type": "string" + }, + "address_addr": { + "description": "The IPv4 alias itself, in hexadecimal format.", + "type": "string" + }, + "address_class_name": { + "description": "The name of the class applied to the object, it can be preceded by the class directory.", + "type": "string" + }, + "address_class_parameters": { + "description": "The class parameters applied to the IPv4 alias.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "address_id": { + "description": "The database identifier (ID) of the IPv4 address associated with the alias.", + "type": "string" + }, + "alias_id": { + "description": "The database identifier (ID) of the IPv4 alias.", + "type": "string" + }, + "alias_type": { + "description": "The type of the alias, either CNAME or A.", + "type": "string" + }, + "address_type": { + "description": "A way to determine if you can assign the IP alias (free) or if it is In use (ip).", + "type": "string" + }, + "port_id": { + "description": "The database identifier (ID) of the NetChange port associated with the IP address.", + "type": "string" + }, + "address_mac_addr": { + "description": "The MAC address associated with the IPv4 alias.", + "type": "string" + }, + "address_name": { + "description": "The name of the IPv4 alias.", + "type": "string" + }, + "pool_id": { + "description": "The database identifier (ID) of the IPv4 pool the object belongs to.", + "type": "string" + }, + "space_class_name": { + "description": "The name of the class applied to the space the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space the object belongs to, a unique numeric key value automatically incremented when you add a space.", + "type": "string" + }, + "space_name": { + "description": "The name of the space the object belongs to.", + "type": "string" + }, + "network_id": { + "description": "The database identifier (ID) of the IPv4 network the object belongs to.", + "type": "string" + } + }, + "title": "_data_inner_ipam_alias_data", + "type": "object" + }, + "dns_acl_edit_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "acl_id": { + "description": "The database identifier (ID) of the DNS ACL, a unique numeric key value automatically incremented when you add a DNS ACL. Use the ID to specify the DNS ACL of your choice.", + "type": "integer" + }, + "acl_name": { + "description": "The name of the DNS ACL, each DNS ACL must have a unique name.", + "type": "string" + }, + "acl_value": { + "description": "The values of the DNS ACL in order of priority, as follows: <value_1>;<value_2>... .", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DNS server.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dns_zone_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dns_zone_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_ipam_address6_edit_success": { + "example": { + "address6_id": "address6_id" + }, + "properties": { + "address6_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_ipam_address6_edit_success", + "type": "object" + }, + "dns_rr_add_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DNS server.", + "type": "string" + }, + "rr_name": { + "description": "The full name of the DNS resource record. Specify it as value, it can either follow the format <rr-name>.<existing-zone-name>.<extension> or be . (a dot).", + "type": "string" + }, + "rr_type": { + "description": "The type of the DNS resource record.


                                                                                                                                                                                                                                              rr_type possible values
                                                                                                                                                                                                                                              ValueRecord type description
                                                                                                                                                                                                                                              SOAStart of Authority. Defines the zone name, an email contact and various time and refresh values applicable to the zone. It is automatically generated upon creation of a zone and cannot be added manually.
                                                                                                                                                                                                                                              NSName Server. Defines the authoritative name server(s) for the domain (defined by the SOA record) or the subdomain. The NS record that indicates which server has authority over a zone is automatically generated upon the creation of a zone, once the server has been synchronized.
                                                                                                                                                                                                                                              AIPv4 Address. An IPv4 address for a host.
                                                                                                                                                                                                                                              PTRPointer Record. Address Resolution, from an IP address (IPv4 or IPv6) to a host. Used in reverse mapping.
                                                                                                                                                                                                                                              AAAAIPv6 Address. An IPv6 address for a host.
                                                                                                                                                                                                                                              CNAMECanonical Name. An alias name for a host.
                                                                                                                                                                                                                                              MXMail Exchange. The mail server/exchanger that services this zone.
                                                                                                                                                                                                                                              SRVServices record. Defines services available in the zone, for example, LDAP, HTTP, etc...
                                                                                                                                                                                                                                              DNAMEDelegation of Reverse Names. Delegation of reverse addresses primarily in IPv6. (Deprecated, use the CNAME RR instead)
                                                                                                                                                                                                                                              TXTText. Information associated with a name.
                                                                                                                                                                                                                                              DSDelegation Signer, a DNSSEC related RR used to verify the validity of the ZSK of a subdomain.
                                                                                                                                                                                                                                              DNSKEYDNS Key. It contains the public cryptographic key used to sign the zone with DNSSEC.
                                                                                                                                                                                                                                              65534A private type record automatically added to the zone once it is signed with DNSSEC.
                                                                                                                                                                                                                                              HINFOSystem Information. Information about a host: hardware type and operating system description.
                                                                                                                                                                                                                                              MINFOMailbox mail list Information. Defines the mail administrator for a mail list and optionally a mailbox to receive error messages relating to the mail list.
                                                                                                                                                                                                                                              AFSDBAFS Database. Location of the AFS servers.
                                                                                                                                                                                                                                              WKSWell-Known Service. Defines the services and protocols supported by a host. (Deprecated, use the SRV RR instead)
                                                                                                                                                                                                                                              NAPTRNaming Authority Pointer Record. General purpose definition of rule set to be used by applications e.g. VoIP.
                                                                                                                                                                                                                                              NSAPNetwork Service Access Point. Defines record (equivalent of an A record) maps a host name to an endpoint address.


                                                                                                                                                                                                                                              Note that the parameter is not case sensitive, you could type in A or a.", + "enum": [ + "A", + "NS", + "MD", + "MF", + "CNAME", + "SOA", + "MB", + "MG", + "MR", + "NULL", + "WKS", + "PTR", + "HINFO", + "MINFO", + "MX", + "TXT", + "SPF", + "RP", + "AFSDB", + "X25", + "ISDN", + "RT", + "NSAP", + "NSAP_PTR", + "SIG", + "KEY", + "PX", + "GPOS", + "AAAA", + "LOC", + "NXT", + "EID", + "NIMLOC", + "SRV", + "ATMA", + "NAPTR", + "KX", + "CERT", + "A6", + "DNAME", + "OPT", + "DS", + "DNSSIG", + "NSEC", + "DNSKEY", + "NSEC3", + "NSEC3PARAM", + "CDS", + "CDNSKEY", + "CAA", + "TLSA", + "SSHFP", + "OPENPGPKEY", + "URI", + "AVC", + "NINFO", + "DLV", + "DHCID", + "EUI48", + "EUI64", + "NID", + "L32", + "L64", + "HTTPS", + "SVCB" + ], + "type": "string" + }, + "rr_value1": { + "description": "The first or only value required for the DNS resource record, as detailed in the service description.", + "type": "string" + }, + "check_value": { + "description": "A way to check the values of the DNS resource record before upon addition (1) in order to create a record with the same name but with different values.", + "enum": [ + "yes", + "no" + ], + "type": "string" + }, + "view_id": { + "description": "The database identifier (ID) of the DNS view, a unique numeric key value automatically incremented when you add a DNS view. Use the ID to specify the DNS view of your choice.", + "type": "integer" + }, + "view_name": { + "description": "The name of the DNS view.", + "type": "string" + }, + "zone_id": { + "description": "The database identifier (ID) of the DNS zone, a unique numeric key value automatically incremented when you add a DNS zone. Use the ID to specify the DNS zone of your choice.", + "type": "integer" + }, + "zone_name": { + "description": "The name of the DNS zone the object belongs to.", + "type": "string" + }, + "zone_space_id": { + "description": "The database identifier (ID) of the space associated with the DNS zone the record belongs to.", + "type": "integer" + }, + "rr_glue": { + "description": "The shortname of the DNS resource record.", + "type": "string" + }, + "rr_ttl": { + "description": "The time to live of the DNS resource record, in seconds.", + "type": "integer" + }, + "rr_value2": { + "description": "The second value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value3": { + "description": "The third value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value4": { + "description": "The fourth value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value5": { + "description": "The fifth value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value6": { + "description": "The sixth value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value7": { + "description": "The seventh value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "rr_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "rr_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dhcp_range_add_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "range_end_addr": { + "description": "The last IP address of the DHCPv4 range.", + "type": "string" + }, + "range_start_addr": { + "description": "The first IP address of the DHCPv4 range.", + "type": "string" + }, + "scope_id": { + "description": "The database identifier (ID) of the DHCPv4 scope, a unique numeric key value automatically incremented when you add a DHCPv4 scope. Use the ID to specify the DHCPv4 scope of your choice.", + "type": "integer" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "range_acl": { + "description": "The list of ACLs associated with the DHCPv4 range, as follows: <ACL_name>;<ACL_name>;... .", + "type": "string" + }, + "range_name": { + "description": "The start and end IP address of the DHCPv4 range, as follows: <start-ip>-<end-ip>.", + "type": "string" + }, + "scope_name": { + "description": "The name of the DHCPv4 scope.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "range_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "range_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_data_inner_dns_zone_data": { + "example": { + "server_ipm_protocol": "server_ipm_protocol", + "zone_space_id": "zone_space_id", + "zone_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_ipm_type": "server_ipm_type", + "server_gss_keytab_id": "server_gss_keytab_id", + "server_version": "server_version", + "smart_parent_name": "smart_parent_name", + "zone_response_policy": "zone_response_policy", + "zone_rpz_log": "zone_rpz_log", + "zone_space_name": "zone_space_name", + "zone_type": "zone_type", + "zone_allow_update": "zone_allow_update", + "zone_rev_sort_zone": "zone_rev_sort_zone", + "zone_ad_integrated": "zone_ad_integrated", + "zone_forward": "zone_forward", + "view_class_name": "view_class_name", + "zone_allow_transfer": "zone_allow_transfer", + "zone_also_notify": "zone_also_notify", + "zone_synching": "zone_synching", + "zone_rpz_recursive_only": "zone_rpz_recursive_only", + "zone_use_update_policy": "zone_use_update_policy", + "server_id": "server_id", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "server_vpc_list": "server_vpc_list", + "zone_xfer_done": "zone_xfer_done", + "zone_masters": "zone_masters", + "zone_is_reverse": "zone_is_reverse", + "zone_notify": "zone_notify", + "server_aws_delegation_set": "server_aws_delegation_set", + "view_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_name": "server_name", + "zone_num_keys": "zone_num_keys", + "server_gss_enabled": "server_gss_enabled", + "zone_sort_zone": "zone_sort_zone", + "zone_forwarders": "zone_forwarders", + "server_class_name": "server_class_name", + "zone_class_name": "zone_class_name", + "zone_name": "zone_name", + "zone_order": "zone_order", + "zone_delayed_create_time": "zone_delayed_create_time", + "zone_id": "zone_id", + "smart_parent_id": "smart_parent_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "zone_ds": "zone_ds", + "server_state": "server_state", + "server_cloud": "server_cloud", + "view_name": "view_name", + "server_comment": "server_comment", + "view_id": "view_id", + "zone_delayed_delete_time": "zone_delayed_delete_time", + "zone_is_rpz": "zone_is_rpz", + "server_force_hybrid": "server_force_hybrid", + "zone_rpz_max_policy_ttl": "zone_rpz_max_policy_ttl", + "server_ddns_scavenging": "server_ddns_scavenging", + "zone_name_utf": "zone_name_utf", + "zone_allow_query": "zone_allow_query", + "zone_multistatus": "zone_multistatus", + "server_type": "server_type" + }, + "properties": { + "server_aws_delegation_set": { + "description": "The reusable delegation set ID configured on the Amazon Route 53 public server the zone belongs to.", + "type": "string" + }, + "server_ddns_scavenging": { + "description": "The DDNS scavenging status of the zone, either enabled (1) or disabled (0). DDNS scavenging is only effective if the parameters zone_use_update_policy and server_gss_enabled are set to 1, and the rule 416 is enabled in the GUI.", + "type": "string" + }, + "zone_delayed_create_time": { + "description": "The delay of creation status. 1 indicates that the object is not created yet.", + "type": "string" + }, + "zone_delayed_delete_time": { + "description": "The delay of deletion status. 1 indicates that the object is not deleted yet.", + "type": "string" + }, + "server_class_name": { + "description": "The name of the class applied to the DNS server the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "server_class_parameters": { + "description": "The class parameters applied to the DNS server the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "server_cloud": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_comment": { + "description": "The description of the DNS server the object belongs to.", + "type": "string" + }, + "server_force_hybrid": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_id": { + "description": "The database identifier (ID) of the DNS server the object belongs to.", + "type": "string" + }, + "server_name": { + "description": "The name of the DNS server the object belongs to.", + "type": "string" + }, + "server_state": { + "description": "The status of the DNS server the object belongs to.


                                                                                                                                                                                                                                              server_state possible values
                                                                                                                                                                                                                                              StatusDescription
                                                                                                                                                                                                                                              ERThe license used in SOLIDserver is not compliant with the added server: the license is invalid.
                                                                                                                                                                                                                                              ESThe server configuration could not be parsed properly.
                                                                                                                                                                                                                                              ETThe server does not answer anymore due to a scheduled configuration of the server.
                                                                                                                                                                                                                                              ICThe SSL credentials are invalid
                                                                                                                                                                                                                                              IPThe provided account does not have sufficient privileges to remotely manage the MS server.
                                                                                                                                                                                                                                              IRSOLIDserver cannot resolve the AWS DNS service. The Amazon services are unreachable and the Amazon Route 53 server cannot be managed. Make sure that the DNS resolvers declared on the page are valid.
                                                                                                                                                                                                                                              ISThere was a setting error during the server declaration. For instance, some settings were added to a server that does not support them or a smart architecture is not managing any physical server.
                                                                                                                                                                                                                                              ITThe server editing performed from the GUI is not pushed to the server because SOLIDserver time and date are incorrect. You must use the UTC system on the appliance, especially when managing Amazon Route 53 servers.
                                                                                                                                                                                                                                              LSThe server configuration is not viable.
                                                                                                                                                                                                                                              NThe server does not have a status as it has not synchronized yet.
                                                                                                                                                                                                                                              UEAn error occurred that SOLIDserver could not identify.
                                                                                                                                                                                                                                              YThe server is operational.


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "server_type": { + "description": "The type of the DNS server the object belongs to.


                                                                                                                                                                                                                                              server_type possible values
                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                              ipmEfficientIP or EfficientIP Package server
                                                                                                                                                                                                                                              msdaemonMicrosoft Windows DNS server
                                                                                                                                                                                                                                              awsAmazon Route 53 server
                                                                                                                                                                                                                                              otherGeneric DNS server
                                                                                                                                                                                                                                              vdnsEfficientIP DNS smart architecture


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "server_version": { + "description": "The version details of the DNS server the object belongs to.", + "type": "string" + }, + "server_vpc_list": { + "description": "The list of cloud networks configured on the DNS private server the zone belongs to, separated by a comma:
                                                                                                                                                                                                                                              • For an Azure server, it returns the list of virtual networks.
                                                                                                                                                                                                                                              • For an Amazon Route 53 server, it returns the list of Virtual Private Cloud (VPC).
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "view_class_name": { + "description": "The name of the class applied to the DNS view the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "view_class_parameters": { + "description": "The class parameters applied to the DNS view the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "view_id": { + "description": "The database identifier (ID) of the DNS view the object belongs to.", + "type": "string" + }, + "view_name": { + "description": "The name of the DNS view the object belongs to.", + "type": "string" + }, + "zone_ad_integrated": { + "description": "The AD integrated status of the DNS zone. 1 indicates that the DNS zone belongs to an Active Directory integrated Microsoft Windows DNS server.", + "type": "string" + }, + "zone_allow_query": { + "description": "The ACL values associated with the allow-query configuration of the DNS zone, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "zone_allow_transfer": { + "description": "The ACL values associated with the allow-transfer configuration of the DNS zone, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "zone_allow_update": { + "description": "The ACL values associated with the allow-update configuration of the DNS zone, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "zone_also_notify": { + "description": "The IP address and port of the DNS server managing the smart architecture the DNS zone belongs to. If the parameter zone_notify is set to yes or explicit, the server specified is instantly notified of any slave zones updates.", + "type": "string" + }, + "zone_class_name": { + "description": "The name of the class applied to the DNS zone, it can be preceded by the class directory.", + "type": "string" + }, + "zone_class_parameters": { + "description": "The class parameters applied to the DNS zone.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "zone_forward": { + "description": "The forwarding mode of the DNS zone.


                                                                                                                                                                                                                                              zone_forward possible values
                                                                                                                                                                                                                                              StatusDescription
                                                                                                                                                                                                                                              firstThe zone sends the queries to the forwarder(s). If no answer is returned, it attempts to answer the queries on its own.
                                                                                                                                                                                                                                              onlyThe zone only forwards the queries to the forwarder(s). Required by some reverse forward zones (e.g., in the case of private addresses).


                                                                                                                                                                                                                                              If the parameter has no value, it indicates that the forwarding is disabled.", + "type": "string" + }, + "zone_forwarders": { + "description": "The IP address(es) of the forwarder(s) associated with the DNS zone. It lists the DNS servers to which any unknown query on this zone should be sent, as follows: <ip_address1>;<ip_address2>;... .", + "type": "string" + }, + "zone_id": { + "description": "The database identifier (ID) of the DNS zone.", + "type": "string" + }, + "zone_is_reverse": { + "description": "A way to determine if the DNS zone provides reverse resolution (1) or direct/name resolution (0),", + "type": "string" + }, + "zone_is_rpz": { + "description": "The RPZ status of the DNS zone. 1 indicates that the DNS zone is a Response Policy Zone.", + "type": "string" + }, + "zone_masters": { + "description": "For slave DNS zones, the IP address of the DNS server and, if relevant, the name of the DNS view that contain the master DNS zone, as follows: <ip_addr>; or <ip_addr> key <dnsview_name>; .", + "type": "string" + }, + "zone_name": { + "description": "The name of the DNS zone.", + "type": "string" + }, + "zone_name_utf": { + "description": "The name of the DNS zone in UTF-8 format.", + "type": "string" + }, + "zone_notify": { + "description": "The notify status of the DNS zone.


                                                                                                                                                                                                                                              zone_notify possible values
                                                                                                                                                                                                                                              StatusDescription
                                                                                                                                                                                                                                              noNo notify message is sent.
                                                                                                                                                                                                                                              yesA notify message is sent to the name servers defined in the NS records of the zone and to the IP address(es) specified in the parameter .
                                                                                                                                                                                                                                              explicitA notify message is sent only to the IP address(es) specified in the parameter .


                                                                                                                                                                                                                                              The notify message is not sent to the server itself or to the primary server defined in the SOA record of the zone.", + "type": "string" + }, + "zone_order": { + "description": "The level of the DNS zone, where 0 represents the highest level in the zones hierarchy. The RPZ rules parameters of each zone are reviewed following this order. The zones with the parameter zone_is_rpz set to 0 will always return 0 for the parameter zone_order.", + "type": "string" + }, + "zone_response_policy": { + "description": "The Overriding rule of the RPZ zone. DNS zones are set with the policy given.", + "type": "string" + }, + "zone_rev_sort_zone": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "zone_rpz_log": { + "description": "The logging status of an RPZ zone.", + "type": "string" + }, + "zone_rpz_max_policy_ttl": { + "description": "The configuration of the option Server max policy TTL, i.e. the number of seconds of the max policy Time To Live of the zone. It overrides the value set at server level. By default it is empty, i.e. set to 5 seconds.", + "type": "string" + }, + "zone_rpz_recursive_only": { + "description": "The configuration of the option Enable recursive-only on the server of the zone. It overrides the value set at server level. By default it is set to 1 (yes), the server only processes policies on recursive queries.", + "type": "string" + }, + "zone_space_id": { + "description": "The database identifier (ID) of the space associated with the DNS zone.", + "type": "string" + }, + "zone_space_name": { + "description": "The name of the space associated with the DNS zone.", + "type": "string" + }, + "zone_sort_zone": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "zone_synching": { + "description": "The synchronization status of the DNS zone. 1 indicates that the zone is currently being synchronized.", + "type": "string" + }, + "zone_type": { + "description": "The type of the DNS zone, either master, slave, forward, stub, hint or delegation-only.", + "type": "string" + }, + "zone_xfer_done": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "zone_ds": { + "description": "The DNSSEC delegation signer (DS) fingerprint key associated with the DNS zone, if it is signed.", + "type": "string" + }, + "server_gss_enabled": { + "description": "The GSS-TSIG status of the DNS server the zone belongs to. 1 indicates that GSS-TSIG is enabled on the server.", + "type": "string" + }, + "server_gss_keytab_id": { + "description": "The database identifier (ID) of the DNS GSS-TSIG keytab.", + "type": "string" + }, + "server_hostaddr": { + "description": "The human readable version of the parameter server_addr or server_addr6.", + "type": "string" + }, + "server_addr6": { + "description": "The IPv6 address of the DNS server the object belongs to, in hexadecimal format.", + "type": "string" + }, + "server_addr": { + "description": "The IPv4 address of the DNS server the object belongs to, in hexadecimal format.", + "type": "string" + }, + "server_ipm_protocol": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_ipm_type": { + "description": "The engine type of the DNS server the DNS zone belongs to: named (BIND engine), nsd (NSD engine) or unbound (Unbound engine).", + "type": "string" + }, + "zone_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                                                                                                                              Multi-status severity levels
                                                                                                                                                                                                                                              Message number Severity Description
                                                                                                                                                                                                                                              0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                                                                                                                              17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                                                                                                                              34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                                                                                                                              51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                                                                                                                              67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                                                                                                                              84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "zone_num_keys": { + "description": "The number of keys associated with the zone. This number of keys includes all ZSK and KSK.", + "type": "string" + }, + "zone_use_update_policy": { + "description": "The update policy status of the DNS zone. 1 indicates that the DNS zone uses a specific GSS-TSIG/update-policy. The parameter server_gss_enabled must be set to 1.", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DNS smart architecture managing the DNS server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_name": { + "description": "The name of the DNS smart architecture managing the DNS server the object belongs to. # indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dns_zone_data", + "type": "object" + }, + "dhcp_sharednetwork6_data": { + "example": { + "data": [ + { + "smart_parent_id": "smart_parent_id", + "sharednetwork6_name": "sharednetwork6_name", + "sharednetwork6_multistatus": "sharednetwork6_multistatus", + "sharednetwork6_delayed_time": "sharednetwork6_delayed_time", + "smart_arch": "smart_arch", + "sharednetwork6_id": "sharednetwork6_id", + "server6_id": "server6_id", + "server6_type": "server6_type", + "server6_name": "server6_name" + }, + { + "smart_parent_id": "smart_parent_id", + "sharednetwork6_name": "sharednetwork6_name", + "sharednetwork6_multistatus": "sharednetwork6_multistatus", + "sharednetwork6_delayed_time": "sharednetwork6_delayed_time", + "smart_arch": "smart_arch", + "sharednetwork6_id": "sharednetwork6_id", + "server6_id": "server6_id", + "server6_type": "server6_type", + "server6_name": "server6_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_sharednetwork6_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_alias_add_input": { + "properties": { + "address_hostaddr": { + "description": "The IP address.", + "type": "string" + }, + "address_id": { + "description": "The database identifier (ID) of the IPv4 address, a unique numeric key value automatically incremented when you add an IPv4 address. Use the ID to specify the IPv4 address of your choice.", + "type": "integer" + }, + "alias_name": { + "description": "The name of the IPv4 alias.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "alias_type": { + "description": "The type of the alias.", + "enum": [ + "A", + "a", + "CNAME", + "cname" + ], + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dhcp_group_add_success": { + "example": { + "data": [ + { + "group_id": "group_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_group_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_ipam_network6_delete_success": { + "example": { + "network6_id": "network6_id" + }, + "properties": { + "network6_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_ipam_network6_delete_success", + "type": "object" + }, + "dns_rr_delete_success": { + "example": { + "data": [ + { + "rr_id": "rr_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_rr_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dns_rr_edit_success": { + "example": { + "rr_id": "rr_id" + }, + "properties": { + "rr_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_dns_rr_edit_success", + "type": "object" + }, + "ipam_network6_edit_success": { + "example": { + "data": [ + { + "network6_id": "network6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_network6_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_sharednetwork6_edit_success": { + "example": { + "data": [ + { + "sharednetwork6_id": "sharednetwork6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_sharednetwork6_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dns_zoneparam_add_success": { + "example": { + "zoneparam_id": "zoneparam_id" + }, + "properties": { + "zoneparam_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_dns_zoneparam_add_success", + "type": "object" + }, + "dns_rr_edit_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DNS server.", + "type": "string" + }, + "rr_id": { + "description": "The database identifier (ID) of the DNS resource record, a unique numeric key value automatically incremented when you add a DNS RR. Use the ID to specify the record of your choice.", + "type": "integer" + }, + "rr_name": { + "description": "The full name of the DNS resource record. Specify it as value, it can either follow the format <rr-name>.<existing-zone-name>.<extension> or be . (a dot).", + "type": "string" + }, + "rr_type": { + "description": "The type of the DNS resource record.


                                                                                                                                                                                                                                              rr_type possible values
                                                                                                                                                                                                                                              ValueRecord type description
                                                                                                                                                                                                                                              SOAStart of Authority. Defines the zone name, an email contact and various time and refresh values applicable to the zone. It is automatically generated upon creation of a zone and cannot be added manually.
                                                                                                                                                                                                                                              NSName Server. Defines the authoritative name server(s) for the domain (defined by the SOA record) or the subdomain. The NS record that indicates which server has authority over a zone is automatically generated upon the creation of a zone, once the server has been synchronized.
                                                                                                                                                                                                                                              AIPv4 Address. An IPv4 address for a host.
                                                                                                                                                                                                                                              PTRPointer Record. Address Resolution, from an IP address (IPv4 or IPv6) to a host. Used in reverse mapping.
                                                                                                                                                                                                                                              AAAAIPv6 Address. An IPv6 address for a host.
                                                                                                                                                                                                                                              CNAMECanonical Name. An alias name for a host.
                                                                                                                                                                                                                                              MXMail Exchange. The mail server/exchanger that services this zone.
                                                                                                                                                                                                                                              SRVServices record. Defines services available in the zone, for example, LDAP, HTTP, etc...
                                                                                                                                                                                                                                              DNAMEDelegation of Reverse Names. Delegation of reverse addresses primarily in IPv6. (Deprecated, use the CNAME RR instead)
                                                                                                                                                                                                                                              TXTText. Information associated with a name.
                                                                                                                                                                                                                                              DSDelegation Signer, a DNSSEC related RR used to verify the validity of the ZSK of a subdomain.
                                                                                                                                                                                                                                              DNSKEYDNS Key. It contains the public cryptographic key used to sign the zone with DNSSEC.
                                                                                                                                                                                                                                              65534A private type record automatically added to the zone once it is signed with DNSSEC.
                                                                                                                                                                                                                                              HINFOSystem Information. Information about a host: hardware type and operating system description.
                                                                                                                                                                                                                                              MINFOMailbox mail list Information. Defines the mail administrator for a mail list and optionally a mailbox to receive error messages relating to the mail list.
                                                                                                                                                                                                                                              AFSDBAFS Database. Location of the AFS servers.
                                                                                                                                                                                                                                              WKSWell-Known Service. Defines the services and protocols supported by a host. (Deprecated, use the SRV RR instead)
                                                                                                                                                                                                                                              NAPTRNaming Authority Pointer Record. General purpose definition of rule set to be used by applications e.g. VoIP.
                                                                                                                                                                                                                                              NSAPNetwork Service Access Point. Defines record (equivalent of an A record) maps a host name to an endpoint address.


                                                                                                                                                                                                                                              Note that the parameter is not case sensitive, you could type in A or a.", + "enum": [ + "A", + "NS", + "MD", + "MF", + "CNAME", + "SOA", + "MB", + "MG", + "MR", + "NULL", + "WKS", + "PTR", + "HINFO", + "MINFO", + "MX", + "TXT", + "SPF", + "RP", + "AFSDB", + "X25", + "ISDN", + "RT", + "NSAP", + "NSAP_PTR", + "SIG", + "KEY", + "PX", + "GPOS", + "AAAA", + "LOC", + "NXT", + "EID", + "NIMLOC", + "SRV", + "ATMA", + "NAPTR", + "KX", + "CERT", + "A6", + "DNAME", + "OPT", + "DS", + "DNSSIG", + "NSEC", + "DNSKEY", + "NSEC3", + "NSEC3PARAM", + "CDS", + "CDNSKEY", + "CAA", + "TLSA", + "SSHFP", + "OPENPGPKEY", + "URI", + "AVC", + "NINFO", + "DLV", + "DHCID", + "EUI48", + "EUI64", + "NID", + "L32", + "L64", + "HTTPS", + "SVCB" + ], + "type": "string" + }, + "rr_value1": { + "description": "The first or only value required for the DNS resource record, as detailed in the service description.", + "type": "string" + }, + "check_value": { + "description": "A way to check the values of the DNS resource record before upon addition (1) in order to create a record with the same name but with different values.", + "enum": [ + "yes", + "no" + ], + "type": "string" + }, + "view_id": { + "description": "The database identifier (ID) of the DNS view, a unique numeric key value automatically incremented when you add a DNS view. Use the ID to specify the DNS view of your choice.", + "type": "integer" + }, + "view_name": { + "description": "The name of the DNS view.", + "type": "string" + }, + "zone_id": { + "description": "The database identifier (ID) of the DNS zone, a unique numeric key value automatically incremented when you add a DNS zone. Use the ID to specify the DNS zone of your choice.", + "type": "integer" + }, + "zone_name": { + "description": "The name of the DNS zone the object belongs to.", + "type": "string" + }, + "zone_space_id": { + "description": "The database identifier (ID) of the space associated with the DNS zone the record belongs to.", + "type": "integer" + }, + "rr_glue": { + "description": "The shortname of the DNS resource record.", + "type": "string" + }, + "rr_ttl": { + "description": "The time to live of the DNS resource record, in seconds.", + "type": "integer" + }, + "rr_value2": { + "description": "The second value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value3": { + "description": "The third value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value4": { + "description": "The fourth value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value5": { + "description": "The fifth value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value6": { + "description": "The sixth value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value7": { + "description": "The seventh value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "rr_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "rr_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_data_inner_dhcp_sharednetwork6_edit_success": { + "example": { + "sharednetwork6_id": "sharednetwork6_id" + }, + "properties": { + "sharednetwork6_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_sharednetwork6_edit_success", + "type": "object" + }, + "ipam_alias_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_alias_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_group_add_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "group_name": { + "description": "The name of the DHCPv4 group, each DHCPv4 group must have a unique name.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "group_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "group_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "ipam_space_delete_success": { + "example": { + "data": [ + { + "space_id": "space_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_space_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_ipam_pool6_data": { + "example": { + "vlsm_block6_id": "vlsm_block6_id", + "end_address6_addr": "end_address6_addr", + "parent_network6_class_name": "parent_network6_class_name", + "pool6_operation_details_requested_by": "pool6_operation_details_requested_by", + "pool6_end_address6_addr": "pool6_end_address6_addr", + "pool6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "parent_network6_id": "parent_network6_id", + "network6_name": "network6_name", + "pool6_operation_details_last_updated_on": "pool6_operation_details_last_updated_on", + "parent_network6_prefix": "parent_network6_prefix", + "space_class_name": "space_class_name", + "start_address6_addr": "start_address6_addr", + "space_description": "space_description", + "pool6_read_only": "pool6_read_only", + "pool6_class_name": "pool6_class_name", + "network6_end_address6_addr": "network6_end_address6_addr", + "network6_prefix": "network6_prefix", + "pool6_operation_details_call_stack": "pool6_operation_details_call_stack", + "network6_start_address6_addr": "network6_start_address6_addr", + "pool6_size": "pool6_size", + "pool6_start_hostaddr": "pool6_start_hostaddr", + "pool6_operation_details_origin_module": "pool6_operation_details_origin_module", + "network6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_is_template": "space_is_template", + "pool6_operation_details_added_on": "pool6_operation_details_added_on", + "vlsm_network6_id": "vlsm_network6_id", + "parent_network6_name": "parent_network6_name", + "pool6_id": "pool6_id", + "pool6_multistatus": "pool6_multistatus", + "pool6_operation_details_added_by": "pool6_operation_details_added_by", + "pool6_name": "pool6_name", + "space_name": "space_name", + "network6_id": "network6_id", + "network6_class_name": "network6_class_name", + "pool6_end_hostaddr": "pool6_end_hostaddr", + "space_id": "space_id", + "pool6_start_address6_addr": "pool6_start_address6_addr" + }, + "properties": { + "pool6_end_hostaddr": { + "description": "The human readable version of the parameter end_address6_addr.", + "type": "string" + }, + "end_address6_addr": { + "description": "The last IP address of the IPv6 pool, in hexadecimal format.", + "type": "string" + }, + "pool6_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                                                                                                                              Multi-status severity levels
                                                                                                                                                                                                                                              Message number Severity Description
                                                                                                                                                                                                                                              0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                                                                                                                              17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                                                                                                                              34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                                                                                                                              51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                                                                                                                              67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                                                                                                                              84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "parent_network6_class_name": { + "description": "The name of the class applied to the parent of the IPv6 network the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "parent_network6_id": { + "description": "The database identifier (ID) of the parent IPv6 network. It identifies the parent of the IPv6 network the object belongs to. 0 indicates that the network the object belongs to has no parent network.", + "type": "string" + }, + "parent_network6_name": { + "description": "The name of the parent IPv6 network. # indicates that the network the object belongs to has no parent network.", + "type": "string" + }, + "parent_network6_prefix": { + "description": "The prefix of the parent of the IPv6 network the object belongs to.", + "type": "string" + }, + "pool6_class_name": { + "description": "The name of the class applied to the IPv6 pool, it can be preceded by the class directory.", + "type": "string" + }, + "pool6_class_parameters": { + "description": "The class parameters applied to the IPv6 pool.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "pool6_end_address6_addr": { + "description": "The last IP address of the IPv6 pool, in hexadecimal format.", + "type": "string" + }, + "pool6_id": { + "description": "The database identifier (ID) of the IPv6 pool.", + "type": "string" + }, + "pool6_name": { + "description": "The name of the IPv6 pool.", + "type": "string" + }, + "pool6_read_only": { + "description": "The reservation status of the IPv6 pool. If set 1, the IP addresses it contains cannot be assigned.", + "type": "string" + }, + "pool6_size": { + "description": "The number of IP addresses the IPv6 pool contains.", + "type": "string" + }, + "pool6_start_address6_addr": { + "description": "The first IP address of the IPv6 pool, in hexadecimal format.", + "type": "string" + }, + "space_class_name": { + "description": "The name of the class applied to the space the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "space_class_parameters": { + "description": "The class parameters applied to the space the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "space_description": { + "description": "The description of the space the object belongs to.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space the object belongs to, a unique numeric key value automatically incremented when you add a space.", + "type": "string" + }, + "space_is_template": { + "description": "The template status of the space the object belongs to. If the space is used as template (1), all the IPv4 networks, pools and IP addresses it contains are also used as template.", + "type": "string" + }, + "space_name": { + "description": "The name of the space the object belongs to.", + "type": "string" + }, + "pool6_start_hostaddr": { + "description": "The human readable version of the parameter start_address6_addr.", + "type": "string" + }, + "start_address6_addr": { + "description": "The first IP address of the IPv6 pool, in hexadecimal format.", + "type": "string" + }, + "network6_class_name": { + "description": "The name of the class applied to the IPv6 network the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "network6_class_parameters": { + "description": "The class parameters applied to the IPv6 network the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "network6_end_address6_addr": { + "description": "The last IP address of the IPv6 network the object belongs to.", + "type": "string" + }, + "network6_id": { + "description": "The database identifier (ID) of the IPv6 network the object belongs to.", + "type": "string" + }, + "network6_name": { + "description": "The name of the IPv6 network the object belongs to.", + "type": "string" + }, + "network6_prefix": { + "description": "The prefix of the IPv6 network the object belongs to.", + "type": "string" + }, + "network6_start_address6_addr": { + "description": "The first IP address of the IPv6 network the object belongs to.", + "type": "string" + }, + "pool6_operation_details_added_on": { + "description": "The creation date of the IPv6 pool, in decimal UNIX date format.", + "type": "string" + }, + "pool6_operation_details_call_stack": { + "description": "The call stack of the IPv6 pool operation details, as follows: <service1>&<service2>&<service3>... .", + "type": "string" + }, + "pool6_operation_details_origin_module": { + "description": "The name of the module where the IPv6 pool addition originated.", + "type": "string" + }, + "pool6_operation_details_requested_by": { + "description": "The login of the user who requested the IPv6 pool.", + "type": "string" + }, + "pool6_operation_details_added_by": { + "description": "The login of the user who added the IPv6 pool.", + "type": "string" + }, + "pool6_operation_details_last_updated_on": { + "description": "The last time the IPv6 pool was updated, in decimal UNIX date format.", + "type": "string" + }, + "vlsm_block6_id": { + "description": "The database identifier (ID) of the IPv6 VLSM block-type network duplicated, in a VLSM child space, from the network the pool belongs to. 0 indicates that the parent of the network the pool belongs to is not duplicated as a VLSM block-type network in a child space.", + "type": "string" + }, + "vlsm_network6_id": { + "description": "The database identifier (ID) of the IPv6 subnet-type network, located in the VLSM parent space, from which the parent of the network the pool belongs to was duplicated. 0 indicates that the parent of the network the pool belongs to is not a VLSM block-type network duplicated from a parent space.", + "type": "string" + } + }, + "title": "_data_inner_ipam_pool6_data", + "type": "object" + }, + "ipam_network_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_network_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_ipam_pool6_edit_success": { + "example": { + "pool6_id": "pool6_id" + }, + "properties": { + "pool6_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_ipam_pool6_edit_success", + "type": "object" + }, + "ipam_address_edit_success": { + "example": { + "data": [ + { + "address_id": "address_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_address_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_pool_edit_success": { + "example": { + "data": [ + { + "pool_id": "pool_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_pool_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_vlan_vlan_edit_success": { + "example": { + "vlan_id": "vlan_id" + }, + "properties": { + "vlan_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_vlan_vlan_edit_success", + "type": "object" + }, + "dns_viewparam_add_success": { + "example": { + "data": [ + { + "viewparam_id": "viewparam_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_viewparam_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dhcp_failover_data": { + "example": { + "server_name": "server_name", + "failover_mclt": "failover_mclt", + "failover_peer_port": "failover_peer_port", + "failover_state": "failover_state", + "failover_name": "failover_name", + "failover_delayed_create_time": "failover_delayed_create_time", + "server_id": "server_id", + "failover_peer_addr": "failover_peer_addr", + "failover_split": "failover_split", + "failover_delayed_delete_time": "failover_delayed_delete_time", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "smart_parent_id": "smart_parent_id", + "failover_addr": "failover_addr", + "failover_type": "failover_type", + "failover_auto_partner_down": "failover_auto_partner_down", + "server_cluster_role": "server_cluster_role", + "peer_server_id": "peer_server_id", + "failover_multistatus": "failover_multistatus", + "server_state": "server_state", + "server_type": "server_type", + "failover_id": "failover_id", + "failover_port": "failover_port" + }, + "properties": { + "server_cluster_role": { + "description": "The role of the server the object belongs to in the cluster, either active (M), passive (B) or N/A (#).", + "type": "string" + }, + "failover_delayed_create_time": { + "description": "The delay of creation status. 1 indicates that the object is not created yet.", + "type": "string" + }, + "failover_delayed_delete_time": { + "description": "The delay of deletion status. 1 indicates that the object is not deleted yet.", + "type": "string" + }, + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_name": { + "description": "The name of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_state": { + "description": "The status of the DHCPv4 smart architecture.", + "type": "string" + }, + "server_type": { + "description": "The type of the DHCPv4 server the object belongs to:


                                                                                                                                                                                                                                              server_type possible values
                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                              ipmEfficientIP or EfficientIP Package server
                                                                                                                                                                                                                                              msrpcMicrosoft Windows DHCP server
                                                                                                                                                                                                                                              vdhcpEfficientIP DHCPv4 smart architecture


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "failover_addr": { + "description": "The IP address of the primary DHCPv4 server.", + "type": "string" + }, + "failover_auto_partner_down": { + "description": "The time after which the DHCPv4 failover channel automatically switches to partner-down after being in communication-interrupted state, in hours.", + "type": "string" + }, + "failover_id": { + "description": "The database identifier (ID) of the DHCPv4 failover channel, a unique numeric key value automatically incremented when you add a failover channel.", + "type": "string" + }, + "failover_mclt": { + "description": "The maximum client lead time (MCLT) of the failover channel, in seconds. It indicates for how long each DHCP server can extend the lease of a client, beyond the time known by its partner server.", + "type": "string" + }, + "failover_name": { + "description": "The name of the DHCPv4 failover channel.", + "type": "string" + }, + "failover_peer_addr": { + "description": "The IP address of the secondary DHCPv4 server.", + "type": "string" + }, + "failover_peer_port": { + "description": "The port number of the secondary DHCPv4 server.", + "type": "string" + }, + "failover_port": { + "description": "The port number of the primary DHCPv4 server.", + "type": "string" + }, + "failover_split": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "failover_state": { + "description": "The status of the DHCPv4 failover channel, either startup, normal, communications-interrupted or recover-wait.", + "type": "string" + }, + "failover_type": { + "description": "The type of the DHCPv4 failover channel, either primary or secondary.", + "type": "string" + }, + "server_hostaddr": { + "description": "The human readable version of the parameter server_addr or server_addr6.", + "type": "string" + }, + "server_addr6": { + "description": "The Management IP address of the DHCPv4 server, the IPv6 address configured when adding the server, on which the failover channel is configured, in hexadecimal format.", + "type": "string" + }, + "server_addr": { + "description": "The Management IP address of the DHCPv4 server, the IPv4 address configured when adding the server, on which the failover channel is configured, in hexadecimal format.", + "type": "string" + }, + "failover_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                                                                                                                              Multi-status severity levels
                                                                                                                                                                                                                                              Message number Severity Description
                                                                                                                                                                                                                                              0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                                                                                                                              17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                                                                                                                              34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                                                                                                                              51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                                                                                                                              67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                                                                                                                              84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "peer_server_id": { + "description": "The database identifier (ID) of the secondary DHCPv4 server.", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_failover_data", + "type": "object" + }, + "dns_zoneparam_add_input": { + "properties": { + "zone_id": { + "description": "The database identifier (ID) of the DNS zone, a unique numeric key value automatically incremented when you add a DNS zone. Use the ID to specify the DNS zone of your choice.", + "type": "integer" + }, + "zoneparam_key": { + "description": "The name of the DNS option you want to add, edit or remove from the zone. You can only set one option at a time.
                                                                                                                                                                                                                                              • To add or edit an option: specify its name in the parameter zoneparam_key, as follows zoneparam_key=<option-name>, and then specify its value in the parameter zoneparam_value.
                                                                                                                                                                                                                                              • To remove an option, specify its name in the parameter zoneparam_key and leave the parameter zoneparam_value empty.
                                                                                                                                                                                                                                              To set several options, specify as many parameters (zoneparam_key and zoneparam_value) as you need.", + "type": "string" + }, + "zoneparam_is_array": { + "description": "A way to determine is the DNS zone option is an array (1).", + "type": "integer" + }, + "zoneparam_value": { + "description": "The value of the DNS option specified in the input zoneparam_key.
                                                                                                                                                                                                                                              • To add or edit an option value, specify its name in the parameter zoneparam_key and set its value as follows: zoneparam_value=<option-value> .
                                                                                                                                                                                                                                              • To remove an option value, specify its name in the parameter zoneparam_key and leave zoneparam_value empty: zoneparam_value= .
                                                                                                                                                                                                                                              ", + "type": "string" + } + }, + "type": "object" + }, + "ipam_network_edit_input": { + "properties": { + "parent_network_id": { + "description": "The database identifier (ID) of an existing IPv4 network you want to set as the parent of the IPv4 network you are editing. You can specify a subnet-type network to set up a network-based VLSM organization.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "network_addr": { + "description": "The start IP address of the IPv4 network, its first IP address.", + "type": "string" + }, + "network_end_addr": { + "description": "The end IP address of the IPv4 network, its last IP address.", + "type": "string" + }, + "network_id": { + "description": "The database identifier (ID) of the IPv4 network, a unique numeric key value automatically incremented when you add an IPv4 network. Use the ID to specify the IPv4 network of your choice.", + "type": "integer" + }, + "network_mask": { + "description": "The netmask of the IPv4 network. It is expressed in dot-decimal notation and defines the number of addresses the network contains.", + "type": "string" + }, + "network_prefix": { + "description": "The prefix of the IPv4 network, an integer that defines the number of addresses the network contains.", + "type": "string" + }, + "network_size": { + "description": "The size of the IPv4 network, the number of IP addresses it contains.", + "type": "integer" + }, + "allow_block_creation": { + "description": "Internal use. Not documented.", + "type": "integer" + }, + "allow_tree_reparenting": { + "description": "A way to allow (1) or prevent (0) changing the parent of the network you are adding. Upon editing of the network, this parameter decides if you can associate it with a different parent network.", + "type": "integer" + }, + "network_is_terminal": { + "description": "A way to determine if a network can contain other networks. If set to 1, the network is terminal and cannot contain other subnet-type networks. By essence, block-type networks are non-terminal and are always set to 0.", + "type": "integer" + }, + "network_lock_network_broadcast": { + "description": "A way to prevent (1) users from assigning the broadcast IP address and network IP address of the network.", + "type": "integer" + }, + "permit_invalid": { + "description": "A way to authorize (1) IPv4 networks overlapping within a space.", + "type": "integer" + }, + "permit_no_block": { + "description": "A way to force the creation of an IPv4 subnet-type network. If set to 1, you can create a subnet-type network even if no block-type network matching the start address exists.", + "type": "integer" + }, + "relative_position": { + "description": "The position of the network within the hierarchy of networks of a VLSM organization. It calculates between 0 and n all the levels of the organization, its behavior depends on the value of the parameter use_reversed_relative_position:
                                                                                                                                                                                                                                              • use_reversed_relative_position=0 where 0 indicates a block-type network at the highest level possible, in a space-based organization, it belongs to the top space. The levels increment from 0 down to n, the lowest level you set up, within networks or spaces.
                                                                                                                                                                                                                                              • use_reversed_relative_position=1 where 1 indicates a network located at the lowest level of the organization, within networks or spaces. The levels increment from 0 up to n, the network at the highest level of the organization.
                                                                                                                                                                                                                                              ", + "type": "integer" + }, + "row_state": { + "description": "The object activation status.
                                                                                                                                                                                                                                              • If set to 0, the object is present in the database but ignored, i.e. it cannot be managed, counted or listed. This status is applied on objects deleted from the GUI.
                                                                                                                                                                                                                                              • If set to 1, the object is enabled and managed.
                                                                                                                                                                                                                                              • If set to 2, the object is unmanaged, disabled or both depending on the context.
                                                                                                                                                                                                                                              By default, row_state is set to 1 when an object is created.", + "enum": [ + "1", + "2" + ], + "type": "string" + }, + "network_level": { + "description": "The level of the network within the space:
                                                                                                                                                                                                                                              • Set it to 0 for a block-type network.
                                                                                                                                                                                                                                              • Set it to a value between 1 and n for a subnet-type network.
                                                                                                                                                                                                                                              If you set a value between 2 and n, you are setting a network-based VLSM organization where non terminal subnet-type networks can contain other subnet-type networks.", + "type": "integer" + }, + "network_name": { + "description": "The name of the IPv4 network, each IPv4 network must have a unique name.", + "type": "string" + }, + "use_reversed_relative_position": { + "description": "A way to determine if the calculation of the parameter relative_position should start from the top (0) or the bottom (1) of the VLSM organization.", + "type": "integer" + }, + "vlan_id": { + "description": "The database identifier (ID) of the VLAN you want to associate with the network.", + "type": "integer" + }, + "vlsm_space_id": { + "description": "The database identifier (ID) of a VLSM child space of the space specified in space_id. If you specify an ID, the subnet-type network you are editing is duplicated as a VLSM block-type network in the child space, with the same name but a different ID. This parameter serves the same purpose as vlsm_space_name.", + "type": "integer" + }, + "vlsm_space_name": { + "description": "The name of a VLSM child space of the space specified in space_id. If you specify a name, the subnet-type network you are editing is duplicated as a VLSM block-type network in the child space, with the same name but a different ID. This parameter serves the same purpose as vlsm_space_id.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "network_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "network_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "dns_zoneparam_delete_success": { + "example": { + "data": [ + { + "zoneparam_id": "zoneparam_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_zoneparam_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dhcp_static_delete_success": { + "example": { + "static_id": "static_id" + }, + "properties": { + "static_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_static_delete_success", + "type": "object" + }, + "ipam_space_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_space_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_scope6_delete_success": { + "example": { + "data": [ + { + "scope6_id": "scope6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_scope6_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_alias_delete_success": { + "example": { + "data": [ + { + "alias_id": "alias_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_alias_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_ipam_space_add_success": { + "example": { + "space_id": "space_id" + }, + "properties": { + "space_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_ipam_space_add_success", + "type": "object" + }, + "_data_inner_dhcp_scope_delete_success": { + "example": { + "scope_id": "scope_id" + }, + "properties": { + "scope_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_scope_delete_success", + "type": "object" + }, + "_data_inner_dhcp_scope6_add_success": { + "example": { + "scope6_id": "scope6_id" + }, + "properties": { + "scope6_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_scope6_add_success", + "type": "object" + }, + "_data_inner_dhcp_scope_data": { + "example": { + "server_name": "server_name", + "sharednetwork_id": "sharednetwork_id", + "server_class_name": "server_class_name", + "scope_start_address_addr": "scope_start_address_addr", + "server_version": "server_version", + "scope_space_name": "scope_space_name", + "scope_name": "scope_name", + "scope_delayed_create_time": "scope_delayed_create_time", + "smart_parent_id": "smart_parent_id", + "scope_multistatus": "scope_multistatus", + "scope_id": "scope_id", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "smart_parent_name": "smart_parent_name", + "scope_size": "scope_size", + "smart_arch": "smart_arch", + "scope_end_address_addr": "scope_end_address_addr", + "failover_name": "failover_name", + "sharednetwork_name": "sharednetwork_name", + "scope_delayed_delete_time": "scope_delayed_delete_time", + "server_id": "server_id", + "server_addr": "server_addr", + "scope_net_mask": "scope_net_mask", + "server_hostaddr": "server_hostaddr", + "scope_net_addr": "scope_net_addr", + "server_addr6": "server_addr6", + "scope_space_id": "scope_space_id", + "scope_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_type": "server_type", + "failover_id": "failover_id", + "scope_class_name": "scope_class_name" + }, + "properties": { + "scope_delayed_create_time": { + "description": "The delay of creation status. 1 indicates that the object is not created yet.", + "type": "string" + }, + "scope_delayed_delete_time": { + "description": "The delay of deletion status. 1 indicates that the object is not deleted yet.", + "type": "string" + }, + "server_class_name": { + "description": "The name of the class applied to the DHCPv4 server the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "server_class_parameters": { + "description": "The class parameters applied to the DHCPv4 server the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_name": { + "description": "The name of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "server_type": { + "description": "The type of the DHCPv4 server the object belongs to:


                                                                                                                                                                                                                                              server_type possible values
                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                              ipmEfficientIP or EfficientIP Package server
                                                                                                                                                                                                                                              msrpcMicrosoft Windows DHCP server
                                                                                                                                                                                                                                              vdhcpEfficientIP DHCPv4 smart architecture


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "server_version": { + "description": "The version details of the DHCPv4 server the object belongs to.", + "type": "string" + }, + "failover_id": { + "description": "The database identifier (ID) of the DHCPv4 failover channel associated with the object.", + "type": "string" + }, + "failover_name": { + "description": "The name of the DHCPv4 failover channel associated with the object.", + "type": "string" + }, + "scope_class_name": { + "description": "The name of the class applied to the DHCPv4 scope, it can be preceded by the class directory.", + "type": "string" + }, + "scope_class_parameters": { + "description": "The class parameters applied to the DHCPv4 scope.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "scope_end_address_addr": { + "description": "The last IP address of the DHCPv4 scope, in hexadecimal format.", + "type": "string" + }, + "scope_id": { + "description": "The database identifier (ID) of the DHCPv4 scope.", + "type": "string" + }, + "scope_name": { + "description": "The name of the DHCPv4 scope.", + "type": "string" + }, + "scope_net_addr": { + "description": "The first IP address of the DHCPv4 scope.", + "type": "string" + }, + "scope_net_mask": { + "description": "The netmask of the DHCPv4 scope. It is expressed in dot-decimal notation and defines the number of addresses the scope contains.", + "type": "string" + }, + "scope_space_id": { + "description": "The database identifier (ID) of the space associated with the DHCPv4 scope.", + "type": "string" + }, + "scope_space_name": { + "description": "The name of the space associated with the DHCPv4 scope.", + "type": "string" + }, + "scope_size": { + "description": "The number of IP addresses the DHCPv4 scope contains.", + "type": "string" + }, + "scope_start_address_addr": { + "description": "The first IP address of the DHCPv4 scope, in hexadecimal format.", + "type": "string" + }, + "sharednetwork_id": { + "description": "The database identifier (ID) of the DHCPv4 shared network the object belongs to.", + "type": "string" + }, + "sharednetwork_name": { + "description": "The name of the DHCPv4 shared network the object belongs to.", + "type": "string" + }, + "server_hostaddr": { + "description": "The human readable version of the parameter server_addr or server_addr6.", + "type": "string" + }, + "server_addr6": { + "description": "The Management IP address of the DHCPv4 server the object belongs to, the IPv6 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "server_addr": { + "description": "The Management IP address of the DHCPv4 server the object belongs to, the IPv4 address configured when adding the server, in hexadecimal format.", + "type": "string" + }, + "scope_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                                                                                                                              Multi-status severity levels
                                                                                                                                                                                                                                              Message number Severity Description
                                                                                                                                                                                                                                              0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                                                                                                                              17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                                                                                                                              34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                                                                                                                              51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                                                                                                                              67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                                                                                                                              84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "smart_arch": { + "description": "The type of the DHCPv4 smart architecture the object belongs to.


                                                                                                                                                                                                                                              smart_arch possible values
                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                              masterslaveThe One-to-One smart architecture sets a pair of DHCP servers in a Master/Backup configuration.
                                                                                                                                                                                                                                              starThe One-to-Many smart architecture sets a multi-site failover configuration at the cost of n-servers+1.
                                                                                                                                                                                                                                              splitscopeThe Split-Scope smart architecture sets a pair of DHCP servers in a configuration where the two scopes listen to the same subnet, but the range of addresses is divided.
                                                                                                                                                                                                                                              singleThe Single-Server smart architecture manages a single DHCP server.


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_name": { + "description": "The name of the DHCPv4 smart architecture managing the DHCPv4 server the object belongs to. # indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_scope_data", + "type": "object" + }, + "_data_inner_vlan_range_edit_success": { + "example": { + "range_id": "range_id" + }, + "properties": { + "range_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_vlan_range_edit_success", + "type": "object" + }, + "dhcp_lease6_data": { + "example": { + "data": [ + { + "scope6_size": "scope6_size", + "lease6_multistatus": "lease6_multistatus", + "server6_version": "server6_version", + "lease6_id": "lease6_id", + "lease6_address6_addr": "lease6_address6_addr", + "range6_failover_name": "range6_failover_name", + "server6_name": "server6_name", + "lease6_end_time": "lease6_end_time", + "lease6_first_time": "lease6_first_time", + "lease6_period": "lease6_period", + "range6_end_address6_addr": "range6_end_address6_addr", + "scope6_prefix": "scope6_prefix", + "smart_parent_id": "smart_parent_id", + "smart_parent_name": "smart_parent_name", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "lease6_clientname": "lease6_clientname", + "server6_type": "server6_type", + "lease6_mac_vendor": "lease6_mac_vendor", + "lease6_domain": "lease6_domain", + "range6_id": "range6_id", + "range6_start_address6_addr": "range6_start_address6_addr", + "server6_addr6": "server6_addr6", + "lease6_time": "lease6_time", + "sharednetwork6_name": "sharednetwork6_name", + "lease6_client_duid": "lease6_client_duid", + "server6_hostaddr": "server6_hostaddr", + "lease6_percent": "lease6_percent", + "server6_addr": "server6_addr", + "lease6_mac_addr": "lease6_mac_addr", + "scope6_class_name": "scope6_class_name", + "scope6_name": "scope6_name", + "range6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_id": "scope6_id", + "sharednetwork6_id": "sharednetwork6_id", + "lease6_giaddr": "lease6_giaddr", + "lease6_time_to_expire": "lease6_time_to_expire", + "lease6_name": "lease6_name", + "scope6_start_address6_addr": "scope6_start_address6_addr", + "range6_class_name": "range6_class_name" + }, + { + "scope6_size": "scope6_size", + "lease6_multistatus": "lease6_multistatus", + "server6_version": "server6_version", + "lease6_id": "lease6_id", + "lease6_address6_addr": "lease6_address6_addr", + "range6_failover_name": "range6_failover_name", + "server6_name": "server6_name", + "lease6_end_time": "lease6_end_time", + "lease6_first_time": "lease6_first_time", + "lease6_period": "lease6_period", + "range6_end_address6_addr": "range6_end_address6_addr", + "scope6_prefix": "scope6_prefix", + "smart_parent_id": "smart_parent_id", + "smart_parent_name": "smart_parent_name", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "lease6_clientname": "lease6_clientname", + "server6_type": "server6_type", + "lease6_mac_vendor": "lease6_mac_vendor", + "lease6_domain": "lease6_domain", + "range6_id": "range6_id", + "range6_start_address6_addr": "range6_start_address6_addr", + "server6_addr6": "server6_addr6", + "lease6_time": "lease6_time", + "sharednetwork6_name": "sharednetwork6_name", + "lease6_client_duid": "lease6_client_duid", + "server6_hostaddr": "server6_hostaddr", + "lease6_percent": "lease6_percent", + "server6_addr": "server6_addr", + "lease6_mac_addr": "lease6_mac_addr", + "scope6_class_name": "scope6_class_name", + "scope6_name": "scope6_name", + "range6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "scope6_id": "scope6_id", + "sharednetwork6_id": "sharednetwork6_id", + "lease6_giaddr": "lease6_giaddr", + "lease6_time_to_expire": "lease6_time_to_expire", + "lease6_name": "lease6_name", + "scope6_start_address6_addr": "scope6_start_address6_addr", + "range6_class_name": "range6_class_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_lease6_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_ipam_alias6_add_success": { + "example": { + "alias6_id": "alias6_id" + }, + "properties": { + "alias6_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_ipam_alias6_add_success", + "type": "object" + }, + "dhcp_sharednetwork_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_sharednetwork_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_ipam_alias6_edit_success": { + "example": { + "alias6_id": "alias6_id" + }, + "properties": { + "alias6_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_ipam_alias6_edit_success", + "type": "object" + }, + "dhcp_scope_edit_success": { + "example": { + "data": [ + { + "scope_id": "scope_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_scope_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dns_viewparam_edit_success": { + "example": { + "data": [ + { + "viewparam_id": "viewparam_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_viewparam_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_scope6_edit_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_scope6_edit_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_alias6_edit_success": { + "example": { + "data": [ + { + "alias6_id": "alias6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_alias6_edit_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_static_edit_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "static_addr": { + "description": "The IP address associated with the DHCPv4 static.", + "type": "string" + }, + "static_id": { + "description": "The database identifier (ID) of the DHCPv4 static, a unique numeric key value automatically incremented when you add a DHCPv4 static. Use the ID to specify the DHCPv4 static of your choice.", + "type": "integer" + }, + "static_identifier": { + "description": "The host identifier you want to associate with the IPv4 static. An option and value to look for to identify clients and assign them the static, specified as follows: option <option-name> expected value.", + "type": "string" + }, + "static_mac_addr": { + "description": "The MAC address you want to associate with the IPv4 static, it must include the MAC address type. The address has 7 sections, 00:11:22:33:44:55:66 , where 00 indicates the type. For Ethernet, type in 01.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "group_id": { + "description": "The database identifier (ID) of the DHCPv4 group, a unique numeric key value automatically incremented when you add a DHCPv4 group. Use the ID to specify the DHCPv4 group of your choice.", + "type": "integer" + }, + "group_name": { + "description": "The name of the DHCPv4 group.", + "type": "string" + }, + "static_name": { + "description": "The name of the DHCPv4 static, each DHCPv4 static must have a unique name.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "static_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "static_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "ipam_address_add_success": { + "example": { + "data": [ + { + "address_id": "address_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_address_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "vlan_range_add_input": { + "properties": { + "domain_id": { + "description": "The database identifier (ID) of the VLAN domain, a unique numeric key value automatically incremented when you add a VLAN domain. Use the ID to specify the VLAN domain of your choice.", + "type": "integer" + }, + "domain_name": { + "description": "The name of the VLAN domain.", + "type": "string" + }, + "range_name": { + "description": "The name of the VLAN range, each VLAN range must have a unique name.", + "type": "string" + }, + "range_description": { + "description": "The description of the VLAN range.", + "type": "string" + }, + "range_disable_overlapping": { + "description": "The overlapping restriction status of the VLAN range. Set it to 1 to prevent VLAN ID overlapping in the range.", + "type": "integer" + }, + "range_end_vlan_id": { + "description": "The VLAN identifier (ID) of an existing VLAN you want to set as the last VLAN in the VLAN range.", + "type": "integer" + }, + "range_start_vlan_id": { + "description": "The VLAN identifier (ID) of an existing VLAN you want to set as the first VLAN in the VLAN range.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "range_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "range_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "ipam_pool_add_success": { + "example": { + "data": [ + { + "pool_id": "pool_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_pool_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dhcp_sharednetwork6_delete_success": { + "example": { + "sharednetwork6_id": "sharednetwork6_id" + }, + "properties": { + "sharednetwork6_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_sharednetwork6_delete_success", + "type": "object" + }, + "dhcp_acl6_data": { + "example": { + "data": [ + { + "acl6_statement": "acl6_statement", + "smart_parent_id": "smart_parent_id", + "acl6_id": "acl6_id", + "acl6_match": "acl6_match", + "server_cluster_role": "server_cluster_role", + "acl6_spawnwith": "acl6_spawnwith", + "acl6_name": "acl6_name", + "server6_id": "server6_id", + "acl6_delayed_time": "acl6_delayed_time", + "server6_type": "server6_type", + "server6_name": "server6_name" + }, + { + "acl6_statement": "acl6_statement", + "smart_parent_id": "smart_parent_id", + "acl6_id": "acl6_id", + "acl6_match": "acl6_match", + "server_cluster_role": "server_cluster_role", + "acl6_spawnwith": "acl6_spawnwith", + "acl6_name": "acl6_name", + "server6_id": "server6_id", + "acl6_delayed_time": "acl6_delayed_time", + "server6_type": "server6_type", + "server6_name": "server6_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_acl6_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dns_zone_edit_success": { + "example": { + "zone_id": "zone_id" + }, + "properties": { + "zone_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_dns_zone_edit_success", + "type": "object" + }, + "_data_inner_dhcp_range6_add_success": { + "example": { + "range6_id": "range6_id" + }, + "properties": { + "range6_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_range6_add_success", + "type": "object" + }, + "_data_inner_dhcp_sharednetwork_delete_success": { + "example": { + "sharednetwork_id": "sharednetwork_id" + }, + "properties": { + "sharednetwork_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_sharednetwork_delete_success", + "type": "object" + }, + "_data_inner_dhcp_sharednetwork6_data": { + "example": { + "smart_parent_id": "smart_parent_id", + "sharednetwork6_name": "sharednetwork6_name", + "sharednetwork6_multistatus": "sharednetwork6_multistatus", + "sharednetwork6_delayed_time": "sharednetwork6_delayed_time", + "smart_arch": "smart_arch", + "sharednetwork6_id": "sharednetwork6_id", + "server6_id": "server6_id", + "server6_type": "server6_type", + "server6_name": "server6_name" + }, + "properties": { + "sharednetwork6_delayed_time": { + "description": "The delay of creation/deletion status. 1 indicates that the object is not created/deleted yet.", + "type": "string" + }, + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_name": { + "description": "The name of the DHCPv6 server the object belongs to.", + "type": "string" + }, + "server6_type": { + "description": "The type of the DHCPv6 server the object belongs to:


                                                                                                                                                                                                                                              server6_type possible values
                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                              ipmEfficientIP or EfficientIP Package server
                                                                                                                                                                                                                                              vdhcpEfficientIP DHCPv6 smart architecture


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "sharednetwork6_id": { + "description": "The database identifier (ID) of the DHCPv6 shared network.", + "type": "string" + }, + "sharednetwork6_name": { + "description": "The name of the DHCPv6 shared network.", + "type": "string" + }, + "sharednetwork6_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                                                                                                                              Multi-status severity levels
                                                                                                                                                                                                                                              Message number Severity Description
                                                                                                                                                                                                                                              0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                                                                                                                              17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                                                                                                                              34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                                                                                                                              51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                                                                                                                              67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                                                                                                                              84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "smart_arch": { + "description": "The type of the DHCPv6 smart architecture the object belongs to.


                                                                                                                                                                                                                                              smart_arch possible values
                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                              singleThe Single-Server smart architecture manages a single DHCPv6 server.
                                                                                                                                                                                                                                              splitscopeThe Split-Scope smart architecture sets a pair of DHCP servers in a configuration where the two scopes listen to the same subnet, but the range of addresses is divided.
                                                                                                                                                                                                                                              statelessThe Stateless smart architecture offers a limited number of options to the DHCP clients. The IP address is delivered thanks to the subnet gateway and it is impossible to create any ranges or statics or to retrieve any leases.


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DHCPv6 smart architecture managing the DHCPv6 server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_sharednetwork6_data", + "type": "object" + }, + "ipam_pool_data": { + "example": { + "data": [ + { + "pool_start_hostaddr": "pool_start_hostaddr", + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "pool_operation_details_added_on": "pool_operation_details_added_on", + "pool_operation_details_call_stack": "pool_operation_details_call_stack", + "pool_start_address_addr": "pool_start_address_addr", + "vlsm_network_id": "vlsm_network_id", + "parent_network_name": "parent_network_name", + "pool_class_name": "pool_class_name", + "space_class_name": "space_class_name", + "parent_network_size": "parent_network_size", + "space_description": "space_description", + "pool_end_ip_addr": "pool_end_ip_addr", + "pool_end_address_addr": "pool_end_address_addr", + "pool_operation_details_added_by": "pool_operation_details_added_by", + "pool_start_ip_addr": "pool_start_ip_addr", + "pool_operation_details_last_updated_on": "pool_operation_details_last_updated_on", + "network_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "network_size": "network_size", + "pool_size": "pool_size", + "space_is_template": "space_is_template", + "network_name": "network_name", + "pool_operation_details_requested_by": "pool_operation_details_requested_by", + "pool_read_only": "pool_read_only", + "pool_id": "pool_id", + "pool_multistatus": "pool_multistatus", + "parent_network_class_name": "parent_network_class_name", + "pool_name": "pool_name", + "pool_operation_details_origin_module": "pool_operation_details_origin_module", + "pool_end_hostaddr": "pool_end_hostaddr", + "network_id": "network_id", + "space_name": "space_name", + "parent_network_id": "parent_network_id", + "network_start_address_addr": "network_start_address_addr", + "pool_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "vlsm_block_id": "vlsm_block_id", + "space_id": "space_id", + "network_end_address_addr": "network_end_address_addr", + "network_class_name": "network_class_name" + }, + { + "pool_start_hostaddr": "pool_start_hostaddr", + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "pool_operation_details_added_on": "pool_operation_details_added_on", + "pool_operation_details_call_stack": "pool_operation_details_call_stack", + "pool_start_address_addr": "pool_start_address_addr", + "vlsm_network_id": "vlsm_network_id", + "parent_network_name": "parent_network_name", + "pool_class_name": "pool_class_name", + "space_class_name": "space_class_name", + "parent_network_size": "parent_network_size", + "space_description": "space_description", + "pool_end_ip_addr": "pool_end_ip_addr", + "pool_end_address_addr": "pool_end_address_addr", + "pool_operation_details_added_by": "pool_operation_details_added_by", + "pool_start_ip_addr": "pool_start_ip_addr", + "pool_operation_details_last_updated_on": "pool_operation_details_last_updated_on", + "network_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "network_size": "network_size", + "pool_size": "pool_size", + "space_is_template": "space_is_template", + "network_name": "network_name", + "pool_operation_details_requested_by": "pool_operation_details_requested_by", + "pool_read_only": "pool_read_only", + "pool_id": "pool_id", + "pool_multistatus": "pool_multistatus", + "parent_network_class_name": "parent_network_class_name", + "pool_name": "pool_name", + "pool_operation_details_origin_module": "pool_operation_details_origin_module", + "pool_end_hostaddr": "pool_end_hostaddr", + "network_id": "network_id", + "space_name": "space_name", + "parent_network_id": "parent_network_id", + "network_start_address_addr": "network_start_address_addr", + "pool_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "vlsm_block_id": "vlsm_block_id", + "space_id": "space_id", + "network_end_address_addr": "network_end_address_addr", + "network_class_name": "network_class_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_pool_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_ipam_address_edit_success": { + "example": { + "address_id": "address_id" + }, + "properties": { + "address_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_ipam_address_edit_success", + "type": "object" + }, + "_data_inner_ipam_pool_delete_success": { + "example": { + "pool_id": "pool_id" + }, + "properties": { + "pool_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_ipam_pool_delete_success", + "type": "object" + }, + "dhcp_sharednetwork6_add_input": { + "properties": { + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "type": "integer" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "sharednetwork6_name": { + "description": "The name of the DHCPv6 shared network.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_data_inner_dhcp_static6_add_success": { + "example": { + "static6_id": "static6_id" + }, + "properties": { + "static6_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_static6_add_success", + "type": "object" + }, + "_data_inner_ipam_network6_edit_success": { + "example": { + "network6_id": "network6_id" + }, + "properties": { + "network6_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_ipam_network6_edit_success", + "type": "object" + }, + "dhcp_range_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_range_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_ipam_pool_add_success": { + "example": { + "pool_id": "pool_id" + }, + "properties": { + "pool_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_ipam_pool_add_success", + "type": "object" + }, + "dns_view_add_input": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "view_name": { + "description": "The name of the DNS view, each DNS view must have a unique name.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DNS server.", + "type": "string" + }, + "view_allow_query": { + "description": "The ACL values associated with the allow-query configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_allow_recursion": { + "description": "The ACL values associated with the allow-recursion configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_allow_transfer": { + "description": "The ACL values associated with the allow-transfer configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_match_clients": { + "description": "The ACL values associated with the match clients configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_match_to": { + "description": "The ACL values associated with the match destination configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_order": { + "description": "The level of the DNS view, where 0 represents the highest level in the views hierarchy. The parameters dnsview_match_client and view_match_to of each view in a server are reviewed following this order.", + "type": "integer" + }, + "view_recursion": { + "description": "The recursion status of the DNS view:


                                                                                                                                                                                                                                              view_recursion possible values
                                                                                                                                                                                                                                              StatusDescription
                                                                                                                                                                                                                                              noThe view only provides iterative query behavior - normally resulting in a referral. If the answer to the query already exists in the cache it will be returned whatever the value of this statement.
                                                                                                                                                                                                                                              yesThe view always provides recursive query behavior if requested by the client.


                                                                                                                                                                                                                                              ", + "enum": [ + "yes", + "no" + ], + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "view_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "view_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_data_inner_ipam_space_edit_success": { + "example": { + "space_id": "space_id" + }, + "properties": { + "space_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_ipam_space_edit_success", + "type": "object" + }, + "_data_inner_dhcp_group_add_success": { + "example": { + "group_id": "group_id" + }, + "properties": { + "group_id": { + "description": "The database identifier (ID) of the object you added.", + "type": "string" + } + }, + "title": "_data_inner_dhcp_group_add_success", + "type": "object" + }, + "_data_inner_dns_zoneparam_edit_success": { + "example": { + "zoneparam_id": "zoneparam_id" + }, + "properties": { + "zoneparam_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_dns_zoneparam_edit_success", + "type": "object" + }, + "ipam_network6_add_success": { + "example": { + "data": [ + { + "network6_id": "network6_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_network6_add_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_address_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_address_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dns_rr_data": { + "example": { + "rr_id": "rr_id", + "rr_value_ip4_addr": "rr_value_ip4_addr", + "server_version": "server_version", + "rr_auth_gsstsig": "rr_auth_gsstsig", + "rr_ttl": "rr_ttl", + "smart_parent_name": "smart_parent_name", + "rr_full_name_utf": "rr_full_name_utf", + "zone_space_name": "zone_space_name", + "zone_type": "zone_type", + "rr_all_value": "rr_all_value", + "view_class_name": "view_class_name", + "rr_type_id": "rr_type_id", + "rr_value1": "rr_value1", + "rr_value_id": "rr_value_id", + "server_id": "server_id", + "rr_glue_id": "rr_glue_id", + "rr_glue": "rr_glue", + "rr_name_id": "rr_name_id", + "rr_delayed_delete_time": "rr_delayed_delete_time", + "rr_last_update_time": "rr_last_update_time", + "zone_masters": "zone_masters", + "zone_is_reverse": "zone_is_reverse", + "view_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "rr_full_name": "rr_full_name", + "rr_last_update_days": "rr_last_update_days", + "server_name": "server_name", + "zone_sort_zone": "zone_sort_zone", + "zone_forwarders": "zone_forwarders", + "server_class_name": "server_class_name", + "zone_class_name": "zone_class_name", + "zone_name": "zone_name", + "rr_name_address_addr": "rr_name_address_addr", + "rr_value7": "rr_value7", + "zone_id": "zone_id", + "rr_value6": "rr_value6", + "rr_delayed_time": "rr_delayed_time", + "rr_class_name": "rr_class_name", + "smart_parent_id": "smart_parent_id", + "rr_value3": "rr_value3", + "rr_value2": "rr_value2", + "rr_value5": "rr_value5", + "rr_value4": "rr_value4", + "rr_type": "rr_type", + "server_cloud": "server_cloud", + "view_name": "view_name", + "server_comment": "server_comment", + "rr_value_address_addr": "rr_value_address_addr", + "view_id": "view_id", + "zone_is_rpz": "zone_is_rpz", + "rr_multistatus": "rr_multistatus", + "rr_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "zone_name_utf": "zone_name_utf", + "rr_name_ip4_addr": "rr_name_ip4_addr", + "rr_delayed_create_time": "rr_delayed_create_time", + "server_type": "server_type" + }, + "properties": { + "rr_delayed_create_time": { + "description": "The delay of creation status. 1 indicates that the object is not created yet.", + "type": "string" + }, + "rr_delayed_delete_time": { + "description": "The delay of deletion status. 1 indicates that the object is not deleted yet.", + "type": "string" + }, + "rr_delayed_time": { + "description": "The delay of creation/deletion status. 1 indicates that the object is not created/deleted yet.", + "type": "string" + }, + "server_class_name": { + "description": "The name of the class applied to the DNS server the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "server_cloud": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_comment": { + "description": "The description of the DNS server the object belongs to.", + "type": "string" + }, + "server_id": { + "description": "The database identifier (ID) of the DNS server the object belongs to.", + "type": "string" + }, + "server_name": { + "description": "The name of the DNS server the object belongs to.", + "type": "string" + }, + "server_type": { + "description": "The type of the DNS server the object belongs to.


                                                                                                                                                                                                                                              server_type possible values
                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                              ipmEfficientIP or EfficientIP Package server
                                                                                                                                                                                                                                              msdaemonMicrosoft Windows DNS server
                                                                                                                                                                                                                                              awsAmazon Route 53 server
                                                                                                                                                                                                                                              otherGeneric DNS server
                                                                                                                                                                                                                                              vdnsEfficientIP DNS smart architecture


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "server_version": { + "description": "The version details of the DNS server the object belongs to.", + "type": "string" + }, + "view_class_name": { + "description": "The name of the class applied to the DNS view the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "view_class_parameters": { + "description": "The class parameters applied to the DNS view the object belongs to.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "view_id": { + "description": "The database identifier (ID) of the DNS view the object belongs to.", + "type": "string" + }, + "view_name": { + "description": "The name of the DNS view the object belongs to.", + "type": "string" + }, + "zone_class_name": { + "description": "The name of the class applied to the DNS zone the object belongs to, it can be preceded by the class directory.", + "type": "string" + }, + "zone_forwarders": { + "description": "The IP address(es) of the forwarder(s) associated with the DNS zone the resource record belongs to. It lists the DNS servers to which any unknown query on this zone should be sent, as follows: <ip_address1>;<ip_address2>;... .", + "type": "string" + }, + "zone_id": { + "description": "The database identifier (ID) of the DNS zone the object belongs to.", + "type": "string" + }, + "zone_is_reverse": { + "description": "A way to determine if the DNS zone the resource record belongs to provides reverse resolution (1) or direct/name resolution (0),", + "type": "string" + }, + "zone_is_rpz": { + "description": "The RPZ status of the DNS zone the resource record belongs to. 1 indicates that the DNS zone the record belongs to is a Response Policy Zone.", + "type": "string" + }, + "zone_masters": { + "description": "For resource records in slave DNS zones, the IP address of the DNS server and, if relevant, the name of the DNS view that contain the master DNS zone, as follows: <ip_addr>; or <ip_addr> key <dnsview_name>; .", + "type": "string" + }, + "zone_name": { + "description": "The name of the DNS zone the object belongs to.", + "type": "string" + }, + "zone_name_utf": { + "description": "The name of the DNS zone the resource record belongs to, in UTF-8 format.", + "type": "string" + }, + "zone_space_name": { + "description": "The name of the space associated with the DNS zone the RR belongs to.", + "type": "string" + }, + "zone_sort_zone": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "zone_type": { + "description": "The type of the DNS zone the object belongs to, either master, slave, forward, stub, hint or delegation-only.", + "type": "string" + }, + "rr_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                                                                                                                              Multi-status severity levels
                                                                                                                                                                                                                                              Message number Severity Description
                                                                                                                                                                                                                                              0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                                                                                                                              17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                                                                                                                              34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                                                                                                                              51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                                                                                                                              67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                                                                                                                              84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "rr_all_value": { + "description": "The concatenated values of the DNS resource record, as follows: <value1>, <value2>, <value3>, <value4>, <value5>, <value6>, <value7>.", + "type": "string" + }, + "rr_auth_gsstsig": { + "description": "A way to determine if the record was authenticated via dynamic update (GSS-TSIG) 1, or not 0.", + "type": "string" + }, + "rr_class_name": { + "description": "The name of the class applied to the resource record, it can be preceded by the class directory.", + "type": "string" + }, + "rr_class_parameters": { + "description": "The class parameters applied to the DNS rr the object belongs to and their value", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "rr_full_name": { + "description": "The full name of the DNS resource record.", + "type": "string" + }, + "rr_full_name_utf": { + "description": "The name of the DNS resource record in UTF-8 format.", + "type": "string" + }, + "rr_glue": { + "description": "The shortname of the DNS resource record.", + "type": "string" + }, + "rr_glue_id": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "rr_id": { + "description": "The database identifier (ID) of the DNS resource record.", + "type": "string" + }, + "rr_last_update_days": { + "description": "The number of days since the record was last updated.", + "type": "string" + }, + "rr_last_update_time": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "rr_name_id": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "rr_name_ip4_addr": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "rr_name_address_addr": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "rr_type": { + "description": "The type of the DNS resource record.


                                                                                                                                                                                                                                              rr_type possible values
                                                                                                                                                                                                                                              ValueRecord type description
                                                                                                                                                                                                                                              SOAStart of Authority. Defines the zone name, an email contact and various time and refresh values applicable to the zone. It is automatically generated upon creation of a zone and cannot be added manually.
                                                                                                                                                                                                                                              NSName Server. Defines the authoritative name server(s) for the domain (defined by the SOA record) or the subdomain. The NS record that indicates which server has authority over a zone is automatically generated upon the creation of a zone, once the server has been synchronized.
                                                                                                                                                                                                                                              AIPv4 Address. An IPv4 address for a host.
                                                                                                                                                                                                                                              PTRPointer Record. Address Resolution, from an IP address (IPv4 or IPv6) to a host. Used in reverse mapping.
                                                                                                                                                                                                                                              AAAAIPv6 Address. An IPv6 address for a host.
                                                                                                                                                                                                                                              CNAMECanonical Name. An alias name for a host.
                                                                                                                                                                                                                                              MXMail Exchange. The mail server/exchanger that services this zone.
                                                                                                                                                                                                                                              SRVServices record. Defines services available in the zone, for example, LDAP, HTTP, etc...
                                                                                                                                                                                                                                              DNAMEDelegation of Reverse Names. Delegation of reverse addresses primarily in IPv6. (Deprecated, use the CNAME RR instead)
                                                                                                                                                                                                                                              TXTText. Information associated with a name.
                                                                                                                                                                                                                                              DSDelegation Signer, a DNSSEC related RR used to verify the validity of the ZSK of a subdomain.
                                                                                                                                                                                                                                              DNSKEYDNS Key. It contains the public cryptographic key used to sign the zone with DNSSEC.
                                                                                                                                                                                                                                              65534A private type record automatically added to the zone once it is signed with DNSSEC.
                                                                                                                                                                                                                                              HINFOSystem Information. Information about a host: hardware type and operating system description.
                                                                                                                                                                                                                                              MINFOMailbox mail list Information. Defines the mail administrator for a mail list and optionally a mailbox to receive error messages relating to the mail list.
                                                                                                                                                                                                                                              AFSDBAFS Database. Location of the AFS servers.
                                                                                                                                                                                                                                              WKSWell-Known Service. Defines the services and protocols supported by a host. (Deprecated, use the SRV RR instead)
                                                                                                                                                                                                                                              NAPTRNaming Authority Pointer Record. General purpose definition of rule set to be used by applications e.g. VoIP.
                                                                                                                                                                                                                                              NSAPNetwork Service Access Point. Defines record (equivalent of an A record) maps a host name to an endpoint address.


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "rr_type_id": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "rr_value_id": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "rr_value_ip4_addr": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "rr_value_address_addr": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "rr_ttl": { + "description": "The time to live of the DNS resource record, in seconds.", + "type": "string" + }, + "rr_value1": { + "description": "The first or only value required for the DNS resource record, as detailed in the service description.", + "type": "string" + }, + "rr_value2": { + "description": "The second value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value3": { + "description": "The third value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value4": { + "description": "The fourth value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value5": { + "description": "The fifth value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value6": { + "description": "The sixth value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value7": { + "description": "The seventh value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DNS smart architecture managing the DNS server the object belongs to. 0 indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_name": { + "description": "The name of the DNS smart architecture managing the DNS server the object belongs to. # indicates that the server the object belongs to is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + } + }, + "title": "_data_inner_dns_rr_data", + "type": "object" + }, + "ApiMessageEntry": { + "example": { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + "properties": { + "code": { + "format": "int32", + "type": "integer" + }, + "msg": { + "type": "string" + }, + "type": { + "enum": [ + "error", + "warning", + "notice" + ], + "type": "string" + }, + "extras": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "type": "object" + }, + "dns_viewparam_delete_success": { + "example": { + "data": [ + { + "viewparam_id": "viewparam_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dns_viewparam_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dns_server_data": { + "example": { + "server_ipm_protocol": "server_ipm_protocol", + "server_aws_role_arn": "server_aws_role_arn", + "server_stat_enabled": "server_stat_enabled", + "server_dnssec_validation": "server_dnssec_validation", + "server_ipm_type": "server_ipm_type", + "server_stat_time": "server_stat_time", + "server_gss_keytab_id": "server_gss_keytab_id", + "server_ldap_domain": "server_ldap_domain", + "server_version": "server_version", + "server_stat_niceness": "server_stat_niceness", + "server_recursion": "server_recursion", + "server_multistatus": "server_multistatus", + "smart_parent_name": "smart_parent_name", + "server_allow_recursion": "server_allow_recursion", + "server_az_tenantid": "server_az_tenantid", + "server_key_name": "server_key_name", + "server_aws_use_role": "server_aws_use_role", + "server_key_proto": "server_key_proto", + "server_also_notify": "server_also_notify", + "server_allow_query_cache": "server_allow_query_cache", + "server_notify": "server_notify", + "server_rpz_max_policy_ttl": "server_rpz_max_policy_ttl", + "server_stat_period": "server_stat_period", + "server_aws_role_external_id": "server_aws_role_external_id", + "server_id": "server_id", + "server_addr": "server_addr", + "server_hostaddr": "server_hostaddr", + "server_addr6": "server_addr6", + "server_rpz_qname_wait_recurse": "server_rpz_qname_wait_recurse", + "server_gslb_supported": "server_gslb_supported", + "server_vpc_list": "server_vpc_list", + "server_forward": "server_forward", + "server_aws_role_session_name": "server_aws_role_session_name", + "connectionprofile_name": "connectionprofile_name", + "server_role": "server_role", + "reverse_proxy_conf": "reverse_proxy_conf", + "server_aws_delegation_set": "server_aws_delegation_set", + "server_querylog_state": "server_querylog_state", + "server_name": "server_name", + "smart_parent_arch": "smart_parent_arch", + "server_gss_enabled": "server_gss_enabled", + "server_class_name": "server_class_name", + "server_guardian_stats_only_supported": "server_guardian_stats_only_supported", + "server_forwarders": "server_forwarders", + "server_hybrid": "server_hybrid", + "server_guardian_gui_management_supported": "server_guardian_gui_management_supported", + "server_rpz_break_dnssec": "server_rpz_break_dnssec", + "smart_parent_id": "smart_parent_id", + "server_blast_status": "server_blast_status", + "server_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server_ipm_is_package": "server_ipm_is_package", + "smart_arch": "smart_arch", + "server_aws_keyid": "server_aws_keyid", + "server_rpz_min_ns_dots": "server_rpz_min_ns_dots", + "server_ipm_login": "server_ipm_login", + "server_az_group": "server_az_group", + "server_state": "server_state", + "server_cloud": "server_cloud", + "server_cloud_private": "server_cloud_private", + "server_blast_enabled": "server_blast_enabled", + "server_az_subscriptionid": "server_az_subscriptionid", + "server_comment": "server_comment", + "server_synching": "server_synching", + "total_smart_members": "total_smart_members", + "server_isolated": "server_isolated", + "server_windns_port": "server_windns_port", + "server_az_keyid": "server_az_keyid", + "server_force_hybrid": "server_force_hybrid", + "smart_public_ns_list": "smart_public_ns_list", + "server_key_value": "server_key_value", + "server_snmp_id": "server_snmp_id", + "server_rpz_recursive_only": "server_rpz_recursive_only", + "smart_members_name": "smart_members_name", + "server_allow_query": "server_allow_query", + "server_ldap_user": "server_ldap_user", + "server_guardian_push_status": "server_guardian_push_status", + "server_guardian_supported": "server_guardian_supported", + "server_windns_protocol": "server_windns_protocol", + "server_allow_transfer": "server_allow_transfer", + "server_windns_use_ssl": "server_windns_use_ssl", + "server_type": "server_type" + }, + "properties": { + "server_aws_delegation_set": { + "description": "The reusable delegation set ID configured on the Amazon Route 53 public server.", + "type": "string" + }, + "server_aws_keyid": { + "description": "The AWS access key identifier (ID) of the DNS server.", + "type": "string" + }, + "server_aws_role_arn": { + "description": "The Amazon Resource Name (ARN) of the role used for the Amazon Route 53 DNS server.", + "type": "string" + }, + "server_aws_role_external_id": { + "description": "The external ID of the role used for the Amazon Route 53 DNS server.", + "type": "string" + }, + "server_aws_role_session_name": { + "description": "The session name of the role used for the Amazon Route 53 DNS server.", + "type": "string" + }, + "server_aws_use_role": { + "description": "The configuration of the option Use a role of the Amazon Route 53 DNS server, either enabled (1) or not (0). If enabled, the role can rely on ARN, an external ID or a session.", + "type": "string" + }, + "server_az_group": { + "description": "For Microsoft Azure servers, the resource group of the DNS server.", + "type": "string" + }, + "server_az_keyid": { + "description": "For Microsoft Azure servers, the Azure Application ID of the DNS server.", + "type": "string" + }, + "server_az_subscriptionid": { + "description": "For Microsoft Azure servers, the subscription ID of the DNS server.", + "type": "string" + }, + "server_az_tenantid": { + "description": "For Microsoft Azure servers, the tenant ID of the DNS server.", + "type": "string" + }, + "connectionprofile_name": { + "description": "The name of the connection profile used as connection method for the DNS server.", + "type": "string" + }, + "server_allow_query": { + "description": "The ACL values associated with the allow-query configuration of the DNS server, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "server_allow_query_cache": { + "description": "The ACL values associated with the allow-query-cache configuration of the DNS server, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "server_allow_recursion": { + "description": "The ACL values associated with the allow-recursion configuration of the DNS server, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "server_allow_transfer": { + "description": "The ACL values associated with the allow-transfer configuration of the DNS server, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "server_also_notify": { + "description": "The IP address and port of the DNS server managing the smart architecture. If the parameter server_notify is set to yes or explicit, the server specified is instantly notified of any slave zones updates.", + "type": "string" + }, + "server_class_name": { + "description": "The name of the class applied to the DNS server, it can be preceded by the class directory.", + "type": "string" + }, + "server_class_parameters": { + "description": "The class parameters applied to the DNS server.", + "items": { + "$ref": "#/components/schemas/ApiClassParameterOutputEntry" + }, + "type": "array" + }, + "server_cloud": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_cloud_private": { + "description": "The type of the DNS Amazon Route 53 or Azure server, either Public (0) or Private (1). If the server is not a cloud server, 0 is returned.", + "type": "string" + }, + "server_comment": { + "description": "The description of the DNS server.", + "type": "string" + }, + "server_force_hybrid": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_forward": { + "description": "The forwarding mode of the DNS server. No value indicates that the forwarding is disabled:


                                                                                                                                                                                                                                              server_forward possible values
                                                                                                                                                                                                                                              StatusDescription
                                                                                                                                                                                                                                              firstThe server sends the queries to the forwarder(s). If no answer is returned, it attempts to answer the queries on its own.
                                                                                                                                                                                                                                              onlyThe server only forwards the queries to the forwarder(s). Required by some reverse forward zones (e.g., in the case of private addresses).


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "server_forwarders": { + "description": "The IP address(es) of the forwarder(s) associated with the DNS server. It lists the DNS servers to which any unknown zone should be sent, as follows: <ip_address1>;<ip_address2>;... .", + "type": "string" + }, + "server_hybrid": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server.", + "type": "string" + }, + "server_key_name": { + "description": "The name of the DNS TSIG key associated with the DNS server.", + "type": "string" + }, + "server_key_proto": { + "description": "The encryption protocol of the TSIG key associated with the DNS server.", + "type": "string" + }, + "server_key_value": { + "description": "The value of the TSIG key associated with the DNS server.", + "type": "string" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "server_notify": { + "description": "The notify status of the DNS server:


                                                                                                                                                                                                                                              server_notify possible values
                                                                                                                                                                                                                                              StatusDescription
                                                                                                                                                                                                                                              noNo notify message is sent when changes are performed in the master zones.
                                                                                                                                                                                                                                              yesThe notify messages are sent to the target of the NS records of the master zone. They are also sent to the IP address(es) specified in the parameter .
                                                                                                                                                                                                                                              explicitThe notify messages are only sent to the IP address(es) specified in the parameter .


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "server_recursion": { + "description": "The recursion status of the DNS server:


                                                                                                                                                                                                                                              server_recursion possible values
                                                                                                                                                                                                                                              StatusDescription
                                                                                                                                                                                                                                              noThe server only provides iterative query behavior - normally resulting in a referral. If the answer to the query already exists in the cache it will be returned whatever the value of this statement.
                                                                                                                                                                                                                                              yesThe server always provides recursive query behavior if requested by the client.


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "server_role": { + "description": "The role of the DNS server in the smart architecture, either master, hidden-master, pseudo-master or slave.", + "type": "string" + }, + "server_rpz_break_dnssec": { + "description": "The configuration of the option Enable break-dnssec on the server. It applies to the RPZ zones of the server, if it is not set at zone level. By default it is set to 0 (no), if set to 1 (yes) the server processes policies on all DNSSEC queries.", + "type": "string" + }, + "server_rpz_max_policy_ttl": { + "description": "The configuration of the option Server max policy TTL, i.e. the number of seconds of the max policy Time To Live of the server. It applies to the RPZ zones of the server, if it is not set at zone level. By default it is empty, i.e. set to 5 seconds.", + "type": "string" + }, + "server_rpz_min_ns_dots": { + "description": "The configuration of the option Server minimum dot separatorsof the server, i.e. the minimum number of dot separators required in any QNAME to process policies. It applies to the RPZ zones of the server, if it is not set at zone level. By default it is empty, i.e. set to 1.", + "type": "string" + }, + "server_rpz_qname_wait_recurse": { + "description": "The configuration of the option Enable qname-wait-recurse on the server. It applies to the RPZ zones of the server, if it is not set at zone level. By default it is set to 0 (no), if set to 1 (yes) the server only process policies when the results of any query are available.", + "type": "string" + }, + "server_rpz_recursive_only": { + "description": "The configuration of the option Enable recursive-only on the server. It applies to the RPZ zones of the server, if it is not set at zone level. By default it is set to 1 (yes), the server only processes policies on recursive queries.", + "type": "string" + }, + "server_state": { + "description": "The status of the DNS server:


                                                                                                                                                                                                                                              server_state possible values
                                                                                                                                                                                                                                              StatusDescription
                                                                                                                                                                                                                                              ERThe license used in SOLIDserver is not compliant with the added server: the license is invalid.
                                                                                                                                                                                                                                              ESThe server configuration could not be parsed properly.
                                                                                                                                                                                                                                              ETThe server does not answer anymore due to a scheduled configuration of the server.
                                                                                                                                                                                                                                              ICThe SSL credentials are invalid
                                                                                                                                                                                                                                              IPThe account used to add the Microsoft Windows DNS server does not have sufficient privileges to manage it.
                                                                                                                                                                                                                                              IRSOLIDserver cannot resolve the AWS DNS service. The Amazon services are unreachable and the Amazon Route 53 server cannot be managed. Make sure that the DNS resolvers declared on the page are valid.
                                                                                                                                                                                                                                              ISThere was a setting error during the server declaration. For instance, some settings were added to a server that does not support them or a smart architecture is not managing any physical server.
                                                                                                                                                                                                                                              ITThe server editing performed from the GUI is not pushed to the server because SOLIDserver time and date are incorrect. You must use the UTC system on the appliance, especially when managing Amazon Route 53 servers.
                                                                                                                                                                                                                                              LSThe server configuration is not viable.
                                                                                                                                                                                                                                              NThe server does not have a status as it has not synchronized yet.
                                                                                                                                                                                                                                              UEAn error occurred that SOLIDserver could not identify.
                                                                                                                                                                                                                                              YThe server is operational.


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "server_synching": { + "description": "The synchronization status of the DNS server. 1 indicates that the server is currently being synchronized.", + "type": "string" + }, + "server_type": { + "description": "The type of the DNS server:


                                                                                                                                                                                                                                              server_type possible values
                                                                                                                                                                                                                                              TypeDescription
                                                                                                                                                                                                                                              ipmEfficientIP or EfficientIP Package server
                                                                                                                                                                                                                                              msdaemonMicrosoft Windows DNS server
                                                                                                                                                                                                                                              awsAmazon Route 53 server
                                                                                                                                                                                                                                              otherGeneric DNS server
                                                                                                                                                                                                                                              vdnsEfficientIP DNS smart architecture


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "server_version": { + "description": "The version details of the DNS server.", + "type": "string" + }, + "server_vpc_list": { + "description": "The list of cloud networks configured on the DNS private server, separated by a comma:
                                                                                                                                                                                                                                              • For an Azure server, it returns the list of virtual networks.
                                                                                                                                                                                                                                              • For an Amazon Route 53 server, it returns the list of Virtual Private Cloud (VPC).
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "server_blast_enabled": { + "description": "The status of the service DNS Guardian, either enabled (1) or disabled (0).", + "type": "string" + }, + "server_guardian_push_status": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_blast_status": { + "description": "The status of the Guardian server, either OK (1), Stopped (2), Invalid Credentials (4) or Timeout (5).", + "type": "string" + }, + "server_gslb_supported": { + "description": "The license GSLB activation status. 1 indicates your license includes GSLB and your appliance supports it.", + "type": "string" + }, + "server_guardian_gui_management_supported": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_guardian_supported": { + "description": "The license Guardian activation status. 1 indicates your license includes Guardian and your appliance supports its latest features.", + "type": "string" + }, + "server_dnssec_validation": { + "description": "The DNSSEC resolution status of the DNS server. yes indicates it is enabled.", + "type": "string" + }, + "server_gss_enabled": { + "description": "The GSS-TSIG status of the DNS server. 1 indicates that GSS-TSIG is enabled on the server.", + "type": "string" + }, + "server_gss_keytab_id": { + "description": "The database identifier (ID) of the DNS GSS-TSIG keytab.", + "type": "string" + }, + "server_guardian_stats_only_supported": { + "description": "A way to determine if the server only retrieves Guardian statistics (1) or not (0). On appliances where the service DNS Guardian / GSLB server is not configured, the server cannot be configured with Guardian options, it can only retrieve statistics.", + "type": "string" + }, + "server_hostaddr": { + "description": "The human readable version of the parameter server_addr or server_addr6.", + "type": "string" + }, + "server_addr6": { + "description": "The IPv6 address of the DNS server, in hexadecimal format.", + "type": "string" + }, + "server_addr": { + "description": "The IPv4 address of the DNS server, in hexadecimal format.", + "type": "string" + }, + "server_ipm_login": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_ipm_is_package": { + "description": "The DNS server package information. Y for an EfficientIP Package server, N for an appliance or virtual machine, U the package information is irrelevant. For servers with a server_type set to ipm, U indicates either EfficientIP Packages or appliances/virtual machines.", + "type": "string" + }, + "server_ipm_protocol": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_ipm_type": { + "description": "The engine type of the DNS server: named (BIND engine), nsd (NSD engine) or unbound (Unbound engine).", + "type": "string" + }, + "server_isolated": { + "description": "A way to determine if the server can update any other module (1).", + "type": "string" + }, + "server_ldap_domain": { + "description": "For Microsoft Windows servers, the domain of the DNS server.", + "type": "string" + }, + "server_ldap_user": { + "description": "For Microsoft Windows servers, the login of the user communicating with the DNS server.", + "type": "string" + }, + "server_multistatus": { + "description": "The Multi-status information is displayed as follows: <number-of-instances>@<message-number>@<multi-status-severity>@<module>. The different severity levels are:
                                                                                                                                                                                                                                              Multi-status severity levels
                                                                                                                                                                                                                                              Message number Severity Description
                                                                                                                                                                                                                                              0 - 16 Emergency The object configuration prevents the system from running properly. Action is required.
                                                                                                                                                                                                                                              17 - 33 Critical The object configuration is in critical conditions. Immediate action is recommended.
                                                                                                                                                                                                                                              34 - 50 Error The object configuration failed at some level. Action is recommended.
                                                                                                                                                                                                                                              51 - 66 Warning The object configuration triggers error messages if no action is taken. Action to be taken at your discretion.
                                                                                                                                                                                                                                              67 - 83 Notice The object configuration is normal but undergoing events that might trigger errors. No immediate action required.
                                                                                                                                                                                                                                              84 - 100 Informational The object configuration is normal, operational messages (might inform you about potential incompatibilities with other modules, etc). No action required.
                                                                                                                                                                                                                                              ", + "type": "string" + }, + "server_querylog_state": { + "description": "The DNS querylog status. 1 indicates that the DNS server querylog is enabled.", + "type": "string" + }, + "reverse_proxy_conf": { + "description": "The URL of the HTTP(S) reverse proxy server that forwards client queries to the DNS server, if you configured one.", + "type": "string" + }, + "server_snmp_id": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_stat_enabled": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_stat_niceness": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_stat_period": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_stat_time": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "total_smart_members": { + "description": "The total number of servers managed by the DNS smart architecture.", + "type": "string" + }, + "smart_arch": { + "description": "The type of the DNS smart architecture:


                                                                                                                                                                                                                                              smart_arch possible values
                                                                                                                                                                                                                                              StatusDescription
                                                                                                                                                                                                                                              masterslaveMaster/Slave
                                                                                                                                                                                                                                              stealthStealth
                                                                                                                                                                                                                                              multimasterMulti-Master
                                                                                                                                                                                                                                              singleSingle-Server
                                                                                                                                                                                                                                              farmFarm


                                                                                                                                                                                                                                              ", + "type": "string" + }, + "smart_members_name": { + "description": "The list of the servers managed by the DNS smart architecture, as follows: <dns_name>,<dns_name>,... .", + "type": "string" + }, + "smart_parent_arch": { + "description": "The type of the DNS smart architecture managing the DNS server. No value indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_id": { + "description": "The database identifier (ID) of the DNS smart architecture managing the DNS server. 0 indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_parent_name": { + "description": "The name of the DNS smart architecture managing the DNS server. # indicates that the server is not managed by a smart architecture or is a smart architecture itself.", + "type": "string" + }, + "smart_public_ns_list": { + "description": "The list of the published name servers associated with the DNS smart architecture, as follows: <ns1>;<ns2>;... .", + "type": "string" + }, + "server_windns_port": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_windns_protocol": { + "description": "Internal use. Not documented.", + "type": "string" + }, + "server_windns_use_ssl": { + "description": "Internal use. Not documented.", + "type": "string" + } + }, + "title": "_data_inner_dns_server_data", + "type": "object" + }, + "dhcp_group6_data": { + "example": { + "data": [ + { + "server6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server6_version": "server6_version", + "server6_addr6": "server6_addr6", + "group6_name": "group6_name", + "server6_hostaddr": "server6_hostaddr", + "group6_multistatus": "group6_multistatus", + "group6_delayed_time": "group6_delayed_time", + "group6_id": "group6_id", + "server6_name": "server6_name", + "server6_addr": "server6_addr", + "smart_parent_id": "smart_parent_id", + "smart_parent_name": "smart_parent_name", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "server6_type": "server6_type", + "group6_class_name": "group6_class_name", + "group6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ] + }, + { + "server6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "server6_version": "server6_version", + "server6_addr6": "server6_addr6", + "group6_name": "group6_name", + "server6_hostaddr": "server6_hostaddr", + "group6_multistatus": "group6_multistatus", + "group6_delayed_time": "group6_delayed_time", + "group6_id": "group6_id", + "server6_name": "server6_name", + "server6_addr": "server6_addr", + "smart_parent_id": "smart_parent_id", + "smart_parent_name": "smart_parent_name", + "server6_class_name": "server6_class_name", + "server6_id": "server6_id", + "server6_type": "server6_type", + "group6_class_name": "group6_class_name", + "group6_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ] + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_dhcp_group6_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "vlan_domain_delete_success": { + "example": { + "data": [ + { + "domain_id": "domain_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_vlan_domain_delete_success" + }, + "maxItems": 1, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + }, + "ipam_space_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_space_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_alias6_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_ipam_alias6_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "_data_inner_dns_acl_data": { + "example": { + "acl_value": "acl_value", + "acl_name": "acl_name", + "acl_id": "acl_id", + "server_id": "server_id" + }, + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server the object belongs to.", + "type": "string" + }, + "acl_id": { + "description": "The database identifier (ID) of the DNS ACL.", + "type": "string" + }, + "acl_name": { + "description": "The name of the DNS ACL.", + "type": "string" + }, + "acl_value": { + "description": "The values of the DNS ACL in order of priority, as follows: <value_1>;<value_2>... .", + "type": "string" + } + }, + "title": "_data_inner_dns_acl_data", + "type": "object" + }, + "_data_inner_vlan_domain_edit_success": { + "example": { + "domain_id": "domain_id" + }, + "properties": { + "domain_id": { + "description": "The database identifier (ID) of the object you edited.", + "type": "string" + } + }, + "title": "_data_inner_vlan_domain_edit_success", + "type": "object" + }, + "_data_inner_ipam_alias6_delete_success": { + "example": { + "alias6_id": "alias6_id" + }, + "properties": { + "alias6_id": { + "description": "The database identifier (ID) of the object you deleted.", + "type": "string" + } + }, + "title": "_data_inner_ipam_alias6_delete_success", + "type": "object" + }, + "ipam_space_data": { + "example": { + "data": [ + { + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_name": "space_name", + "parent_space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_class_name": "space_class_name", + "space_is_template": "space_is_template", + "space_multistatus": "space_multistatus", + "parent_space_id": "parent_space_id", + "space_description": "space_description", + "parent_space_class_name": "parent_space_class_name", + "space_id": "space_id", + "parent_space_name": "parent_space_name" + }, + { + "space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_name": "space_name", + "parent_space_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_class_name": "space_class_name", + "space_is_template": "space_is_template", + "space_multistatus": "space_multistatus", + "parent_space_id": "parent_space_id", + "space_description": "space_description", + "parent_space_class_name": "parent_space_class_name", + "space_id": "space_id", + "parent_space_name": "parent_space_name" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_space_data" + }, + "type": "array" + } + }, + "type": "object" + }, + "dhcp_group_delete_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_dhcp_group_delete_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_address_edit_input": { + "properties": { + "address_hostaddr": { + "description": "The IP address.", + "type": "string" + }, + "address_id": { + "description": "The database identifier (ID) of the IPv4 address, a unique numeric key value automatically incremented when you add an IPv4 address. Use the ID to specify the IPv4 address of your choice.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "check_is_server_ip": { + "description": "A way to force a validity check, if you configured the IPAM to DHCP replication. If the check is enabled (1), the configuration of the IP address you are adding must be valid as well for the DHCP.", + "type": "integer" + }, + "static_id": { + "description": "The database identifier (ID) of the DHCP static you want to associate with the IP address.", + "type": "integer" + }, + "lease_id": { + "description": "The database identifier (ID) of the DHCP lease you want to associate with the IP address.", + "type": "integer" + }, + "device_id": { + "description": "The database identifier (ID) of the Device Manager device you want to associate with the IP address.", + "type": "integer" + }, + "interface_id": { + "description": "The database identifier (ID) of the Device Manager interface you want to associate with the IP address.", + "type": "integer" + }, + "port_id": { + "description": "The database identifier (ID) of the NetChange port you want to associate with the IP address.", + "type": "integer" + }, + "address_mac_addr": { + "description": "The MAC address you want to associate with the IPv4 address.", + "type": "string" + }, + "address_name": { + "description": "The name of the IPv4 address, each IPv4 address must have a unique name.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "address_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "address_class_parameters": { + "description": "class parameters in json format", + "items": { + "$ref": "#/components/schemas/ApiClassParameterInputEntry" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "vlan_domain_add_failed": { + "example": { + "data": [ + "{}", + "{}" + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "title": "_data_inner_vlan_domain_add_success", + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "ipam_alias_data": { + "example": { + "data": [ + { + "device_id": "device_id", + "address_addr": "address_addr", + "address_type": "address_type", + "static_id": "static_id", + "alias_id": "alias_id", + "address_id": "address_id", + "address_name": "address_name", + "alias_name": "alias_name", + "address_mac_addr": "address_mac_addr", + "pool_id": "pool_id", + "alias_type": "alias_type", + "network_id": "network_id", + "interface_id": "interface_id", + "address_class_name": "address_class_name", + "address_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_name": "space_name", + "space_class_name": "space_class_name", + "port_id": "port_id", + "space_id": "space_id", + "lease_id": "lease_id" + }, + { + "device_id": "device_id", + "address_addr": "address_addr", + "address_type": "address_type", + "static_id": "static_id", + "alias_id": "alias_id", + "address_id": "address_id", + "address_name": "address_name", + "alias_name": "alias_name", + "address_mac_addr": "address_mac_addr", + "pool_id": "pool_id", + "alias_type": "alias_type", + "network_id": "network_id", + "interface_id": "interface_id", + "address_class_name": "address_class_name", + "address_class_parameters": [ + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + }, + { + "propagation": "propagate", + "name": "name", + "inheritance": "set", + "source": "source", + "value": "value" + } + ], + "space_name": "space_name", + "space_class_name": "space_class_name", + "port_id": "port_id", + "space_id": "space_id", + "lease_id": "lease_id" + } + ], + "success": true, + "messages": [ + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + }, + { + "msg": "msg", + "code": 0, + "extras": { + "key": "extras" + }, + "type": "error" + } + ] + }, + "properties": { + "success": { + "description": "state true/false indicate if action succeed", + "type": "boolean" + }, + "messages": { + "description": "List or notice/warning/error messages", + "items": { + "$ref": "#/components/schemas/ApiMessageEntry" + }, + "type": "array" + }, + "data": { + "items": { + "$ref": "#/components/schemas/_data_inner_ipam_alias_data" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "securitySchemes": { + "BasicAuth": { + "type": "http", + "scheme": "basic" + } + } + } +} \ No newline at end of file diff --git a/EfficientIP/SOLIDserver/README.md b/EfficientIP/SOLIDserver/README.md new file mode 100644 index 0000000..1aec690 --- /dev/null +++ b/EfficientIP/SOLIDserver/README.md @@ -0,0 +1,102 @@ +EfficientIP SOLIDserver is a DDI (DNS-DHCP-IPAM) management platform, providing unified management of DNS zones and records, DHCP scopes and leases, and IP address space (IPv4 and IPv6) alongside VLAN management. + +This project provides OpenAPI specs for automating against SOLIDserver's REST API via an Integration Model, plus a Studio Project of ready-to-import CRUD workflows built on that model. + +## Table of Contents + +- [Contents](#contents) +- [Requirements](#requirements) +- [Integration Configuration](#integration-configuration) +- [OpenAPIs](#openapis) + - [`efficientip_solidserver-latest.json`](#efficientip_solidserver-latestjson) + - [`efficientip_solidserver-2.0.json`](#efficientip_solidserver-20json) +- [Studio Projects](#studio-projects) + - [EfficientIP SOLIDserver Project](#efficientip-solidserver-project) + - [Folder Structure](#folder-structure) + - [Dependencies](#dependencies) + +## Contents + +| Asset | Description | +|---|---| +| [OpenAPIs/](./OpenAPIs/) | EfficientIP SOLIDserver API OpenAPI specs — curated `-latest` plus the full vendor spec | +| [Studio Projects/](./Studio%20Projects/) | Itential Platform project containing all 153 workflows in 4 folders | + +## Requirements + +| Requirement | Version | +|---|---| +| Itential Platform | 6.x | +| `EfficientIP SOLIDserver:latest` Integration Model | Required to build automation against the OpenAPI spec, and to run the Studio Project below | + +## Integration Configuration + +Import `efficientip_solidserver-latest.json` as an Integration Model in **Admin > Integrations**, then create an integration pointing at your SOLIDserver appliance. + +Authentication is HTTP Basic Auth, using the username/password of a SOLIDserver account. + +The instance's `authentication`/`server` properties should look like this once configured: + +```json +{ + "authentication": { + "BasicAuth": { + "username": "", + "password": "" + } + }, + "server": { + "protocol": "https", + "host": "", + "base_path": "/api/v2.0" + } +} +``` + +## OpenAPIs + +| Spec | Version | Operations | Description | +|---|---|---|---| +| [`efficientip_solidserver-latest.json`](./OpenAPIs/efficientip_solidserver-latest.json) | latest (curated) | 153 | Curated to DNS, DHCP, IPAM, and VLAN — see breakdown below | +| [`efficientip_solidserver-2.0.json`](./OpenAPIs/efficientip_solidserver-2.0.json) | 2.0 | 231 | Full spec for the EfficientIP SOLIDserver API, version 2.0 | + +### `efficientip_solidserver-latest.json` + +Built directly from EfficientIP's own official OpenAPI 3.0.2 spec (bundled with their official [`solidserver-go-client`](https://github.com/EfficientIP-Labs/solidserver-go-client)), curated to the core DDI categories. + +Resources included, by category: + +- **DNS**: ACLs, resource records, servers, views, view parameters, zones, zone parameters +- **DHCP**: ACLs, ACL entries, failover relationships, groups, leases, ranges, scopes, shared networks, static leases, servers (IPv4 and IPv6 for every object) +- **IPAM**: address space, networks, pools, addresses, aliases (IPv4 and IPv6) +- **VLAN**: domains, ranges, VLANs + +Excluded: Device Manager (physical device/port/link inventory), Application (load-balancing), and DNS Guardian (security policy) — all outside DDI automation scope. Within the kept categories, only "count" operations (return a count of matching objects, not needed for CRUD automation) were dropped — every other operation, including full IPv4/IPv6 parity, is included. + +A handful of resource names are prefixed with `EfficientIP` (e.g. `EfficientIP Create DNS View`) to avoid colliding with identically-named workflows already published for other products — workflow names are unique across the whole Itential Platform instance, not scoped per-project. + +### `efficientip_solidserver-2.0.json` + +Full, unmodified vendor spec for the EfficientIP SOLIDserver API, version 2.0 — the vendor's complete API surface (including Device Manager, Application, and DNS Guardian), preserved as-is. See `efficientip_solidserver-latest.json` above for the curated subset if you just need common DDI automation. + +## Studio Projects + +### EfficientIP SOLIDserver Project + +Backed by the **`EfficientIP SOLIDserver:latest`** Integration Model (see [`efficientip_solidserver-latest.json`](./OpenAPIs/efficientip_solidserver-latest.json) above). The project contains **153 workflows** organized into **4 folders**. + +#### Folder Structure + +| Folder | Workflows | Scope | +|---|---|---| +| DHCP | 63 | ACLs, ACL entries, failover, groups, leases, ranges, scopes, shared networks, static leases, servers | +| IPAM | 43 | Address space, networks, pools, addresses, aliases | +| DNS | 32 | ACLs, resource records, servers, views, view/zone parameters, zones | +| VLAN | 15 | Domains, ranges, VLANs | + +#### Dependencies + +| Dependency | Notes | +|---|---| +| `EfficientIP SOLIDserver:latest` Integration Model | Import from [`efficientip_solidserver-latest.json`](./OpenAPIs/efficientip_solidserver-latest.json) before importing the project | +| `EfficientIP SOLIDserver` integration instance | Create in **Admin > Integrations** with the connection properties above. Workflows are wired to an integration instance named `EfficientIP SOLIDserver` — update the `adapter_id` value in each workflow task if yours is named differently | diff --git a/EfficientIP/SOLIDserver/Studio Projects/EfficientIP SOLIDserver.project.json b/EfficientIP/SOLIDserver/Studio Projects/EfficientIP SOLIDserver.project.json new file mode 100644 index 0000000..a87811e --- /dev/null +++ b/EfficientIP/SOLIDserver/Studio Projects/EfficientIP SOLIDserver.project.json @@ -0,0 +1,31669 @@ +{ + "_id": "6a8daf03a0c83fce206f95aa", + "name": "EfficientIP SOLIDserver", + "description": "DNS, DHCP, IPAM, and VLAN workflows backed by the EfficientIP SOLIDserver Integration Model.", + "components": [ + { + "iid": 0, + "reference": "771a1457-1d07-4ff4-a85f-0c1117cc7b13", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Get DHCP ACL", + "description": "Get DHCP ACL", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_acl_info", + "canvasName": "dhcp_acl_info", + "summary": "dhcp_acl_info", + "description": "dhcp_acl_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "acl_id": "$var.job.acl_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "acl_id": { + "type": "integer" + } + }, + "required": [ + "acl_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "acl_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "7ef36aff-cea8-41c8-8a32-a1f7e90ec083", + "created": "2026-08-25T15:03:59.157Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 1, + "reference": "477491d1-75ff-421f-800e-337fe076ab98", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "List DHCP ACLs", + "description": "List DHCP ACLs", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_acl_list", + "canvasName": "dhcp_acl_list", + "summary": "dhcp_acl_list", + "description": "dhcp_acl_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "38bbe457-b977-46ab-8986-af49ddbbf44d", + "created": "2026-08-25T15:03:59.239Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 2, + "reference": "b3df00a9-f726-4eae-8735-b5c0bb4234c5", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Get DHCP IPv6 ACL", + "description": "Get DHCP IPv6 ACL", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_acl6_info", + "canvasName": "dhcp_acl6_info", + "summary": "dhcp_acl6_info", + "description": "dhcp_acl6_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "acl6_id": "$var.job.acl6_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "acl6_id": { + "type": "integer" + } + }, + "required": [ + "acl6_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "acl6_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "ce43432d-4580-4814-b90c-302cf34c7d18", + "created": "2026-08-25T15:03:59.299Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 3, + "reference": "d8e0b648-5d47-4517-accf-4f9d0417f3c3", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "List DHCP IPv6 ACLs", + "description": "List DHCP IPv6 ACLs", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_acl6_list", + "canvasName": "dhcp_acl6_list", + "summary": "dhcp_acl6_list", + "description": "dhcp_acl6_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "b828da90-c7aa-4d3c-b94d-0654264b1738", + "created": "2026-08-25T15:03:59.351Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 4, + "reference": "6dfc75b5-b478-473b-99b1-0654ae6d17e3", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Get DHCP ACL Entry", + "description": "Get DHCP ACL Entry", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_aclentry_info", + "canvasName": "dhcp_aclentry_info", + "summary": "dhcp_aclentry_info", + "description": "dhcp_aclentry_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "aclentry_id": "$var.job.aclentry_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "aclentry_id": { + "type": "integer" + } + }, + "required": [ + "aclentry_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "aclentry_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "84f444cc-e708-446f-80b4-2e00a743ee67", + "created": "2026-08-25T15:03:59.394Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 5, + "reference": "84e00665-aeed-4348-9856-912cd0b5989c", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "List DHCP ACL Entries", + "description": "List DHCP ACL Entries", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_aclentry_list", + "canvasName": "dhcp_aclentry_list", + "summary": "dhcp_aclentry_list", + "description": "dhcp_aclentry_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "0ecc1e7e-81c8-435f-b83e-5c5f7fec4561", + "created": "2026-08-25T15:03:59.435Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 6, + "reference": "fbd4fe62-cf1f-4fb3-9638-7a88a95cd7da", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Get DHCP IPv6 ACL Entry", + "description": "Get DHCP IPv6 ACL Entry", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_aclentry6_info", + "canvasName": "dhcp_aclentry6_info", + "summary": "dhcp_aclentry6_info", + "description": "dhcp_aclentry6_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "aclentry6_id": "$var.job.aclentry6_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "aclentry6_id": { + "type": "integer" + } + }, + "required": [ + "aclentry6_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "aclentry6_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "2546860c-2432-49b9-b0cf-ef4ef79d5ef5", + "created": "2026-08-25T15:03:59.475Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 7, + "reference": "85de9729-de3f-4cf7-a910-d60204edf48b", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "List DHCP IPv6 ACL Entries", + "description": "List DHCP IPv6 ACL Entries", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_aclentry6_list", + "canvasName": "dhcp_aclentry6_list", + "summary": "dhcp_aclentry6_list", + "description": "dhcp_aclentry6_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "c279c8b5-5186-4fc4-9f94-7ad555967b65", + "created": "2026-08-25T15:03:59.510Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 8, + "reference": "fd81d1a7-1b6b-438a-82d4-2cdd9a96c7da", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Get DHCP Failover Relationship", + "description": "Get DHCP Failover Relationship", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_failover_info", + "canvasName": "dhcp_failover_info", + "summary": "dhcp_failover_info", + "description": "dhcp_failover_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "failover_id": "$var.job.failover_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "failover_id": { + "type": "integer" + } + }, + "required": [ + "failover_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "failover_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "23f505b3-5883-4b9b-80f0-3221ab100795", + "created": "2026-08-25T15:03:59.554Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 9, + "reference": "0e1323cb-9208-45f5-88c7-f0cd203f582d", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "List DHCP Failover Relationships", + "description": "List DHCP Failover Relationships", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_failover_list", + "canvasName": "dhcp_failover_list", + "summary": "dhcp_failover_list", + "description": "dhcp_failover_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "835686bc-8db1-4128-97c8-092ef32e34ac", + "created": "2026-08-25T15:03:59.596Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 10, + "reference": "18f7ad46-09a9-4a50-9b95-01d51ab2617f", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Create DHCP Group", + "description": "Create DHCP Group", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_group_add", + "canvasName": "dhcp_group_add", + "summary": "dhcp_group_add", + "description": "dhcp_group_add", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "group_name": { + "description": "The name of the DHCPv4 group, each DHCPv4 group must have a unique name.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "group_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "group_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "group_name": { + "description": "The name of the DHCPv4 group, each DHCPv4 group must have a unique name.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "group_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "group_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "4ace241e-708c-45e6-bd67-287538ae879b", + "created": "2026-08-25T15:03:59.639Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 11, + "reference": "1aae645a-d12e-4ea5-b318-49f39a406786", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Delete DHCP Group", + "description": "Delete DHCP Group", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_group_delete", + "canvasName": "dhcp_group_delete", + "summary": "dhcp_group_delete", + "description": "dhcp_group_delete", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "server_id": "$var.job.server_id", + "server_name": "$var.job.server_name", + "group_id": "$var.job.group_id", + "group_name": "$var.job.group_name", + "server_hostaddr": "$var.job.server_hostaddr", + "warnings": "$var.job.warnings" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "server_id": { + "type": "integer" + }, + "server_name": { + "type": "string" + }, + "group_id": { + "type": "integer" + }, + "group_name": { + "type": "string" + }, + "server_hostaddr": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + } + }, + "required": [ + "server_id", + "server_name", + "group_id", + "group_name", + "server_hostaddr", + "warnings" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "server_id": { + "type": "integer" + }, + "server_name": { + "type": "string" + }, + "group_id": { + "type": "integer" + }, + "group_name": { + "type": "string" + }, + "server_hostaddr": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "c6d1b532-3ecd-4915-9f6f-ea7a0ad16d71", + "created": "2026-08-25T15:03:59.677Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 12, + "reference": "1c166bcd-a503-4fea-a498-52187e2c8e48", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Update DHCP Group", + "description": "Update DHCP Group", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_group_edit", + "canvasName": "dhcp_group_edit", + "summary": "dhcp_group_edit", + "description": "dhcp_group_edit", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "group_id": { + "description": "The database identifier (ID) of the DHCPv4 group, a unique numeric key value automatically incremented when you add a DHCPv4 group. Use the ID to specify the DHCPv4 group of your choice.", + "type": "integer" + }, + "group_name": { + "description": "The name of the DHCPv4 group, each DHCPv4 group must have a unique name.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "group_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "group_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "group_id": { + "description": "The database identifier (ID) of the DHCPv4 group, a unique numeric key value automatically incremented when you add a DHCPv4 group. Use the ID to specify the DHCPv4 group of your choice.", + "type": "integer" + }, + "group_name": { + "description": "The name of the DHCPv4 group, each DHCPv4 group must have a unique name.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "group_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "group_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "18c864d3-e7ba-4277-a261-62723814b04e", + "created": "2026-08-25T15:03:59.711Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 13, + "reference": "0ea44f01-66aa-4924-b3bc-fffb14897f14", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Get DHCP Group", + "description": "Get DHCP Group", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_group_info", + "canvasName": "dhcp_group_info", + "summary": "dhcp_group_info", + "description": "dhcp_group_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "no_parent_class_param": "$var.job.no_parent_class_param", + "group_id": "$var.job.group_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "group_id": { + "type": "integer" + } + }, + "required": [ + "no_parent_class_param", + "group_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "group_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "e4a099cd-6b06-4134-ac5b-11f2b8d16401", + "created": "2026-08-25T15:03:59.750Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 14, + "reference": "1cf381da-8956-46e0-861e-d7c072856b31", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "List DHCP Groups", + "description": "List DHCP Groups", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_group_list", + "canvasName": "dhcp_group_list", + "summary": "dhcp_group_list", + "description": "dhcp_group_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset", + "no_parent_class_param": "$var.job.no_parent_class_param", + "tags": "$var.job.tags" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset", + "no_parent_class_param", + "tags" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "33cca7dd-c72c-41a8-8642-223e6affa1a9", + "created": "2026-08-25T15:03:59.785Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 15, + "reference": "08c69bbc-cea8-4955-95ef-aef6eccd8403", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "List DHCP IPv6 Groups", + "description": "List DHCP IPv6 Groups", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_group6_list", + "canvasName": "dhcp_group6_list", + "summary": "dhcp_group6_list", + "description": "dhcp_group6_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset", + "no_parent_class_param": "$var.job.no_parent_class_param", + "tags": "$var.job.tags" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset", + "no_parent_class_param", + "tags" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "e08d36d8-6f41-45c8-8c4e-e1f46e04f35f", + "created": "2026-08-25T15:03:59.819Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 16, + "reference": "bb156ca6-cd23-4699-b570-d087646f68cc", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Get DHCP Lease", + "description": "Get DHCP Lease", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_lease_info", + "canvasName": "dhcp_lease_info", + "summary": "dhcp_lease_info", + "description": "dhcp_lease_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "no_parent_class_param": "$var.job.no_parent_class_param", + "lease_id": "$var.job.lease_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "lease_id": { + "type": "integer" + } + }, + "required": [ + "no_parent_class_param", + "lease_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "lease_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "21742da9-bdc1-4b05-9d2a-984f7cb456a3", + "created": "2026-08-25T15:03:59.851Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 17, + "reference": "957b0f61-67f0-4306-82fe-58ea5f35aef6", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "List DHCP Leases", + "description": "List DHCP Leases", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_lease_list", + "canvasName": "dhcp_lease_list", + "summary": "dhcp_lease_list", + "description": "dhcp_lease_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset", + "no_parent_class_param": "$var.job.no_parent_class_param", + "tags": "$var.job.tags" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset", + "no_parent_class_param", + "tags" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "144d576a-cc32-4dee-a24b-e589df6a7449", + "created": "2026-08-25T15:03:59.886Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 18, + "reference": "8b6a848c-2eb3-4f01-ab7e-036bc7207b80", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "List DHCP IPv6 Leases", + "description": "List DHCP IPv6 Leases", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_lease6_list", + "canvasName": "dhcp_lease6_list", + "summary": "dhcp_lease6_list", + "description": "dhcp_lease6_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset", + "no_parent_class_param": "$var.job.no_parent_class_param", + "tags": "$var.job.tags" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset", + "no_parent_class_param", + "tags" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "5ba89578-a602-40a7-84b7-e469511135fd", + "created": "2026-08-25T15:03:59.915Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 19, + "reference": "373bce15-25e5-45f7-9692-04b79c9bd599", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Create DHCP Range", + "description": "Create DHCP Range", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_range_add", + "canvasName": "dhcp_range_add", + "summary": "dhcp_range_add", + "description": "dhcp_range_add", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "range_end_addr": { + "description": "The last IP address of the DHCPv4 range.", + "type": "string" + }, + "range_start_addr": { + "description": "The first IP address of the DHCPv4 range.", + "type": "string" + }, + "scope_id": { + "description": "The database identifier (ID) of the DHCPv4 scope, a unique numeric key value automatically incremented when you add a DHCPv4 scope. Use the ID to specify the DHCPv4 scope of your choice.", + "type": "integer" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "range_acl": { + "description": "The list of ACLs associated with the DHCPv4 range, as follows: <ACL_name>;<ACL_name>;... .", + "type": "string" + }, + "range_name": { + "description": "The start and end IP address of the DHCPv4 range, as follows: <start-ip>-<end-ip>.", + "type": "string" + }, + "scope_name": { + "description": "The name of the DHCPv4 scope.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "range_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "range_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "range_end_addr": { + "description": "The last IP address of the DHCPv4 range.", + "type": "string" + }, + "range_start_addr": { + "description": "The first IP address of the DHCPv4 range.", + "type": "string" + }, + "scope_id": { + "description": "The database identifier (ID) of the DHCPv4 scope, a unique numeric key value automatically incremented when you add a DHCPv4 scope. Use the ID to specify the DHCPv4 scope of your choice.", + "type": "integer" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "range_acl": { + "description": "The list of ACLs associated with the DHCPv4 range, as follows: <ACL_name>;<ACL_name>;... .", + "type": "string" + }, + "range_name": { + "description": "The start and end IP address of the DHCPv4 range, as follows: <start-ip>-<end-ip>.", + "type": "string" + }, + "scope_name": { + "description": "The name of the DHCPv4 scope.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "range_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "range_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "f57ac75d-9295-4f70-9612-a7d0789c1419", + "created": "2026-08-25T15:03:59.949Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 20, + "reference": "9042ba53-5911-49f6-a62e-f50d52e0a3a7", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Delete DHCP Range", + "description": "Delete DHCP Range", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_range_delete", + "canvasName": "dhcp_range_delete", + "summary": "dhcp_range_delete", + "description": "dhcp_range_delete", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "server_id": "$var.job.server_id", + "server_name": "$var.job.server_name", + "range_end_addr": "$var.job.range_end_addr", + "range_id": "$var.job.range_id", + "range_name": "$var.job.range_name", + "range_start_addr": "$var.job.range_start_addr", + "scope_id": "$var.job.scope_id", + "server_hostaddr": "$var.job.server_hostaddr", + "warnings": "$var.job.warnings" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "server_id": { + "type": "integer" + }, + "server_name": { + "type": "string" + }, + "range_end_addr": { + "type": "string" + }, + "range_id": { + "type": "integer" + }, + "range_name": { + "type": "string" + }, + "range_start_addr": { + "type": "string" + }, + "scope_id": { + "type": "integer" + }, + "server_hostaddr": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + } + }, + "required": [ + "server_id", + "server_name", + "range_end_addr", + "range_id", + "range_name", + "range_start_addr", + "scope_id", + "server_hostaddr", + "warnings" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "server_id": { + "type": "integer" + }, + "server_name": { + "type": "string" + }, + "range_end_addr": { + "type": "string" + }, + "range_id": { + "type": "integer" + }, + "range_name": { + "type": "string" + }, + "range_start_addr": { + "type": "string" + }, + "scope_id": { + "type": "integer" + }, + "server_hostaddr": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "f07c784d-934f-4ed0-9c0e-ea4d95ed7d6b", + "created": "2026-08-25T15:03:59.999Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 21, + "reference": "37b9d1a7-8bae-4742-bc6f-8decf6be7582", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Update DHCP Range", + "description": "Update DHCP Range", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_range_edit", + "canvasName": "dhcp_range_edit", + "summary": "dhcp_range_edit", + "description": "dhcp_range_edit", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "range_end_addr": { + "description": "The last IP address of the DHCPv4 range.", + "type": "string" + }, + "range_id": { + "description": "The database identifier (ID) of the DHCPv4 range, a unique numeric key value automatically incremented when you add a DHCPv4 range. Use the ID to specify the DHCPv4 range of your choice.", + "type": "integer" + }, + "range_start_addr": { + "description": "The first IP address of the DHCPv4 range.", + "type": "string" + }, + "scope_id": { + "description": "The database identifier (ID) of the DHCPv4 scope, a unique numeric key value automatically incremented when you add a DHCPv4 scope. Use the ID to specify the DHCPv4 scope of your choice.", + "type": "integer" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "range_acl": { + "description": "The list of ACLs associated with the DHCPv4 range, as follows: <ACL_name>;<ACL_name>;... .", + "type": "string" + }, + "range_name": { + "description": "The start and end IP address of the DHCPv4 range, as follows: <start-ip>-<end-ip>.", + "type": "string" + }, + "scope_name": { + "description": "The name of the DHCPv4 scope.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "range_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "range_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "range_end_addr": { + "description": "The last IP address of the DHCPv4 range.", + "type": "string" + }, + "range_id": { + "description": "The database identifier (ID) of the DHCPv4 range, a unique numeric key value automatically incremented when you add a DHCPv4 range. Use the ID to specify the DHCPv4 range of your choice.", + "type": "integer" + }, + "range_start_addr": { + "description": "The first IP address of the DHCPv4 range.", + "type": "string" + }, + "scope_id": { + "description": "The database identifier (ID) of the DHCPv4 scope, a unique numeric key value automatically incremented when you add a DHCPv4 scope. Use the ID to specify the DHCPv4 scope of your choice.", + "type": "integer" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "range_acl": { + "description": "The list of ACLs associated with the DHCPv4 range, as follows: <ACL_name>;<ACL_name>;... .", + "type": "string" + }, + "range_name": { + "description": "The start and end IP address of the DHCPv4 range, as follows: <start-ip>-<end-ip>.", + "type": "string" + }, + "scope_name": { + "description": "The name of the DHCPv4 scope.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "range_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "range_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "5a2c4512-1991-4285-b739-83247c7f8c7a", + "created": "2026-08-25T15:04:00.034Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 22, + "reference": "07269982-2c85-46dd-89da-10c569526480", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Get DHCP Range", + "description": "Get DHCP Range", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_range_info", + "canvasName": "dhcp_range_info", + "summary": "dhcp_range_info", + "description": "dhcp_range_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "no_parent_class_param": "$var.job.no_parent_class_param", + "range_id": "$var.job.range_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "range_id": { + "type": "integer" + } + }, + "required": [ + "no_parent_class_param", + "range_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "range_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "131dba07-4b22-4cd4-80e4-9f8eba8c5a19", + "created": "2026-08-25T15:04:00.062Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 23, + "reference": "d9dffd1f-e2d1-48ef-ab7c-8028b334c2d8", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "List DHCP Ranges", + "description": "List DHCP Ranges", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_range_list", + "canvasName": "dhcp_range_list", + "summary": "dhcp_range_list", + "description": "dhcp_range_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset", + "no_parent_class_param": "$var.job.no_parent_class_param", + "tags": "$var.job.tags" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset", + "no_parent_class_param", + "tags" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "8f90212b-7037-43be-a6a1-432210bd9767", + "created": "2026-08-25T15:04:00.099Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 24, + "reference": "1615353a-3578-499b-8d94-b514ac9f22bb", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Create DHCP IPv6 Range", + "description": "Create DHCP IPv6 Range", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_range6_add", + "canvasName": "dhcp_range6_add", + "summary": "dhcp_range6_add", + "description": "dhcp_range6_add", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "type": "integer" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "range6_end_addr": { + "description": "The last IP address of the DHCPv6 range.", + "type": "string" + }, + "range6_start_addr": { + "description": "The first IP address of the DHCPv6 range.", + "type": "string" + }, + "scope6_id": { + "description": "The database identifier (ID) of the DHCPv6 scope, a unique numeric key value automatically incremented when you add a DHCPv6 scope. Use the ID to specify the DHCPv6 scope of your choice.", + "type": "integer" + }, + "server6_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "range6_acl": { + "description": "The list of ACLs associated with the DHCPv6 range, as follows: <ACL_name>;<ACL_name>;... .", + "type": "string" + }, + "scope6_name": { + "description": "The name of the DHCPv6 scope.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "range6_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "range6_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "type": "integer" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "range6_end_addr": { + "description": "The last IP address of the DHCPv6 range.", + "type": "string" + }, + "range6_start_addr": { + "description": "The first IP address of the DHCPv6 range.", + "type": "string" + }, + "scope6_id": { + "description": "The database identifier (ID) of the DHCPv6 scope, a unique numeric key value automatically incremented when you add a DHCPv6 scope. Use the ID to specify the DHCPv6 scope of your choice.", + "type": "integer" + }, + "server6_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "range6_acl": { + "description": "The list of ACLs associated with the DHCPv6 range, as follows: <ACL_name>;<ACL_name>;... .", + "type": "string" + }, + "scope6_name": { + "description": "The name of the DHCPv6 scope.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "range6_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "range6_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "b0b27c69-1f93-4a55-adf6-8ca867903dcc", + "created": "2026-08-25T15:04:00.137Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 25, + "reference": "49e09bd8-210c-460a-b070-f04ead7d6716", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Delete DHCP IPv6 Range", + "description": "Delete DHCP IPv6 Range", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_range6_delete", + "canvasName": "dhcp_range6_delete", + "summary": "dhcp_range6_delete", + "description": "dhcp_range6_delete", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "server6_id": "$var.job.server6_id", + "server6_name": "$var.job.server6_name", + "range6_end_addr": "$var.job.range6_end_addr", + "range6_id": "$var.job.range6_id", + "range6_start_addr": "$var.job.range6_start_addr", + "scope6_id": "$var.job.scope6_id", + "server6_hostaddr": "$var.job.server6_hostaddr", + "warnings": "$var.job.warnings" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "server6_id": { + "type": "integer" + }, + "server6_name": { + "type": "string" + }, + "range6_end_addr": { + "type": "string" + }, + "range6_id": { + "type": "integer" + }, + "range6_start_addr": { + "type": "string" + }, + "scope6_id": { + "type": "integer" + }, + "server6_hostaddr": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + } + }, + "required": [ + "server6_id", + "server6_name", + "range6_end_addr", + "range6_id", + "range6_start_addr", + "scope6_id", + "server6_hostaddr", + "warnings" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "server6_id": { + "type": "integer" + }, + "server6_name": { + "type": "string" + }, + "range6_end_addr": { + "type": "string" + }, + "range6_id": { + "type": "integer" + }, + "range6_start_addr": { + "type": "string" + }, + "scope6_id": { + "type": "integer" + }, + "server6_hostaddr": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "48f9cdbb-77b8-439c-aade-1d25a233758e", + "created": "2026-08-25T15:04:00.168Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 26, + "reference": "e2281555-1c34-45c4-a4d2-6048a65e0751", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Update DHCP IPv6 Range", + "description": "Update DHCP IPv6 Range", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_range6_edit", + "canvasName": "dhcp_range6_edit", + "summary": "dhcp_range6_edit", + "description": "dhcp_range6_edit", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "type": "integer" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "range6_end_addr": { + "description": "The last IP address of the DHCPv6 range.", + "type": "string" + }, + "range6_id": { + "description": "The database identifier (ID) of the DHCPv6 range, a unique numeric key value automatically incremented when you add a DHCPv6 range. Use the ID to specify the DHCPv6 range of your choice.", + "type": "integer" + }, + "range6_start_addr": { + "description": "The first IP address of the DHCPv6 range.", + "type": "string" + }, + "scope6_id": { + "description": "The database identifier (ID) of the DHCPv6 scope, a unique numeric key value automatically incremented when you add a DHCPv6 scope. Use the ID to specify the DHCPv6 scope of your choice.", + "type": "integer" + }, + "server6_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "range6_acl": { + "description": "The list of ACLs associated with the DHCPv6 range, as follows: <ACL_name>;<ACL_name>;... .", + "type": "string" + }, + "scope6_name": { + "description": "The name of the DHCPv6 scope.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "range6_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "range6_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "type": "integer" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "range6_end_addr": { + "description": "The last IP address of the DHCPv6 range.", + "type": "string" + }, + "range6_id": { + "description": "The database identifier (ID) of the DHCPv6 range, a unique numeric key value automatically incremented when you add a DHCPv6 range. Use the ID to specify the DHCPv6 range of your choice.", + "type": "integer" + }, + "range6_start_addr": { + "description": "The first IP address of the DHCPv6 range.", + "type": "string" + }, + "scope6_id": { + "description": "The database identifier (ID) of the DHCPv6 scope, a unique numeric key value automatically incremented when you add a DHCPv6 scope. Use the ID to specify the DHCPv6 scope of your choice.", + "type": "integer" + }, + "server6_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "range6_acl": { + "description": "The list of ACLs associated with the DHCPv6 range, as follows: <ACL_name>;<ACL_name>;... .", + "type": "string" + }, + "scope6_name": { + "description": "The name of the DHCPv6 scope.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "range6_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "range6_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "f9ff0632-a73c-4c22-9728-629caaddfa16", + "created": "2026-08-25T15:04:00.197Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 27, + "reference": "efc56204-6ded-4322-a41f-6337eef59645", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Get DHCP IPv6 Range", + "description": "Get DHCP IPv6 Range", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_range6_info", + "canvasName": "dhcp_range6_info", + "summary": "dhcp_range6_info", + "description": "dhcp_range6_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "no_parent_class_param": "$var.job.no_parent_class_param", + "range6_id": "$var.job.range6_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "range6_id": { + "type": "integer" + } + }, + "required": [ + "no_parent_class_param", + "range6_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "range6_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "d15069d3-4c0f-403b-81a4-9af299de2dd3", + "created": "2026-08-25T15:04:00.229Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 28, + "reference": "889263eb-d49c-4196-8d72-7978cac7d82d", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "List DHCP IPv6 Ranges", + "description": "List DHCP IPv6 Ranges", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_range6_list", + "canvasName": "dhcp_range6_list", + "summary": "dhcp_range6_list", + "description": "dhcp_range6_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset", + "no_parent_class_param": "$var.job.no_parent_class_param", + "tags": "$var.job.tags" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset", + "no_parent_class_param", + "tags" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "3b7d4185-86ef-41b3-a345-ba901e880b42", + "created": "2026-08-25T15:04:00.258Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 29, + "reference": "3d724ba9-424e-4d54-af30-c09d43301ac7", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Create DHCP Scope", + "description": "Create DHCP Scope", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_scope_add", + "canvasName": "dhcp_scope_add", + "summary": "dhcp_scope_add", + "description": "dhcp_scope_add", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "scope_net_addr": { + "description": "The first IP address of the DHCPv4 scope.", + "type": "string" + }, + "scope_net_mask": { + "description": "The netmask of the DHCPv4 scope. It is expressed in dot-decimal notation and defines the number of addresses the scope contains.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "failover_id": { + "description": "The database identifier (ID) of the DHCPv4 failover channel, a unique numeric key value automatically incremented when you add a DHCPv4 failover channel. Use the ID to specify the DHCPv4 failover channel of your choice.", + "type": "integer" + }, + "failover_name": { + "description": "The name of the DHCPv4 failover channel.", + "type": "string" + }, + "scope_name": { + "description": "The name of the DHCPv4 scope, each DHCPv4 scope must have a unique name.", + "type": "string" + }, + "scope_space_id": { + "description": "The database identifier (ID) of an existing space you want to associate with the DHCPv4 scope.", + "type": "integer" + }, + "scope_space_name": { + "description": "The name of an existing space you want to associate with the DHCPv4 scope.", + "type": "string" + }, + "sharednetwork_id": { + "description": "The database identifier (ID) of the DHCPv4 shared network, a unique numeric key value automatically incremented when you add a DHCPv4 shared network. Use the ID to specify the DHCPv4 shared network of your choice.", + "type": "integer" + }, + "sharednetwork_name": { + "description": "The name of the DHCPv4 shared network.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "scope_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "scope_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "scope_net_addr": { + "description": "The first IP address of the DHCPv4 scope.", + "type": "string" + }, + "scope_net_mask": { + "description": "The netmask of the DHCPv4 scope. It is expressed in dot-decimal notation and defines the number of addresses the scope contains.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "failover_id": { + "description": "The database identifier (ID) of the DHCPv4 failover channel, a unique numeric key value automatically incremented when you add a DHCPv4 failover channel. Use the ID to specify the DHCPv4 failover channel of your choice.", + "type": "integer" + }, + "failover_name": { + "description": "The name of the DHCPv4 failover channel.", + "type": "string" + }, + "scope_name": { + "description": "The name of the DHCPv4 scope, each DHCPv4 scope must have a unique name.", + "type": "string" + }, + "scope_space_id": { + "description": "The database identifier (ID) of an existing space you want to associate with the DHCPv4 scope.", + "type": "integer" + }, + "scope_space_name": { + "description": "The name of an existing space you want to associate with the DHCPv4 scope.", + "type": "string" + }, + "sharednetwork_id": { + "description": "The database identifier (ID) of the DHCPv4 shared network, a unique numeric key value automatically incremented when you add a DHCPv4 shared network. Use the ID to specify the DHCPv4 shared network of your choice.", + "type": "integer" + }, + "sharednetwork_name": { + "description": "The name of the DHCPv4 shared network.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "scope_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "scope_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "aa5ee90b-3d2f-4578-a477-866bd57f3507", + "created": "2026-08-25T15:04:00.295Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 30, + "reference": "8dc7b3c7-15d4-4412-bf94-d6615c8c5ceb", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Delete DHCP Scope", + "description": "Delete DHCP Scope", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_scope_delete", + "canvasName": "dhcp_scope_delete", + "summary": "dhcp_scope_delete", + "description": "dhcp_scope_delete", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "server_id": "$var.job.server_id", + "server_name": "$var.job.server_name", + "scope_id": "$var.job.scope_id", + "scope_net_addr": "$var.job.scope_net_addr", + "server_hostaddr": "$var.job.server_hostaddr", + "warnings": "$var.job.warnings" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "server_id": { + "type": "integer" + }, + "server_name": { + "type": "string" + }, + "scope_id": { + "type": "integer" + }, + "scope_net_addr": { + "type": "string" + }, + "server_hostaddr": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + } + }, + "required": [ + "server_id", + "server_name", + "scope_id", + "scope_net_addr", + "server_hostaddr", + "warnings" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "server_id": { + "type": "integer" + }, + "server_name": { + "type": "string" + }, + "scope_id": { + "type": "integer" + }, + "scope_net_addr": { + "type": "string" + }, + "server_hostaddr": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "75869c90-3ac6-461b-aa3c-aa9c274f79fc", + "created": "2026-08-25T15:04:00.326Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 31, + "reference": "d72630f9-928c-4a62-ae2c-ea2286c52e63", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Update DHCP Scope", + "description": "Update DHCP Scope", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_scope_edit", + "canvasName": "dhcp_scope_edit", + "summary": "dhcp_scope_edit", + "description": "dhcp_scope_edit", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "scope_id": { + "description": "The database identifier (ID) of the DHCPv4 scope, a unique numeric key value automatically incremented when you add a DHCPv4 scope. Use the ID to specify the DHCPv4 scope of your choice.", + "type": "integer" + }, + "scope_net_addr": { + "description": "The first IP address of the DHCPv4 scope.", + "type": "string" + }, + "scope_net_mask": { + "description": "The netmask of the DHCPv4 scope. It is expressed in dot-decimal notation and defines the number of addresses the scope contains.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "failover_id": { + "description": "The database identifier (ID) of the DHCPv4 failover channel, a unique numeric key value automatically incremented when you add a DHCPv4 failover channel. Use the ID to specify the DHCPv4 failover channel of your choice.", + "type": "integer" + }, + "failover_name": { + "description": "The name of the DHCPv4 failover channel.", + "type": "string" + }, + "scope_name": { + "description": "The name of the DHCPv4 scope, each DHCPv4 scope must have a unique name.", + "type": "string" + }, + "scope_space_id": { + "description": "The database identifier (ID) of an existing space you want to associate with the DHCPv4 scope.", + "type": "integer" + }, + "scope_space_name": { + "description": "The name of an existing space you want to associate with the DHCPv4 scope.", + "type": "string" + }, + "sharednetwork_id": { + "description": "The database identifier (ID) of the DHCPv4 shared network, a unique numeric key value automatically incremented when you add a DHCPv4 shared network. Use the ID to specify the DHCPv4 shared network of your choice.", + "type": "integer" + }, + "sharednetwork_name": { + "description": "The name of the DHCPv4 shared network.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "scope_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "scope_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "scope_id": { + "description": "The database identifier (ID) of the DHCPv4 scope, a unique numeric key value automatically incremented when you add a DHCPv4 scope. Use the ID to specify the DHCPv4 scope of your choice.", + "type": "integer" + }, + "scope_net_addr": { + "description": "The first IP address of the DHCPv4 scope.", + "type": "string" + }, + "scope_net_mask": { + "description": "The netmask of the DHCPv4 scope. It is expressed in dot-decimal notation and defines the number of addresses the scope contains.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "failover_id": { + "description": "The database identifier (ID) of the DHCPv4 failover channel, a unique numeric key value automatically incremented when you add a DHCPv4 failover channel. Use the ID to specify the DHCPv4 failover channel of your choice.", + "type": "integer" + }, + "failover_name": { + "description": "The name of the DHCPv4 failover channel.", + "type": "string" + }, + "scope_name": { + "description": "The name of the DHCPv4 scope, each DHCPv4 scope must have a unique name.", + "type": "string" + }, + "scope_space_id": { + "description": "The database identifier (ID) of an existing space you want to associate with the DHCPv4 scope.", + "type": "integer" + }, + "scope_space_name": { + "description": "The name of an existing space you want to associate with the DHCPv4 scope.", + "type": "string" + }, + "sharednetwork_id": { + "description": "The database identifier (ID) of the DHCPv4 shared network, a unique numeric key value automatically incremented when you add a DHCPv4 shared network. Use the ID to specify the DHCPv4 shared network of your choice.", + "type": "integer" + }, + "sharednetwork_name": { + "description": "The name of the DHCPv4 shared network.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "scope_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "scope_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "5d085343-0a8c-40c7-839b-a60066829344", + "created": "2026-08-25T15:04:00.358Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 32, + "reference": "d9607439-dc97-4885-84b3-c230867ada5a", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Get DHCP Scope", + "description": "Get DHCP Scope", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_scope_info", + "canvasName": "dhcp_scope_info", + "summary": "dhcp_scope_info", + "description": "dhcp_scope_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "no_parent_class_param": "$var.job.no_parent_class_param", + "scope_id": "$var.job.scope_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "scope_id": { + "type": "integer" + } + }, + "required": [ + "no_parent_class_param", + "scope_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "scope_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "4c3a1f7a-c555-490f-9456-17c74aa888ce", + "created": "2026-08-25T15:04:00.393Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 33, + "reference": "2814eecd-5a92-4925-9144-47442519e588", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "List DHCP Scopes", + "description": "List DHCP Scopes", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_scope_list", + "canvasName": "dhcp_scope_list", + "summary": "dhcp_scope_list", + "description": "dhcp_scope_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset", + "no_parent_class_param": "$var.job.no_parent_class_param", + "tags": "$var.job.tags" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset", + "no_parent_class_param", + "tags" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "0a43aa92-33f4-433d-8d61-3f7dc0b79132", + "created": "2026-08-25T15:04:00.444Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 34, + "reference": "7cfd59aa-a2a6-4039-9501-e34ebcb58506", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Create DHCP IPv6 Scope", + "description": "Create DHCP IPv6 Scope", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_scope6_add", + "canvasName": "dhcp_scope6_add", + "summary": "dhcp_scope6_add", + "description": "dhcp_scope6_add", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "type": "integer" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "scope6_end_addr": { + "description": "The last IP address of the DHCPv6 scope.", + "type": "string" + }, + "scope6_prefix": { + "description": "The prefix of the DHCPv6 scope, an integer that defines the number of address the scope contains.", + "type": "string" + }, + "scope6_start_addr": { + "description": "The first IP address of the DHCPv6 scope.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "failover6_id": { + "description": "The database identifier (ID) of the DHCPv6 failover channel, a unique numeric key value automatically incremented when you add a DHCPv6 failover channel. Use the ID to specify the DHCPv6 failover channel of your choice.", + "type": "integer" + }, + "failover6_name": { + "description": "The name of the DHCPv6 failover channel.", + "type": "string" + }, + "scope6_name": { + "description": "The name of the DHCPv6 scope, each DHCPv6 scope must have a unique name.", + "type": "string" + }, + "scope6_space_id": { + "description": "The database identifier (ID) of an existing space you want to associate with the DHCPv6 scope.", + "type": "integer" + }, + "scope6_space_name": { + "description": "The name of an existing space you want to associate with the DHCPv6 scope.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "scope6_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "scope6_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "type": "integer" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "scope6_end_addr": { + "description": "The last IP address of the DHCPv6 scope.", + "type": "string" + }, + "scope6_prefix": { + "description": "The prefix of the DHCPv6 scope, an integer that defines the number of address the scope contains.", + "type": "string" + }, + "scope6_start_addr": { + "description": "The first IP address of the DHCPv6 scope.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "failover6_id": { + "description": "The database identifier (ID) of the DHCPv6 failover channel, a unique numeric key value automatically incremented when you add a DHCPv6 failover channel. Use the ID to specify the DHCPv6 failover channel of your choice.", + "type": "integer" + }, + "failover6_name": { + "description": "The name of the DHCPv6 failover channel.", + "type": "string" + }, + "scope6_name": { + "description": "The name of the DHCPv6 scope, each DHCPv6 scope must have a unique name.", + "type": "string" + }, + "scope6_space_id": { + "description": "The database identifier (ID) of an existing space you want to associate with the DHCPv6 scope.", + "type": "integer" + }, + "scope6_space_name": { + "description": "The name of an existing space you want to associate with the DHCPv6 scope.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "scope6_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "scope6_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "a5ee10e8-005e-49fa-9076-4ccc5420164a", + "created": "2026-08-25T15:04:00.478Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 35, + "reference": "5d39b45d-526e-4666-81b5-fb964197b5d6", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Delete DHCP IPv6 Scope", + "description": "Delete DHCP IPv6 Scope", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_scope6_delete", + "canvasName": "dhcp_scope6_delete", + "summary": "dhcp_scope6_delete", + "description": "dhcp_scope6_delete", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "server6_id": "$var.job.server6_id", + "server6_name": "$var.job.server6_name", + "scope6_id": "$var.job.scope6_id", + "scope6_start_addr": "$var.job.scope6_start_addr", + "server6_hostaddr": "$var.job.server6_hostaddr", + "warnings": "$var.job.warnings" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "server6_id": { + "type": "integer" + }, + "server6_name": { + "type": "string" + }, + "scope6_id": { + "type": "integer" + }, + "scope6_start_addr": { + "type": "string" + }, + "server6_hostaddr": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + } + }, + "required": [ + "server6_id", + "server6_name", + "scope6_id", + "scope6_start_addr", + "server6_hostaddr", + "warnings" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "server6_id": { + "type": "integer" + }, + "server6_name": { + "type": "string" + }, + "scope6_id": { + "type": "integer" + }, + "scope6_start_addr": { + "type": "string" + }, + "server6_hostaddr": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "1049e92e-4bc9-4ae9-b138-cae96fdb0a89", + "created": "2026-08-25T15:04:00.510Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 36, + "reference": "b566559f-4e62-410f-9c42-6e3d2fd4a050", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Update DHCP IPv6 Scope", + "description": "Update DHCP IPv6 Scope", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_scope6_edit", + "canvasName": "dhcp_scope6_edit", + "summary": "dhcp_scope6_edit", + "description": "dhcp_scope6_edit", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "type": "integer" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "scope6_end_addr": { + "description": "The last IP address of the DHCPv6 scope.", + "type": "string" + }, + "scope6_id": { + "description": "The database identifier (ID) of the DHCPv6 scope, a unique numeric key value automatically incremented when you add a DHCPv6 scope. Use the ID to specify the DHCPv6 scope of your choice.", + "type": "integer" + }, + "scope6_prefix": { + "description": "The prefix of the DHCPv6 scope, an integer that defines the number of address the scope contains.", + "type": "string" + }, + "scope6_start_addr": { + "description": "The first IP address of the DHCPv6 scope.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "failover6_id": { + "description": "The database identifier (ID) of the DHCPv6 failover channel, a unique numeric key value automatically incremented when you add a DHCPv6 failover channel. Use the ID to specify the DHCPv6 failover channel of your choice.", + "type": "integer" + }, + "failover6_name": { + "description": "The name of the DHCPv6 failover channel.", + "type": "string" + }, + "scope6_name": { + "description": "The name of the DHCPv6 scope, each DHCPv6 scope must have a unique name.", + "type": "string" + }, + "scope6_space_id": { + "description": "The database identifier (ID) of an existing space you want to associate with the DHCPv6 scope.", + "type": "integer" + }, + "scope6_space_name": { + "description": "The name of an existing space you want to associate with the DHCPv6 scope.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "scope6_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "scope6_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "type": "integer" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "scope6_end_addr": { + "description": "The last IP address of the DHCPv6 scope.", + "type": "string" + }, + "scope6_id": { + "description": "The database identifier (ID) of the DHCPv6 scope, a unique numeric key value automatically incremented when you add a DHCPv6 scope. Use the ID to specify the DHCPv6 scope of your choice.", + "type": "integer" + }, + "scope6_prefix": { + "description": "The prefix of the DHCPv6 scope, an integer that defines the number of address the scope contains.", + "type": "string" + }, + "scope6_start_addr": { + "description": "The first IP address of the DHCPv6 scope.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "failover6_id": { + "description": "The database identifier (ID) of the DHCPv6 failover channel, a unique numeric key value automatically incremented when you add a DHCPv6 failover channel. Use the ID to specify the DHCPv6 failover channel of your choice.", + "type": "integer" + }, + "failover6_name": { + "description": "The name of the DHCPv6 failover channel.", + "type": "string" + }, + "scope6_name": { + "description": "The name of the DHCPv6 scope, each DHCPv6 scope must have a unique name.", + "type": "string" + }, + "scope6_space_id": { + "description": "The database identifier (ID) of an existing space you want to associate with the DHCPv6 scope.", + "type": "integer" + }, + "scope6_space_name": { + "description": "The name of an existing space you want to associate with the DHCPv6 scope.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "scope6_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "scope6_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "25cb1753-b3b7-41ae-ac74-8164b9a6db01", + "created": "2026-08-25T15:04:00.557Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 37, + "reference": "cecb807e-180b-47ba-97a2-6b35fb5e6212", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Get DHCP IPv6 Scope", + "description": "Get DHCP IPv6 Scope", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_scope6_info", + "canvasName": "dhcp_scope6_info", + "summary": "dhcp_scope6_info", + "description": "dhcp_scope6_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "no_parent_class_param": "$var.job.no_parent_class_param", + "scope6_id": "$var.job.scope6_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "scope6_id": { + "type": "integer" + } + }, + "required": [ + "no_parent_class_param", + "scope6_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "scope6_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "85bd0061-47af-4142-912e-87c8e3e0b365", + "created": "2026-08-25T15:04:00.590Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 38, + "reference": "a07ef7ba-23c5-4545-8b47-12d2e2a8f43f", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "List DHCP IPv6 Scopes", + "description": "List DHCP IPv6 Scopes", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_scope6_list", + "canvasName": "dhcp_scope6_list", + "summary": "dhcp_scope6_list", + "description": "dhcp_scope6_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset", + "no_parent_class_param": "$var.job.no_parent_class_param", + "tags": "$var.job.tags" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset", + "no_parent_class_param", + "tags" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "a1ff7551-f83b-40a1-9f73-27b62b8e0162", + "created": "2026-08-25T15:04:00.622Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 39, + "reference": "156db7d3-9e95-41c4-9d7e-28b65cb2de5f", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Get DHCP Server", + "description": "Get DHCP Server", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_server_info", + "canvasName": "dhcp_server_info", + "summary": "dhcp_server_info", + "description": "dhcp_server_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "server_id": "$var.job.server_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "server_id": { + "type": "integer" + } + }, + "required": [ + "server_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "server_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "2b54235f-5ad2-4910-aba1-a95c409dfafd", + "created": "2026-08-25T15:04:00.653Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 40, + "reference": "e02be33a-d941-4bb9-9d7c-d15bffbdbfbe", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "List DHCP Servers", + "description": "List DHCP Servers", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_server_list", + "canvasName": "dhcp_server_list", + "summary": "dhcp_server_list", + "description": "dhcp_server_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset", + "tags": "$var.job.tags" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "tags": { + "type": "string" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset", + "tags" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "tags": { + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "f5a9101a-c836-4ede-8a5b-35e03e64e8f0", + "created": "2026-08-25T15:04:00.683Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 41, + "reference": "62793b03-a507-473a-ba64-5b8bcb343af3", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Get DHCP IPv6 Server", + "description": "Get DHCP IPv6 Server", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_server6_info", + "canvasName": "dhcp_server6_info", + "summary": "dhcp_server6_info", + "description": "dhcp_server6_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "server6_id": "$var.job.server6_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "server6_id": { + "type": "integer" + } + }, + "required": [ + "server6_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "server6_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "3dcb4f07-5383-4289-beea-525b30a63fcf", + "created": "2026-08-25T15:04:00.715Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 42, + "reference": "3cd6c220-7cad-47ec-a0d9-91db04e405b8", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "List DHCP IPv6 Servers", + "description": "List DHCP IPv6 Servers", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_server6_list", + "canvasName": "dhcp_server6_list", + "summary": "dhcp_server6_list", + "description": "dhcp_server6_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset", + "tags": "$var.job.tags" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "tags": { + "type": "string" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset", + "tags" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "tags": { + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "a7e5e39a-e3be-4aad-b314-e594c7105fa3", + "created": "2026-08-25T15:04:00.743Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 43, + "reference": "dddc9ee5-2d32-4b0d-9916-0cc887e4dcb3", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Create DHCP Shared Network", + "description": "Create DHCP Shared Network", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_sharednetwork_add", + "canvasName": "dhcp_sharednetwork_add", + "summary": "dhcp_sharednetwork_add", + "description": "dhcp_sharednetwork_add", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "sharednetwork_name": { + "description": "The name of the DHCPv4 shared network, each DHCPv4 shared network must have a unique name.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "sharednetwork_name": { + "description": "The name of the DHCPv4 shared network, each DHCPv4 shared network must have a unique name.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "a69f7376-bf73-4845-b1d4-bdd5cc4a7725", + "created": "2026-08-25T15:04:00.771Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 44, + "reference": "ac404e36-7049-46e5-8b98-320ed9980ecc", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Delete DHCP Shared Network", + "description": "Delete DHCP Shared Network", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_sharednetwork_delete", + "canvasName": "dhcp_sharednetwork_delete", + "summary": "dhcp_sharednetwork_delete", + "description": "dhcp_sharednetwork_delete", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "server_id": "$var.job.server_id", + "server_name": "$var.job.server_name", + "sharednetwork_id": "$var.job.sharednetwork_id", + "sharednetwork_name": "$var.job.sharednetwork_name", + "server_hostaddr": "$var.job.server_hostaddr", + "warnings": "$var.job.warnings" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "server_id": { + "type": "integer" + }, + "server_name": { + "type": "string" + }, + "sharednetwork_id": { + "type": "integer" + }, + "sharednetwork_name": { + "type": "string" + }, + "server_hostaddr": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + } + }, + "required": [ + "server_id", + "server_name", + "sharednetwork_id", + "sharednetwork_name", + "server_hostaddr", + "warnings" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "server_id": { + "type": "integer" + }, + "server_name": { + "type": "string" + }, + "sharednetwork_id": { + "type": "integer" + }, + "sharednetwork_name": { + "type": "string" + }, + "server_hostaddr": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "3fb2ef80-2e41-493d-a118-aea7e41d0b0f", + "created": "2026-08-25T15:04:00.806Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 45, + "reference": "5bacc841-e784-4bc7-97c0-27e3b765009b", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Update DHCP Shared Network", + "description": "Update DHCP Shared Network", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_sharednetwork_edit", + "canvasName": "dhcp_sharednetwork_edit", + "summary": "dhcp_sharednetwork_edit", + "description": "dhcp_sharednetwork_edit", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "sharednetwork_id": { + "description": "The database identifier (ID) of the DHCPv4 shared network, a unique numeric key value automatically incremented when you add a DHCPv4 shared network. Use the ID to specify the DHCPv4 shared network of your choice.", + "type": "integer" + }, + "sharednetwork_name": { + "description": "The name of the DHCPv4 shared network, each DHCPv4 shared network must have a unique name.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "sharednetwork_id": { + "description": "The database identifier (ID) of the DHCPv4 shared network, a unique numeric key value automatically incremented when you add a DHCPv4 shared network. Use the ID to specify the DHCPv4 shared network of your choice.", + "type": "integer" + }, + "sharednetwork_name": { + "description": "The name of the DHCPv4 shared network, each DHCPv4 shared network must have a unique name.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "e70a59fa-6fd9-465d-87ec-7cc8dc7340ec", + "created": "2026-08-25T15:04:00.835Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 46, + "reference": "d31d8a15-fc01-4b50-b25d-c2b98953bb5c", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Get DHCP Shared Network", + "description": "Get DHCP Shared Network", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_sharednetwork_info", + "canvasName": "dhcp_sharednetwork_info", + "summary": "dhcp_sharednetwork_info", + "description": "dhcp_sharednetwork_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "sharednetwork_id": "$var.job.sharednetwork_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "sharednetwork_id": { + "type": "integer" + } + }, + "required": [ + "sharednetwork_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "sharednetwork_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "7df54525-2b7d-43ee-8ddb-98f8db47d891", + "created": "2026-08-25T15:04:00.864Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 47, + "reference": "bd5b3910-55e4-4b5e-8700-dda75e4c4b97", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "List DHCP Shared Networks", + "description": "List DHCP Shared Networks", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_sharednetwork_list", + "canvasName": "dhcp_sharednetwork_list", + "summary": "dhcp_sharednetwork_list", + "description": "dhcp_sharednetwork_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "b8c7ef4e-8685-45a3-8762-231a3522b0b3", + "created": "2026-08-25T15:04:00.895Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 48, + "reference": "aae293f8-1c15-400f-9d06-036357a25933", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Create DHCP IPv6 Shared Network", + "description": "Create DHCP IPv6 Shared Network", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_sharednetwork6_add", + "canvasName": "dhcp_sharednetwork6_add", + "summary": "dhcp_sharednetwork6_add", + "description": "dhcp_sharednetwork6_add", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "type": "integer" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "sharednetwork6_name": { + "description": "The name of the DHCPv6 shared network.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "type": "integer" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "sharednetwork6_name": { + "description": "The name of the DHCPv6 shared network.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "41489e42-dca4-443a-985d-3cc7e186ac0d", + "created": "2026-08-25T15:04:00.924Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 49, + "reference": "cf98c6fa-73cb-4bc3-933e-33cf9b363aa9", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Delete DHCP IPv6 Shared Network", + "description": "Delete DHCP IPv6 Shared Network", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_sharednetwork6_delete", + "canvasName": "dhcp_sharednetwork6_delete", + "summary": "dhcp_sharednetwork6_delete", + "description": "dhcp_sharednetwork6_delete", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "server6_id": "$var.job.server6_id", + "server6_name": "$var.job.server6_name", + "sharednetwork6_id": "$var.job.sharednetwork6_id", + "sharednetwork6_name": "$var.job.sharednetwork6_name", + "server6_hostaddr": "$var.job.server6_hostaddr", + "warnings": "$var.job.warnings" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "server6_id": { + "type": "integer" + }, + "server6_name": { + "type": "string" + }, + "sharednetwork6_id": { + "type": "integer" + }, + "sharednetwork6_name": { + "type": "string" + }, + "server6_hostaddr": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + } + }, + "required": [ + "server6_id", + "server6_name", + "sharednetwork6_id", + "sharednetwork6_name", + "server6_hostaddr", + "warnings" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "server6_id": { + "type": "integer" + }, + "server6_name": { + "type": "string" + }, + "sharednetwork6_id": { + "type": "integer" + }, + "sharednetwork6_name": { + "type": "string" + }, + "server6_hostaddr": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "1a3ed358-54f2-49c8-aec0-f74de2a1e945", + "created": "2026-08-25T15:04:00.953Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 50, + "reference": "b3ac437e-ab4b-4887-acc7-9f78cdcbfddb", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Update DHCP IPv6 Shared Network", + "description": "Update DHCP IPv6 Shared Network", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_sharednetwork6_edit", + "canvasName": "dhcp_sharednetwork6_edit", + "summary": "dhcp_sharednetwork6_edit", + "description": "dhcp_sharednetwork6_edit", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "type": "integer" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "sharednetwork6_id": { + "description": "The database identifier (ID) of the DHCPv6 shared network, a unique numeric key value automatically incremented when you add a DHCPv6 shared network. Use the ID to specify the DHCPv6 shared network of your choice.", + "type": "integer" + }, + "sharednetwork6_name": { + "description": "The name of the DHCPv6 shared network.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "type": "integer" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "sharednetwork6_id": { + "description": "The database identifier (ID) of the DHCPv6 shared network, a unique numeric key value automatically incremented when you add a DHCPv6 shared network. Use the ID to specify the DHCPv6 shared network of your choice.", + "type": "integer" + }, + "sharednetwork6_name": { + "description": "The name of the DHCPv6 shared network.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "31c2f21b-d14a-4330-82ed-8f967ccb9cc4", + "created": "2026-08-25T15:04:00.987Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 51, + "reference": "7bc6def6-6673-4fc4-b864-7b61c37fd611", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Get DHCP IPv6 Shared Network", + "description": "Get DHCP IPv6 Shared Network", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_sharednetwork6_info", + "canvasName": "dhcp_sharednetwork6_info", + "summary": "dhcp_sharednetwork6_info", + "description": "dhcp_sharednetwork6_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "sharednetwork6_id": "$var.job.sharednetwork6_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "sharednetwork6_id": { + "type": "integer" + } + }, + "required": [ + "sharednetwork6_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "sharednetwork6_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "4edd26dc-9e7a-4500-b2eb-0e9ed5616d84", + "created": "2026-08-25T15:04:01.015Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 52, + "reference": "b9de39e4-0c64-4053-9253-6332610dc7cc", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "List DHCP IPv6 Shared Networks", + "description": "List DHCP IPv6 Shared Networks", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_sharednetwork6_list", + "canvasName": "dhcp_sharednetwork6_list", + "summary": "dhcp_sharednetwork6_list", + "description": "dhcp_sharednetwork6_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "9ac95294-e899-49a6-b1a6-cc64623d94c5", + "created": "2026-08-25T15:04:01.048Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 53, + "reference": "c4b006ad-e406-4872-8c8a-83b466e81a5f", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Create DHCP Static Lease", + "description": "Create DHCP Static Lease", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_static_add", + "canvasName": "dhcp_static_add", + "summary": "dhcp_static_add", + "description": "dhcp_static_add", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "static_addr": { + "description": "The IP address associated with the DHCPv4 static.", + "type": "string" + }, + "static_identifier": { + "description": "The host identifier you want to associate with the IPv4 static. An option and value to look for to identify clients and assign them the static, specified as follows: option <option-name> expected value.", + "type": "string" + }, + "static_mac_addr": { + "description": "The MAC address you want to associate with the IPv4 static, it must include the MAC address type. The address has 7 sections, 00:11:22:33:44:55:66 , where 00 indicates the type. For Ethernet, type in 01.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "group_id": { + "description": "The database identifier (ID) of the DHCPv4 group, a unique numeric key value automatically incremented when you add a DHCPv4 group. Use the ID to specify the DHCPv4 group of your choice.", + "type": "integer" + }, + "group_name": { + "description": "The name of the DHCPv4 group.", + "type": "string" + }, + "static_name": { + "description": "The name of the DHCPv4 static, each DHCPv4 static must have a unique name.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "static_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "static_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "static_addr": { + "description": "The IP address associated with the DHCPv4 static.", + "type": "string" + }, + "static_identifier": { + "description": "The host identifier you want to associate with the IPv4 static. An option and value to look for to identify clients and assign them the static, specified as follows: option <option-name> expected value.", + "type": "string" + }, + "static_mac_addr": { + "description": "The MAC address you want to associate with the IPv4 static, it must include the MAC address type. The address has 7 sections, 00:11:22:33:44:55:66 , where 00 indicates the type. For Ethernet, type in 01.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "group_id": { + "description": "The database identifier (ID) of the DHCPv4 group, a unique numeric key value automatically incremented when you add a DHCPv4 group. Use the ID to specify the DHCPv4 group of your choice.", + "type": "integer" + }, + "group_name": { + "description": "The name of the DHCPv4 group.", + "type": "string" + }, + "static_name": { + "description": "The name of the DHCPv4 static, each DHCPv4 static must have a unique name.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "static_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "static_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "d1a538f4-f5cb-4379-9ac5-f7875c6b37bd", + "created": "2026-08-25T15:04:01.085Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 54, + "reference": "e6e8f848-b109-4140-8de1-92831310ba04", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Delete DHCP Static Lease", + "description": "Delete DHCP Static Lease", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_static_delete", + "canvasName": "dhcp_static_delete", + "summary": "dhcp_static_delete", + "description": "dhcp_static_delete", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "server_id": "$var.job.server_id", + "server_name": "$var.job.server_name", + "static_addr": "$var.job.static_addr", + "static_id": "$var.job.static_id", + "static_identifier": "$var.job.static_identifier", + "static_mac_addr": "$var.job.static_mac_addr", + "scope_id": "$var.job.scope_id", + "server_hostaddr": "$var.job.server_hostaddr", + "static_name": "$var.job.static_name", + "warnings": "$var.job.warnings" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "server_id": { + "type": "integer" + }, + "server_name": { + "type": "string" + }, + "static_addr": { + "type": "string" + }, + "static_id": { + "type": "integer" + }, + "static_identifier": { + "type": "string" + }, + "static_mac_addr": { + "type": "string" + }, + "scope_id": { + "type": "integer" + }, + "server_hostaddr": { + "type": "string" + }, + "static_name": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + } + }, + "required": [ + "server_id", + "server_name", + "static_addr", + "static_id", + "static_identifier", + "static_mac_addr", + "scope_id", + "server_hostaddr", + "static_name", + "warnings" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "server_id": { + "type": "integer" + }, + "server_name": { + "type": "string" + }, + "static_addr": { + "type": "string" + }, + "static_id": { + "type": "integer" + }, + "static_identifier": { + "type": "string" + }, + "static_mac_addr": { + "type": "string" + }, + "scope_id": { + "type": "integer" + }, + "server_hostaddr": { + "type": "string" + }, + "static_name": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "11c97aac-6a3e-4fac-b6fc-ca2d0e0bff7b", + "created": "2026-08-25T15:04:01.123Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 55, + "reference": "90d77b4d-289d-41ed-a353-bef61430d2bc", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Update DHCP Static Lease", + "description": "Update DHCP Static Lease", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_static_edit", + "canvasName": "dhcp_static_edit", + "summary": "dhcp_static_edit", + "description": "dhcp_static_edit", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "static_addr": { + "description": "The IP address associated with the DHCPv4 static.", + "type": "string" + }, + "static_id": { + "description": "The database identifier (ID) of the DHCPv4 static, a unique numeric key value automatically incremented when you add a DHCPv4 static. Use the ID to specify the DHCPv4 static of your choice.", + "type": "integer" + }, + "static_identifier": { + "description": "The host identifier you want to associate with the IPv4 static. An option and value to look for to identify clients and assign them the static, specified as follows: option <option-name> expected value.", + "type": "string" + }, + "static_mac_addr": { + "description": "The MAC address you want to associate with the IPv4 static, it must include the MAC address type. The address has 7 sections, 00:11:22:33:44:55:66 , where 00 indicates the type. For Ethernet, type in 01.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "group_id": { + "description": "The database identifier (ID) of the DHCPv4 group, a unique numeric key value automatically incremented when you add a DHCPv4 group. Use the ID to specify the DHCPv4 group of your choice.", + "type": "integer" + }, + "group_name": { + "description": "The name of the DHCPv4 group.", + "type": "string" + }, + "static_name": { + "description": "The name of the DHCPv4 static, each DHCPv4 static must have a unique name.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "static_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "static_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DHCPv4 server, a unique numeric key value automatically incremented when you add a DHCPv4 server. Use the ID to specify the DHCPv4 server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DHCPv4 server.", + "type": "string" + }, + "static_addr": { + "description": "The IP address associated with the DHCPv4 static.", + "type": "string" + }, + "static_id": { + "description": "The database identifier (ID) of the DHCPv4 static, a unique numeric key value automatically incremented when you add a DHCPv4 static. Use the ID to specify the DHCPv4 static of your choice.", + "type": "integer" + }, + "static_identifier": { + "description": "The host identifier you want to associate with the IPv4 static. An option and value to look for to identify clients and assign them the static, specified as follows: option <option-name> expected value.", + "type": "string" + }, + "static_mac_addr": { + "description": "The MAC address you want to associate with the IPv4 static, it must include the MAC address type. The address has 7 sections, 00:11:22:33:44:55:66 , where 00 indicates the type. For Ethernet, type in 01.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "group_id": { + "description": "The database identifier (ID) of the DHCPv4 group, a unique numeric key value automatically incremented when you add a DHCPv4 group. Use the ID to specify the DHCPv4 group of your choice.", + "type": "integer" + }, + "group_name": { + "description": "The name of the DHCPv4 group.", + "type": "string" + }, + "static_name": { + "description": "The name of the DHCPv4 static, each DHCPv4 static must have a unique name.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "static_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "static_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "b93c5057-5013-4a57-a704-eb04aad33607", + "created": "2026-08-25T15:04:01.160Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 56, + "reference": "b76c1735-688a-4aee-b300-b52da3b162b9", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Get DHCP Static Lease", + "description": "Get DHCP Static Lease", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_static_info", + "canvasName": "dhcp_static_info", + "summary": "dhcp_static_info", + "description": "dhcp_static_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "no_parent_class_param": "$var.job.no_parent_class_param", + "static_id": "$var.job.static_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "static_id": { + "type": "integer" + } + }, + "required": [ + "no_parent_class_param", + "static_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "static_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "69b022b2-e127-44c3-b0e1-fac8804fa497", + "created": "2026-08-25T15:04:01.210Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 57, + "reference": "5e1c40e2-d60e-48d1-8a72-08f47c8d1486", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "List DHCP Static Leases", + "description": "List DHCP Static Leases", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_static_list", + "canvasName": "dhcp_static_list", + "summary": "dhcp_static_list", + "description": "dhcp_static_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset", + "no_parent_class_param": "$var.job.no_parent_class_param", + "tags": "$var.job.tags" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset", + "no_parent_class_param", + "tags" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "35eefad8-534e-4cec-9895-a6a9da4d7650", + "created": "2026-08-25T15:04:01.259Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 58, + "reference": "85164b94-454e-46ac-9d6a-6c24a572606b", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Create DHCP IPv6 Static Lease", + "description": "Create DHCP IPv6 Static Lease", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_static6_add", + "canvasName": "dhcp_static6_add", + "summary": "dhcp_static6_add", + "description": "dhcp_static6_add", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "type": "integer" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "static6_client_duid": { + "description": "The client DHCP Unique Identifier (DUID) associated with the DHCPv6 static.", + "type": "string" + }, + "static6_mac_addr": { + "description": "The MAC address you want to associate with the IPv6 static.", + "type": "string" + }, + "static6_name": { + "description": "The name of the DHCPv6 static, each DHCPv6 static must have a unique name.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "group6_id": { + "description": "The database identifier (ID) of the DHCPv6 group, a unique numeric key value automatically incremented when you add a DHCPv6 group. Use the ID to specify the DHCPv6 group of your choice.", + "type": "integer" + }, + "group6_name": { + "description": "The name of the DHCPv6 group.", + "type": "string" + }, + "static6_addr": { + "description": "The IP address associated with the DHCPv6 static.", + "type": "string" + }, + "static6_prefix6": { + "description": "The IP address of the delegated prefix of the DHCPv6 static.", + "type": "string" + }, + "static6_prefix6_addr": { + "description": "The prefix of the delegated prefix of the DHCPv6 static.", + "type": "string" + }, + "static6_prefix6_prefix": { + "description": "The IP address and prefix of the delegated prefix of the DHCPv6 static. You must specify them as follows: <IPv6-address>/<prefix>.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "static6_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "static6_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "type": "integer" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "static6_client_duid": { + "description": "The client DHCP Unique Identifier (DUID) associated with the DHCPv6 static.", + "type": "string" + }, + "static6_mac_addr": { + "description": "The MAC address you want to associate with the IPv6 static.", + "type": "string" + }, + "static6_name": { + "description": "The name of the DHCPv6 static, each DHCPv6 static must have a unique name.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "group6_id": { + "description": "The database identifier (ID) of the DHCPv6 group, a unique numeric key value automatically incremented when you add a DHCPv6 group. Use the ID to specify the DHCPv6 group of your choice.", + "type": "integer" + }, + "group6_name": { + "description": "The name of the DHCPv6 group.", + "type": "string" + }, + "static6_addr": { + "description": "The IP address associated with the DHCPv6 static.", + "type": "string" + }, + "static6_prefix6": { + "description": "The IP address of the delegated prefix of the DHCPv6 static.", + "type": "string" + }, + "static6_prefix6_addr": { + "description": "The prefix of the delegated prefix of the DHCPv6 static.", + "type": "string" + }, + "static6_prefix6_prefix": { + "description": "The IP address and prefix of the delegated prefix of the DHCPv6 static. You must specify them as follows: <IPv6-address>/<prefix>.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "static6_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "static6_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "89571deb-f18e-444a-98d4-263b68521e22", + "created": "2026-08-25T15:04:01.298Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 59, + "reference": "e2be1e9c-1c71-4078-a464-a6cacc8f1138", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Delete DHCP IPv6 Static Lease", + "description": "Delete DHCP IPv6 Static Lease", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_static6_delete", + "canvasName": "dhcp_static6_delete", + "summary": "dhcp_static6_delete", + "description": "dhcp_static6_delete", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "server6_id": "$var.job.server6_id", + "server6_name": "$var.job.server6_name", + "static6_addr": "$var.job.static6_addr", + "static6_id": "$var.job.static6_id", + "static6_name": "$var.job.static6_name", + "scope6_id": "$var.job.scope6_id", + "server6_hostaddr": "$var.job.server6_hostaddr", + "warnings": "$var.job.warnings" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "server6_id": { + "type": "integer" + }, + "server6_name": { + "type": "string" + }, + "static6_addr": { + "type": "string" + }, + "static6_id": { + "type": "integer" + }, + "static6_name": { + "type": "string" + }, + "scope6_id": { + "type": "integer" + }, + "server6_hostaddr": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + } + }, + "required": [ + "server6_id", + "server6_name", + "static6_addr", + "static6_id", + "static6_name", + "scope6_id", + "server6_hostaddr", + "warnings" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "server6_id": { + "type": "integer" + }, + "server6_name": { + "type": "string" + }, + "static6_addr": { + "type": "string" + }, + "static6_id": { + "type": "integer" + }, + "static6_name": { + "type": "string" + }, + "scope6_id": { + "type": "integer" + }, + "server6_hostaddr": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "5f8a2cc1-c03e-49da-986a-b18ad0116823", + "created": "2026-08-25T15:04:01.331Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 60, + "reference": "0686aba5-46bc-4208-b426-8c712d5bc053", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Update DHCP IPv6 Static Lease", + "description": "Update DHCP IPv6 Static Lease", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_static6_edit", + "canvasName": "dhcp_static6_edit", + "summary": "dhcp_static6_edit", + "description": "dhcp_static6_edit", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "type": "integer" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "static6_client_duid": { + "description": "The client DHCP Unique Identifier (DUID) associated with the DHCPv6 static.", + "type": "string" + }, + "static6_id": { + "description": "The database identifier (ID) of the DHCPv6 static, a unique numeric key value automatically incremented when you add a DHCPv6 static. Use the ID to specify the DHCPv6 static of your choice.", + "type": "integer" + }, + "static6_mac_addr": { + "description": "The MAC address you want to associate with the IPv6 static.", + "type": "string" + }, + "static6_name": { + "description": "The name of the DHCPv6 static, each DHCPv6 static must have a unique name.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "group6_id": { + "description": "The database identifier (ID) of the DHCPv6 group, a unique numeric key value automatically incremented when you add a DHCPv6 group. Use the ID to specify the DHCPv6 group of your choice.", + "type": "integer" + }, + "group6_name": { + "description": "The name of the DHCPv6 group.", + "type": "string" + }, + "static6_addr": { + "description": "The IP address associated with the DHCPv6 static.", + "type": "string" + }, + "static6_prefix6": { + "description": "The IP address of the delegated prefix of the DHCPv6 static.", + "type": "string" + }, + "static6_prefix6_addr": { + "description": "The prefix of the delegated prefix of the DHCPv6 static.", + "type": "string" + }, + "static6_prefix6_prefix": { + "description": "The IP address and prefix of the delegated prefix of the DHCPv6 static. You must specify them as follows: <IPv6-address>/<prefix>.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "static6_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "static6_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server6_id": { + "description": "The database identifier (ID) of the DHCPv6 server, a unique numeric key value automatically incremented when you add a DHCPv6 server. Use the ID to specify the DHCPv6 server of your choice.", + "type": "integer" + }, + "server6_name": { + "description": "The name of the DHCPv6 server.", + "type": "string" + }, + "static6_client_duid": { + "description": "The client DHCP Unique Identifier (DUID) associated with the DHCPv6 static.", + "type": "string" + }, + "static6_id": { + "description": "The database identifier (ID) of the DHCPv6 static, a unique numeric key value automatically incremented when you add a DHCPv6 static. Use the ID to specify the DHCPv6 static of your choice.", + "type": "integer" + }, + "static6_mac_addr": { + "description": "The MAC address you want to associate with the IPv6 static.", + "type": "string" + }, + "static6_name": { + "description": "The name of the DHCPv6 static, each DHCPv6 static must have a unique name.", + "type": "string" + }, + "server6_hostaddr": { + "description": "The IP address of the DHCP server.", + "type": "string" + }, + "group6_id": { + "description": "The database identifier (ID) of the DHCPv6 group, a unique numeric key value automatically incremented when you add a DHCPv6 group. Use the ID to specify the DHCPv6 group of your choice.", + "type": "integer" + }, + "group6_name": { + "description": "The name of the DHCPv6 group.", + "type": "string" + }, + "static6_addr": { + "description": "The IP address associated with the DHCPv6 static.", + "type": "string" + }, + "static6_prefix6": { + "description": "The IP address of the delegated prefix of the DHCPv6 static.", + "type": "string" + }, + "static6_prefix6_addr": { + "description": "The prefix of the delegated prefix of the DHCPv6 static.", + "type": "string" + }, + "static6_prefix6_prefix": { + "description": "The IP address and prefix of the delegated prefix of the DHCPv6 static. You must specify them as follows: <IPv6-address>/<prefix>.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "static6_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "static6_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "ee5c50a3-3f85-49f9-85ec-3e42de92fa2f", + "created": "2026-08-25T15:04:01.361Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 61, + "reference": "a4f50e41-f354-4daa-9bdf-1b908cfd6647", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "Get DHCP IPv6 Static Lease", + "description": "Get DHCP IPv6 Static Lease", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_static6_info", + "canvasName": "dhcp_static6_info", + "summary": "dhcp_static6_info", + "description": "dhcp_static6_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "no_parent_class_param": "$var.job.no_parent_class_param", + "static6_id": "$var.job.static6_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "static6_id": { + "type": "integer" + } + }, + "required": [ + "no_parent_class_param", + "static6_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "static6_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "37e52630-d5b0-4b48-9790-7cf000cc8b00", + "created": "2026-08-25T15:04:01.394Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 62, + "reference": "84b8b122-a1ea-473e-a10d-93c0423402cd", + "type": "workflow", + "folder": "/DHCP", + "document": { + "name": "List DHCP IPv6 Static Leases", + "description": "List DHCP IPv6 Static Leases", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dhcp_static6_list", + "canvasName": "dhcp_static6_list", + "summary": "dhcp_static6_list", + "description": "dhcp_static6_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset", + "no_parent_class_param": "$var.job.no_parent_class_param", + "tags": "$var.job.tags" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset", + "no_parent_class_param", + "tags" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "1015e07c-15b3-4848-a366-59bc08ca5f20", + "created": "2026-08-25T15:04:01.422Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 63, + "reference": "05c4a3e6-aa30-46fa-88b9-8bb80ed3dec2", + "type": "workflow", + "folder": "/DNS", + "document": { + "name": "Create DNS ACL", + "description": "Create DNS ACL", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dns_acl_add", + "canvasName": "dns_acl_add", + "summary": "dns_acl_add", + "description": "dns_acl_add", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "acl_name": { + "description": "The name of the DNS ACL, each DNS ACL must have a unique name.", + "type": "string" + }, + "acl_value": { + "description": "The values of the DNS ACL in order of priority, as follows: <value_1>;<value_2>... .", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DNS server.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "acl_name": { + "description": "The name of the DNS ACL, each DNS ACL must have a unique name.", + "type": "string" + }, + "acl_value": { + "description": "The values of the DNS ACL in order of priority, as follows: <value_1>;<value_2>... .", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DNS server.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "4cfa8af8-853e-4377-a54a-8b2481ca3fe5", + "created": "2026-08-25T15:04:01.451Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 64, + "reference": "fcd94e9c-50f4-4f0d-8630-d293826c8025", + "type": "workflow", + "folder": "/DNS", + "document": { + "name": "Delete DNS ACL", + "description": "Delete DNS ACL", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dns_acl_delete", + "canvasName": "dns_acl_delete", + "summary": "dns_acl_delete", + "description": "dns_acl_delete", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "acl_id": "$var.job.acl_id", + "server_id": "$var.job.server_id", + "server_name": "$var.job.server_name", + "acl_name": "$var.job.acl_name", + "server_hostaddr": "$var.job.server_hostaddr", + "warnings": "$var.job.warnings" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "acl_id": { + "type": "integer" + }, + "server_id": { + "type": "integer" + }, + "server_name": { + "type": "string" + }, + "acl_name": { + "type": "string" + }, + "server_hostaddr": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + } + }, + "required": [ + "acl_id", + "server_id", + "server_name", + "acl_name", + "server_hostaddr", + "warnings" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "acl_id": { + "type": "integer" + }, + "server_id": { + "type": "integer" + }, + "server_name": { + "type": "string" + }, + "acl_name": { + "type": "string" + }, + "server_hostaddr": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "814053fa-3250-487e-85d1-d1d747c555d3", + "created": "2026-08-25T15:04:01.478Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 65, + "reference": "2540cddf-649b-4c7f-801a-6c998d408a05", + "type": "workflow", + "folder": "/DNS", + "document": { + "name": "Update DNS ACL", + "description": "Update DNS ACL", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dns_acl_edit", + "canvasName": "dns_acl_edit", + "summary": "dns_acl_edit", + "description": "dns_acl_edit", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "acl_id": { + "description": "The database identifier (ID) of the DNS ACL, a unique numeric key value automatically incremented when you add a DNS ACL. Use the ID to specify the DNS ACL of your choice.", + "type": "integer" + }, + "acl_name": { + "description": "The name of the DNS ACL, each DNS ACL must have a unique name.", + "type": "string" + }, + "acl_value": { + "description": "The values of the DNS ACL in order of priority, as follows: <value_1>;<value_2>... .", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DNS server.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "acl_id": { + "description": "The database identifier (ID) of the DNS ACL, a unique numeric key value automatically incremented when you add a DNS ACL. Use the ID to specify the DNS ACL of your choice.", + "type": "integer" + }, + "acl_name": { + "description": "The name of the DNS ACL, each DNS ACL must have a unique name.", + "type": "string" + }, + "acl_value": { + "description": "The values of the DNS ACL in order of priority, as follows: <value_1>;<value_2>... .", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DNS server.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "2c54addb-99dd-4935-a910-1a3b5815f2fa", + "created": "2026-08-25T15:04:01.504Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 66, + "reference": "64e4d3ab-82a7-4362-81d7-8307b27b3265", + "type": "workflow", + "folder": "/DNS", + "document": { + "name": "Get DNS ACL", + "description": "Get DNS ACL", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dns_acl_info", + "canvasName": "dns_acl_info", + "summary": "dns_acl_info", + "description": "dns_acl_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "acl_id": "$var.job.acl_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "acl_id": { + "type": "integer" + } + }, + "required": [ + "acl_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "acl_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "5e266f78-840e-458c-b26a-010519106651", + "created": "2026-08-25T15:04:01.532Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 67, + "reference": "2c19e29f-459b-451f-b772-22503b2d4caf", + "type": "workflow", + "folder": "/DNS", + "document": { + "name": "List DNS ACLs", + "description": "List DNS ACLs", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dns_acl_list", + "canvasName": "dns_acl_list", + "summary": "dns_acl_list", + "description": "dns_acl_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "bff97a85-36e2-4138-94c5-062fde1a7eaf", + "created": "2026-08-25T15:04:01.564Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 68, + "reference": "dfe1342b-2253-4bee-a0a1-e43daf9813b0", + "type": "workflow", + "folder": "/DNS", + "document": { + "name": "Create DNS Resource Record", + "description": "Create DNS Resource Record", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dns_rr_add", + "canvasName": "dns_rr_add", + "summary": "dns_rr_add", + "description": "dns_rr_add", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DNS server.", + "type": "string" + }, + "rr_name": { + "description": "The full name of the DNS resource record. Specify it as value, it can either follow the format <rr-name>.<existing-zone-name>.<extension> or be . (a dot).", + "type": "string" + }, + "rr_type": { + "description": "The type of the DNS resource record.


                                                                                                                                                                                                                                              rr_type possible values
                                                                                                                                                                                                                                              ValueRecord type description
                                                                                                                                                                                                                                              SOAStart of Authority. Defines the zone name, an email contact and various time and refresh values applicable to the zone. It is automatically generated upon creation of a zone and cannot be added manually.
                                                                                                                                                                                                                                              NSName Server. Defines the authoritative name server(s) for the domain (defined by the SOA record) or the subdomain. The NS record that indicates which server has authority over a zone is automatically generated upon the creation of a zone, once the server has been synchronized.
                                                                                                                                                                                                                                              AIPv4 Address. An IPv4 address for a host.
                                                                                                                                                                                                                                              PTRPointer Record. Address Resolution, from an IP address (IPv4 or IPv6) to a host. Used in reverse mapping.
                                                                                                                                                                                                                                              AAAAIPv6 Address. An IPv6 address for a host.
                                                                                                                                                                                                                                              CNAMECanonical Name. An alias name for a host.
                                                                                                                                                                                                                                              MXMail Exchange. The mail server/exchanger that services this zone.
                                                                                                                                                                                                                                              SRVServices record. Defines services available in the zone, for example, LDAP, HTTP, etc...
                                                                                                                                                                                                                                              DNAMEDelegation of Reverse Names. Delegation of reverse addresses primarily in IPv6. (Deprecated, use the CNAME RR instead)
                                                                                                                                                                                                                                              TXTText. Information associated with a name.
                                                                                                                                                                                                                                              DSDelegation Signer, a DNSSEC related RR used to verify the validity of the ZSK of a subdomain.
                                                                                                                                                                                                                                              DNSKEYDNS Key. It contains the public cryptographic key used to sign the zone with DNSSEC.
                                                                                                                                                                                                                                              65534A private type record automatically added to the zone once it is signed with DNSSEC.
                                                                                                                                                                                                                                              HINFOSystem Information. Information about a host: hardware type and operating system description.
                                                                                                                                                                                                                                              MINFOMailbox mail list Information. Defines the mail administrator for a mail list and optionally a mailbox to receive error messages relating to the mail list.
                                                                                                                                                                                                                                              AFSDBAFS Database. Location of the AFS servers.
                                                                                                                                                                                                                                              WKSWell-Known Service. Defines the services and protocols supported by a host. (Deprecated, use the SRV RR instead)
                                                                                                                                                                                                                                              NAPTRNaming Authority Pointer Record. General purpose definition of rule set to be used by applications e.g. VoIP.
                                                                                                                                                                                                                                              NSAPNetwork Service Access Point. Defines record (equivalent of an A record) maps a host name to an endpoint address.


                                                                                                                                                                                                                                              Note that the parameter is not case sensitive, you could type in A or a.", + "enum": [ + "A", + "NS", + "MD", + "MF", + "CNAME", + "SOA", + "MB", + "MG", + "MR", + "NULL", + "WKS", + "PTR", + "HINFO", + "MINFO", + "MX", + "TXT", + "SPF", + "RP", + "AFSDB", + "X25", + "ISDN", + "RT", + "NSAP", + "NSAP_PTR", + "SIG", + "KEY", + "PX", + "GPOS", + "AAAA", + "LOC", + "NXT", + "EID", + "NIMLOC", + "SRV", + "ATMA", + "NAPTR", + "KX", + "CERT", + "A6", + "DNAME", + "OPT", + "DS", + "DNSSIG", + "NSEC", + "DNSKEY", + "NSEC3", + "NSEC3PARAM", + "CDS", + "CDNSKEY", + "CAA", + "TLSA", + "SSHFP", + "OPENPGPKEY", + "URI", + "AVC", + "NINFO", + "DLV", + "DHCID", + "EUI48", + "EUI64", + "NID", + "L32", + "L64", + "HTTPS", + "SVCB" + ], + "type": "string" + }, + "rr_value1": { + "description": "The first or only value required for the DNS resource record, as detailed in the service description.", + "type": "string" + }, + "check_value": { + "description": "A way to check the values of the DNS resource record before upon addition (1) in order to create a record with the same name but with different values.", + "enum": [ + "yes", + "no" + ], + "type": "string" + }, + "view_id": { + "description": "The database identifier (ID) of the DNS view, a unique numeric key value automatically incremented when you add a DNS view. Use the ID to specify the DNS view of your choice.", + "type": "integer" + }, + "view_name": { + "description": "The name of the DNS view.", + "type": "string" + }, + "zone_id": { + "description": "The database identifier (ID) of the DNS zone, a unique numeric key value automatically incremented when you add a DNS zone. Use the ID to specify the DNS zone of your choice.", + "type": "integer" + }, + "zone_name": { + "description": "The name of the DNS zone the object belongs to.", + "type": "string" + }, + "zone_space_id": { + "description": "The database identifier (ID) of the space associated with the DNS zone the record belongs to.", + "type": "integer" + }, + "rr_glue": { + "description": "The shortname of the DNS resource record.", + "type": "string" + }, + "rr_ttl": { + "description": "The time to live of the DNS resource record, in seconds.", + "type": "integer" + }, + "rr_value2": { + "description": "The second value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value3": { + "description": "The third value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value4": { + "description": "The fourth value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value5": { + "description": "The fifth value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value6": { + "description": "The sixth value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value7": { + "description": "The seventh value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "rr_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "rr_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DNS server.", + "type": "string" + }, + "rr_name": { + "description": "The full name of the DNS resource record. Specify it as value, it can either follow the format <rr-name>.<existing-zone-name>.<extension> or be . (a dot).", + "type": "string" + }, + "rr_type": { + "description": "The type of the DNS resource record.


                                                                                                                                                                                                                                              rr_type possible values
                                                                                                                                                                                                                                              ValueRecord type description
                                                                                                                                                                                                                                              SOAStart of Authority. Defines the zone name, an email contact and various time and refresh values applicable to the zone. It is automatically generated upon creation of a zone and cannot be added manually.
                                                                                                                                                                                                                                              NSName Server. Defines the authoritative name server(s) for the domain (defined by the SOA record) or the subdomain. The NS record that indicates which server has authority over a zone is automatically generated upon the creation of a zone, once the server has been synchronized.
                                                                                                                                                                                                                                              AIPv4 Address. An IPv4 address for a host.
                                                                                                                                                                                                                                              PTRPointer Record. Address Resolution, from an IP address (IPv4 or IPv6) to a host. Used in reverse mapping.
                                                                                                                                                                                                                                              AAAAIPv6 Address. An IPv6 address for a host.
                                                                                                                                                                                                                                              CNAMECanonical Name. An alias name for a host.
                                                                                                                                                                                                                                              MXMail Exchange. The mail server/exchanger that services this zone.
                                                                                                                                                                                                                                              SRVServices record. Defines services available in the zone, for example, LDAP, HTTP, etc...
                                                                                                                                                                                                                                              DNAMEDelegation of Reverse Names. Delegation of reverse addresses primarily in IPv6. (Deprecated, use the CNAME RR instead)
                                                                                                                                                                                                                                              TXTText. Information associated with a name.
                                                                                                                                                                                                                                              DSDelegation Signer, a DNSSEC related RR used to verify the validity of the ZSK of a subdomain.
                                                                                                                                                                                                                                              DNSKEYDNS Key. It contains the public cryptographic key used to sign the zone with DNSSEC.
                                                                                                                                                                                                                                              65534A private type record automatically added to the zone once it is signed with DNSSEC.
                                                                                                                                                                                                                                              HINFOSystem Information. Information about a host: hardware type and operating system description.
                                                                                                                                                                                                                                              MINFOMailbox mail list Information. Defines the mail administrator for a mail list and optionally a mailbox to receive error messages relating to the mail list.
                                                                                                                                                                                                                                              AFSDBAFS Database. Location of the AFS servers.
                                                                                                                                                                                                                                              WKSWell-Known Service. Defines the services and protocols supported by a host. (Deprecated, use the SRV RR instead)
                                                                                                                                                                                                                                              NAPTRNaming Authority Pointer Record. General purpose definition of rule set to be used by applications e.g. VoIP.
                                                                                                                                                                                                                                              NSAPNetwork Service Access Point. Defines record (equivalent of an A record) maps a host name to an endpoint address.


                                                                                                                                                                                                                                              Note that the parameter is not case sensitive, you could type in A or a.", + "enum": [ + "A", + "NS", + "MD", + "MF", + "CNAME", + "SOA", + "MB", + "MG", + "MR", + "NULL", + "WKS", + "PTR", + "HINFO", + "MINFO", + "MX", + "TXT", + "SPF", + "RP", + "AFSDB", + "X25", + "ISDN", + "RT", + "NSAP", + "NSAP_PTR", + "SIG", + "KEY", + "PX", + "GPOS", + "AAAA", + "LOC", + "NXT", + "EID", + "NIMLOC", + "SRV", + "ATMA", + "NAPTR", + "KX", + "CERT", + "A6", + "DNAME", + "OPT", + "DS", + "DNSSIG", + "NSEC", + "DNSKEY", + "NSEC3", + "NSEC3PARAM", + "CDS", + "CDNSKEY", + "CAA", + "TLSA", + "SSHFP", + "OPENPGPKEY", + "URI", + "AVC", + "NINFO", + "DLV", + "DHCID", + "EUI48", + "EUI64", + "NID", + "L32", + "L64", + "HTTPS", + "SVCB" + ], + "type": "string" + }, + "rr_value1": { + "description": "The first or only value required for the DNS resource record, as detailed in the service description.", + "type": "string" + }, + "check_value": { + "description": "A way to check the values of the DNS resource record before upon addition (1) in order to create a record with the same name but with different values.", + "enum": [ + "yes", + "no" + ], + "type": "string" + }, + "view_id": { + "description": "The database identifier (ID) of the DNS view, a unique numeric key value automatically incremented when you add a DNS view. Use the ID to specify the DNS view of your choice.", + "type": "integer" + }, + "view_name": { + "description": "The name of the DNS view.", + "type": "string" + }, + "zone_id": { + "description": "The database identifier (ID) of the DNS zone, a unique numeric key value automatically incremented when you add a DNS zone. Use the ID to specify the DNS zone of your choice.", + "type": "integer" + }, + "zone_name": { + "description": "The name of the DNS zone the object belongs to.", + "type": "string" + }, + "zone_space_id": { + "description": "The database identifier (ID) of the space associated with the DNS zone the record belongs to.", + "type": "integer" + }, + "rr_glue": { + "description": "The shortname of the DNS resource record.", + "type": "string" + }, + "rr_ttl": { + "description": "The time to live of the DNS resource record, in seconds.", + "type": "integer" + }, + "rr_value2": { + "description": "The second value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value3": { + "description": "The third value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value4": { + "description": "The fourth value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value5": { + "description": "The fifth value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value6": { + "description": "The sixth value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value7": { + "description": "The seventh value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "rr_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "rr_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "c65b9602-db76-436d-9625-e389319182fd", + "created": "2026-08-25T15:04:01.598Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 69, + "reference": "dc524721-fec6-4e45-9895-c3fa3f60cb18", + "type": "workflow", + "folder": "/DNS", + "document": { + "name": "Delete DNS Resource Record", + "description": "Delete DNS Resource Record", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dns_rr_delete", + "canvasName": "dns_rr_delete", + "summary": "dns_rr_delete", + "description": "dns_rr_delete", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "server_id": "$var.job.server_id", + "server_name": "$var.job.server_name", + "server_hostaddr": "$var.job.server_hostaddr", + "rr_id": "$var.job.rr_id", + "rr_name": "$var.job.rr_name", + "view_id": "$var.job.view_id", + "view_name": "$var.job.view_name", + "zone_id": "$var.job.zone_id", + "zone_name": "$var.job.zone_name", + "zone_space_id": "$var.job.zone_space_id", + "rr_type": "$var.job.rr_type", + "rr_value1": "$var.job.rr_value1", + "rr_value2": "$var.job.rr_value2", + "rr_value3": "$var.job.rr_value3", + "rr_value4": "$var.job.rr_value4", + "rr_value5": "$var.job.rr_value5", + "rr_value6": "$var.job.rr_value6", + "rr_value7": "$var.job.rr_value7", + "warnings": "$var.job.warnings" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "server_id": { + "type": "integer" + }, + "server_name": { + "type": "string" + }, + "server_hostaddr": { + "type": "string" + }, + "rr_id": { + "type": "integer" + }, + "rr_name": { + "type": "string" + }, + "view_id": { + "type": "integer" + }, + "view_name": { + "type": "string" + }, + "zone_id": { + "type": "integer" + }, + "zone_name": { + "type": "string" + }, + "zone_space_id": { + "type": "integer" + }, + "rr_type": { + "enum": [ + "A", + "NS", + "MD", + "MF", + "CNAME", + "SOA", + "MB", + "MG", + "MR", + "NULL", + "WKS", + "PTR", + "HINFO", + "MINFO", + "MX", + "TXT", + "SPF", + "RP", + "AFSDB", + "X25", + "ISDN", + "RT", + "NSAP", + "NSAP_PTR", + "SIG", + "KEY", + "PX", + "GPOS", + "AAAA", + "LOC", + "NXT", + "EID", + "NIMLOC", + "SRV", + "ATMA", + "NAPTR", + "KX", + "CERT", + "A6", + "DNAME", + "OPT", + "DS", + "DNSSIG", + "NSEC", + "DNSKEY", + "NSEC3", + "NSEC3PARAM", + "CDS", + "CDNSKEY", + "CAA", + "TLSA", + "SSHFP", + "OPENPGPKEY", + "URI", + "AVC", + "NINFO", + "DLV", + "DHCID", + "EUI48", + "EUI64", + "NID", + "L32", + "L64", + "HTTPS", + "SVCB" + ], + "type": "string" + }, + "rr_value1": { + "type": "string" + }, + "rr_value2": { + "type": "string" + }, + "rr_value3": { + "type": "string" + }, + "rr_value4": { + "type": "string" + }, + "rr_value5": { + "type": "string" + }, + "rr_value6": { + "type": "string" + }, + "rr_value7": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + } + }, + "required": [ + "server_id", + "server_name", + "server_hostaddr", + "rr_id", + "rr_name", + "view_id", + "view_name", + "zone_id", + "zone_name", + "zone_space_id", + "rr_type", + "rr_value1", + "rr_value2", + "rr_value3", + "rr_value4", + "rr_value5", + "rr_value6", + "rr_value7", + "warnings" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "server_id": { + "type": "integer" + }, + "server_name": { + "type": "string" + }, + "server_hostaddr": { + "type": "string" + }, + "rr_id": { + "type": "integer" + }, + "rr_name": { + "type": "string" + }, + "view_id": { + "type": "integer" + }, + "view_name": { + "type": "string" + }, + "zone_id": { + "type": "integer" + }, + "zone_name": { + "type": "string" + }, + "zone_space_id": { + "type": "integer" + }, + "rr_type": { + "enum": [ + "A", + "NS", + "MD", + "MF", + "CNAME", + "SOA", + "MB", + "MG", + "MR", + "NULL", + "WKS", + "PTR", + "HINFO", + "MINFO", + "MX", + "TXT", + "SPF", + "RP", + "AFSDB", + "X25", + "ISDN", + "RT", + "NSAP", + "NSAP_PTR", + "SIG", + "KEY", + "PX", + "GPOS", + "AAAA", + "LOC", + "NXT", + "EID", + "NIMLOC", + "SRV", + "ATMA", + "NAPTR", + "KX", + "CERT", + "A6", + "DNAME", + "OPT", + "DS", + "DNSSIG", + "NSEC", + "DNSKEY", + "NSEC3", + "NSEC3PARAM", + "CDS", + "CDNSKEY", + "CAA", + "TLSA", + "SSHFP", + "OPENPGPKEY", + "URI", + "AVC", + "NINFO", + "DLV", + "DHCID", + "EUI48", + "EUI64", + "NID", + "L32", + "L64", + "HTTPS", + "SVCB" + ], + "type": "string" + }, + "rr_value1": { + "type": "string" + }, + "rr_value2": { + "type": "string" + }, + "rr_value3": { + "type": "string" + }, + "rr_value4": { + "type": "string" + }, + "rr_value5": { + "type": "string" + }, + "rr_value6": { + "type": "string" + }, + "rr_value7": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "9158e845-78a3-4180-b3f9-b44b3de8dbb5", + "created": "2026-08-25T15:04:01.631Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 70, + "reference": "1f66ddfa-3ca6-475c-a120-8dd18f60b899", + "type": "workflow", + "folder": "/DNS", + "document": { + "name": "Update DNS Resource Record", + "description": "Update DNS Resource Record", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dns_rr_edit", + "canvasName": "dns_rr_edit", + "summary": "dns_rr_edit", + "description": "dns_rr_edit", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DNS server.", + "type": "string" + }, + "rr_id": { + "description": "The database identifier (ID) of the DNS resource record, a unique numeric key value automatically incremented when you add a DNS RR. Use the ID to specify the record of your choice.", + "type": "integer" + }, + "rr_name": { + "description": "The full name of the DNS resource record. Specify it as value, it can either follow the format <rr-name>.<existing-zone-name>.<extension> or be . (a dot).", + "type": "string" + }, + "rr_type": { + "description": "The type of the DNS resource record.


                                                                                                                                                                                                                                              rr_type possible values
                                                                                                                                                                                                                                              ValueRecord type description
                                                                                                                                                                                                                                              SOAStart of Authority. Defines the zone name, an email contact and various time and refresh values applicable to the zone. It is automatically generated upon creation of a zone and cannot be added manually.
                                                                                                                                                                                                                                              NSName Server. Defines the authoritative name server(s) for the domain (defined by the SOA record) or the subdomain. The NS record that indicates which server has authority over a zone is automatically generated upon the creation of a zone, once the server has been synchronized.
                                                                                                                                                                                                                                              AIPv4 Address. An IPv4 address for a host.
                                                                                                                                                                                                                                              PTRPointer Record. Address Resolution, from an IP address (IPv4 or IPv6) to a host. Used in reverse mapping.
                                                                                                                                                                                                                                              AAAAIPv6 Address. An IPv6 address for a host.
                                                                                                                                                                                                                                              CNAMECanonical Name. An alias name for a host.
                                                                                                                                                                                                                                              MXMail Exchange. The mail server/exchanger that services this zone.
                                                                                                                                                                                                                                              SRVServices record. Defines services available in the zone, for example, LDAP, HTTP, etc...
                                                                                                                                                                                                                                              DNAMEDelegation of Reverse Names. Delegation of reverse addresses primarily in IPv6. (Deprecated, use the CNAME RR instead)
                                                                                                                                                                                                                                              TXTText. Information associated with a name.
                                                                                                                                                                                                                                              DSDelegation Signer, a DNSSEC related RR used to verify the validity of the ZSK of a subdomain.
                                                                                                                                                                                                                                              DNSKEYDNS Key. It contains the public cryptographic key used to sign the zone with DNSSEC.
                                                                                                                                                                                                                                              65534A private type record automatically added to the zone once it is signed with DNSSEC.
                                                                                                                                                                                                                                              HINFOSystem Information. Information about a host: hardware type and operating system description.
                                                                                                                                                                                                                                              MINFOMailbox mail list Information. Defines the mail administrator for a mail list and optionally a mailbox to receive error messages relating to the mail list.
                                                                                                                                                                                                                                              AFSDBAFS Database. Location of the AFS servers.
                                                                                                                                                                                                                                              WKSWell-Known Service. Defines the services and protocols supported by a host. (Deprecated, use the SRV RR instead)
                                                                                                                                                                                                                                              NAPTRNaming Authority Pointer Record. General purpose definition of rule set to be used by applications e.g. VoIP.
                                                                                                                                                                                                                                              NSAPNetwork Service Access Point. Defines record (equivalent of an A record) maps a host name to an endpoint address.


                                                                                                                                                                                                                                              Note that the parameter is not case sensitive, you could type in A or a.", + "enum": [ + "A", + "NS", + "MD", + "MF", + "CNAME", + "SOA", + "MB", + "MG", + "MR", + "NULL", + "WKS", + "PTR", + "HINFO", + "MINFO", + "MX", + "TXT", + "SPF", + "RP", + "AFSDB", + "X25", + "ISDN", + "RT", + "NSAP", + "NSAP_PTR", + "SIG", + "KEY", + "PX", + "GPOS", + "AAAA", + "LOC", + "NXT", + "EID", + "NIMLOC", + "SRV", + "ATMA", + "NAPTR", + "KX", + "CERT", + "A6", + "DNAME", + "OPT", + "DS", + "DNSSIG", + "NSEC", + "DNSKEY", + "NSEC3", + "NSEC3PARAM", + "CDS", + "CDNSKEY", + "CAA", + "TLSA", + "SSHFP", + "OPENPGPKEY", + "URI", + "AVC", + "NINFO", + "DLV", + "DHCID", + "EUI48", + "EUI64", + "NID", + "L32", + "L64", + "HTTPS", + "SVCB" + ], + "type": "string" + }, + "rr_value1": { + "description": "The first or only value required for the DNS resource record, as detailed in the service description.", + "type": "string" + }, + "check_value": { + "description": "A way to check the values of the DNS resource record before upon addition (1) in order to create a record with the same name but with different values.", + "enum": [ + "yes", + "no" + ], + "type": "string" + }, + "view_id": { + "description": "The database identifier (ID) of the DNS view, a unique numeric key value automatically incremented when you add a DNS view. Use the ID to specify the DNS view of your choice.", + "type": "integer" + }, + "view_name": { + "description": "The name of the DNS view.", + "type": "string" + }, + "zone_id": { + "description": "The database identifier (ID) of the DNS zone, a unique numeric key value automatically incremented when you add a DNS zone. Use the ID to specify the DNS zone of your choice.", + "type": "integer" + }, + "zone_name": { + "description": "The name of the DNS zone the object belongs to.", + "type": "string" + }, + "zone_space_id": { + "description": "The database identifier (ID) of the space associated with the DNS zone the record belongs to.", + "type": "integer" + }, + "rr_glue": { + "description": "The shortname of the DNS resource record.", + "type": "string" + }, + "rr_ttl": { + "description": "The time to live of the DNS resource record, in seconds.", + "type": "integer" + }, + "rr_value2": { + "description": "The second value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value3": { + "description": "The third value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value4": { + "description": "The fourth value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value5": { + "description": "The fifth value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value6": { + "description": "The sixth value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value7": { + "description": "The seventh value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "rr_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "rr_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DNS server.", + "type": "string" + }, + "rr_id": { + "description": "The database identifier (ID) of the DNS resource record, a unique numeric key value automatically incremented when you add a DNS RR. Use the ID to specify the record of your choice.", + "type": "integer" + }, + "rr_name": { + "description": "The full name of the DNS resource record. Specify it as value, it can either follow the format <rr-name>.<existing-zone-name>.<extension> or be . (a dot).", + "type": "string" + }, + "rr_type": { + "description": "The type of the DNS resource record.


                                                                                                                                                                                                                                              rr_type possible values
                                                                                                                                                                                                                                              ValueRecord type description
                                                                                                                                                                                                                                              SOAStart of Authority. Defines the zone name, an email contact and various time and refresh values applicable to the zone. It is automatically generated upon creation of a zone and cannot be added manually.
                                                                                                                                                                                                                                              NSName Server. Defines the authoritative name server(s) for the domain (defined by the SOA record) or the subdomain. The NS record that indicates which server has authority over a zone is automatically generated upon the creation of a zone, once the server has been synchronized.
                                                                                                                                                                                                                                              AIPv4 Address. An IPv4 address for a host.
                                                                                                                                                                                                                                              PTRPointer Record. Address Resolution, from an IP address (IPv4 or IPv6) to a host. Used in reverse mapping.
                                                                                                                                                                                                                                              AAAAIPv6 Address. An IPv6 address for a host.
                                                                                                                                                                                                                                              CNAMECanonical Name. An alias name for a host.
                                                                                                                                                                                                                                              MXMail Exchange. The mail server/exchanger that services this zone.
                                                                                                                                                                                                                                              SRVServices record. Defines services available in the zone, for example, LDAP, HTTP, etc...
                                                                                                                                                                                                                                              DNAMEDelegation of Reverse Names. Delegation of reverse addresses primarily in IPv6. (Deprecated, use the CNAME RR instead)
                                                                                                                                                                                                                                              TXTText. Information associated with a name.
                                                                                                                                                                                                                                              DSDelegation Signer, a DNSSEC related RR used to verify the validity of the ZSK of a subdomain.
                                                                                                                                                                                                                                              DNSKEYDNS Key. It contains the public cryptographic key used to sign the zone with DNSSEC.
                                                                                                                                                                                                                                              65534A private type record automatically added to the zone once it is signed with DNSSEC.
                                                                                                                                                                                                                                              HINFOSystem Information. Information about a host: hardware type and operating system description.
                                                                                                                                                                                                                                              MINFOMailbox mail list Information. Defines the mail administrator for a mail list and optionally a mailbox to receive error messages relating to the mail list.
                                                                                                                                                                                                                                              AFSDBAFS Database. Location of the AFS servers.
                                                                                                                                                                                                                                              WKSWell-Known Service. Defines the services and protocols supported by a host. (Deprecated, use the SRV RR instead)
                                                                                                                                                                                                                                              NAPTRNaming Authority Pointer Record. General purpose definition of rule set to be used by applications e.g. VoIP.
                                                                                                                                                                                                                                              NSAPNetwork Service Access Point. Defines record (equivalent of an A record) maps a host name to an endpoint address.


                                                                                                                                                                                                                                              Note that the parameter is not case sensitive, you could type in A or a.", + "enum": [ + "A", + "NS", + "MD", + "MF", + "CNAME", + "SOA", + "MB", + "MG", + "MR", + "NULL", + "WKS", + "PTR", + "HINFO", + "MINFO", + "MX", + "TXT", + "SPF", + "RP", + "AFSDB", + "X25", + "ISDN", + "RT", + "NSAP", + "NSAP_PTR", + "SIG", + "KEY", + "PX", + "GPOS", + "AAAA", + "LOC", + "NXT", + "EID", + "NIMLOC", + "SRV", + "ATMA", + "NAPTR", + "KX", + "CERT", + "A6", + "DNAME", + "OPT", + "DS", + "DNSSIG", + "NSEC", + "DNSKEY", + "NSEC3", + "NSEC3PARAM", + "CDS", + "CDNSKEY", + "CAA", + "TLSA", + "SSHFP", + "OPENPGPKEY", + "URI", + "AVC", + "NINFO", + "DLV", + "DHCID", + "EUI48", + "EUI64", + "NID", + "L32", + "L64", + "HTTPS", + "SVCB" + ], + "type": "string" + }, + "rr_value1": { + "description": "The first or only value required for the DNS resource record, as detailed in the service description.", + "type": "string" + }, + "check_value": { + "description": "A way to check the values of the DNS resource record before upon addition (1) in order to create a record with the same name but with different values.", + "enum": [ + "yes", + "no" + ], + "type": "string" + }, + "view_id": { + "description": "The database identifier (ID) of the DNS view, a unique numeric key value automatically incremented when you add a DNS view. Use the ID to specify the DNS view of your choice.", + "type": "integer" + }, + "view_name": { + "description": "The name of the DNS view.", + "type": "string" + }, + "zone_id": { + "description": "The database identifier (ID) of the DNS zone, a unique numeric key value automatically incremented when you add a DNS zone. Use the ID to specify the DNS zone of your choice.", + "type": "integer" + }, + "zone_name": { + "description": "The name of the DNS zone the object belongs to.", + "type": "string" + }, + "zone_space_id": { + "description": "The database identifier (ID) of the space associated with the DNS zone the record belongs to.", + "type": "integer" + }, + "rr_glue": { + "description": "The shortname of the DNS resource record.", + "type": "string" + }, + "rr_ttl": { + "description": "The time to live of the DNS resource record, in seconds.", + "type": "integer" + }, + "rr_value2": { + "description": "The second value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value3": { + "description": "The third value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value4": { + "description": "The fourth value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value5": { + "description": "The fifth value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value6": { + "description": "The sixth value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "rr_value7": { + "description": "The seventh value of the DNS resource record, depending on its type, as detailed in the service description.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "rr_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "rr_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "9e8a4841-0937-46c6-9d92-a3085506fad7", + "created": "2026-08-25T15:04:01.664Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 71, + "reference": "3cfc3ec5-c4f5-453f-91b4-4495f216ad84", + "type": "workflow", + "folder": "/DNS", + "document": { + "name": "Get DNS Resource Record", + "description": "Get DNS Resource Record", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dns_rr_info", + "canvasName": "dns_rr_info", + "summary": "dns_rr_info", + "description": "dns_rr_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "no_parent_class_param": "$var.job.no_parent_class_param", + "rr_id": "$var.job.rr_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "rr_id": { + "type": "integer" + } + }, + "required": [ + "no_parent_class_param", + "rr_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "rr_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "9094f2d6-a1d8-4058-b345-b3e4a2ed6007", + "created": "2026-08-25T15:04:01.694Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 72, + "reference": "a958736d-240f-4da4-8c7e-7504b10c3d3a", + "type": "workflow", + "folder": "/DNS", + "document": { + "name": "List DNS Resource Records", + "description": "List DNS Resource Records", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dns_rr_list", + "canvasName": "dns_rr_list", + "summary": "dns_rr_list", + "description": "dns_rr_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset", + "no_parent_class_param": "$var.job.no_parent_class_param", + "tags": "$var.job.tags" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset", + "no_parent_class_param", + "tags" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "db5aba89-7ea6-4313-872b-d88a1c545399", + "created": "2026-08-25T15:04:01.724Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 73, + "reference": "dd2395d7-174b-4d30-a5a8-027c1350fc79", + "type": "workflow", + "folder": "/DNS", + "document": { + "name": "Get DNS Server", + "description": "Get DNS Server", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dns_server_info", + "canvasName": "dns_server_info", + "summary": "dns_server_info", + "description": "dns_server_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "server_id": "$var.job.server_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "server_id": { + "type": "integer" + } + }, + "required": [ + "server_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "server_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "e03ca5f1-cfd5-4268-92fc-a6bb26eef1dc", + "created": "2026-08-25T15:04:01.755Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 74, + "reference": "9bee974a-5b1b-4934-92b1-75539e2e39e0", + "type": "workflow", + "folder": "/DNS", + "document": { + "name": "List DNS Servers", + "description": "List DNS Servers", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dns_server_list", + "canvasName": "dns_server_list", + "summary": "dns_server_list", + "description": "dns_server_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset", + "tags": "$var.job.tags" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "tags": { + "type": "string" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset", + "tags" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "tags": { + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "77d912e4-234f-4000-a85a-ebac1fbd6d2b", + "created": "2026-08-25T15:04:01.783Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 75, + "reference": "fc2d62b6-544c-49b1-b208-bf3ca3915ea7", + "type": "workflow", + "folder": "/DNS", + "document": { + "name": "EfficientIP Create DNS View", + "description": "EfficientIP Create DNS View", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dns_view_add", + "canvasName": "dns_view_add", + "summary": "dns_view_add", + "description": "dns_view_add", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "view_name": { + "description": "The name of the DNS view, each DNS view must have a unique name.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DNS server.", + "type": "string" + }, + "view_allow_query": { + "description": "The ACL values associated with the allow-query configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_allow_recursion": { + "description": "The ACL values associated with the allow-recursion configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_allow_transfer": { + "description": "The ACL values associated with the allow-transfer configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_match_clients": { + "description": "The ACL values associated with the match clients configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_match_to": { + "description": "The ACL values associated with the match destination configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_order": { + "description": "The level of the DNS view, where 0 represents the highest level in the views hierarchy. The parameters dnsview_match_client and view_match_to of each view in a server are reviewed following this order.", + "type": "integer" + }, + "view_recursion": { + "description": "The recursion status of the DNS view:


                                                                                                                                                                                                                                              view_recursion possible values
                                                                                                                                                                                                                                              StatusDescription
                                                                                                                                                                                                                                              noThe view only provides iterative query behavior - normally resulting in a referral. If the answer to the query already exists in the cache it will be returned whatever the value of this statement.
                                                                                                                                                                                                                                              yesThe view always provides recursive query behavior if requested by the client.


                                                                                                                                                                                                                                              ", + "enum": [ + "yes", + "no" + ], + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "view_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "view_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "view_name": { + "description": "The name of the DNS view, each DNS view must have a unique name.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DNS server.", + "type": "string" + }, + "view_allow_query": { + "description": "The ACL values associated with the allow-query configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_allow_recursion": { + "description": "The ACL values associated with the allow-recursion configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_allow_transfer": { + "description": "The ACL values associated with the allow-transfer configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_match_clients": { + "description": "The ACL values associated with the match clients configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_match_to": { + "description": "The ACL values associated with the match destination configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_order": { + "description": "The level of the DNS view, where 0 represents the highest level in the views hierarchy. The parameters dnsview_match_client and view_match_to of each view in a server are reviewed following this order.", + "type": "integer" + }, + "view_recursion": { + "description": "The recursion status of the DNS view:


                                                                                                                                                                                                                                              view_recursion possible values
                                                                                                                                                                                                                                              StatusDescription
                                                                                                                                                                                                                                              noThe view only provides iterative query behavior - normally resulting in a referral. If the answer to the query already exists in the cache it will be returned whatever the value of this statement.
                                                                                                                                                                                                                                              yesThe view always provides recursive query behavior if requested by the client.


                                                                                                                                                                                                                                              ", + "enum": [ + "yes", + "no" + ], + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "view_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "view_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "0594622b-6777-444f-8339-c98aacb90391", + "created": "2026-08-25T15:04:01.816Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 76, + "reference": "8abe08a0-f981-4a58-97fa-72faea432d92", + "type": "workflow", + "folder": "/DNS", + "document": { + "name": "EfficientIP Delete DNS View", + "description": "EfficientIP Delete DNS View", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dns_view_delete", + "canvasName": "dns_view_delete", + "summary": "dns_view_delete", + "description": "dns_view_delete", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "server_id": "$var.job.server_id", + "server_name": "$var.job.server_name", + "view_id": "$var.job.view_id", + "view_name": "$var.job.view_name", + "server_hostaddr": "$var.job.server_hostaddr", + "warnings": "$var.job.warnings" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "server_id": { + "type": "integer" + }, + "server_name": { + "type": "string" + }, + "view_id": { + "type": "integer" + }, + "view_name": { + "type": "string" + }, + "server_hostaddr": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + } + }, + "required": [ + "server_id", + "server_name", + "view_id", + "view_name", + "server_hostaddr", + "warnings" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "server_id": { + "type": "integer" + }, + "server_name": { + "type": "string" + }, + "view_id": { + "type": "integer" + }, + "view_name": { + "type": "string" + }, + "server_hostaddr": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "1abffce8-4fbb-4093-bd3b-dc47a895df20", + "created": "2026-08-25T15:04:01.850Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 77, + "reference": "4729a2ed-8a64-4663-87f8-eae00512b30e", + "type": "workflow", + "folder": "/DNS", + "document": { + "name": "EfficientIP Update DNS View", + "description": "EfficientIP Update DNS View", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dns_view_edit", + "canvasName": "dns_view_edit", + "summary": "dns_view_edit", + "description": "dns_view_edit", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "view_id": { + "description": "The database identifier (ID) of the DNS view, a unique numeric key value automatically incremented when you add a DNS view. Use the ID to specify the DNS view of your choice.", + "type": "integer" + }, + "view_name": { + "description": "The name of the DNS view, each DNS view must have a unique name.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DNS server.", + "type": "string" + }, + "view_allow_query": { + "description": "The ACL values associated with the allow-query configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_allow_recursion": { + "description": "The ACL values associated with the allow-recursion configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_allow_transfer": { + "description": "The ACL values associated with the allow-transfer configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_match_clients": { + "description": "The ACL values associated with the match clients configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_match_to": { + "description": "The ACL values associated with the match destination configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_order": { + "description": "The level of the DNS view, where 0 represents the highest level in the views hierarchy. The parameters dnsview_match_client and view_match_to of each view in a server are reviewed following this order.", + "type": "integer" + }, + "view_recursion": { + "description": "The recursion status of the DNS view:


                                                                                                                                                                                                                                              view_recursion possible values
                                                                                                                                                                                                                                              StatusDescription
                                                                                                                                                                                                                                              noThe view only provides iterative query behavior - normally resulting in a referral. If the answer to the query already exists in the cache it will be returned whatever the value of this statement.
                                                                                                                                                                                                                                              yesThe view always provides recursive query behavior if requested by the client.


                                                                                                                                                                                                                                              ", + "enum": [ + "yes", + "no" + ], + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "view_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "view_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "view_id": { + "description": "The database identifier (ID) of the DNS view, a unique numeric key value automatically incremented when you add a DNS view. Use the ID to specify the DNS view of your choice.", + "type": "integer" + }, + "view_name": { + "description": "The name of the DNS view, each DNS view must have a unique name.", + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DNS server.", + "type": "string" + }, + "view_allow_query": { + "description": "The ACL values associated with the allow-query configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_allow_recursion": { + "description": "The ACL values associated with the allow-recursion configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_allow_transfer": { + "description": "The ACL values associated with the allow-transfer configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_match_clients": { + "description": "The ACL values associated with the match clients configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_match_to": { + "description": "The ACL values associated with the match destination configuration of the DNS view, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "view_order": { + "description": "The level of the DNS view, where 0 represents the highest level in the views hierarchy. The parameters dnsview_match_client and view_match_to of each view in a server are reviewed following this order.", + "type": "integer" + }, + "view_recursion": { + "description": "The recursion status of the DNS view:


                                                                                                                                                                                                                                              view_recursion possible values
                                                                                                                                                                                                                                              StatusDescription
                                                                                                                                                                                                                                              noThe view only provides iterative query behavior - normally resulting in a referral. If the answer to the query already exists in the cache it will be returned whatever the value of this statement.
                                                                                                                                                                                                                                              yesThe view always provides recursive query behavior if requested by the client.


                                                                                                                                                                                                                                              ", + "enum": [ + "yes", + "no" + ], + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "view_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "view_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "18bb7760-81c4-49bf-ae2a-1c50caf9b434", + "created": "2026-08-25T15:04:01.877Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 78, + "reference": "492618c2-98ef-44fb-97be-3908187cd551", + "type": "workflow", + "folder": "/DNS", + "document": { + "name": "EfficientIP Get DNS View", + "description": "EfficientIP Get DNS View", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dns_view_info", + "canvasName": "dns_view_info", + "summary": "dns_view_info", + "description": "dns_view_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "no_parent_class_param": "$var.job.no_parent_class_param", + "view_id": "$var.job.view_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "view_id": { + "type": "integer" + } + }, + "required": [ + "no_parent_class_param", + "view_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "view_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "c90d7f3e-f541-4d5b-b23f-f0d5f8ec782d", + "created": "2026-08-25T15:04:01.905Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 79, + "reference": "3fb1ec86-fb68-42fc-9f00-f14bffeec38d", + "type": "workflow", + "folder": "/DNS", + "document": { + "name": "EfficientIP List DNS Views", + "description": "EfficientIP List DNS Views", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dns_view_list", + "canvasName": "dns_view_list", + "summary": "dns_view_list", + "description": "dns_view_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset", + "no_parent_class_param": "$var.job.no_parent_class_param", + "tags": "$var.job.tags" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset", + "no_parent_class_param", + "tags" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "c540c65b-d438-4c1c-84d9-466b7d988320", + "created": "2026-08-25T15:04:01.936Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 80, + "reference": "248ba776-2e04-49fb-847f-01aaa0383c73", + "type": "workflow", + "folder": "/DNS", + "document": { + "name": "Create DNS View Parameter", + "description": "Create DNS View Parameter", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dns_viewparam_add", + "canvasName": "dns_viewparam_add", + "summary": "dns_viewparam_add", + "description": "dns_viewparam_add", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "view_id": { + "description": "The database identifier (ID) of the DNS view. Use the ID to specify the DNS view of your choice.", + "type": "integer" + }, + "viewparam_key": { + "description": "The name of the DNS option you want to add, edit or remove from the view. You can only set one option at a time.
                                                                                                                                                                                                                                              • To add or edit an option: specify its name in the parameter viewparam_key, as follows viewparam_key=<option-name>, and then specify its value in the parameter viewparam_value.
                                                                                                                                                                                                                                              • To remove an option, specify its name in the parameter viewparam_key and leave the parameter viewparam_value empty.
                                                                                                                                                                                                                                              To set several options, specify as many parameters (viewparam_key and viewparam_value) as you need.", + "type": "string" + }, + "viewparam_is_array": { + "description": "A way to determine is the DNS view option is an array (1).", + "type": "integer" + }, + "viewparam_value": { + "description": "The value of the DNS option specified in the input viewparam_key.
                                                                                                                                                                                                                                              • To add or edit an option value, specify its name in the parameter viewparam_key and set its value as follows: viewparam_value=<option-value> .
                                                                                                                                                                                                                                              • To remove an option value, specify its name in the parameter viewparam_key and leave viewparam_value empty: viewparam_value= .
                                                                                                                                                                                                                                              ", + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "view_id": { + "description": "The database identifier (ID) of the DNS view. Use the ID to specify the DNS view of your choice.", + "type": "integer" + }, + "viewparam_key": { + "description": "The name of the DNS option you want to add, edit or remove from the view. You can only set one option at a time.
                                                                                                                                                                                                                                              • To add or edit an option: specify its name in the parameter viewparam_key, as follows viewparam_key=<option-name>, and then specify its value in the parameter viewparam_value.
                                                                                                                                                                                                                                              • To remove an option, specify its name in the parameter viewparam_key and leave the parameter viewparam_value empty.
                                                                                                                                                                                                                                              To set several options, specify as many parameters (viewparam_key and viewparam_value) as you need.", + "type": "string" + }, + "viewparam_is_array": { + "description": "A way to determine is the DNS view option is an array (1).", + "type": "integer" + }, + "viewparam_value": { + "description": "The value of the DNS option specified in the input viewparam_key.
                                                                                                                                                                                                                                              • To add or edit an option value, specify its name in the parameter viewparam_key and set its value as follows: viewparam_value=<option-value> .
                                                                                                                                                                                                                                              • To remove an option value, specify its name in the parameter viewparam_key and leave viewparam_value empty: viewparam_value= .
                                                                                                                                                                                                                                              ", + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "8184882a-8911-4cac-bf4f-4edd921d8fa3", + "created": "2026-08-25T15:04:01.962Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 81, + "reference": "1fa633c0-7145-47ea-be4b-c680a9b5d07b", + "type": "workflow", + "folder": "/DNS", + "document": { + "name": "Delete DNS View Parameter", + "description": "Delete DNS View Parameter", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dns_viewparam_delete", + "canvasName": "dns_viewparam_delete", + "summary": "dns_viewparam_delete", + "description": "dns_viewparam_delete", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "view_id": "$var.job.view_id", + "viewparam_key": "$var.job.viewparam_key" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "view_id": { + "type": "integer" + }, + "viewparam_key": { + "type": "string" + } + }, + "required": [ + "view_id", + "viewparam_key" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "view_id": { + "type": "integer" + }, + "viewparam_key": { + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "41b51874-063c-4c13-b800-4ba4be4e3b0d", + "created": "2026-08-25T15:04:01.990Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 82, + "reference": "12e68e7e-e8bc-4209-b1d3-53ba72465586", + "type": "workflow", + "folder": "/DNS", + "document": { + "name": "Update DNS View Parameter", + "description": "Update DNS View Parameter", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dns_viewparam_edit", + "canvasName": "dns_viewparam_edit", + "summary": "dns_viewparam_edit", + "description": "dns_viewparam_edit", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "view_id": { + "description": "The database identifier (ID) of the DNS view. Use the ID to specify the DNS view of your choice.", + "type": "integer" + }, + "viewparam_key": { + "description": "The name of the DNS option you want to add, edit or remove from the view. You can only set one option at a time.
                                                                                                                                                                                                                                              • To add or edit an option: specify its name in the parameter viewparam_key, as follows viewparam_key=<option-name>, and then specify its value in the parameter viewparam_value.
                                                                                                                                                                                                                                              • To remove an option, specify its name in the parameter viewparam_key and leave the parameter viewparam_value empty.
                                                                                                                                                                                                                                              To set several options, specify as many parameters (viewparam_key and viewparam_value) as you need.", + "type": "string" + }, + "viewparam_is_array": { + "description": "A way to determine is the DNS view option is an array (1).", + "type": "integer" + }, + "viewparam_value": { + "description": "The value of the DNS option specified in the input viewparam_key.
                                                                                                                                                                                                                                              • To add or edit an option value, specify its name in the parameter viewparam_key and set its value as follows: viewparam_value=<option-value> .
                                                                                                                                                                                                                                              • To remove an option value, specify its name in the parameter viewparam_key and leave viewparam_value empty: viewparam_value= .
                                                                                                                                                                                                                                              ", + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "view_id": { + "description": "The database identifier (ID) of the DNS view. Use the ID to specify the DNS view of your choice.", + "type": "integer" + }, + "viewparam_key": { + "description": "The name of the DNS option you want to add, edit or remove from the view. You can only set one option at a time.
                                                                                                                                                                                                                                              • To add or edit an option: specify its name in the parameter viewparam_key, as follows viewparam_key=<option-name>, and then specify its value in the parameter viewparam_value.
                                                                                                                                                                                                                                              • To remove an option, specify its name in the parameter viewparam_key and leave the parameter viewparam_value empty.
                                                                                                                                                                                                                                              To set several options, specify as many parameters (viewparam_key and viewparam_value) as you need.", + "type": "string" + }, + "viewparam_is_array": { + "description": "A way to determine is the DNS view option is an array (1).", + "type": "integer" + }, + "viewparam_value": { + "description": "The value of the DNS option specified in the input viewparam_key.
                                                                                                                                                                                                                                              • To add or edit an option value, specify its name in the parameter viewparam_key and set its value as follows: viewparam_value=<option-value> .
                                                                                                                                                                                                                                              • To remove an option value, specify its name in the parameter viewparam_key and leave viewparam_value empty: viewparam_value= .
                                                                                                                                                                                                                                              ", + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "42494fc7-14a3-44cc-99f6-42632433ff13", + "created": "2026-08-25T15:04:02.021Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 83, + "reference": "b15c7dd2-b2ee-4263-a95c-88dbb4aef8eb", + "type": "workflow", + "folder": "/DNS", + "document": { + "name": "Get DNS View Parameter", + "description": "Get DNS View Parameter", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dns_viewparam_info", + "canvasName": "dns_viewparam_info", + "summary": "dns_viewparam_info", + "description": "dns_viewparam_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "view_id": "$var.job.view_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "view_id": { + "type": "integer" + } + }, + "required": [ + "view_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "view_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "3ead5ff7-8877-48a7-970f-10ab806234b4", + "created": "2026-08-25T15:04:02.050Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 84, + "reference": "74f953bc-a6ac-464b-80f0-c17d30beba1f", + "type": "workflow", + "folder": "/DNS", + "document": { + "name": "List DNS View Parameters", + "description": "List DNS View Parameters", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dns_viewparam_list", + "canvasName": "dns_viewparam_list", + "summary": "dns_viewparam_list", + "description": "dns_viewparam_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "9cbd478e-d38b-46b3-94c5-312ee80e85a4", + "created": "2026-08-25T15:04:02.081Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 85, + "reference": "64c33817-ee3d-4cb7-9ff0-bd7b9a643dfd", + "type": "workflow", + "folder": "/DNS", + "document": { + "name": "Create DNS Zone", + "description": "Create DNS Zone", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dns_zone_add", + "canvasName": "dns_zone_add", + "summary": "dns_zone_add", + "description": "dns_zone_add", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "view_id": { + "description": "The database identifier (ID) of the DNS view the object belongs to.", + "type": "integer" + }, + "view_name": { + "description": "The name of the DNS view the object belongs to.", + "type": "string" + }, + "zone_name": { + "description": "The name of the DNS zone, each DNS zone must have a unique name. For hint zones (zone_type: hint), you must type in . (dot) as zone_name.", + "type": "string" + }, + "zone_type": { + "description": "The type of the DNS zone, either master, slave, forward, stub, hint or delegation-only.", + "enum": [ + "master", + "slave", + "hint", + "stub", + "forward", + "delegation-only" + ], + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DNS server.", + "type": "string" + }, + "server_ddns_scavenging": { + "description": "The DDNS scavenging status of the zone. Set it to 1 to enable the scavenging and automatically delete the stale resource records dynamically added via GSS-TSIG. DDNS scavenging is only effective if the parameters zone_use_update_policy and gss_enabled are set to 1, and the rule 416 is enabled in the GUI.", + "type": "integer" + }, + "zone_ad_integrated": { + "description": "The AD integrated status of the DNS zone. Set it to 1 to indicate that the DNS zone belongs to an Active Directory integrated Microsoft Windows DNS server.", + "type": "integer" + }, + "zone_allow_query": { + "description": "The ACL values associated with the allow-query configuration of the DNS zone, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "zone_allow_transfer": { + "description": "The ACL values associated with the allow-transfer configuration of the DNS zone, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "zone_allow_update": { + "description": "The ACL values associated with the allow-update configuration of the DNS zone, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "zone_also_notify": { + "description": "The IP address and port of the DNS server managing the smart architecture the DNS zone belongs to. If the parameter zone_notify is set to yes or explicit, the server specified is instantly notified of any slave zones updates.", + "type": "string" + }, + "zone_forward": { + "description": "The forwarding mode of the DNS zone.


                                                                                                                                                                                                                                              zone_forward possible values
                                                                                                                                                                                                                                              StatusDescription
                                                                                                                                                                                                                                              firstThe zone sends the queries to the forwarder(s). If no answer is returned, it attempts to answer the queries on its own.
                                                                                                                                                                                                                                              onlyThe zone only forwards the queries to the forwarder(s). Required by some reverse forward zones (e.g., in the case of private addresses).


                                                                                                                                                                                                                                              If the parameter has no value, it indicates that the forwarding is disabled.", + "enum": [ + "none", + "first", + "only", + "default" + ], + "type": "string" + }, + "zone_forwarders": { + "description": "The IP address(es) of the forwarder(s) associated with the DNS zone. It lists the DNS servers to which any unknown query on this zone should be sent, as follows: <ip_address1>;<ip_address2>;... .", + "type": "string" + }, + "zone_is_rpz": { + "description": "The RPZ status of the DNS zone. Set it to 1 to indicate that the DNS zone is a Response Policy Zone.", + "type": "integer" + }, + "zone_masters": { + "description": "For slave DNS zones, the IP address of the DNS server and, if relevant, the name of the DNS view that contain the master DNS zone, as follows: <ip_addr>; or <ip_addr> key <dnsview_name>; .", + "type": "string" + }, + "zone_notify": { + "description": "The notify status of the DNS zone.


                                                                                                                                                                                                                                              zone_notify possible values
                                                                                                                                                                                                                                              StatusDescription
                                                                                                                                                                                                                                              noNo notify message is sent.
                                                                                                                                                                                                                                              yesA notify message is sent to the name servers defined in the NS records of the zone and to the IP address(es) specified in the parameter .
                                                                                                                                                                                                                                              explicitA notify message is sent only to the IP address(es) specified in the parameter .


                                                                                                                                                                                                                                              The notify message is not sent to the server itself or to the primary server defined in the SOA record of the zone.", + "enum": [ + "yes", + "no", + "explicit" + ], + "type": "string" + }, + "zone_order": { + "description": "The level of the RPZ zone, where 0 represents the highest level in the views hierarchy. The RPZ rules of each zone are reviewed following this order. For non-RPZ zones, that have their parameter zone_is_rpz set to 0, you do not need to set this parameter.", + "type": "integer" + }, + "zone_response_policy": { + "description": "The response policy of the DNS zone. All the zones can be set with the policy given, only RPZ zones can be set with other policies.


                                                                                                                                                                                                                                              zone_response_policy possible values
                                                                                                                                                                                                                                              PolicyDescription
                                                                                                                                                                                                                                              givenAll the rules specified in the RPZ zone are applied normally.
                                                                                                                                                                                                                                              disabledThe RPZ zone rules configuration is not applied. All the rules it contains are ignored.
                                                                                                                                                                                                                                              passthruThe rules specified in the RPZ matching the listed RR names are ignored, no matter the RPZ zone they belong to.
                                                                                                                                                                                                                                              nxdomainThe rules specified in the RPZ return an NXDOMAIN response.
                                                                                                                                                                                                                                              nodataThe rules specified in the RPZ return a NODATA response.
                                                                                                                                                                                                                                              cname All the rules specified in the RPZ are redirected toward the specified domain name.


                                                                                                                                                                                                                                              You can only add RPZ zones on EfficientIP or BIND DNS servers.", + "type": "string" + }, + "zone_rpz_log": { + "description": "The RPZ logging status, if zone_is_rpz is set to 1 or yes. It allows you to log all the operations triggered by the RPZ rules of the zone.", + "type": "integer" + }, + "zone_rpz_max_policy_ttl": { + "description": "A way to set the number of seconds of the max policy Time To Live of the zone. By default, the parameter is empty, and the Server max policy TTL of the zone is of 5 seconds. It overrides the same option set at server level.", + "type": "integer" + }, + "zone_rpz_recursive_only": { + "description": "A way to Enable recursive-only on the server for the zone. By default it is enabled (1) and, for this zone, the server only processes policies on recursive queries. It overrides the same option set at server level.", + "type": "integer" + }, + "zone_space_id": { + "description": "The database identifier (ID) of the space associated with the DNS zone the record belongs to.", + "type": "integer" + }, + "zone_space_name": { + "description": "The name of the space associated with the DNS zone the record belongs to.", + "type": "string" + }, + "row_state": { + "description": "The object activation status.
                                                                                                                                                                                                                                              • If set to 0, the object is present in the database but ignored, i.e. it cannot be managed, counted or listed. This status is applied on objects deleted from the GUI.
                                                                                                                                                                                                                                              • If set to 1, the object is enabled and managed.
                                                                                                                                                                                                                                              • If set to 2, the object is unmanaged, disabled or both depending on the context.
                                                                                                                                                                                                                                              By default, row_state is set to 1 when an object is created.", + "type": "integer" + }, + "zone_use_update_policy": { + "description": "The update policy status of the DNS zone. Set it to 1 to indicate that the DNS zone uses a specific GSS-TSIG/update-policy. You can only configure the zone update policy if the parameter gss_enabled is set to 1.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "zone_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "zone_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "view_id": { + "description": "The database identifier (ID) of the DNS view the object belongs to.", + "type": "integer" + }, + "view_name": { + "description": "The name of the DNS view the object belongs to.", + "type": "string" + }, + "zone_name": { + "description": "The name of the DNS zone, each DNS zone must have a unique name. For hint zones (zone_type: hint), you must type in . (dot) as zone_name.", + "type": "string" + }, + "zone_type": { + "description": "The type of the DNS zone, either master, slave, forward, stub, hint or delegation-only.", + "enum": [ + "master", + "slave", + "hint", + "stub", + "forward", + "delegation-only" + ], + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DNS server.", + "type": "string" + }, + "server_ddns_scavenging": { + "description": "The DDNS scavenging status of the zone. Set it to 1 to enable the scavenging and automatically delete the stale resource records dynamically added via GSS-TSIG. DDNS scavenging is only effective if the parameters zone_use_update_policy and gss_enabled are set to 1, and the rule 416 is enabled in the GUI.", + "type": "integer" + }, + "zone_ad_integrated": { + "description": "The AD integrated status of the DNS zone. Set it to 1 to indicate that the DNS zone belongs to an Active Directory integrated Microsoft Windows DNS server.", + "type": "integer" + }, + "zone_allow_query": { + "description": "The ACL values associated with the allow-query configuration of the DNS zone, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "zone_allow_transfer": { + "description": "The ACL values associated with the allow-transfer configuration of the DNS zone, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "zone_allow_update": { + "description": "The ACL values associated with the allow-update configuration of the DNS zone, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "zone_also_notify": { + "description": "The IP address and port of the DNS server managing the smart architecture the DNS zone belongs to. If the parameter zone_notify is set to yes or explicit, the server specified is instantly notified of any slave zones updates.", + "type": "string" + }, + "zone_forward": { + "description": "The forwarding mode of the DNS zone.


                                                                                                                                                                                                                                              zone_forward possible values
                                                                                                                                                                                                                                              StatusDescription
                                                                                                                                                                                                                                              firstThe zone sends the queries to the forwarder(s). If no answer is returned, it attempts to answer the queries on its own.
                                                                                                                                                                                                                                              onlyThe zone only forwards the queries to the forwarder(s). Required by some reverse forward zones (e.g., in the case of private addresses).


                                                                                                                                                                                                                                              If the parameter has no value, it indicates that the forwarding is disabled.", + "enum": [ + "none", + "first", + "only", + "default" + ], + "type": "string" + }, + "zone_forwarders": { + "description": "The IP address(es) of the forwarder(s) associated with the DNS zone. It lists the DNS servers to which any unknown query on this zone should be sent, as follows: <ip_address1>;<ip_address2>;... .", + "type": "string" + }, + "zone_is_rpz": { + "description": "The RPZ status of the DNS zone. Set it to 1 to indicate that the DNS zone is a Response Policy Zone.", + "type": "integer" + }, + "zone_masters": { + "description": "For slave DNS zones, the IP address of the DNS server and, if relevant, the name of the DNS view that contain the master DNS zone, as follows: <ip_addr>; or <ip_addr> key <dnsview_name>; .", + "type": "string" + }, + "zone_notify": { + "description": "The notify status of the DNS zone.


                                                                                                                                                                                                                                              zone_notify possible values
                                                                                                                                                                                                                                              StatusDescription
                                                                                                                                                                                                                                              noNo notify message is sent.
                                                                                                                                                                                                                                              yesA notify message is sent to the name servers defined in the NS records of the zone and to the IP address(es) specified in the parameter .
                                                                                                                                                                                                                                              explicitA notify message is sent only to the IP address(es) specified in the parameter .


                                                                                                                                                                                                                                              The notify message is not sent to the server itself or to the primary server defined in the SOA record of the zone.", + "enum": [ + "yes", + "no", + "explicit" + ], + "type": "string" + }, + "zone_order": { + "description": "The level of the RPZ zone, where 0 represents the highest level in the views hierarchy. The RPZ rules of each zone are reviewed following this order. For non-RPZ zones, that have their parameter zone_is_rpz set to 0, you do not need to set this parameter.", + "type": "integer" + }, + "zone_response_policy": { + "description": "The response policy of the DNS zone. All the zones can be set with the policy given, only RPZ zones can be set with other policies.


                                                                                                                                                                                                                                              zone_response_policy possible values
                                                                                                                                                                                                                                              PolicyDescription
                                                                                                                                                                                                                                              givenAll the rules specified in the RPZ zone are applied normally.
                                                                                                                                                                                                                                              disabledThe RPZ zone rules configuration is not applied. All the rules it contains are ignored.
                                                                                                                                                                                                                                              passthruThe rules specified in the RPZ matching the listed RR names are ignored, no matter the RPZ zone they belong to.
                                                                                                                                                                                                                                              nxdomainThe rules specified in the RPZ return an NXDOMAIN response.
                                                                                                                                                                                                                                              nodataThe rules specified in the RPZ return a NODATA response.
                                                                                                                                                                                                                                              cname All the rules specified in the RPZ are redirected toward the specified domain name.


                                                                                                                                                                                                                                              You can only add RPZ zones on EfficientIP or BIND DNS servers.", + "type": "string" + }, + "zone_rpz_log": { + "description": "The RPZ logging status, if zone_is_rpz is set to 1 or yes. It allows you to log all the operations triggered by the RPZ rules of the zone.", + "type": "integer" + }, + "zone_rpz_max_policy_ttl": { + "description": "A way to set the number of seconds of the max policy Time To Live of the zone. By default, the parameter is empty, and the Server max policy TTL of the zone is of 5 seconds. It overrides the same option set at server level.", + "type": "integer" + }, + "zone_rpz_recursive_only": { + "description": "A way to Enable recursive-only on the server for the zone. By default it is enabled (1) and, for this zone, the server only processes policies on recursive queries. It overrides the same option set at server level.", + "type": "integer" + }, + "zone_space_id": { + "description": "The database identifier (ID) of the space associated with the DNS zone the record belongs to.", + "type": "integer" + }, + "zone_space_name": { + "description": "The name of the space associated with the DNS zone the record belongs to.", + "type": "string" + }, + "row_state": { + "description": "The object activation status.
                                                                                                                                                                                                                                              • If set to 0, the object is present in the database but ignored, i.e. it cannot be managed, counted or listed. This status is applied on objects deleted from the GUI.
                                                                                                                                                                                                                                              • If set to 1, the object is enabled and managed.
                                                                                                                                                                                                                                              • If set to 2, the object is unmanaged, disabled or both depending on the context.
                                                                                                                                                                                                                                              By default, row_state is set to 1 when an object is created.", + "type": "integer" + }, + "zone_use_update_policy": { + "description": "The update policy status of the DNS zone. Set it to 1 to indicate that the DNS zone uses a specific GSS-TSIG/update-policy. You can only configure the zone update policy if the parameter gss_enabled is set to 1.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "zone_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "zone_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "8d875a4a-94b1-4719-a95e-5c3bec5527d1", + "created": "2026-08-25T15:04:02.122Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 86, + "reference": "09653230-7d00-40a0-bad4-a73f39aba28d", + "type": "workflow", + "folder": "/DNS", + "document": { + "name": "Delete DNS Zone", + "description": "Delete DNS Zone", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dns_zone_delete", + "canvasName": "dns_zone_delete", + "summary": "dns_zone_delete", + "description": "dns_zone_delete", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "server_id": "$var.job.server_id", + "server_name": "$var.job.server_name", + "view_id": "$var.job.view_id", + "view_name": "$var.job.view_name", + "zone_id": "$var.job.zone_id", + "zone_name": "$var.job.zone_name", + "server_hostaddr": "$var.job.server_hostaddr", + "warnings": "$var.job.warnings" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "server_id": { + "type": "integer" + }, + "server_name": { + "type": "string" + }, + "view_id": { + "type": "integer" + }, + "view_name": { + "type": "string" + }, + "zone_id": { + "type": "integer" + }, + "zone_name": { + "type": "string" + }, + "server_hostaddr": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + } + }, + "required": [ + "server_id", + "server_name", + "view_id", + "view_name", + "zone_id", + "zone_name", + "server_hostaddr", + "warnings" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "server_id": { + "type": "integer" + }, + "server_name": { + "type": "string" + }, + "view_id": { + "type": "integer" + }, + "view_name": { + "type": "string" + }, + "zone_id": { + "type": "integer" + }, + "zone_name": { + "type": "string" + }, + "server_hostaddr": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "388f0382-8891-4e90-994f-92f808b6cbf4", + "created": "2026-08-25T15:04:02.161Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 87, + "reference": "6c2192b3-d3d9-47a6-8c57-b3d0c19e065f", + "type": "workflow", + "folder": "/DNS", + "document": { + "name": "Update DNS Zone", + "description": "Update DNS Zone", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dns_zone_edit", + "canvasName": "dns_zone_edit", + "summary": "dns_zone_edit", + "description": "dns_zone_edit", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "view_id": { + "description": "The database identifier (ID) of the DNS view the object belongs to.", + "type": "integer" + }, + "view_name": { + "description": "The name of the DNS view the object belongs to.", + "type": "string" + }, + "zone_id": { + "description": "The database identifier (ID) of the DNS zone, a unique numeric key value automatically incremented when you add a DNS zone. Use the ID to specify the DNS zone of your choice.", + "type": "integer" + }, + "zone_name": { + "description": "The name of the DNS zone, each DNS zone must have a unique name. For hint zones (zone_type: hint), you must type in . (dot) as zone_name.", + "type": "string" + }, + "zone_type": { + "description": "The type of the DNS zone, either master, slave, forward, stub, hint or delegation-only.", + "enum": [ + "master", + "slave", + "hint", + "stub", + "forward", + "delegation-only" + ], + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DNS server.", + "type": "string" + }, + "server_ddns_scavenging": { + "description": "The DDNS scavenging status of the zone. Set it to 1 to enable the scavenging and automatically delete the stale resource records dynamically added via GSS-TSIG. DDNS scavenging is only effective if the parameters zone_use_update_policy and gss_enabled are set to 1, and the rule 416 is enabled in the GUI.", + "type": "integer" + }, + "zone_ad_integrated": { + "description": "The AD integrated status of the DNS zone. Set it to 1 to indicate that the DNS zone belongs to an Active Directory integrated Microsoft Windows DNS server.", + "type": "integer" + }, + "zone_allow_query": { + "description": "The ACL values associated with the allow-query configuration of the DNS zone, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "zone_allow_transfer": { + "description": "The ACL values associated with the allow-transfer configuration of the DNS zone, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "zone_allow_update": { + "description": "The ACL values associated with the allow-update configuration of the DNS zone, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "zone_also_notify": { + "description": "The IP address and port of the DNS server managing the smart architecture the DNS zone belongs to. If the parameter zone_notify is set to yes or explicit, the server specified is instantly notified of any slave zones updates.", + "type": "string" + }, + "zone_forward": { + "description": "The forwarding mode of the DNS zone.


                                                                                                                                                                                                                                              zone_forward possible values
                                                                                                                                                                                                                                              StatusDescription
                                                                                                                                                                                                                                              firstThe zone sends the queries to the forwarder(s). If no answer is returned, it attempts to answer the queries on its own.
                                                                                                                                                                                                                                              onlyThe zone only forwards the queries to the forwarder(s). Required by some reverse forward zones (e.g., in the case of private addresses).


                                                                                                                                                                                                                                              If the parameter has no value, it indicates that the forwarding is disabled.", + "enum": [ + "none", + "first", + "only", + "default" + ], + "type": "string" + }, + "zone_forwarders": { + "description": "The IP address(es) of the forwarder(s) associated with the DNS zone. It lists the DNS servers to which any unknown query on this zone should be sent, as follows: <ip_address1>;<ip_address2>;... .", + "type": "string" + }, + "zone_is_rpz": { + "description": "The RPZ status of the DNS zone. Set it to 1 to indicate that the DNS zone is a Response Policy Zone.", + "type": "integer" + }, + "zone_masters": { + "description": "For slave DNS zones, the IP address of the DNS server and, if relevant, the name of the DNS view that contain the master DNS zone, as follows: <ip_addr>; or <ip_addr> key <dnsview_name>; .", + "type": "string" + }, + "zone_notify": { + "description": "The notify status of the DNS zone.


                                                                                                                                                                                                                                              zone_notify possible values
                                                                                                                                                                                                                                              StatusDescription
                                                                                                                                                                                                                                              noNo notify message is sent.
                                                                                                                                                                                                                                              yesA notify message is sent to the name servers defined in the NS records of the zone and to the IP address(es) specified in the parameter .
                                                                                                                                                                                                                                              explicitA notify message is sent only to the IP address(es) specified in the parameter .


                                                                                                                                                                                                                                              The notify message is not sent to the server itself or to the primary server defined in the SOA record of the zone.", + "enum": [ + "yes", + "no", + "explicit" + ], + "type": "string" + }, + "zone_order": { + "description": "The level of the RPZ zone, where 0 represents the highest level in the views hierarchy. The RPZ rules of each zone are reviewed following this order. For non-RPZ zones, that have their parameter zone_is_rpz set to 0, you do not need to set this parameter.", + "type": "integer" + }, + "zone_response_policy": { + "description": "The response policy of the DNS zone. All the zones can be set with the policy given, only RPZ zones can be set with other policies.


                                                                                                                                                                                                                                              zone_response_policy possible values
                                                                                                                                                                                                                                              PolicyDescription
                                                                                                                                                                                                                                              givenAll the rules specified in the RPZ zone are applied normally.
                                                                                                                                                                                                                                              disabledThe RPZ zone rules configuration is not applied. All the rules it contains are ignored.
                                                                                                                                                                                                                                              passthruThe rules specified in the RPZ matching the listed RR names are ignored, no matter the RPZ zone they belong to.
                                                                                                                                                                                                                                              nxdomainThe rules specified in the RPZ return an NXDOMAIN response.
                                                                                                                                                                                                                                              nodataThe rules specified in the RPZ return a NODATA response.
                                                                                                                                                                                                                                              cname All the rules specified in the RPZ are redirected toward the specified domain name.


                                                                                                                                                                                                                                              You can only add RPZ zones on EfficientIP or BIND DNS servers.", + "type": "string" + }, + "zone_rpz_log": { + "description": "The RPZ logging status, if zone_is_rpz is set to 1 or yes. It allows you to log all the operations triggered by the RPZ rules of the zone.", + "type": "integer" + }, + "zone_rpz_max_policy_ttl": { + "description": "A way to set the number of seconds of the max policy Time To Live of the zone. By default, the parameter is empty, and the Server max policy TTL of the zone is of 5 seconds. It overrides the same option set at server level.", + "type": "integer" + }, + "zone_rpz_recursive_only": { + "description": "A way to Enable recursive-only on the server for the zone. By default it is enabled (1) and, for this zone, the server only processes policies on recursive queries. It overrides the same option set at server level.", + "type": "integer" + }, + "zone_space_id": { + "description": "The database identifier (ID) of the space associated with the DNS zone the record belongs to.", + "type": "integer" + }, + "zone_space_name": { + "description": "The name of the space associated with the DNS zone the record belongs to.", + "type": "string" + }, + "row_state": { + "description": "The object activation status.
                                                                                                                                                                                                                                              • If set to 0, the object is present in the database but ignored, i.e. it cannot be managed, counted or listed. This status is applied on objects deleted from the GUI.
                                                                                                                                                                                                                                              • If set to 1, the object is enabled and managed.
                                                                                                                                                                                                                                              • If set to 2, the object is unmanaged, disabled or both depending on the context.
                                                                                                                                                                                                                                              By default, row_state is set to 1 when an object is created.", + "type": "integer" + }, + "zone_use_update_policy": { + "description": "The update policy status of the DNS zone. Set it to 1 to indicate that the DNS zone uses a specific GSS-TSIG/update-policy. You can only configure the zone update policy if the parameter gss_enabled is set to 1.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "zone_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "zone_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "server_id": { + "description": "The database identifier (ID) of the DNS server, a unique numeric key value automatically incremented when you add a DNS server. Use the ID to specify the DNS server of your choice.", + "type": "integer" + }, + "server_name": { + "description": "The name of the DNS server.", + "type": "string" + }, + "view_id": { + "description": "The database identifier (ID) of the DNS view the object belongs to.", + "type": "integer" + }, + "view_name": { + "description": "The name of the DNS view the object belongs to.", + "type": "string" + }, + "zone_id": { + "description": "The database identifier (ID) of the DNS zone, a unique numeric key value automatically incremented when you add a DNS zone. Use the ID to specify the DNS zone of your choice.", + "type": "integer" + }, + "zone_name": { + "description": "The name of the DNS zone, each DNS zone must have a unique name. For hint zones (zone_type: hint), you must type in . (dot) as zone_name.", + "type": "string" + }, + "zone_type": { + "description": "The type of the DNS zone, either master, slave, forward, stub, hint or delegation-only.", + "enum": [ + "master", + "slave", + "hint", + "stub", + "forward", + "delegation-only" + ], + "type": "string" + }, + "server_hostaddr": { + "description": "The IP address of the DNS server.", + "type": "string" + }, + "server_ddns_scavenging": { + "description": "The DDNS scavenging status of the zone. Set it to 1 to enable the scavenging and automatically delete the stale resource records dynamically added via GSS-TSIG. DDNS scavenging is only effective if the parameters zone_use_update_policy and gss_enabled are set to 1, and the rule 416 is enabled in the GUI.", + "type": "integer" + }, + "zone_ad_integrated": { + "description": "The AD integrated status of the DNS zone. Set it to 1 to indicate that the DNS zone belongs to an Active Directory integrated Microsoft Windows DNS server.", + "type": "integer" + }, + "zone_allow_query": { + "description": "The ACL values associated with the allow-query configuration of the DNS zone, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "zone_allow_transfer": { + "description": "The ACL values associated with the allow-transfer configuration of the DNS zone, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "zone_allow_update": { + "description": "The ACL values associated with the allow-update configuration of the DNS zone, as follows: <value1>;<value2>;... . Values may include IP and network addresses, the name of TSIG keys and ACLs, preceded by ! if the access is denied.", + "type": "string" + }, + "zone_also_notify": { + "description": "The IP address and port of the DNS server managing the smart architecture the DNS zone belongs to. If the parameter zone_notify is set to yes or explicit, the server specified is instantly notified of any slave zones updates.", + "type": "string" + }, + "zone_forward": { + "description": "The forwarding mode of the DNS zone.


                                                                                                                                                                                                                                              zone_forward possible values
                                                                                                                                                                                                                                              StatusDescription
                                                                                                                                                                                                                                              firstThe zone sends the queries to the forwarder(s). If no answer is returned, it attempts to answer the queries on its own.
                                                                                                                                                                                                                                              onlyThe zone only forwards the queries to the forwarder(s). Required by some reverse forward zones (e.g., in the case of private addresses).


                                                                                                                                                                                                                                              If the parameter has no value, it indicates that the forwarding is disabled.", + "enum": [ + "none", + "first", + "only", + "default" + ], + "type": "string" + }, + "zone_forwarders": { + "description": "The IP address(es) of the forwarder(s) associated with the DNS zone. It lists the DNS servers to which any unknown query on this zone should be sent, as follows: <ip_address1>;<ip_address2>;... .", + "type": "string" + }, + "zone_is_rpz": { + "description": "The RPZ status of the DNS zone. Set it to 1 to indicate that the DNS zone is a Response Policy Zone.", + "type": "integer" + }, + "zone_masters": { + "description": "For slave DNS zones, the IP address of the DNS server and, if relevant, the name of the DNS view that contain the master DNS zone, as follows: <ip_addr>; or <ip_addr> key <dnsview_name>; .", + "type": "string" + }, + "zone_notify": { + "description": "The notify status of the DNS zone.


                                                                                                                                                                                                                                              zone_notify possible values
                                                                                                                                                                                                                                              StatusDescription
                                                                                                                                                                                                                                              noNo notify message is sent.
                                                                                                                                                                                                                                              yesA notify message is sent to the name servers defined in the NS records of the zone and to the IP address(es) specified in the parameter .
                                                                                                                                                                                                                                              explicitA notify message is sent only to the IP address(es) specified in the parameter .


                                                                                                                                                                                                                                              The notify message is not sent to the server itself or to the primary server defined in the SOA record of the zone.", + "enum": [ + "yes", + "no", + "explicit" + ], + "type": "string" + }, + "zone_order": { + "description": "The level of the RPZ zone, where 0 represents the highest level in the views hierarchy. The RPZ rules of each zone are reviewed following this order. For non-RPZ zones, that have their parameter zone_is_rpz set to 0, you do not need to set this parameter.", + "type": "integer" + }, + "zone_response_policy": { + "description": "The response policy of the DNS zone. All the zones can be set with the policy given, only RPZ zones can be set with other policies.


                                                                                                                                                                                                                                              zone_response_policy possible values
                                                                                                                                                                                                                                              PolicyDescription
                                                                                                                                                                                                                                              givenAll the rules specified in the RPZ zone are applied normally.
                                                                                                                                                                                                                                              disabledThe RPZ zone rules configuration is not applied. All the rules it contains are ignored.
                                                                                                                                                                                                                                              passthruThe rules specified in the RPZ matching the listed RR names are ignored, no matter the RPZ zone they belong to.
                                                                                                                                                                                                                                              nxdomainThe rules specified in the RPZ return an NXDOMAIN response.
                                                                                                                                                                                                                                              nodataThe rules specified in the RPZ return a NODATA response.
                                                                                                                                                                                                                                              cname All the rules specified in the RPZ are redirected toward the specified domain name.


                                                                                                                                                                                                                                              You can only add RPZ zones on EfficientIP or BIND DNS servers.", + "type": "string" + }, + "zone_rpz_log": { + "description": "The RPZ logging status, if zone_is_rpz is set to 1 or yes. It allows you to log all the operations triggered by the RPZ rules of the zone.", + "type": "integer" + }, + "zone_rpz_max_policy_ttl": { + "description": "A way to set the number of seconds of the max policy Time To Live of the zone. By default, the parameter is empty, and the Server max policy TTL of the zone is of 5 seconds. It overrides the same option set at server level.", + "type": "integer" + }, + "zone_rpz_recursive_only": { + "description": "A way to Enable recursive-only on the server for the zone. By default it is enabled (1) and, for this zone, the server only processes policies on recursive queries. It overrides the same option set at server level.", + "type": "integer" + }, + "zone_space_id": { + "description": "The database identifier (ID) of the space associated with the DNS zone the record belongs to.", + "type": "integer" + }, + "zone_space_name": { + "description": "The name of the space associated with the DNS zone the record belongs to.", + "type": "string" + }, + "row_state": { + "description": "The object activation status.
                                                                                                                                                                                                                                              • If set to 0, the object is present in the database but ignored, i.e. it cannot be managed, counted or listed. This status is applied on objects deleted from the GUI.
                                                                                                                                                                                                                                              • If set to 1, the object is enabled and managed.
                                                                                                                                                                                                                                              • If set to 2, the object is unmanaged, disabled or both depending on the context.
                                                                                                                                                                                                                                              By default, row_state is set to 1 when an object is created.", + "type": "integer" + }, + "zone_use_update_policy": { + "description": "The update policy status of the DNS zone. Set it to 1 to indicate that the DNS zone uses a specific GSS-TSIG/update-policy. You can only configure the zone update policy if the parameter gss_enabled is set to 1.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "zone_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "zone_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "14d32f72-5567-42f2-9cfb-d0dd2b6c23d6", + "created": "2026-08-25T15:04:02.192Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 88, + "reference": "07c513a3-c3d8-4c4f-8ab5-88b9c37eba2c", + "type": "workflow", + "folder": "/DNS", + "document": { + "name": "Get DNS Zone", + "description": "Get DNS Zone", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dns_zone_info", + "canvasName": "dns_zone_info", + "summary": "dns_zone_info", + "description": "dns_zone_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "no_parent_class_param": "$var.job.no_parent_class_param", + "zone_id": "$var.job.zone_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "zone_id": { + "type": "integer" + } + }, + "required": [ + "no_parent_class_param", + "zone_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "zone_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "2dc9eb3a-eb3b-4812-9b88-7a060e145911", + "created": "2026-08-25T15:04:02.222Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 89, + "reference": "7989d6f2-e6e8-4ae6-9940-2d278c0e59d7", + "type": "workflow", + "folder": "/DNS", + "document": { + "name": "List DNS Zones", + "description": "List DNS Zones", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dns_zone_list", + "canvasName": "dns_zone_list", + "summary": "dns_zone_list", + "description": "dns_zone_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset", + "no_parent_class_param": "$var.job.no_parent_class_param", + "tags": "$var.job.tags" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset", + "no_parent_class_param", + "tags" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "a8d9118e-1703-46ab-bdf9-d294a78817f9", + "created": "2026-08-25T15:04:02.251Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 90, + "reference": "b5b5caeb-0898-4c5d-9f56-240374f52c21", + "type": "workflow", + "folder": "/DNS", + "document": { + "name": "Create DNS Zone Parameter", + "description": "Create DNS Zone Parameter", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dns_zoneparam_add", + "canvasName": "dns_zoneparam_add", + "summary": "dns_zoneparam_add", + "description": "dns_zoneparam_add", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "zone_id": { + "description": "The database identifier (ID) of the DNS zone, a unique numeric key value automatically incremented when you add a DNS zone. Use the ID to specify the DNS zone of your choice.", + "type": "integer" + }, + "zoneparam_key": { + "description": "The name of the DNS option you want to add, edit or remove from the zone. You can only set one option at a time.
                                                                                                                                                                                                                                              • To add or edit an option: specify its name in the parameter zoneparam_key, as follows zoneparam_key=<option-name>, and then specify its value in the parameter zoneparam_value.
                                                                                                                                                                                                                                              • To remove an option, specify its name in the parameter zoneparam_key and leave the parameter zoneparam_value empty.
                                                                                                                                                                                                                                              To set several options, specify as many parameters (zoneparam_key and zoneparam_value) as you need.", + "type": "string" + }, + "zoneparam_is_array": { + "description": "A way to determine is the DNS zone option is an array (1).", + "type": "integer" + }, + "zoneparam_value": { + "description": "The value of the DNS option specified in the input zoneparam_key.
                                                                                                                                                                                                                                              • To add or edit an option value, specify its name in the parameter zoneparam_key and set its value as follows: zoneparam_value=<option-value> .
                                                                                                                                                                                                                                              • To remove an option value, specify its name in the parameter zoneparam_key and leave zoneparam_value empty: zoneparam_value= .
                                                                                                                                                                                                                                              ", + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "zone_id": { + "description": "The database identifier (ID) of the DNS zone, a unique numeric key value automatically incremented when you add a DNS zone. Use the ID to specify the DNS zone of your choice.", + "type": "integer" + }, + "zoneparam_key": { + "description": "The name of the DNS option you want to add, edit or remove from the zone. You can only set one option at a time.
                                                                                                                                                                                                                                              • To add or edit an option: specify its name in the parameter zoneparam_key, as follows zoneparam_key=<option-name>, and then specify its value in the parameter zoneparam_value.
                                                                                                                                                                                                                                              • To remove an option, specify its name in the parameter zoneparam_key and leave the parameter zoneparam_value empty.
                                                                                                                                                                                                                                              To set several options, specify as many parameters (zoneparam_key and zoneparam_value) as you need.", + "type": "string" + }, + "zoneparam_is_array": { + "description": "A way to determine is the DNS zone option is an array (1).", + "type": "integer" + }, + "zoneparam_value": { + "description": "The value of the DNS option specified in the input zoneparam_key.
                                                                                                                                                                                                                                              • To add or edit an option value, specify its name in the parameter zoneparam_key and set its value as follows: zoneparam_value=<option-value> .
                                                                                                                                                                                                                                              • To remove an option value, specify its name in the parameter zoneparam_key and leave zoneparam_value empty: zoneparam_value= .
                                                                                                                                                                                                                                              ", + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "11b9e4fb-1bf3-47e8-ac95-d202f3c01b36", + "created": "2026-08-25T15:04:02.284Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 91, + "reference": "07d36ce9-0fce-45a6-bf79-d58d3af91e4a", + "type": "workflow", + "folder": "/DNS", + "document": { + "name": "Delete DNS Zone Parameter", + "description": "Delete DNS Zone Parameter", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dns_zoneparam_delete", + "canvasName": "dns_zoneparam_delete", + "summary": "dns_zoneparam_delete", + "description": "dns_zoneparam_delete", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "zone_id": "$var.job.zone_id", + "zoneparam_key": "$var.job.zoneparam_key", + "server_id": "$var.job.server_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "zone_id": { + "type": "integer" + }, + "zoneparam_key": { + "type": "string" + }, + "server_id": { + "type": "integer" + } + }, + "required": [ + "zone_id", + "zoneparam_key", + "server_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "zone_id": { + "type": "integer" + }, + "zoneparam_key": { + "type": "string" + }, + "server_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "6e81fb84-c564-46b9-86ca-a5e97d8a4ce1", + "created": "2026-08-25T15:04:02.315Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 92, + "reference": "f5461677-0aec-46c0-8a02-e360c6073ccf", + "type": "workflow", + "folder": "/DNS", + "document": { + "name": "Update DNS Zone Parameter", + "description": "Update DNS Zone Parameter", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dns_zoneparam_edit", + "canvasName": "dns_zoneparam_edit", + "summary": "dns_zoneparam_edit", + "description": "dns_zoneparam_edit", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "zone_id": { + "description": "The database identifier (ID) of the DNS zone, a unique numeric key value automatically incremented when you add a DNS zone. Use the ID to specify the DNS zone of your choice.", + "type": "integer" + }, + "zoneparam_key": { + "description": "The name of the DNS option you want to add, edit or remove from the zone. You can only set one option at a time.
                                                                                                                                                                                                                                              • To add or edit an option: specify its name in the parameter zoneparam_key, as follows zoneparam_key=<option-name>, and then specify its value in the parameter zoneparam_value.
                                                                                                                                                                                                                                              • To remove an option, specify its name in the parameter zoneparam_key and leave the parameter zoneparam_value empty.
                                                                                                                                                                                                                                              To set several options, specify as many parameters (zoneparam_key and zoneparam_value) as you need.", + "type": "string" + }, + "zoneparam_is_array": { + "description": "A way to determine is the DNS zone option is an array (1).", + "type": "integer" + }, + "zoneparam_value": { + "description": "The value of the DNS option specified in the input zoneparam_key.
                                                                                                                                                                                                                                              • To add or edit an option value, specify its name in the parameter zoneparam_key and set its value as follows: zoneparam_value=<option-value> .
                                                                                                                                                                                                                                              • To remove an option value, specify its name in the parameter zoneparam_key and leave zoneparam_value empty: zoneparam_value= .
                                                                                                                                                                                                                                              ", + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "zone_id": { + "description": "The database identifier (ID) of the DNS zone, a unique numeric key value automatically incremented when you add a DNS zone. Use the ID to specify the DNS zone of your choice.", + "type": "integer" + }, + "zoneparam_key": { + "description": "The name of the DNS option you want to add, edit or remove from the zone. You can only set one option at a time.
                                                                                                                                                                                                                                              • To add or edit an option: specify its name in the parameter zoneparam_key, as follows zoneparam_key=<option-name>, and then specify its value in the parameter zoneparam_value.
                                                                                                                                                                                                                                              • To remove an option, specify its name in the parameter zoneparam_key and leave the parameter zoneparam_value empty.
                                                                                                                                                                                                                                              To set several options, specify as many parameters (zoneparam_key and zoneparam_value) as you need.", + "type": "string" + }, + "zoneparam_is_array": { + "description": "A way to determine is the DNS zone option is an array (1).", + "type": "integer" + }, + "zoneparam_value": { + "description": "The value of the DNS option specified in the input zoneparam_key.
                                                                                                                                                                                                                                              • To add or edit an option value, specify its name in the parameter zoneparam_key and set its value as follows: zoneparam_value=<option-value> .
                                                                                                                                                                                                                                              • To remove an option value, specify its name in the parameter zoneparam_key and leave zoneparam_value empty: zoneparam_value= .
                                                                                                                                                                                                                                              ", + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "7ac1b0d1-8e85-4614-83df-0956d96d32b6", + "created": "2026-08-25T15:04:02.345Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 93, + "reference": "3dad1e2e-7e81-49e9-9ff4-0f2680df3f91", + "type": "workflow", + "folder": "/DNS", + "document": { + "name": "Get DNS Zone Parameter", + "description": "Get DNS Zone Parameter", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dns_zoneparam_info", + "canvasName": "dns_zoneparam_info", + "summary": "dns_zoneparam_info", + "description": "dns_zoneparam_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "zone_id": "$var.job.zone_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "zone_id": { + "type": "integer" + } + }, + "required": [ + "zone_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "zone_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "f95d4004-c07a-49fd-b852-7c41ae2ecffd", + "created": "2026-08-25T15:04:02.380Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 94, + "reference": "5c062260-b293-47d8-9e25-bee25968ce97", + "type": "workflow", + "folder": "/DNS", + "document": { + "name": "List DNS Zone Parameters", + "description": "List DNS Zone Parameters", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "dns_zoneparam_list", + "canvasName": "dns_zoneparam_list", + "summary": "dns_zoneparam_list", + "description": "dns_zoneparam_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "af2d9137-34ad-4ba2-9a83-8aec8b3b0c09", + "created": "2026-08-25T15:04:02.409Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 95, + "reference": "ed4ca059-6f7c-4d18-ac2b-2c76a614d346", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "Create IPAM Address", + "description": "Create IPAM Address", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_address_add", + "canvasName": "ipam_address_add", + "summary": "ipam_address_add", + "description": "ipam_address_add", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "address_hostaddr": { + "description": "The IP address.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "check_is_server_ip": { + "description": "A way to force a validity check, if you configured the IPAM to DHCP replication. If the check is enabled (1), the configuration of the IP address you are adding must be valid as well for the DHCP.", + "type": "integer" + }, + "static_id": { + "description": "The database identifier (ID) of the DHCP static you want to associate with the IP address.", + "type": "integer" + }, + "lease_id": { + "description": "The database identifier (ID) of the DHCP lease you want to associate with the IP address.", + "type": "integer" + }, + "device_id": { + "description": "The database identifier (ID) of the Device Manager device you want to associate with the IP address.", + "type": "integer" + }, + "interface_id": { + "description": "The database identifier (ID) of the Device Manager interface you want to associate with the IP address.", + "type": "integer" + }, + "port_id": { + "description": "The database identifier (ID) of the NetChange port you want to associate with the IP address.", + "type": "integer" + }, + "address_mac_addr": { + "description": "The MAC address you want to associate with the IPv4 address.", + "type": "string" + }, + "address_name": { + "description": "The name of the IPv4 address, each IPv4 address must have a unique name.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "address_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "address_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "address_hostaddr": { + "description": "The IP address.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "check_is_server_ip": { + "description": "A way to force a validity check, if you configured the IPAM to DHCP replication. If the check is enabled (1), the configuration of the IP address you are adding must be valid as well for the DHCP.", + "type": "integer" + }, + "static_id": { + "description": "The database identifier (ID) of the DHCP static you want to associate with the IP address.", + "type": "integer" + }, + "lease_id": { + "description": "The database identifier (ID) of the DHCP lease you want to associate with the IP address.", + "type": "integer" + }, + "device_id": { + "description": "The database identifier (ID) of the Device Manager device you want to associate with the IP address.", + "type": "integer" + }, + "interface_id": { + "description": "The database identifier (ID) of the Device Manager interface you want to associate with the IP address.", + "type": "integer" + }, + "port_id": { + "description": "The database identifier (ID) of the NetChange port you want to associate with the IP address.", + "type": "integer" + }, + "address_mac_addr": { + "description": "The MAC address you want to associate with the IPv4 address.", + "type": "string" + }, + "address_name": { + "description": "The name of the IPv4 address, each IPv4 address must have a unique name.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "address_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "address_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "57bc999c-8671-4019-ac38-aea60281640b", + "created": "2026-08-25T15:04:02.440Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 96, + "reference": "fa21376e-76b8-441b-86db-27bf38942ea4", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "Delete IPAM Address", + "description": "Delete IPAM Address", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_address_delete", + "canvasName": "ipam_address_delete", + "summary": "ipam_address_delete", + "description": "ipam_address_delete", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "address_hostaddr": "$var.job.address_hostaddr", + "address_id": "$var.job.address_id", + "space_id": "$var.job.space_id", + "space_name": "$var.job.space_name", + "address_name": "$var.job.address_name", + "warnings": "$var.job.warnings" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "address_hostaddr": { + "type": "string" + }, + "address_id": { + "type": "integer" + }, + "space_id": { + "type": "integer" + }, + "space_name": { + "type": "string" + }, + "address_name": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + } + }, + "required": [ + "address_hostaddr", + "address_id", + "space_id", + "space_name", + "address_name", + "warnings" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "address_hostaddr": { + "type": "string" + }, + "address_id": { + "type": "integer" + }, + "space_id": { + "type": "integer" + }, + "space_name": { + "type": "string" + }, + "address_name": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "12e28a89-05e4-4dbe-82f2-f2a2548784de", + "created": "2026-08-25T15:04:02.474Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 97, + "reference": "786c95de-cd76-4a2f-9a49-714a1781948f", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "Update IPAM Address", + "description": "Update IPAM Address", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_address_edit", + "canvasName": "ipam_address_edit", + "summary": "ipam_address_edit", + "description": "ipam_address_edit", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "address_hostaddr": { + "description": "The IP address.", + "type": "string" + }, + "address_id": { + "description": "The database identifier (ID) of the IPv4 address, a unique numeric key value automatically incremented when you add an IPv4 address. Use the ID to specify the IPv4 address of your choice.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "check_is_server_ip": { + "description": "A way to force a validity check, if you configured the IPAM to DHCP replication. If the check is enabled (1), the configuration of the IP address you are adding must be valid as well for the DHCP.", + "type": "integer" + }, + "static_id": { + "description": "The database identifier (ID) of the DHCP static you want to associate with the IP address.", + "type": "integer" + }, + "lease_id": { + "description": "The database identifier (ID) of the DHCP lease you want to associate with the IP address.", + "type": "integer" + }, + "device_id": { + "description": "The database identifier (ID) of the Device Manager device you want to associate with the IP address.", + "type": "integer" + }, + "interface_id": { + "description": "The database identifier (ID) of the Device Manager interface you want to associate with the IP address.", + "type": "integer" + }, + "port_id": { + "description": "The database identifier (ID) of the NetChange port you want to associate with the IP address.", + "type": "integer" + }, + "address_mac_addr": { + "description": "The MAC address you want to associate with the IPv4 address.", + "type": "string" + }, + "address_name": { + "description": "The name of the IPv4 address, each IPv4 address must have a unique name.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "address_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "address_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "address_hostaddr": { + "description": "The IP address.", + "type": "string" + }, + "address_id": { + "description": "The database identifier (ID) of the IPv4 address, a unique numeric key value automatically incremented when you add an IPv4 address. Use the ID to specify the IPv4 address of your choice.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "check_is_server_ip": { + "description": "A way to force a validity check, if you configured the IPAM to DHCP replication. If the check is enabled (1), the configuration of the IP address you are adding must be valid as well for the DHCP.", + "type": "integer" + }, + "static_id": { + "description": "The database identifier (ID) of the DHCP static you want to associate with the IP address.", + "type": "integer" + }, + "lease_id": { + "description": "The database identifier (ID) of the DHCP lease you want to associate with the IP address.", + "type": "integer" + }, + "device_id": { + "description": "The database identifier (ID) of the Device Manager device you want to associate with the IP address.", + "type": "integer" + }, + "interface_id": { + "description": "The database identifier (ID) of the Device Manager interface you want to associate with the IP address.", + "type": "integer" + }, + "port_id": { + "description": "The database identifier (ID) of the NetChange port you want to associate with the IP address.", + "type": "integer" + }, + "address_mac_addr": { + "description": "The MAC address you want to associate with the IPv4 address.", + "type": "string" + }, + "address_name": { + "description": "The name of the IPv4 address, each IPv4 address must have a unique name.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "address_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "address_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "005a6877-7a52-4a67-9fef-7b31e5ea593f", + "created": "2026-08-25T15:04:02.507Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 98, + "reference": "7b786200-d1e9-413f-bddc-dd6c45249662", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "Get IPAM Address", + "description": "Get IPAM Address", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_address_info", + "canvasName": "ipam_address_info", + "summary": "ipam_address_info", + "description": "ipam_address_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "no_parent_class_param": "$var.job.no_parent_class_param", + "address_id": "$var.job.address_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "address_id": { + "type": "integer" + } + }, + "required": [ + "no_parent_class_param", + "address_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "address_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "2d9347bf-b8b2-4b3b-8417-50bb441d3820", + "created": "2026-08-25T15:04:02.539Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 99, + "reference": "93fa33f2-2aab-44f9-90e5-e0bca98d68f0", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "List IPAM Addresses", + "description": "List IPAM Addresses", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_address_list", + "canvasName": "ipam_address_list", + "summary": "ipam_address_list", + "description": "ipam_address_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset", + "no_parent_class_param": "$var.job.no_parent_class_param", + "tags": "$var.job.tags" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset", + "no_parent_class_param", + "tags" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "c0e9beb6-e152-4e70-8600-0cf58f80a13f", + "created": "2026-08-25T15:04:02.571Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 100, + "reference": "6a1cbb38-55da-41cb-945e-ed7fa4290d27", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "Create IPAM IPv6 Address", + "description": "Create IPAM IPv6 Address", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_address6_add", + "canvasName": "ipam_address6_add", + "summary": "ipam_address6_add", + "description": "ipam_address6_add", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "address6_hostaddr": { + "description": "The IP address.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "device_id": { + "description": "The database identifier (ID) of the Device Manager device you want to associate with the IP address.", + "type": "integer" + }, + "interface_id": { + "description": "The database identifier (ID) of the Device Manager interface you want to associate with the IP address.", + "type": "integer" + }, + "address6_mac_addr": { + "description": "The MAC address you want to associate with the IPv6 address.", + "type": "string" + }, + "address6_name": { + "description": "The name of the IPv6 address, each IPv6 address must have a unique name.", + "type": "string" + }, + "port_id": { + "description": "The database identifier (ID) of the NetChange port you want to associate with the IP address.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "address6_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "address6_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "address6_hostaddr": { + "description": "The IP address.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "device_id": { + "description": "The database identifier (ID) of the Device Manager device you want to associate with the IP address.", + "type": "integer" + }, + "interface_id": { + "description": "The database identifier (ID) of the Device Manager interface you want to associate with the IP address.", + "type": "integer" + }, + "address6_mac_addr": { + "description": "The MAC address you want to associate with the IPv6 address.", + "type": "string" + }, + "address6_name": { + "description": "The name of the IPv6 address, each IPv6 address must have a unique name.", + "type": "string" + }, + "port_id": { + "description": "The database identifier (ID) of the NetChange port you want to associate with the IP address.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "address6_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "address6_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "8105a306-a750-41b3-97bb-265bf1a1f851", + "created": "2026-08-25T15:04:02.601Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 101, + "reference": "7a5eaa3e-429e-4b17-83da-f854ca75eef9", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "Delete IPAM IPv6 Address", + "description": "Delete IPAM IPv6 Address", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_address6_delete", + "canvasName": "ipam_address6_delete", + "summary": "ipam_address6_delete", + "description": "ipam_address6_delete", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "address6_hostaddr": "$var.job.address6_hostaddr", + "address6_id": "$var.job.address6_id", + "space_id": "$var.job.space_id", + "space_name": "$var.job.space_name", + "address6_name": "$var.job.address6_name", + "warnings": "$var.job.warnings" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "address6_hostaddr": { + "type": "string" + }, + "address6_id": { + "type": "integer" + }, + "space_id": { + "type": "integer" + }, + "space_name": { + "type": "string" + }, + "address6_name": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + } + }, + "required": [ + "address6_hostaddr", + "address6_id", + "space_id", + "space_name", + "address6_name", + "warnings" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "address6_hostaddr": { + "type": "string" + }, + "address6_id": { + "type": "integer" + }, + "space_id": { + "type": "integer" + }, + "space_name": { + "type": "string" + }, + "address6_name": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "830b25b0-ab45-4463-a8af-6e8ff27447e2", + "created": "2026-08-25T15:04:02.632Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 102, + "reference": "d47b5696-82c6-4d57-a4bc-0919c537f26e", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "Update IPAM IPv6 Address", + "description": "Update IPAM IPv6 Address", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_address6_edit", + "canvasName": "ipam_address6_edit", + "summary": "ipam_address6_edit", + "description": "ipam_address6_edit", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "address6_hostaddr": { + "description": "The IP address.", + "type": "string" + }, + "address6_id": { + "description": "The database identifier (ID) of the IPv6 address, a unique numeric key value automatically incremented when you add an IPv6 address. Use the ID to specify the IPv6 address of your choice.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "device_id": { + "description": "The database identifier (ID) of the Device Manager device you want to associate with the IP address.", + "type": "integer" + }, + "interface_id": { + "description": "The database identifier (ID) of the Device Manager interface you want to associate with the IP address.", + "type": "integer" + }, + "address6_mac_addr": { + "description": "The MAC address you want to associate with the IPv6 address.", + "type": "string" + }, + "address6_name": { + "description": "The name of the IPv6 address, each IPv6 address must have a unique name.", + "type": "string" + }, + "port_id": { + "description": "The database identifier (ID) of the NetChange port you want to associate with the IP address.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "address6_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "address6_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "address6_hostaddr": { + "description": "The IP address.", + "type": "string" + }, + "address6_id": { + "description": "The database identifier (ID) of the IPv6 address, a unique numeric key value automatically incremented when you add an IPv6 address. Use the ID to specify the IPv6 address of your choice.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "device_id": { + "description": "The database identifier (ID) of the Device Manager device you want to associate with the IP address.", + "type": "integer" + }, + "interface_id": { + "description": "The database identifier (ID) of the Device Manager interface you want to associate with the IP address.", + "type": "integer" + }, + "address6_mac_addr": { + "description": "The MAC address you want to associate with the IPv6 address.", + "type": "string" + }, + "address6_name": { + "description": "The name of the IPv6 address, each IPv6 address must have a unique name.", + "type": "string" + }, + "port_id": { + "description": "The database identifier (ID) of the NetChange port you want to associate with the IP address.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "address6_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "address6_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "7c73af5f-1469-4b8a-a094-615a36eb012d", + "created": "2026-08-25T15:04:02.661Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 103, + "reference": "47775443-e765-4898-b357-1a76b7ddb2cf", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "Get IPAM IPv6 Address", + "description": "Get IPAM IPv6 Address", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_address6_info", + "canvasName": "ipam_address6_info", + "summary": "ipam_address6_info", + "description": "ipam_address6_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "no_parent_class_param": "$var.job.no_parent_class_param", + "address6_id": "$var.job.address6_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "address6_id": { + "type": "integer" + } + }, + "required": [ + "no_parent_class_param", + "address6_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "address6_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "0b70a308-867d-4afd-a0be-26edfcba20e0", + "created": "2026-08-25T15:04:02.694Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 104, + "reference": "73b034db-1c95-48fc-9aba-a28e008fc5ac", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "List IPAM IPv6 Addresses", + "description": "List IPAM IPv6 Addresses", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_address6_list", + "canvasName": "ipam_address6_list", + "summary": "ipam_address6_list", + "description": "ipam_address6_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset", + "no_parent_class_param": "$var.job.no_parent_class_param", + "tags": "$var.job.tags" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset", + "no_parent_class_param", + "tags" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "69967747-5279-4bf3-8ef6-6517ee17d33d", + "created": "2026-08-25T15:04:02.726Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 105, + "reference": "bae8af4b-8133-4568-844b-b9643516e863", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "Create IPAM Alias", + "description": "Create IPAM Alias", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_alias_add", + "canvasName": "ipam_alias_add", + "summary": "ipam_alias_add", + "description": "ipam_alias_add", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "address_hostaddr": { + "description": "The IP address.", + "type": "string" + }, + "address_id": { + "description": "The database identifier (ID) of the IPv4 address, a unique numeric key value automatically incremented when you add an IPv4 address. Use the ID to specify the IPv4 address of your choice.", + "type": "integer" + }, + "alias_name": { + "description": "The name of the IPv4 alias.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "alias_type": { + "description": "The type of the alias.", + "enum": [ + "A", + "a", + "CNAME", + "cname" + ], + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "address_hostaddr": { + "description": "The IP address.", + "type": "string" + }, + "address_id": { + "description": "The database identifier (ID) of the IPv4 address, a unique numeric key value automatically incremented when you add an IPv4 address. Use the ID to specify the IPv4 address of your choice.", + "type": "integer" + }, + "alias_name": { + "description": "The name of the IPv4 alias.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "alias_type": { + "description": "The type of the alias.", + "enum": [ + "A", + "a", + "CNAME", + "cname" + ], + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "dd7b87eb-31e3-46ae-925c-871f441099a4", + "created": "2026-08-25T15:04:02.757Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 106, + "reference": "48440db0-dcdf-4494-9fb1-ea82913d4445", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "Delete IPAM Alias", + "description": "Delete IPAM Alias", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_alias_delete", + "canvasName": "ipam_alias_delete", + "summary": "ipam_alias_delete", + "description": "ipam_alias_delete", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "address_hostaddr": "$var.job.address_hostaddr", + "address_id": "$var.job.address_id", + "alias_name": "$var.job.alias_name", + "alias_id": "$var.job.alias_id", + "space_id": "$var.job.space_id", + "space_name": "$var.job.space_name", + "alias_type": "$var.job.alias_type", + "warnings": "$var.job.warnings" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "address_hostaddr": { + "type": "string" + }, + "address_id": { + "type": "integer" + }, + "alias_name": { + "type": "string" + }, + "alias_id": { + "type": "integer" + }, + "space_id": { + "type": "integer" + }, + "space_name": { + "type": "string" + }, + "alias_type": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + } + }, + "required": [ + "address_hostaddr", + "address_id", + "alias_name", + "alias_id", + "space_id", + "space_name", + "alias_type", + "warnings" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "address_hostaddr": { + "type": "string" + }, + "address_id": { + "type": "integer" + }, + "alias_name": { + "type": "string" + }, + "alias_id": { + "type": "integer" + }, + "space_id": { + "type": "integer" + }, + "space_name": { + "type": "string" + }, + "alias_type": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "a27a8acd-6c27-4057-ae68-9fb4b385c998", + "created": "2026-08-25T15:04:02.790Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 107, + "reference": "e9f146b4-2254-4c12-9b24-cc220a4fca33", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "Update IPAM Alias", + "description": "Update IPAM Alias", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_alias_edit", + "canvasName": "ipam_alias_edit", + "summary": "ipam_alias_edit", + "description": "ipam_alias_edit", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "address_hostaddr": { + "description": "The IP address.", + "type": "string" + }, + "address_id": { + "description": "The database identifier (ID) of the IPv4 address, a unique numeric key value automatically incremented when you add an IPv4 address. Use the ID to specify the IPv4 address of your choice.", + "type": "integer" + }, + "alias_name": { + "description": "The name of the IPv4 alias.", + "type": "string" + }, + "alias_id": { + "description": "The database identifier (ID) of the IPv4 alias, a unique numeric key value automatically incremented when you add an IPv4 alias. Use the ID to specify the IPv4 alias of your choice.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "alias_type": { + "description": "The type of the alias.", + "enum": [ + "A", + "a", + "CNAME", + "cname" + ], + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "address_hostaddr": { + "description": "The IP address.", + "type": "string" + }, + "address_id": { + "description": "The database identifier (ID) of the IPv4 address, a unique numeric key value automatically incremented when you add an IPv4 address. Use the ID to specify the IPv4 address of your choice.", + "type": "integer" + }, + "alias_name": { + "description": "The name of the IPv4 alias.", + "type": "string" + }, + "alias_id": { + "description": "The database identifier (ID) of the IPv4 alias, a unique numeric key value automatically incremented when you add an IPv4 alias. Use the ID to specify the IPv4 alias of your choice.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "alias_type": { + "description": "The type of the alias.", + "enum": [ + "A", + "a", + "CNAME", + "cname" + ], + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "6bbd6904-8a7f-40ad-aad1-edb415f6d64c", + "created": "2026-08-25T15:04:02.819Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 108, + "reference": "70e42494-04e1-422a-84c6-ffa21daaef7d", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "List IPAM Aliases", + "description": "List IPAM Aliases", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_alias_list", + "canvasName": "ipam_alias_list", + "summary": "ipam_alias_list", + "description": "ipam_alias_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset", + "no_parent_class_param": "$var.job.no_parent_class_param", + "address_id": "$var.job.address_id", + "tags": "$var.job.tags" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "address_id": { + "type": "integer" + }, + "tags": { + "type": "string" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset", + "no_parent_class_param", + "address_id", + "tags" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "address_id": { + "type": "integer" + }, + "tags": { + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "ffbfd094-e285-4063-82e3-fd1fccc29424", + "created": "2026-08-25T15:04:02.849Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 109, + "reference": "a858a46a-36b8-4508-9778-c476e83f84ce", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "Create IPAM IPv6 Alias", + "description": "Create IPAM IPv6 Alias", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_alias6_add", + "canvasName": "ipam_alias6_add", + "summary": "ipam_alias6_add", + "description": "ipam_alias6_add", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "address6_hostaddr": { + "description": "The IP address.", + "type": "string" + }, + "address6_id": { + "description": "The database identifier (ID) of the IPv6 address, a unique numeric key value automatically incremented when you add an IPv6 address. Use the ID to specify the IPv6 address of your choice.", + "type": "integer" + }, + "alias6_name": { + "description": "The name of the IPv6 address.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "alias6_type": { + "description": "The type of the alias.", + "enum": [ + "AAAA", + "aaaa", + "CNAME", + "cname" + ], + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "address6_hostaddr": { + "description": "The IP address.", + "type": "string" + }, + "address6_id": { + "description": "The database identifier (ID) of the IPv6 address, a unique numeric key value automatically incremented when you add an IPv6 address. Use the ID to specify the IPv6 address of your choice.", + "type": "integer" + }, + "alias6_name": { + "description": "The name of the IPv6 address.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "alias6_type": { + "description": "The type of the alias.", + "enum": [ + "AAAA", + "aaaa", + "CNAME", + "cname" + ], + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "bcd6a6ae-c7df-41bf-be5c-7985fbf6eb9d", + "created": "2026-08-25T15:04:02.881Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 110, + "reference": "0e8973fb-68ec-4071-adcd-52d05d71006e", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "Delete IPAM IPv6 Alias", + "description": "Delete IPAM IPv6 Alias", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_alias6_delete", + "canvasName": "ipam_alias6_delete", + "summary": "ipam_alias6_delete", + "description": "ipam_alias6_delete", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "address6_hostaddr": "$var.job.address6_hostaddr", + "address6_id": "$var.job.address6_id", + "alias6_name": "$var.job.alias6_name", + "alias6_id": "$var.job.alias6_id", + "space_id": "$var.job.space_id", + "space_name": "$var.job.space_name", + "alias6_type": "$var.job.alias6_type", + "warnings": "$var.job.warnings" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "address6_hostaddr": { + "type": "string" + }, + "address6_id": { + "type": "integer" + }, + "alias6_name": { + "type": "string" + }, + "alias6_id": { + "type": "integer" + }, + "space_id": { + "type": "integer" + }, + "space_name": { + "type": "string" + }, + "alias6_type": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + } + }, + "required": [ + "address6_hostaddr", + "address6_id", + "alias6_name", + "alias6_id", + "space_id", + "space_name", + "alias6_type", + "warnings" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "address6_hostaddr": { + "type": "string" + }, + "address6_id": { + "type": "integer" + }, + "alias6_name": { + "type": "string" + }, + "alias6_id": { + "type": "integer" + }, + "space_id": { + "type": "integer" + }, + "space_name": { + "type": "string" + }, + "alias6_type": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "7e7ceccd-dcf8-4634-a219-74cd6bb63618", + "created": "2026-08-25T15:04:02.911Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 111, + "reference": "a83e802b-b5dc-40bd-993a-a99d579f3b84", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "Update IPAM IPv6 Alias", + "description": "Update IPAM IPv6 Alias", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_alias6_edit", + "canvasName": "ipam_alias6_edit", + "summary": "ipam_alias6_edit", + "description": "ipam_alias6_edit", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "address6_hostaddr": { + "description": "The IP address.", + "type": "string" + }, + "address6_id": { + "description": "The database identifier (ID) of the IPv6 address, a unique numeric key value automatically incremented when you add an IPv6 address. Use the ID to specify the IPv6 address of your choice.", + "type": "integer" + }, + "alias6_name": { + "description": "The name of the IPv6 address.", + "type": "string" + }, + "alias6_id": { + "description": "The database identifier (ID) of the IPv6 alias, a unique numeric key value automatically incremented when you add an IPv6 alias. Use the ID to specify the IPv6 alias of your choice.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "alias6_type": { + "description": "The type of the alias.", + "enum": [ + "AAAA", + "aaaa", + "CNAME", + "cname" + ], + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "address6_hostaddr": { + "description": "The IP address.", + "type": "string" + }, + "address6_id": { + "description": "The database identifier (ID) of the IPv6 address, a unique numeric key value automatically incremented when you add an IPv6 address. Use the ID to specify the IPv6 address of your choice.", + "type": "integer" + }, + "alias6_name": { + "description": "The name of the IPv6 address.", + "type": "string" + }, + "alias6_id": { + "description": "The database identifier (ID) of the IPv6 alias, a unique numeric key value automatically incremented when you add an IPv6 alias. Use the ID to specify the IPv6 alias of your choice.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "alias6_type": { + "description": "The type of the alias.", + "enum": [ + "AAAA", + "aaaa", + "CNAME", + "cname" + ], + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "9a1a8f8e-4a1d-4761-b86a-d430eb625c7e", + "created": "2026-08-25T15:04:02.941Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 112, + "reference": "d2b28128-c9a2-4cc5-a262-d170f1dfaffc", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "List IPAM IPv6 Aliases", + "description": "List IPAM IPv6 Aliases", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_alias6_list", + "canvasName": "ipam_alias6_list", + "summary": "ipam_alias6_list", + "description": "ipam_alias6_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset", + "no_parent_class_param": "$var.job.no_parent_class_param", + "address6_id": "$var.job.address6_id", + "tags": "$var.job.tags" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "address6_id": { + "type": "integer" + }, + "tags": { + "type": "string" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset", + "no_parent_class_param", + "address6_id", + "tags" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "address6_id": { + "type": "integer" + }, + "tags": { + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "5c31724a-a342-42e4-9611-befe0916b305", + "created": "2026-08-25T15:04:02.977Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 113, + "reference": "dbffcfc9-b55c-42d6-9897-a53b397c87a2", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "EfficientIP Create IPAM Network", + "description": "EfficientIP Create IPAM Network", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_network_add", + "canvasName": "ipam_network_add", + "summary": "ipam_network_add", + "description": "ipam_network_add", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "parent_network_id": { + "description": "The database identifier (ID) of an existing IPv4 network you want to set as the parent of the IPv4 network you are adding. You can specify a subnet-type network to set up a network-based VLSM organization.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "network_addr": { + "description": "The start IP address of the IPv4 network, its first IP address.", + "type": "string" + }, + "network_end_addr": { + "description": "The end IP address of the IPv4 network, its last IP address.", + "type": "string" + }, + "network_mask": { + "description": "The netmask of the IPv4 network. It is expressed in dot-decimal notation and defines the number of addresses the network contains.", + "type": "string" + }, + "network_prefix": { + "description": "The prefix of the IPv4 network, an integer that defines the number of addresses the network contains.", + "type": "string" + }, + "network_size": { + "description": "The size of the IPv4 network, the number of IP addresses it contains.", + "type": "integer" + }, + "allow_block_creation": { + "description": "Internal use. Not documented.", + "type": "integer" + }, + "allow_tree_reparenting": { + "description": "A way to allow (1) or prevent (0) changing the parent of the network you are adding. Upon editing of the network, this parameter decides if you can associate it with a different parent network.", + "type": "integer" + }, + "network_is_terminal": { + "description": "A way to determine if a network can contain other networks. If set to 1, the network is terminal and cannot contain other subnet-type networks. By essence, block-type networks are non-terminal and are always set to 0.", + "type": "integer" + }, + "network_lock_network_broadcast": { + "description": "A way to prevent (1) users from assigning the broadcast IP address and network IP address of the network.", + "type": "integer" + }, + "permit_invalid": { + "description": "A way to authorize (1) IPv4 networks overlapping within a space.", + "type": "integer" + }, + "permit_no_block": { + "description": "A way to force the creation of an IPv4 subnet-type network. If set to 1, you can create a subnet-type network even if no block-type network matching the start address exists.", + "type": "integer" + }, + "relative_position": { + "description": "The position of the network within the hierarchy of networks of a VLSM organization. It calculates between 0 and n all the levels of the organization, its behavior depends on the value of the parameter use_reversed_relative_position:
                                                                                                                                                                                                                                              • use_reversed_relative_position=0 where 0 indicates a block-type network at the highest level possible, in a space-based organization, it belongs to the top space. The levels increment from 0 down to n, the lowest level you set up, within networks or spaces.
                                                                                                                                                                                                                                              • use_reversed_relative_position=1 where 1 indicates a network located at the lowest level of the organization, within networks or spaces. The levels increment from 0 up to n, the network at the highest level of the organization.
                                                                                                                                                                                                                                              ", + "type": "integer" + }, + "row_state": { + "description": "The object activation status.
                                                                                                                                                                                                                                              • If set to 0, the object is present in the database but ignored, i.e. it cannot be managed, counted or listed. This status is applied on objects deleted from the GUI.
                                                                                                                                                                                                                                              • If set to 1, the object is enabled and managed.
                                                                                                                                                                                                                                              • If set to 2, the object is unmanaged, disabled or both depending on the context.
                                                                                                                                                                                                                                              By default, row_state is set to 1 when an object is created.", + "enum": [ + "1", + "2" + ], + "type": "string" + }, + "network_level": { + "description": "The level of the network within the space:
                                                                                                                                                                                                                                              • Set it to 0 for a block-type network.
                                                                                                                                                                                                                                              • Set it to a value between 1 and n for a subnet-type network.
                                                                                                                                                                                                                                              If you set a value between 2 and n, you are setting a network-based VLSM organization where non terminal subnet-type networks can contain other subnet-type networks.", + "type": "integer" + }, + "network_name": { + "description": "The name of the IPv4 network, each IPv4 network must have a unique name.", + "type": "string" + }, + "use_reversed_relative_position": { + "description": "A way to determine if the calculation of the parameter relative_position should start from the top (0) or the bottom (1) of the VLSM organization.", + "type": "integer" + }, + "vlan_id": { + "description": "The database identifier (ID) of the VLAN you want to associate with the network.", + "type": "integer" + }, + "vlsm_space_id": { + "description": "The database identifier (ID) of a VLSM child space of the space specified in space_id. If you specify an ID, the subnet-type network you are adding is duplicated as a VLSM block-type network in the child space, with the same name but a different ID. This parameter serves the same purpose as vlsm_space_name.", + "type": "integer" + }, + "vlsm_space_name": { + "description": "The name of a VLSM child space of the space specified in space_id. If you specify a name, the subnet-type network you are adding is duplicated as a VLSM block-type network in the child space, with the same name but a different ID. This parameter serves the same purpose as vlsm_space_id.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "network_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "network_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "parent_network_id": { + "description": "The database identifier (ID) of an existing IPv4 network you want to set as the parent of the IPv4 network you are adding. You can specify a subnet-type network to set up a network-based VLSM organization.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "network_addr": { + "description": "The start IP address of the IPv4 network, its first IP address.", + "type": "string" + }, + "network_end_addr": { + "description": "The end IP address of the IPv4 network, its last IP address.", + "type": "string" + }, + "network_mask": { + "description": "The netmask of the IPv4 network. It is expressed in dot-decimal notation and defines the number of addresses the network contains.", + "type": "string" + }, + "network_prefix": { + "description": "The prefix of the IPv4 network, an integer that defines the number of addresses the network contains.", + "type": "string" + }, + "network_size": { + "description": "The size of the IPv4 network, the number of IP addresses it contains.", + "type": "integer" + }, + "allow_block_creation": { + "description": "Internal use. Not documented.", + "type": "integer" + }, + "allow_tree_reparenting": { + "description": "A way to allow (1) or prevent (0) changing the parent of the network you are adding. Upon editing of the network, this parameter decides if you can associate it with a different parent network.", + "type": "integer" + }, + "network_is_terminal": { + "description": "A way to determine if a network can contain other networks. If set to 1, the network is terminal and cannot contain other subnet-type networks. By essence, block-type networks are non-terminal and are always set to 0.", + "type": "integer" + }, + "network_lock_network_broadcast": { + "description": "A way to prevent (1) users from assigning the broadcast IP address and network IP address of the network.", + "type": "integer" + }, + "permit_invalid": { + "description": "A way to authorize (1) IPv4 networks overlapping within a space.", + "type": "integer" + }, + "permit_no_block": { + "description": "A way to force the creation of an IPv4 subnet-type network. If set to 1, you can create a subnet-type network even if no block-type network matching the start address exists.", + "type": "integer" + }, + "relative_position": { + "description": "The position of the network within the hierarchy of networks of a VLSM organization. It calculates between 0 and n all the levels of the organization, its behavior depends on the value of the parameter use_reversed_relative_position:
                                                                                                                                                                                                                                              • use_reversed_relative_position=0 where 0 indicates a block-type network at the highest level possible, in a space-based organization, it belongs to the top space. The levels increment from 0 down to n, the lowest level you set up, within networks or spaces.
                                                                                                                                                                                                                                              • use_reversed_relative_position=1 where 1 indicates a network located at the lowest level of the organization, within networks or spaces. The levels increment from 0 up to n, the network at the highest level of the organization.
                                                                                                                                                                                                                                              ", + "type": "integer" + }, + "row_state": { + "description": "The object activation status.
                                                                                                                                                                                                                                              • If set to 0, the object is present in the database but ignored, i.e. it cannot be managed, counted or listed. This status is applied on objects deleted from the GUI.
                                                                                                                                                                                                                                              • If set to 1, the object is enabled and managed.
                                                                                                                                                                                                                                              • If set to 2, the object is unmanaged, disabled or both depending on the context.
                                                                                                                                                                                                                                              By default, row_state is set to 1 when an object is created.", + "enum": [ + "1", + "2" + ], + "type": "string" + }, + "network_level": { + "description": "The level of the network within the space:
                                                                                                                                                                                                                                              • Set it to 0 for a block-type network.
                                                                                                                                                                                                                                              • Set it to a value between 1 and n for a subnet-type network.
                                                                                                                                                                                                                                              If you set a value between 2 and n, you are setting a network-based VLSM organization where non terminal subnet-type networks can contain other subnet-type networks.", + "type": "integer" + }, + "network_name": { + "description": "The name of the IPv4 network, each IPv4 network must have a unique name.", + "type": "string" + }, + "use_reversed_relative_position": { + "description": "A way to determine if the calculation of the parameter relative_position should start from the top (0) or the bottom (1) of the VLSM organization.", + "type": "integer" + }, + "vlan_id": { + "description": "The database identifier (ID) of the VLAN you want to associate with the network.", + "type": "integer" + }, + "vlsm_space_id": { + "description": "The database identifier (ID) of a VLSM child space of the space specified in space_id. If you specify an ID, the subnet-type network you are adding is duplicated as a VLSM block-type network in the child space, with the same name but a different ID. This parameter serves the same purpose as vlsm_space_name.", + "type": "integer" + }, + "vlsm_space_name": { + "description": "The name of a VLSM child space of the space specified in space_id. If you specify a name, the subnet-type network you are adding is duplicated as a VLSM block-type network in the child space, with the same name but a different ID. This parameter serves the same purpose as vlsm_space_id.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "network_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "network_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "7bb1b222-c6db-4fb3-b81e-06ca42ac63da", + "created": "2026-08-25T15:04:03.011Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 114, + "reference": "168863a3-f3d2-4471-bf2b-cf38ec9ae908", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "EfficientIP Delete IPAM Network", + "description": "EfficientIP Delete IPAM Network", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_network_delete", + "canvasName": "ipam_network_delete", + "summary": "ipam_network_delete", + "description": "ipam_network_delete", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "parent_network_id": "$var.job.parent_network_id", + "space_id": "$var.job.space_id", + "space_name": "$var.job.space_name", + "network_addr": "$var.job.network_addr", + "network_end_addr": "$var.job.network_end_addr", + "network_id": "$var.job.network_id", + "network_mask": "$var.job.network_mask", + "network_prefix": "$var.job.network_prefix", + "network_size": "$var.job.network_size", + "relative_position": "$var.job.relative_position", + "network_level": "$var.job.network_level", + "network_name": "$var.job.network_name", + "use_reversed_relative_position": "$var.job.use_reversed_relative_position", + "warnings": "$var.job.warnings" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "parent_network_id": { + "type": "integer" + }, + "space_id": { + "type": "integer" + }, + "space_name": { + "type": "string" + }, + "network_addr": { + "type": "string" + }, + "network_end_addr": { + "type": "string" + }, + "network_id": { + "type": "integer" + }, + "network_mask": { + "type": "string" + }, + "network_prefix": { + "type": "string" + }, + "network_size": { + "type": "integer" + }, + "relative_position": { + "type": "integer" + }, + "network_level": { + "type": "integer" + }, + "network_name": { + "type": "string" + }, + "use_reversed_relative_position": { + "type": "integer" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + } + }, + "required": [ + "parent_network_id", + "space_id", + "space_name", + "network_addr", + "network_end_addr", + "network_id", + "network_mask", + "network_prefix", + "network_size", + "relative_position", + "network_level", + "network_name", + "use_reversed_relative_position", + "warnings" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "parent_network_id": { + "type": "integer" + }, + "space_id": { + "type": "integer" + }, + "space_name": { + "type": "string" + }, + "network_addr": { + "type": "string" + }, + "network_end_addr": { + "type": "string" + }, + "network_id": { + "type": "integer" + }, + "network_mask": { + "type": "string" + }, + "network_prefix": { + "type": "string" + }, + "network_size": { + "type": "integer" + }, + "relative_position": { + "type": "integer" + }, + "network_level": { + "type": "integer" + }, + "network_name": { + "type": "string" + }, + "use_reversed_relative_position": { + "type": "integer" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "7244f499-4dff-4ca6-99ab-453ad1b0f8d8", + "created": "2026-08-25T15:04:03.044Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 115, + "reference": "2c8ff587-1f8d-4549-91c0-9fee068d205b", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "EfficientIP Update IPAM Network", + "description": "EfficientIP Update IPAM Network", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_network_edit", + "canvasName": "ipam_network_edit", + "summary": "ipam_network_edit", + "description": "ipam_network_edit", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "parent_network_id": { + "description": "The database identifier (ID) of an existing IPv4 network you want to set as the parent of the IPv4 network you are editing. You can specify a subnet-type network to set up a network-based VLSM organization.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "network_addr": { + "description": "The start IP address of the IPv4 network, its first IP address.", + "type": "string" + }, + "network_end_addr": { + "description": "The end IP address of the IPv4 network, its last IP address.", + "type": "string" + }, + "network_id": { + "description": "The database identifier (ID) of the IPv4 network, a unique numeric key value automatically incremented when you add an IPv4 network. Use the ID to specify the IPv4 network of your choice.", + "type": "integer" + }, + "network_mask": { + "description": "The netmask of the IPv4 network. It is expressed in dot-decimal notation and defines the number of addresses the network contains.", + "type": "string" + }, + "network_prefix": { + "description": "The prefix of the IPv4 network, an integer that defines the number of addresses the network contains.", + "type": "string" + }, + "network_size": { + "description": "The size of the IPv4 network, the number of IP addresses it contains.", + "type": "integer" + }, + "allow_block_creation": { + "description": "Internal use. Not documented.", + "type": "integer" + }, + "allow_tree_reparenting": { + "description": "A way to allow (1) or prevent (0) changing the parent of the network you are adding. Upon editing of the network, this parameter decides if you can associate it with a different parent network.", + "type": "integer" + }, + "network_is_terminal": { + "description": "A way to determine if a network can contain other networks. If set to 1, the network is terminal and cannot contain other subnet-type networks. By essence, block-type networks are non-terminal and are always set to 0.", + "type": "integer" + }, + "network_lock_network_broadcast": { + "description": "A way to prevent (1) users from assigning the broadcast IP address and network IP address of the network.", + "type": "integer" + }, + "permit_invalid": { + "description": "A way to authorize (1) IPv4 networks overlapping within a space.", + "type": "integer" + }, + "permit_no_block": { + "description": "A way to force the creation of an IPv4 subnet-type network. If set to 1, you can create a subnet-type network even if no block-type network matching the start address exists.", + "type": "integer" + }, + "relative_position": { + "description": "The position of the network within the hierarchy of networks of a VLSM organization. It calculates between 0 and n all the levels of the organization, its behavior depends on the value of the parameter use_reversed_relative_position:
                                                                                                                                                                                                                                              • use_reversed_relative_position=0 where 0 indicates a block-type network at the highest level possible, in a space-based organization, it belongs to the top space. The levels increment from 0 down to n, the lowest level you set up, within networks or spaces.
                                                                                                                                                                                                                                              • use_reversed_relative_position=1 where 1 indicates a network located at the lowest level of the organization, within networks or spaces. The levels increment from 0 up to n, the network at the highest level of the organization.
                                                                                                                                                                                                                                              ", + "type": "integer" + }, + "row_state": { + "description": "The object activation status.
                                                                                                                                                                                                                                              • If set to 0, the object is present in the database but ignored, i.e. it cannot be managed, counted or listed. This status is applied on objects deleted from the GUI.
                                                                                                                                                                                                                                              • If set to 1, the object is enabled and managed.
                                                                                                                                                                                                                                              • If set to 2, the object is unmanaged, disabled or both depending on the context.
                                                                                                                                                                                                                                              By default, row_state is set to 1 when an object is created.", + "enum": [ + "1", + "2" + ], + "type": "string" + }, + "network_level": { + "description": "The level of the network within the space:
                                                                                                                                                                                                                                              • Set it to 0 for a block-type network.
                                                                                                                                                                                                                                              • Set it to a value between 1 and n for a subnet-type network.
                                                                                                                                                                                                                                              If you set a value between 2 and n, you are setting a network-based VLSM organization where non terminal subnet-type networks can contain other subnet-type networks.", + "type": "integer" + }, + "network_name": { + "description": "The name of the IPv4 network, each IPv4 network must have a unique name.", + "type": "string" + }, + "use_reversed_relative_position": { + "description": "A way to determine if the calculation of the parameter relative_position should start from the top (0) or the bottom (1) of the VLSM organization.", + "type": "integer" + }, + "vlan_id": { + "description": "The database identifier (ID) of the VLAN you want to associate with the network.", + "type": "integer" + }, + "vlsm_space_id": { + "description": "The database identifier (ID) of a VLSM child space of the space specified in space_id. If you specify an ID, the subnet-type network you are editing is duplicated as a VLSM block-type network in the child space, with the same name but a different ID. This parameter serves the same purpose as vlsm_space_name.", + "type": "integer" + }, + "vlsm_space_name": { + "description": "The name of a VLSM child space of the space specified in space_id. If you specify a name, the subnet-type network you are editing is duplicated as a VLSM block-type network in the child space, with the same name but a different ID. This parameter serves the same purpose as vlsm_space_id.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "network_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "network_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "parent_network_id": { + "description": "The database identifier (ID) of an existing IPv4 network you want to set as the parent of the IPv4 network you are editing. You can specify a subnet-type network to set up a network-based VLSM organization.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "network_addr": { + "description": "The start IP address of the IPv4 network, its first IP address.", + "type": "string" + }, + "network_end_addr": { + "description": "The end IP address of the IPv4 network, its last IP address.", + "type": "string" + }, + "network_id": { + "description": "The database identifier (ID) of the IPv4 network, a unique numeric key value automatically incremented when you add an IPv4 network. Use the ID to specify the IPv4 network of your choice.", + "type": "integer" + }, + "network_mask": { + "description": "The netmask of the IPv4 network. It is expressed in dot-decimal notation and defines the number of addresses the network contains.", + "type": "string" + }, + "network_prefix": { + "description": "The prefix of the IPv4 network, an integer that defines the number of addresses the network contains.", + "type": "string" + }, + "network_size": { + "description": "The size of the IPv4 network, the number of IP addresses it contains.", + "type": "integer" + }, + "allow_block_creation": { + "description": "Internal use. Not documented.", + "type": "integer" + }, + "allow_tree_reparenting": { + "description": "A way to allow (1) or prevent (0) changing the parent of the network you are adding. Upon editing of the network, this parameter decides if you can associate it with a different parent network.", + "type": "integer" + }, + "network_is_terminal": { + "description": "A way to determine if a network can contain other networks. If set to 1, the network is terminal and cannot contain other subnet-type networks. By essence, block-type networks are non-terminal and are always set to 0.", + "type": "integer" + }, + "network_lock_network_broadcast": { + "description": "A way to prevent (1) users from assigning the broadcast IP address and network IP address of the network.", + "type": "integer" + }, + "permit_invalid": { + "description": "A way to authorize (1) IPv4 networks overlapping within a space.", + "type": "integer" + }, + "permit_no_block": { + "description": "A way to force the creation of an IPv4 subnet-type network. If set to 1, you can create a subnet-type network even if no block-type network matching the start address exists.", + "type": "integer" + }, + "relative_position": { + "description": "The position of the network within the hierarchy of networks of a VLSM organization. It calculates between 0 and n all the levels of the organization, its behavior depends on the value of the parameter use_reversed_relative_position:
                                                                                                                                                                                                                                              • use_reversed_relative_position=0 where 0 indicates a block-type network at the highest level possible, in a space-based organization, it belongs to the top space. The levels increment from 0 down to n, the lowest level you set up, within networks or spaces.
                                                                                                                                                                                                                                              • use_reversed_relative_position=1 where 1 indicates a network located at the lowest level of the organization, within networks or spaces. The levels increment from 0 up to n, the network at the highest level of the organization.
                                                                                                                                                                                                                                              ", + "type": "integer" + }, + "row_state": { + "description": "The object activation status.
                                                                                                                                                                                                                                              • If set to 0, the object is present in the database but ignored, i.e. it cannot be managed, counted or listed. This status is applied on objects deleted from the GUI.
                                                                                                                                                                                                                                              • If set to 1, the object is enabled and managed.
                                                                                                                                                                                                                                              • If set to 2, the object is unmanaged, disabled or both depending on the context.
                                                                                                                                                                                                                                              By default, row_state is set to 1 when an object is created.", + "enum": [ + "1", + "2" + ], + "type": "string" + }, + "network_level": { + "description": "The level of the network within the space:
                                                                                                                                                                                                                                              • Set it to 0 for a block-type network.
                                                                                                                                                                                                                                              • Set it to a value between 1 and n for a subnet-type network.
                                                                                                                                                                                                                                              If you set a value between 2 and n, you are setting a network-based VLSM organization where non terminal subnet-type networks can contain other subnet-type networks.", + "type": "integer" + }, + "network_name": { + "description": "The name of the IPv4 network, each IPv4 network must have a unique name.", + "type": "string" + }, + "use_reversed_relative_position": { + "description": "A way to determine if the calculation of the parameter relative_position should start from the top (0) or the bottom (1) of the VLSM organization.", + "type": "integer" + }, + "vlan_id": { + "description": "The database identifier (ID) of the VLAN you want to associate with the network.", + "type": "integer" + }, + "vlsm_space_id": { + "description": "The database identifier (ID) of a VLSM child space of the space specified in space_id. If you specify an ID, the subnet-type network you are editing is duplicated as a VLSM block-type network in the child space, with the same name but a different ID. This parameter serves the same purpose as vlsm_space_name.", + "type": "integer" + }, + "vlsm_space_name": { + "description": "The name of a VLSM child space of the space specified in space_id. If you specify a name, the subnet-type network you are editing is duplicated as a VLSM block-type network in the child space, with the same name but a different ID. This parameter serves the same purpose as vlsm_space_id.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "network_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "network_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "9dd78d72-5288-4bb7-8c56-e2d72c5a59ec", + "created": "2026-08-25T15:04:03.080Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 116, + "reference": "0b443a6a-b299-4713-be16-7506118d28ad", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "EfficientIP Get IPAM Network", + "description": "EfficientIP Get IPAM Network", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_network_info", + "canvasName": "ipam_network_info", + "summary": "ipam_network_info", + "description": "ipam_network_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "no_parent_class_param": "$var.job.no_parent_class_param", + "network_id": "$var.job.network_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "network_id": { + "type": "integer" + } + }, + "required": [ + "no_parent_class_param", + "network_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "network_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "34915a22-a5aa-4ff5-b7ed-f9c6e6453477", + "created": "2026-08-25T15:04:03.110Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 117, + "reference": "a6de0033-7708-4306-91bf-22f8711e7fdc", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "EfficientIP List IPAM Networks", + "description": "EfficientIP List IPAM Networks", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_network_list", + "canvasName": "ipam_network_list", + "summary": "ipam_network_list", + "description": "ipam_network_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset", + "no_parent_class_param": "$var.job.no_parent_class_param", + "tags": "$var.job.tags" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset", + "no_parent_class_param", + "tags" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "7214c2ff-c22c-4104-8ff6-ea138111cb04", + "created": "2026-08-25T15:04:03.139Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 118, + "reference": "65ed23f4-3b80-47de-b818-bb3909a4c28c", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "Create IPAM IPv6 Network", + "description": "Create IPAM IPv6 Network", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_network6_add", + "canvasName": "ipam_network6_add", + "summary": "ipam_network6_add", + "description": "ipam_network6_add", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "parent_network6_id": { + "description": "The database identifier (ID) of an existing IPv6 network you want to set as the parent of the IPv6 network you are adding. You can specify a subnet-type network to set up a network-based VLSM organization.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "network6_addr": { + "description": "The start IP address of the IPv6 network, its first IP address.", + "type": "string" + }, + "network6_end_addr": { + "description": "The end IP address of the IPv6 network, its last IP address.", + "type": "string" + }, + "network6_prefix": { + "description": "The prefix of the IPv6 network, an integer that defines the number of address the network contains.", + "type": "string" + }, + "allow_block6_creation": { + "description": "Internal use. Not documented.", + "type": "integer" + }, + "allow_tree_reparenting": { + "description": "A way to allow (1) or prevent (0) changing the parent of the network you are adding. Upon editing of the network, this parameter decides if you can associate it with a different parent network.", + "type": "integer" + }, + "network6_is_terminal": { + "description": "A way to determine if a network can contain other networks. If set to 1, the network is terminal and cannot contain other subnet-type networks. By essence, block-type networks are non-terminal and are always set to 0.", + "type": "integer" + }, + "network6_lock_network_broadcast": { + "description": "A way to prevent (1) users from assigning the broadcast IP address and network IP address of the network.", + "type": "integer" + }, + "permit_invalid": { + "description": "A way to authorize (1) IPv6 networks overlapping within a space.", + "type": "integer" + }, + "permit_no_block6": { + "description": "A way to force the creation of an IPv6 subnet-type network. If set to 1, you can create a subnet-type network even if no block-type network matching the start address exists.", + "type": "integer" + }, + "relative_position": { + "description": "The position of the network within the hierarchy of networks of a VLSM organization. It calculates between 0 and n all the levels of the organization, its behavior depends on the value of the parameter use_reversed_relative_position:
                                                                                                                                                                                                                                              • use_reversed_relative_position=0 where 0 indicates a block-type network at the highest level possible, in a space-based organization, it belongs to the top space. The levels increment from 0 down to n, the lowest level you set up, within networks or spaces.
                                                                                                                                                                                                                                              • use_reversed_relative_position=1 where 1 indicates a network located at the lowest level of the organization, within networks or spaces. The levels increment from 0 up to n, the network at the highest level of the organization.
                                                                                                                                                                                                                                              ", + "type": "integer" + }, + "row_state": { + "description": "The object activation status.
                                                                                                                                                                                                                                              • If set to 0, the object is present in the database but ignored, i.e. it cannot be managed, counted or listed. This status is applied on objects deleted from the GUI.
                                                                                                                                                                                                                                              • If set to 1, the object is enabled and managed.
                                                                                                                                                                                                                                              • If set to 2, the object is unmanaged, disabled or both depending on the context.
                                                                                                                                                                                                                                              By default, row_state is set to 1 when an object is created.", + "enum": [ + "1", + "2" + ], + "type": "string" + }, + "network6_name": { + "description": "The name of the IPv6 network, each IPv6 network must have a unique name.", + "type": "string" + }, + "network_level": { + "description": "The level of the network within the space:
                                                                                                                                                                                                                                              • Set it to 0 for a block-type network.
                                                                                                                                                                                                                                              • Set it to a value between 1 and n for a subnet-type network.
                                                                                                                                                                                                                                              If you set a value between 2 and n, you are setting a network-based VLSM organization where non terminal subnet-type networks can contain other subnet-type networks.", + "type": "integer" + }, + "use_reversed_relative_position": { + "description": "A way to determine if the calculation of the parameter relative_position should start from the top (0) or the bottom (1) of the VLSM organization.", + "type": "integer" + }, + "vlan_id": { + "description": "The database identifier (ID) of the VLAN you want to associate with the network.", + "type": "integer" + }, + "vlsm_space_id": { + "description": "The database identifier (ID) of a VLSM child space of the space specified in space_id. If you specify an ID, the subnet-type network you are adding is duplicated as a VLSM block-type network in the child space, with the same name but a different ID. This parameter serves the same purpose as vlsm_space_name.", + "type": "integer" + }, + "vlsm_space_name": { + "description": "The name of a VLSM child space of the space specified in space_id. If you specify a name, the subnet-type network you are adding is duplicated as a VLSM block-type network in the child space, with the same name but a different ID. This parameter serves the same purpose as vlsm_space_id.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "network6_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "network6_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "parent_network6_id": { + "description": "The database identifier (ID) of an existing IPv6 network you want to set as the parent of the IPv6 network you are adding. You can specify a subnet-type network to set up a network-based VLSM organization.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "network6_addr": { + "description": "The start IP address of the IPv6 network, its first IP address.", + "type": "string" + }, + "network6_end_addr": { + "description": "The end IP address of the IPv6 network, its last IP address.", + "type": "string" + }, + "network6_prefix": { + "description": "The prefix of the IPv6 network, an integer that defines the number of address the network contains.", + "type": "string" + }, + "allow_block6_creation": { + "description": "Internal use. Not documented.", + "type": "integer" + }, + "allow_tree_reparenting": { + "description": "A way to allow (1) or prevent (0) changing the parent of the network you are adding. Upon editing of the network, this parameter decides if you can associate it with a different parent network.", + "type": "integer" + }, + "network6_is_terminal": { + "description": "A way to determine if a network can contain other networks. If set to 1, the network is terminal and cannot contain other subnet-type networks. By essence, block-type networks are non-terminal and are always set to 0.", + "type": "integer" + }, + "network6_lock_network_broadcast": { + "description": "A way to prevent (1) users from assigning the broadcast IP address and network IP address of the network.", + "type": "integer" + }, + "permit_invalid": { + "description": "A way to authorize (1) IPv6 networks overlapping within a space.", + "type": "integer" + }, + "permit_no_block6": { + "description": "A way to force the creation of an IPv6 subnet-type network. If set to 1, you can create a subnet-type network even if no block-type network matching the start address exists.", + "type": "integer" + }, + "relative_position": { + "description": "The position of the network within the hierarchy of networks of a VLSM organization. It calculates between 0 and n all the levels of the organization, its behavior depends on the value of the parameter use_reversed_relative_position:
                                                                                                                                                                                                                                              • use_reversed_relative_position=0 where 0 indicates a block-type network at the highest level possible, in a space-based organization, it belongs to the top space. The levels increment from 0 down to n, the lowest level you set up, within networks or spaces.
                                                                                                                                                                                                                                              • use_reversed_relative_position=1 where 1 indicates a network located at the lowest level of the organization, within networks or spaces. The levels increment from 0 up to n, the network at the highest level of the organization.
                                                                                                                                                                                                                                              ", + "type": "integer" + }, + "row_state": { + "description": "The object activation status.
                                                                                                                                                                                                                                              • If set to 0, the object is present in the database but ignored, i.e. it cannot be managed, counted or listed. This status is applied on objects deleted from the GUI.
                                                                                                                                                                                                                                              • If set to 1, the object is enabled and managed.
                                                                                                                                                                                                                                              • If set to 2, the object is unmanaged, disabled or both depending on the context.
                                                                                                                                                                                                                                              By default, row_state is set to 1 when an object is created.", + "enum": [ + "1", + "2" + ], + "type": "string" + }, + "network6_name": { + "description": "The name of the IPv6 network, each IPv6 network must have a unique name.", + "type": "string" + }, + "network_level": { + "description": "The level of the network within the space:
                                                                                                                                                                                                                                              • Set it to 0 for a block-type network.
                                                                                                                                                                                                                                              • Set it to a value between 1 and n for a subnet-type network.
                                                                                                                                                                                                                                              If you set a value between 2 and n, you are setting a network-based VLSM organization where non terminal subnet-type networks can contain other subnet-type networks.", + "type": "integer" + }, + "use_reversed_relative_position": { + "description": "A way to determine if the calculation of the parameter relative_position should start from the top (0) or the bottom (1) of the VLSM organization.", + "type": "integer" + }, + "vlan_id": { + "description": "The database identifier (ID) of the VLAN you want to associate with the network.", + "type": "integer" + }, + "vlsm_space_id": { + "description": "The database identifier (ID) of a VLSM child space of the space specified in space_id. If you specify an ID, the subnet-type network you are adding is duplicated as a VLSM block-type network in the child space, with the same name but a different ID. This parameter serves the same purpose as vlsm_space_name.", + "type": "integer" + }, + "vlsm_space_name": { + "description": "The name of a VLSM child space of the space specified in space_id. If you specify a name, the subnet-type network you are adding is duplicated as a VLSM block-type network in the child space, with the same name but a different ID. This parameter serves the same purpose as vlsm_space_id.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "network6_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "network6_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "f28ebc31-9d42-4727-bfd4-4f94365392fa", + "created": "2026-08-25T15:04:03.173Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 119, + "reference": "a019c2c5-26ba-4452-8bba-f26527d51a15", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "Delete IPAM IPv6 Network", + "description": "Delete IPAM IPv6 Network", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_network6_delete", + "canvasName": "ipam_network6_delete", + "summary": "ipam_network6_delete", + "description": "ipam_network6_delete", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "parent_network6_id": "$var.job.parent_network6_id", + "space_id": "$var.job.space_id", + "space_name": "$var.job.space_name", + "network6_addr": "$var.job.network6_addr", + "network6_end_addr": "$var.job.network6_end_addr", + "network6_id": "$var.job.network6_id", + "network6_prefix": "$var.job.network6_prefix", + "relative_position": "$var.job.relative_position", + "network6_name": "$var.job.network6_name", + "network_level": "$var.job.network_level", + "use_reversed_relative_position": "$var.job.use_reversed_relative_position", + "warnings": "$var.job.warnings" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "parent_network6_id": { + "type": "integer" + }, + "space_id": { + "type": "integer" + }, + "space_name": { + "type": "string" + }, + "network6_addr": { + "type": "string" + }, + "network6_end_addr": { + "type": "string" + }, + "network6_id": { + "type": "integer" + }, + "network6_prefix": { + "type": "string" + }, + "relative_position": { + "type": "integer" + }, + "network6_name": { + "type": "string" + }, + "network_level": { + "type": "integer" + }, + "use_reversed_relative_position": { + "type": "integer" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + } + }, + "required": [ + "parent_network6_id", + "space_id", + "space_name", + "network6_addr", + "network6_end_addr", + "network6_id", + "network6_prefix", + "relative_position", + "network6_name", + "network_level", + "use_reversed_relative_position", + "warnings" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "parent_network6_id": { + "type": "integer" + }, + "space_id": { + "type": "integer" + }, + "space_name": { + "type": "string" + }, + "network6_addr": { + "type": "string" + }, + "network6_end_addr": { + "type": "string" + }, + "network6_id": { + "type": "integer" + }, + "network6_prefix": { + "type": "string" + }, + "relative_position": { + "type": "integer" + }, + "network6_name": { + "type": "string" + }, + "network_level": { + "type": "integer" + }, + "use_reversed_relative_position": { + "type": "integer" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "902dd61d-5dca-4de3-a6a3-5ba25940a393", + "created": "2026-08-25T15:04:03.203Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 120, + "reference": "808a67a7-a4aa-4676-b985-d612f8726eba", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "Update IPAM IPv6 Network", + "description": "Update IPAM IPv6 Network", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_network6_edit", + "canvasName": "ipam_network6_edit", + "summary": "ipam_network6_edit", + "description": "ipam_network6_edit", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "parent_network6_id": { + "description": "The database identifier (ID) of an existing IPv6 network you want to set as the parent of the IPv6 network you are editing. You can specify a subnet-type network to set up a network-based VLSM organization.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "network6_addr": { + "description": "The start IP address of the IPv6 network, its first IP address.", + "type": "string" + }, + "network6_end_addr": { + "description": "The end IP address of the IPv6 network, its last IP address.", + "type": "string" + }, + "network6_id": { + "description": "The database identifier (ID) of the IPv6 network, a unique numeric key value automatically incremented when you add an IPv6 network. Use the ID to specify the IPv6 network of your choice.", + "type": "integer" + }, + "network6_prefix": { + "description": "The prefix of the IPv6 network, an integer that defines the number of address the network contains.", + "type": "string" + }, + "allow_block6_creation": { + "description": "Internal use. Not documented.", + "type": "integer" + }, + "allow_tree_reparenting": { + "description": "A way to allow (1) or prevent (0) changing the parent of the network you are adding. Upon editing of the network, this parameter decides if you can associate it with a different parent network.", + "type": "integer" + }, + "network6_is_terminal": { + "description": "A way to determine if a network can contain other networks. If set to 1, the network is terminal and cannot contain other subnet-type networks. By essence, block-type networks are non-terminal and are always set to 0.", + "type": "integer" + }, + "network6_lock_network_broadcast": { + "description": "A way to prevent (1) users from assigning the broadcast IP address and network IP address of the network.", + "type": "integer" + }, + "permit_invalid": { + "description": "A way to authorize (1) IPv6 networks overlapping within a space.", + "type": "integer" + }, + "permit_no_block6": { + "description": "A way to force the creation of an IPv6 subnet-type network. If set to 1, you can create a subnet-type network even if no block-type network matching the start address exists.", + "type": "integer" + }, + "relative_position": { + "description": "The position of the network within the hierarchy of networks of a VLSM organization. It calculates between 0 and n all the levels of the organization, its behavior depends on the value of the parameter use_reversed_relative_position:
                                                                                                                                                                                                                                              • use_reversed_relative_position=0 where 0 indicates a block-type network at the highest level possible, in a space-based organization, it belongs to the top space. The levels increment from 0 down to n, the lowest level you set up, within networks or spaces.
                                                                                                                                                                                                                                              • use_reversed_relative_position=1 where 1 indicates a network located at the lowest level of the organization, within networks or spaces. The levels increment from 0 up to n, the network at the highest level of the organization.
                                                                                                                                                                                                                                              ", + "type": "integer" + }, + "row_state": { + "description": "The object activation status.
                                                                                                                                                                                                                                              • If set to 0, the object is present in the database but ignored, i.e. it cannot be managed, counted or listed. This status is applied on objects deleted from the GUI.
                                                                                                                                                                                                                                              • If set to 1, the object is enabled and managed.
                                                                                                                                                                                                                                              • If set to 2, the object is unmanaged, disabled or both depending on the context.
                                                                                                                                                                                                                                              By default, row_state is set to 1 when an object is created.", + "enum": [ + "1", + "2" + ], + "type": "string" + }, + "network6_name": { + "description": "The name of the IPv6 network, each IPv6 network must have a unique name.", + "type": "string" + }, + "network_level": { + "description": "The level of the network within the space:
                                                                                                                                                                                                                                              • Set it to 0 for a block-type network.
                                                                                                                                                                                                                                              • Set it to a value between 1 and n for a subnet-type network.
                                                                                                                                                                                                                                              If you set a value between 2 and n, you are setting a network-based VLSM organization where non terminal subnet-type networks can contain other subnet-type networks.", + "type": "integer" + }, + "use_reversed_relative_position": { + "description": "A way to determine if the calculation of the parameter relative_position should start from the top (0) or the bottom (1) of the VLSM organization.", + "type": "integer" + }, + "vlan_id": { + "description": "The database identifier (ID) of the VLAN you want to associate with the network.", + "type": "integer" + }, + "vlsm_space_id": { + "description": "The database identifier (ID) of a VLSM child space of the space specified in space_id. If you specify an ID, the subnet-type network you are editing is duplicated as a VLSM block-type network in the child space, with the same name but a different ID. This parameter serves the same purpose as vlsm_space_name.", + "type": "integer" + }, + "vlsm_space_name": { + "description": "The name of a VLSM child space of the space specified in space_id. If you specify a name, the subnet-type network you are editing is duplicated as a VLSM block-type network in the child space, with the same name but a different ID. This parameter serves the same purpose as vlsm_space_id.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "network6_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "network6_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "parent_network6_id": { + "description": "The database identifier (ID) of an existing IPv6 network you want to set as the parent of the IPv6 network you are editing. You can specify a subnet-type network to set up a network-based VLSM organization.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "network6_addr": { + "description": "The start IP address of the IPv6 network, its first IP address.", + "type": "string" + }, + "network6_end_addr": { + "description": "The end IP address of the IPv6 network, its last IP address.", + "type": "string" + }, + "network6_id": { + "description": "The database identifier (ID) of the IPv6 network, a unique numeric key value automatically incremented when you add an IPv6 network. Use the ID to specify the IPv6 network of your choice.", + "type": "integer" + }, + "network6_prefix": { + "description": "The prefix of the IPv6 network, an integer that defines the number of address the network contains.", + "type": "string" + }, + "allow_block6_creation": { + "description": "Internal use. Not documented.", + "type": "integer" + }, + "allow_tree_reparenting": { + "description": "A way to allow (1) or prevent (0) changing the parent of the network you are adding. Upon editing of the network, this parameter decides if you can associate it with a different parent network.", + "type": "integer" + }, + "network6_is_terminal": { + "description": "A way to determine if a network can contain other networks. If set to 1, the network is terminal and cannot contain other subnet-type networks. By essence, block-type networks are non-terminal and are always set to 0.", + "type": "integer" + }, + "network6_lock_network_broadcast": { + "description": "A way to prevent (1) users from assigning the broadcast IP address and network IP address of the network.", + "type": "integer" + }, + "permit_invalid": { + "description": "A way to authorize (1) IPv6 networks overlapping within a space.", + "type": "integer" + }, + "permit_no_block6": { + "description": "A way to force the creation of an IPv6 subnet-type network. If set to 1, you can create a subnet-type network even if no block-type network matching the start address exists.", + "type": "integer" + }, + "relative_position": { + "description": "The position of the network within the hierarchy of networks of a VLSM organization. It calculates between 0 and n all the levels of the organization, its behavior depends on the value of the parameter use_reversed_relative_position:
                                                                                                                                                                                                                                              • use_reversed_relative_position=0 where 0 indicates a block-type network at the highest level possible, in a space-based organization, it belongs to the top space. The levels increment from 0 down to n, the lowest level you set up, within networks or spaces.
                                                                                                                                                                                                                                              • use_reversed_relative_position=1 where 1 indicates a network located at the lowest level of the organization, within networks or spaces. The levels increment from 0 up to n, the network at the highest level of the organization.
                                                                                                                                                                                                                                              ", + "type": "integer" + }, + "row_state": { + "description": "The object activation status.
                                                                                                                                                                                                                                              • If set to 0, the object is present in the database but ignored, i.e. it cannot be managed, counted or listed. This status is applied on objects deleted from the GUI.
                                                                                                                                                                                                                                              • If set to 1, the object is enabled and managed.
                                                                                                                                                                                                                                              • If set to 2, the object is unmanaged, disabled or both depending on the context.
                                                                                                                                                                                                                                              By default, row_state is set to 1 when an object is created.", + "enum": [ + "1", + "2" + ], + "type": "string" + }, + "network6_name": { + "description": "The name of the IPv6 network, each IPv6 network must have a unique name.", + "type": "string" + }, + "network_level": { + "description": "The level of the network within the space:
                                                                                                                                                                                                                                              • Set it to 0 for a block-type network.
                                                                                                                                                                                                                                              • Set it to a value between 1 and n for a subnet-type network.
                                                                                                                                                                                                                                              If you set a value between 2 and n, you are setting a network-based VLSM organization where non terminal subnet-type networks can contain other subnet-type networks.", + "type": "integer" + }, + "use_reversed_relative_position": { + "description": "A way to determine if the calculation of the parameter relative_position should start from the top (0) or the bottom (1) of the VLSM organization.", + "type": "integer" + }, + "vlan_id": { + "description": "The database identifier (ID) of the VLAN you want to associate with the network.", + "type": "integer" + }, + "vlsm_space_id": { + "description": "The database identifier (ID) of a VLSM child space of the space specified in space_id. If you specify an ID, the subnet-type network you are editing is duplicated as a VLSM block-type network in the child space, with the same name but a different ID. This parameter serves the same purpose as vlsm_space_name.", + "type": "integer" + }, + "vlsm_space_name": { + "description": "The name of a VLSM child space of the space specified in space_id. If you specify a name, the subnet-type network you are editing is duplicated as a VLSM block-type network in the child space, with the same name but a different ID. This parameter serves the same purpose as vlsm_space_id.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "network6_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "network6_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "9ab55ae3-4ad9-4baa-bca2-ce1670fcf8a5", + "created": "2026-08-25T15:04:03.234Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 121, + "reference": "609bad53-a9bb-47a7-b702-117bda9f94a1", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "Get IPAM IPv6 Network", + "description": "Get IPAM IPv6 Network", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_network6_info", + "canvasName": "ipam_network6_info", + "summary": "ipam_network6_info", + "description": "ipam_network6_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "no_parent_class_param": "$var.job.no_parent_class_param", + "network6_id": "$var.job.network6_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "network6_id": { + "type": "integer" + } + }, + "required": [ + "no_parent_class_param", + "network6_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "network6_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "bc625433-52eb-4fe1-a372-695d118c3480", + "created": "2026-08-25T15:04:03.274Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 122, + "reference": "2415bcab-98a0-4cc1-9611-ca16cf7bb39f", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "List IPAM IPv6 Networks", + "description": "List IPAM IPv6 Networks", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_network6_list", + "canvasName": "ipam_network6_list", + "summary": "ipam_network6_list", + "description": "ipam_network6_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset", + "no_parent_class_param": "$var.job.no_parent_class_param", + "tags": "$var.job.tags" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset", + "no_parent_class_param", + "tags" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "a63d8f57-58f9-4d15-b36c-9dd4094f1e26", + "created": "2026-08-25T15:04:03.314Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 123, + "reference": "e0e5c50d-ba4d-4f09-bc43-a89bb82970de", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "Create IPAM Pool", + "description": "Create IPAM Pool", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_pool_add", + "canvasName": "ipam_pool_add", + "summary": "ipam_pool_add", + "description": "ipam_pool_add", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "pool_end_ip_addr": { + "description": "The last IP address of the pool.", + "type": "string" + }, + "pool_size": { + "description": "The size of the pool, the number of IP addresses it contains.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "pool_start_ip_addr": { + "description": "The first IP address of the pool.", + "type": "string" + }, + "network_id": { + "description": "The database identifier (ID) of the IPv4 network, a unique numeric key value automatically incremented when you add an IPv4 network. Use the ID to specify the IPv4 network of your choice.", + "type": "integer" + }, + "pool_name": { + "description": "The name of the IPv4 pool, each IPv4 pool must have a unique name.", + "type": "string" + }, + "pool_read_only": { + "description": "The reservation status of the IPv4 pool. If set 1, the IP addresses it contains cannot be assigned.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "pool_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "pool_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "pool_end_ip_addr": { + "description": "The last IP address of the pool.", + "type": "string" + }, + "pool_size": { + "description": "The size of the pool, the number of IP addresses it contains.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "pool_start_ip_addr": { + "description": "The first IP address of the pool.", + "type": "string" + }, + "network_id": { + "description": "The database identifier (ID) of the IPv4 network, a unique numeric key value automatically incremented when you add an IPv4 network. Use the ID to specify the IPv4 network of your choice.", + "type": "integer" + }, + "pool_name": { + "description": "The name of the IPv4 pool, each IPv4 pool must have a unique name.", + "type": "string" + }, + "pool_read_only": { + "description": "The reservation status of the IPv4 pool. If set 1, the IP addresses it contains cannot be assigned.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "pool_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "pool_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "583eea13-41a4-42dd-97b1-5ab54035f596", + "created": "2026-08-25T15:04:03.345Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 124, + "reference": "e145fcb1-e484-44ac-880b-3bbce53bd074", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "Delete IPAM Pool", + "description": "Delete IPAM Pool", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_pool_delete", + "canvasName": "ipam_pool_delete", + "summary": "ipam_pool_delete", + "description": "ipam_pool_delete", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "pool_end_ip_addr": "$var.job.pool_end_ip_addr", + "pool_id": "$var.job.pool_id", + "pool_size": "$var.job.pool_size", + "space_id": "$var.job.space_id", + "space_name": "$var.job.space_name", + "pool_start_ip_addr": "$var.job.pool_start_ip_addr", + "network_id": "$var.job.network_id", + "warnings": "$var.job.warnings" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "pool_end_ip_addr": { + "type": "string" + }, + "pool_id": { + "type": "integer" + }, + "pool_size": { + "type": "integer" + }, + "space_id": { + "type": "integer" + }, + "space_name": { + "type": "string" + }, + "pool_start_ip_addr": { + "type": "string" + }, + "network_id": { + "type": "integer" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + } + }, + "required": [ + "pool_end_ip_addr", + "pool_id", + "pool_size", + "space_id", + "space_name", + "pool_start_ip_addr", + "network_id", + "warnings" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "pool_end_ip_addr": { + "type": "string" + }, + "pool_id": { + "type": "integer" + }, + "pool_size": { + "type": "integer" + }, + "space_id": { + "type": "integer" + }, + "space_name": { + "type": "string" + }, + "pool_start_ip_addr": { + "type": "string" + }, + "network_id": { + "type": "integer" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "58164aaf-eae7-4aac-a3bb-c09965d28c6e", + "created": "2026-08-25T15:04:03.376Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 125, + "reference": "3db92b38-a6c4-4a24-ac54-1cca91b6af5e", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "Update IPAM Pool", + "description": "Update IPAM Pool", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_pool_edit", + "canvasName": "ipam_pool_edit", + "summary": "ipam_pool_edit", + "description": "ipam_pool_edit", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "pool_end_ip_addr": { + "description": "The last IP address of the pool.", + "type": "string" + }, + "pool_id": { + "description": "The database identifier (ID) of the IPv4 pool, a unique numeric key value automatically incremented when you add an IPv4 pool. Use the ID to specify the IPv4 pool of your choice.", + "type": "integer" + }, + "pool_size": { + "description": "The size of the pool, the number of IP addresses it contains.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "pool_start_ip_addr": { + "description": "The first IP address of the pool.", + "type": "string" + }, + "network_id": { + "description": "The database identifier (ID) of the IPv4 network, a unique numeric key value automatically incremented when you add an IPv4 network. Use the ID to specify the IPv4 network of your choice.", + "type": "integer" + }, + "pool_name": { + "description": "The name of the IPv4 pool, each IPv4 pool must have a unique name.", + "type": "string" + }, + "pool_read_only": { + "description": "The reservation status of the IPv4 pool. If set 1, the IP addresses it contains cannot be assigned.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "pool_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "pool_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "pool_end_ip_addr": { + "description": "The last IP address of the pool.", + "type": "string" + }, + "pool_id": { + "description": "The database identifier (ID) of the IPv4 pool, a unique numeric key value automatically incremented when you add an IPv4 pool. Use the ID to specify the IPv4 pool of your choice.", + "type": "integer" + }, + "pool_size": { + "description": "The size of the pool, the number of IP addresses it contains.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "pool_start_ip_addr": { + "description": "The first IP address of the pool.", + "type": "string" + }, + "network_id": { + "description": "The database identifier (ID) of the IPv4 network, a unique numeric key value automatically incremented when you add an IPv4 network. Use the ID to specify the IPv4 network of your choice.", + "type": "integer" + }, + "pool_name": { + "description": "The name of the IPv4 pool, each IPv4 pool must have a unique name.", + "type": "string" + }, + "pool_read_only": { + "description": "The reservation status of the IPv4 pool. If set 1, the IP addresses it contains cannot be assigned.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "pool_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "pool_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "fe7847d5-8e7c-4f85-85fa-8cf78082066b", + "created": "2026-08-25T15:04:03.405Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 126, + "reference": "d6aa19ba-ce09-409c-b31f-76040f5b4de6", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "Get IPAM Pool", + "description": "Get IPAM Pool", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_pool_info", + "canvasName": "ipam_pool_info", + "summary": "ipam_pool_info", + "description": "ipam_pool_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "no_parent_class_param": "$var.job.no_parent_class_param", + "pool_id": "$var.job.pool_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "pool_id": { + "type": "integer" + } + }, + "required": [ + "no_parent_class_param", + "pool_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "pool_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "306d7b01-9e56-4138-af97-369e5c9b5c48", + "created": "2026-08-25T15:04:03.434Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 127, + "reference": "cfdb6594-7185-4a22-bd1b-93405a99bb43", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "List IPAM Pools", + "description": "List IPAM Pools", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_pool_list", + "canvasName": "ipam_pool_list", + "summary": "ipam_pool_list", + "description": "ipam_pool_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset", + "no_parent_class_param": "$var.job.no_parent_class_param", + "tags": "$var.job.tags" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset", + "no_parent_class_param", + "tags" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "947d262b-977f-4111-aa0c-c519c09ef4a4", + "created": "2026-08-25T15:04:03.469Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 128, + "reference": "8a8363cd-af04-4aff-b8c8-df0e3903d5f3", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "Create IPAM IPv6 Pool", + "description": "Create IPAM IPv6 Pool", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_pool6_add", + "canvasName": "ipam_pool6_add", + "summary": "ipam_pool6_add", + "description": "ipam_pool6_add", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "pool6_end_ip_addr": { + "description": "The last IP address of the pool.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "pool6_start_ip_addr": { + "description": "The first IP address of the pool.", + "type": "string" + }, + "network6_id": { + "description": "The database identifier (ID) of the IPv6 network, a unique numeric key value automatically incremented when you add an IPv6 network. Use the ID to specify the IPv6 network of your choice.", + "type": "integer" + }, + "pool6_name": { + "description": "The name of the IPv6 pool, each IPv6 pool must have a unique name.", + "type": "string" + }, + "pool6_read_only": { + "description": "The reservation status of the IPv6 pool. If set 1, the IP addresses it contains cannot be assigned.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "pool6_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "pool6_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "pool6_end_ip_addr": { + "description": "The last IP address of the pool.", + "type": "string" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "pool6_start_ip_addr": { + "description": "The first IP address of the pool.", + "type": "string" + }, + "network6_id": { + "description": "The database identifier (ID) of the IPv6 network, a unique numeric key value automatically incremented when you add an IPv6 network. Use the ID to specify the IPv6 network of your choice.", + "type": "integer" + }, + "pool6_name": { + "description": "The name of the IPv6 pool, each IPv6 pool must have a unique name.", + "type": "string" + }, + "pool6_read_only": { + "description": "The reservation status of the IPv6 pool. If set 1, the IP addresses it contains cannot be assigned.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "pool6_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "pool6_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "960b0e56-c38b-40d9-a47e-3c4298073ee5", + "created": "2026-08-25T15:04:03.497Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 129, + "reference": "ad444f41-e00a-4812-9a38-2cfd8c9b394b", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "Delete IPAM IPv6 Pool", + "description": "Delete IPAM IPv6 Pool", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_pool6_delete", + "canvasName": "ipam_pool6_delete", + "summary": "ipam_pool6_delete", + "description": "ipam_pool6_delete", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "pool6_end_ip_addr": "$var.job.pool6_end_ip_addr", + "pool6_id": "$var.job.pool6_id", + "space_id": "$var.job.space_id", + "space_name": "$var.job.space_name", + "pool6_start_ip_addr": "$var.job.pool6_start_ip_addr", + "network6_id": "$var.job.network6_id", + "warnings": "$var.job.warnings" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "pool6_end_ip_addr": { + "type": "string" + }, + "pool6_id": { + "type": "integer" + }, + "space_id": { + "type": "integer" + }, + "space_name": { + "type": "string" + }, + "pool6_start_ip_addr": { + "type": "string" + }, + "network6_id": { + "type": "integer" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + } + }, + "required": [ + "pool6_end_ip_addr", + "pool6_id", + "space_id", + "space_name", + "pool6_start_ip_addr", + "network6_id", + "warnings" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "pool6_end_ip_addr": { + "type": "string" + }, + "pool6_id": { + "type": "integer" + }, + "space_id": { + "type": "integer" + }, + "space_name": { + "type": "string" + }, + "pool6_start_ip_addr": { + "type": "string" + }, + "network6_id": { + "type": "integer" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "0b0210db-54e8-48ce-94e8-803b8924fbdb", + "created": "2026-08-25T15:04:03.528Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 130, + "reference": "314069c9-ce83-4d91-bf2d-3b5f72bdbfd6", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "Update IPAM IPv6 Pool", + "description": "Update IPAM IPv6 Pool", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_pool6_edit", + "canvasName": "ipam_pool6_edit", + "summary": "ipam_pool6_edit", + "description": "ipam_pool6_edit", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "pool6_end_ip_addr": { + "description": "The last IP address of the pool.", + "type": "string" + }, + "pool6_id": { + "description": "The database identifier (ID) of the IPv6 pool, a unique numeric key value automatically incremented when you add an IPv6 pool. Use the ID to specify the IPv6 pool of your choice.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "pool6_start_ip_addr": { + "description": "The first IP address of the pool.", + "type": "string" + }, + "network6_id": { + "description": "The database identifier (ID) of the IPv6 network, a unique numeric key value automatically incremented when you add an IPv6 network. Use the ID to specify the IPv6 network of your choice.", + "type": "integer" + }, + "pool6_name": { + "description": "The name of the IPv6 pool, each IPv6 pool must have a unique name.", + "type": "string" + }, + "pool6_read_only": { + "description": "The reservation status of the IPv6 pool. If set 1, the IP addresses it contains cannot be assigned.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "pool6_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "pool6_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "pool6_end_ip_addr": { + "description": "The last IP address of the pool.", + "type": "string" + }, + "pool6_id": { + "description": "The database identifier (ID) of the IPv6 pool, a unique numeric key value automatically incremented when you add an IPv6 pool. Use the ID to specify the IPv6 pool of your choice.", + "type": "integer" + }, + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space.", + "type": "string" + }, + "pool6_start_ip_addr": { + "description": "The first IP address of the pool.", + "type": "string" + }, + "network6_id": { + "description": "The database identifier (ID) of the IPv6 network, a unique numeric key value automatically incremented when you add an IPv6 network. Use the ID to specify the IPv6 network of your choice.", + "type": "integer" + }, + "pool6_name": { + "description": "The name of the IPv6 pool, each IPv6 pool must have a unique name.", + "type": "string" + }, + "pool6_read_only": { + "description": "The reservation status of the IPv6 pool. If set 1, the IP addresses it contains cannot be assigned.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "pool6_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "pool6_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "af1d3cb1-97ba-4ad2-a55b-0b0bd6eb0b50", + "created": "2026-08-25T15:04:03.556Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 131, + "reference": "3ff93617-eb79-4187-bdaf-d862439d3df7", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "Get IPAM IPv6 Pool", + "description": "Get IPAM IPv6 Pool", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_pool6_info", + "canvasName": "ipam_pool6_info", + "summary": "ipam_pool6_info", + "description": "ipam_pool6_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "no_parent_class_param": "$var.job.no_parent_class_param", + "pool6_id": "$var.job.pool6_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "pool6_id": { + "type": "integer" + } + }, + "required": [ + "no_parent_class_param", + "pool6_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "pool6_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "e1011391-665d-432c-ba7d-8807b72da555", + "created": "2026-08-25T15:04:03.584Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 132, + "reference": "32b36021-509a-4c58-be1b-495a6b03172d", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "List IPAM IPv6 Pools", + "description": "List IPAM IPv6 Pools", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_pool6_list", + "canvasName": "ipam_pool6_list", + "summary": "ipam_pool6_list", + "description": "ipam_pool6_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset", + "no_parent_class_param": "$var.job.no_parent_class_param", + "tags": "$var.job.tags" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset", + "no_parent_class_param", + "tags" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "47d3a709-eda5-433c-8bd1-77f30795bd19", + "created": "2026-08-25T15:04:03.615Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 133, + "reference": "88641230-411a-45b4-b63a-6929fbf5025c", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "Create IPAM Space", + "description": "Create IPAM Space", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_space_add", + "canvasName": "ipam_space_add", + "summary": "ipam_space_add", + "description": "ipam_space_add", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "space_name": { + "description": "The name of the space, each space must have a unique name.", + "type": "string" + }, + "parent_space_id": { + "description": "The database identifier (ID) of an existing space you want to set as the VLSM parent of the space you are adding. This sets up a space-based VLSM organization.", + "type": "integer" + }, + "parent_space_name": { + "description": "The name of an existing space you want to set as the VLSM parent of the space you are adding. This sets up a space-based VLSM organization.", + "type": "string" + }, + "space_description": { + "description": "The description of the space.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "space_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "space_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "space_name": { + "description": "The name of the space, each space must have a unique name.", + "type": "string" + }, + "parent_space_id": { + "description": "The database identifier (ID) of an existing space you want to set as the VLSM parent of the space you are adding. This sets up a space-based VLSM organization.", + "type": "integer" + }, + "parent_space_name": { + "description": "The name of an existing space you want to set as the VLSM parent of the space you are adding. This sets up a space-based VLSM organization.", + "type": "string" + }, + "space_description": { + "description": "The description of the space.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "space_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "space_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "a035c73f-98de-4d30-8e98-fb0ab7554fd7", + "created": "2026-08-25T15:04:03.644Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 134, + "reference": "6eac27be-b001-473c-b37d-7eb5aabc3ff9", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "Delete IPAM Space", + "description": "Delete IPAM Space", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_space_delete", + "canvasName": "ipam_space_delete", + "summary": "ipam_space_delete", + "description": "ipam_space_delete", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "space_id": "$var.job.space_id", + "space_name": "$var.job.space_name", + "warnings": "$var.job.warnings" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "space_id": { + "type": "integer" + }, + "space_name": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + } + }, + "required": [ + "space_id", + "space_name", + "warnings" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "space_id": { + "type": "integer" + }, + "space_name": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "12e523c0-0716-4a9c-8822-65f2fabaa571", + "created": "2026-08-25T15:04:03.672Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 135, + "reference": "f1d25aa6-ae38-4d77-ac82-0b8b6e53ea22", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "Update IPAM Space", + "description": "Update IPAM Space", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_space_edit", + "canvasName": "ipam_space_edit", + "summary": "ipam_space_edit", + "description": "ipam_space_edit", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space, each space must have a unique name.", + "type": "string" + }, + "parent_space_id": { + "description": "The database identifier (ID) of an existing space you want to set as the VLSM parent of the space you are editing. This sets up a space-based VLSM organization.", + "type": "integer" + }, + "parent_space_name": { + "description": "The name of an existing space you want to set as the VLSM parent of the space you are editing. This sets up a space-based VLSM organization.", + "type": "string" + }, + "space_description": { + "description": "The description of the space.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "space_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "space_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "space_id": { + "description": "The database identifier (ID) of the space, a unique numeric key value automatically incremented when you add a space. Use the ID to specify the space of your choice.", + "type": "integer" + }, + "space_name": { + "description": "The name of the space, each space must have a unique name.", + "type": "string" + }, + "parent_space_id": { + "description": "The database identifier (ID) of an existing space you want to set as the VLSM parent of the space you are editing. This sets up a space-based VLSM organization.", + "type": "integer" + }, + "parent_space_name": { + "description": "The name of an existing space you want to set as the VLSM parent of the space you are editing. This sets up a space-based VLSM organization.", + "type": "string" + }, + "space_description": { + "description": "The description of the space.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "space_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "space_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "bb9c1fb7-309d-4e6b-87d9-1ed26472b546", + "created": "2026-08-25T15:04:03.712Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 136, + "reference": "e2f588d0-3283-4d2e-b20b-8af5ae39acc1", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "Get IPAM Space", + "description": "Get IPAM Space", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_space_info", + "canvasName": "ipam_space_info", + "summary": "ipam_space_info", + "description": "ipam_space_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "no_parent_class_param": "$var.job.no_parent_class_param", + "space_id": "$var.job.space_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "space_id": { + "type": "integer" + } + }, + "required": [ + "no_parent_class_param", + "space_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "space_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "bb85cf94-97da-4ce4-b286-f498041632f7", + "created": "2026-08-25T15:04:03.739Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 137, + "reference": "308786de-1e90-4920-be92-2afd6f5325fb", + "type": "workflow", + "folder": "/IPAM", + "document": { + "name": "List IPAM Spaces", + "description": "List IPAM Spaces", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "ipam_space_list", + "canvasName": "ipam_space_list", + "summary": "ipam_space_list", + "description": "ipam_space_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset", + "no_parent_class_param": "$var.job.no_parent_class_param", + "tags": "$var.job.tags" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset", + "no_parent_class_param", + "tags" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "bdf85301-bfba-40f6-ab8d-746edc87c841", + "created": "2026-08-25T15:04:03.769Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 138, + "reference": "e621a90d-bc42-4b77-aaa5-be059ca6527d", + "type": "workflow", + "folder": "/VLAN", + "document": { + "name": "Create VLAN Domain", + "description": "Create VLAN Domain", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "vlan_domain_add", + "canvasName": "vlan_domain_add", + "summary": "vlan_domain_add", + "description": "vlan_domain_add", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "domain_name": { + "description": "The name of the VLAN domain, each VLAN domain must have a unique name.", + "type": "string" + }, + "domain_support_vxlan": { + "description": "The type of virtual network used by the domain. Set it to 1 to use VXLAN or 0 to use VLAN.", + "type": "integer" + }, + "domain_description": { + "description": "The description of the VLAN domain.", + "type": "string" + }, + "domain_end_vlan_id": { + "description": "The VLAN identifier (ID) of a VLAN, a numeric value between 1 and 4094. Use the ID to specify the last VLAN in the VLAN domain.", + "type": "integer" + }, + "domain_start_vlan_id": { + "description": "The VLAN identifier (ID) of a VLAN, a numeric value between 1 and 4094. Use the ID to specify the first VLAN in the VLAN domain.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "domain_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "domain_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "domain_name": { + "description": "The name of the VLAN domain, each VLAN domain must have a unique name.", + "type": "string" + }, + "domain_support_vxlan": { + "description": "The type of virtual network used by the domain. Set it to 1 to use VXLAN or 0 to use VLAN.", + "type": "integer" + }, + "domain_description": { + "description": "The description of the VLAN domain.", + "type": "string" + }, + "domain_end_vlan_id": { + "description": "The VLAN identifier (ID) of a VLAN, a numeric value between 1 and 4094. Use the ID to specify the last VLAN in the VLAN domain.", + "type": "integer" + }, + "domain_start_vlan_id": { + "description": "The VLAN identifier (ID) of a VLAN, a numeric value between 1 and 4094. Use the ID to specify the first VLAN in the VLAN domain.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "domain_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "domain_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "ec2dc302-ce44-467f-a481-ead1981c3c11", + "created": "2026-08-25T15:04:03.796Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 139, + "reference": "4725ed1d-e765-4156-8418-aac8bea7ca8f", + "type": "workflow", + "folder": "/VLAN", + "document": { + "name": "Delete VLAN Domain", + "description": "Delete VLAN Domain", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "vlan_domain_delete", + "canvasName": "vlan_domain_delete", + "summary": "vlan_domain_delete", + "description": "vlan_domain_delete", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "domain_id": "$var.job.domain_id", + "domain_name": "$var.job.domain_name", + "warnings": "$var.job.warnings" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "domain_id": { + "type": "integer" + }, + "domain_name": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + } + }, + "required": [ + "domain_id", + "domain_name", + "warnings" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "domain_id": { + "type": "integer" + }, + "domain_name": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "149f88db-ca8e-4870-801d-38eedda45f38", + "created": "2026-08-25T15:04:03.830Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 140, + "reference": "4671d7a3-e0c2-43d0-aa46-7aef70c3d14b", + "type": "workflow", + "folder": "/VLAN", + "document": { + "name": "Update VLAN Domain", + "description": "Update VLAN Domain", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "vlan_domain_edit", + "canvasName": "vlan_domain_edit", + "summary": "vlan_domain_edit", + "description": "vlan_domain_edit", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "domain_id": { + "description": "The database identifier (ID) of the VLAN domain, a unique numeric key value automatically incremented when you add a VLAN domain. Use the ID to specify the VLAN domain of your choice.", + "type": "integer" + }, + "domain_name": { + "description": "The name of the VLAN domain, each VLAN domain must have a unique name.", + "type": "string" + }, + "domain_support_vxlan": { + "description": "The type of virtual network used by the domain. Set it to 1 to use VXLAN or 0 to use VLAN.", + "type": "integer" + }, + "domain_description": { + "description": "The description of the VLAN domain.", + "type": "string" + }, + "domain_end_vlan_id": { + "description": "The VLAN identifier (ID) of a VLAN, a numeric value between 1 and 4094. Use the ID to specify the last VLAN in the VLAN domain.", + "type": "integer" + }, + "domain_start_vlan_id": { + "description": "The VLAN identifier (ID) of a VLAN, a numeric value between 1 and 4094. Use the ID to specify the first VLAN in the VLAN domain.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "domain_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "domain_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "domain_id": { + "description": "The database identifier (ID) of the VLAN domain, a unique numeric key value automatically incremented when you add a VLAN domain. Use the ID to specify the VLAN domain of your choice.", + "type": "integer" + }, + "domain_name": { + "description": "The name of the VLAN domain, each VLAN domain must have a unique name.", + "type": "string" + }, + "domain_support_vxlan": { + "description": "The type of virtual network used by the domain. Set it to 1 to use VXLAN or 0 to use VLAN.", + "type": "integer" + }, + "domain_description": { + "description": "The description of the VLAN domain.", + "type": "string" + }, + "domain_end_vlan_id": { + "description": "The VLAN identifier (ID) of a VLAN, a numeric value between 1 and 4094. Use the ID to specify the last VLAN in the VLAN domain.", + "type": "integer" + }, + "domain_start_vlan_id": { + "description": "The VLAN identifier (ID) of a VLAN, a numeric value between 1 and 4094. Use the ID to specify the first VLAN in the VLAN domain.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "domain_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "domain_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "cba04ac3-1af2-4e5c-bded-2a2b318f7350", + "created": "2026-08-25T15:04:03.862Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 141, + "reference": "48015658-38ff-4e92-9b4b-99575e7ba4d0", + "type": "workflow", + "folder": "/VLAN", + "document": { + "name": "Get VLAN Domain", + "description": "Get VLAN Domain", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "vlan_domain_info", + "canvasName": "vlan_domain_info", + "summary": "vlan_domain_info", + "description": "vlan_domain_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "domain_id": "$var.job.domain_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "domain_id": { + "type": "integer" + } + }, + "required": [ + "domain_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "domain_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "b3460b2b-f2fe-49fd-8535-0c6b445846bd", + "created": "2026-08-25T15:04:03.900Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 142, + "reference": "2b32e25e-55d5-4f2f-954c-f0f6746201f3", + "type": "workflow", + "folder": "/VLAN", + "document": { + "name": "List VLAN Domains", + "description": "List VLAN Domains", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "vlan_domain_list", + "canvasName": "vlan_domain_list", + "summary": "vlan_domain_list", + "description": "vlan_domain_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset", + "tags": "$var.job.tags" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "tags": { + "type": "string" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset", + "tags" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "tags": { + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "891c33dd-ebd3-43c6-aff6-49fcb9bfe0f6", + "created": "2026-08-25T15:04:03.936Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 143, + "reference": "f97d125d-be43-48cc-891f-f5cfce8b0d0d", + "type": "workflow", + "folder": "/VLAN", + "document": { + "name": "EfficientIP Create VLAN Range", + "description": "EfficientIP Create VLAN Range", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "vlan_range_add", + "canvasName": "vlan_range_add", + "summary": "vlan_range_add", + "description": "vlan_range_add", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "domain_id": { + "description": "The database identifier (ID) of the VLAN domain, a unique numeric key value automatically incremented when you add a VLAN domain. Use the ID to specify the VLAN domain of your choice.", + "type": "integer" + }, + "domain_name": { + "description": "The name of the VLAN domain.", + "type": "string" + }, + "range_name": { + "description": "The name of the VLAN range, each VLAN range must have a unique name.", + "type": "string" + }, + "range_description": { + "description": "The description of the VLAN range.", + "type": "string" + }, + "range_disable_overlapping": { + "description": "The overlapping restriction status of the VLAN range. Set it to 1 to prevent VLAN ID overlapping in the range.", + "type": "integer" + }, + "range_end_vlan_id": { + "description": "The VLAN identifier (ID) of an existing VLAN you want to set as the last VLAN in the VLAN range.", + "type": "integer" + }, + "range_start_vlan_id": { + "description": "The VLAN identifier (ID) of an existing VLAN you want to set as the first VLAN in the VLAN range.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "range_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "range_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "domain_id": { + "description": "The database identifier (ID) of the VLAN domain, a unique numeric key value automatically incremented when you add a VLAN domain. Use the ID to specify the VLAN domain of your choice.", + "type": "integer" + }, + "domain_name": { + "description": "The name of the VLAN domain.", + "type": "string" + }, + "range_name": { + "description": "The name of the VLAN range, each VLAN range must have a unique name.", + "type": "string" + }, + "range_description": { + "description": "The description of the VLAN range.", + "type": "string" + }, + "range_disable_overlapping": { + "description": "The overlapping restriction status of the VLAN range. Set it to 1 to prevent VLAN ID overlapping in the range.", + "type": "integer" + }, + "range_end_vlan_id": { + "description": "The VLAN identifier (ID) of an existing VLAN you want to set as the last VLAN in the VLAN range.", + "type": "integer" + }, + "range_start_vlan_id": { + "description": "The VLAN identifier (ID) of an existing VLAN you want to set as the first VLAN in the VLAN range.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "range_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "range_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "6d64aebe-f7c9-4e33-bce8-58101afacdec", + "created": "2026-08-25T15:04:03.965Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 144, + "reference": "6a26e91d-1596-4647-8763-c389c2f419bc", + "type": "workflow", + "folder": "/VLAN", + "document": { + "name": "EfficientIP Delete VLAN Range", + "description": "EfficientIP Delete VLAN Range", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "vlan_range_delete", + "canvasName": "vlan_range_delete", + "summary": "vlan_range_delete", + "description": "vlan_range_delete", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "domain_id": "$var.job.domain_id", + "domain_name": "$var.job.domain_name", + "range_id": "$var.job.range_id", + "range_name": "$var.job.range_name", + "warnings": "$var.job.warnings" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "domain_id": { + "type": "integer" + }, + "domain_name": { + "type": "string" + }, + "range_id": { + "type": "integer" + }, + "range_name": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + } + }, + "required": [ + "domain_id", + "domain_name", + "range_id", + "range_name", + "warnings" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "domain_id": { + "type": "integer" + }, + "domain_name": { + "type": "string" + }, + "range_id": { + "type": "integer" + }, + "range_name": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "214bc07e-155f-4345-ab9c-d1ea8bfddb82", + "created": "2026-08-25T15:04:03.996Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 145, + "reference": "09e32708-2a6b-4156-a144-b0bc0cb2c6ee", + "type": "workflow", + "folder": "/VLAN", + "document": { + "name": "EfficientIP Update VLAN Range", + "description": "EfficientIP Update VLAN Range", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "vlan_range_edit", + "canvasName": "vlan_range_edit", + "summary": "vlan_range_edit", + "description": "vlan_range_edit", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "domain_id": { + "description": "The database identifier (ID) of the VLAN domain, a unique numeric key value automatically incremented when you add a VLAN domain. Use the ID to specify the VLAN domain of your choice.", + "type": "integer" + }, + "domain_name": { + "description": "The name of the VLAN domain.", + "type": "string" + }, + "range_id": { + "description": "The database identifier (ID) of the VLAN range, a unique numeric key value automatically incremented when you add a VLAN range. Use the ID to specify the VLAN range of your choice.", + "type": "integer" + }, + "range_name": { + "description": "The name of the VLAN range, each VLAN range must have a unique name.", + "type": "string" + }, + "range_description": { + "description": "The description of the VLAN range.", + "type": "string" + }, + "range_disable_overlapping": { + "description": "The overlapping restriction status of the VLAN range. Set it to 1 to prevent VLAN ID overlapping in the range.", + "type": "integer" + }, + "range_end_vlan_id": { + "description": "The VLAN identifier (ID) of an existing VLAN you want to set as the last VLAN in the VLAN range.", + "type": "integer" + }, + "range_start_vlan_id": { + "description": "The VLAN identifier (ID) of an existing VLAN you want to set as the first VLAN in the VLAN range.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "range_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "range_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "domain_id": { + "description": "The database identifier (ID) of the VLAN domain, a unique numeric key value automatically incremented when you add a VLAN domain. Use the ID to specify the VLAN domain of your choice.", + "type": "integer" + }, + "domain_name": { + "description": "The name of the VLAN domain.", + "type": "string" + }, + "range_id": { + "description": "The database identifier (ID) of the VLAN range, a unique numeric key value automatically incremented when you add a VLAN range. Use the ID to specify the VLAN range of your choice.", + "type": "integer" + }, + "range_name": { + "description": "The name of the VLAN range, each VLAN range must have a unique name.", + "type": "string" + }, + "range_description": { + "description": "The description of the VLAN range.", + "type": "string" + }, + "range_disable_overlapping": { + "description": "The overlapping restriction status of the VLAN range. Set it to 1 to prevent VLAN ID overlapping in the range.", + "type": "integer" + }, + "range_end_vlan_id": { + "description": "The VLAN identifier (ID) of an existing VLAN you want to set as the last VLAN in the VLAN range.", + "type": "integer" + }, + "range_start_vlan_id": { + "description": "The VLAN identifier (ID) of an existing VLAN you want to set as the first VLAN in the VLAN range.", + "type": "integer" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "range_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "range_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "53639e74-ecda-485e-8675-d90e015116db", + "created": "2026-08-25T15:04:04.027Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 146, + "reference": "70c838e9-22e1-47c5-8739-13b8002e01ca", + "type": "workflow", + "folder": "/VLAN", + "document": { + "name": "EfficientIP Get VLAN Range", + "description": "EfficientIP Get VLAN Range", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "vlan_range_info", + "canvasName": "vlan_range_info", + "summary": "vlan_range_info", + "description": "vlan_range_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "no_parent_class_param": "$var.job.no_parent_class_param", + "range_id": "$var.job.range_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "range_id": { + "type": "integer" + } + }, + "required": [ + "no_parent_class_param", + "range_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "range_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "7e2ebbdb-5a6a-4878-a729-2d39aa5896e3", + "created": "2026-08-25T15:04:04.056Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 147, + "reference": "5b029678-55d8-4873-93d3-f910dfc9a504", + "type": "workflow", + "folder": "/VLAN", + "document": { + "name": "EfficientIP List VLAN Ranges", + "description": "EfficientIP List VLAN Ranges", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "vlan_range_list", + "canvasName": "vlan_range_list", + "summary": "vlan_range_list", + "description": "vlan_range_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset", + "no_parent_class_param": "$var.job.no_parent_class_param", + "tags": "$var.job.tags" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset", + "no_parent_class_param", + "tags" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "a5c2d7a9-e4cb-4959-a980-a11b51dfa58d", + "created": "2026-08-25T15:04:04.084Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 148, + "reference": "9ca0b1a1-80a9-43dd-b1b7-31061fd62340", + "type": "workflow", + "folder": "/VLAN", + "document": { + "name": "Create VLAN VLAN", + "description": "Create VLAN VLAN", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "vlan_vlan_add", + "canvasName": "vlan_vlan_add", + "summary": "vlan_vlan_add", + "description": "vlan_vlan_add", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "domain_id": { + "description": "The database identifier (ID) of the VLAN domain, a unique numeric key value automatically incremented when you add a VLAN domain. Use the ID to specify the VLAN domain of your choice.", + "type": "integer" + }, + "domain_name": { + "description": "The name of the VLAN domain.", + "type": "string" + }, + "vlan_vlan_id": { + "description": "The VLAN identifier (ID) of the VLAN, a unique numeric key value within a VLAN domain. Use the ID to specify the VLAN of your choice.", + "type": "integer" + }, + "range_id": { + "description": "The database identifier (ID) of the VLAN range, a unique numeric key value automatically incremented when you add a VLAN range. Use the ID to specify the VLAN range of your choice.", + "type": "integer" + }, + "range_name": { + "description": "The name of the VLAN range.", + "type": "string" + }, + "vlan_name": { + "description": "The name of the VLAN, each VLAN must have a unique name.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "vlan_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "vlan_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "domain_id": { + "description": "The database identifier (ID) of the VLAN domain, a unique numeric key value automatically incremented when you add a VLAN domain. Use the ID to specify the VLAN domain of your choice.", + "type": "integer" + }, + "domain_name": { + "description": "The name of the VLAN domain.", + "type": "string" + }, + "vlan_vlan_id": { + "description": "The VLAN identifier (ID) of the VLAN, a unique numeric key value within a VLAN domain. Use the ID to specify the VLAN of your choice.", + "type": "integer" + }, + "range_id": { + "description": "The database identifier (ID) of the VLAN range, a unique numeric key value automatically incremented when you add a VLAN range. Use the ID to specify the VLAN range of your choice.", + "type": "integer" + }, + "range_name": { + "description": "The name of the VLAN range.", + "type": "string" + }, + "vlan_name": { + "description": "The name of the VLAN, each VLAN must have a unique name.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "vlan_class_name": { + "description": "The name of the class to apply to the object you are adding. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "vlan_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "89f61fdd-f458-4bfa-89ba-4296d8d77236", + "created": "2026-08-25T15:04:04.117Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 149, + "reference": "f070e49a-a6ea-4275-ae81-e30d1abc701b", + "type": "workflow", + "folder": "/VLAN", + "document": { + "name": "Delete VLAN VLAN", + "description": "Delete VLAN VLAN", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "vlan_vlan_delete", + "canvasName": "vlan_vlan_delete", + "summary": "vlan_vlan_delete", + "description": "vlan_vlan_delete", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "domain_id": "$var.job.domain_id", + "domain_name": "$var.job.domain_name", + "vlan_id": "$var.job.vlan_id", + "vlan_vlan_id": "$var.job.vlan_vlan_id", + "range_id": "$var.job.range_id", + "range_name": "$var.job.range_name", + "vlan_name": "$var.job.vlan_name", + "warnings": "$var.job.warnings" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "domain_id": { + "type": "integer" + }, + "domain_name": { + "type": "string" + }, + "vlan_id": { + "type": "integer" + }, + "vlan_vlan_id": { + "type": "integer" + }, + "range_id": { + "type": "integer" + }, + "range_name": { + "type": "string" + }, + "vlan_name": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + } + }, + "required": [ + "domain_id", + "domain_name", + "vlan_id", + "vlan_vlan_id", + "range_id", + "range_name", + "vlan_name", + "warnings" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "domain_id": { + "type": "integer" + }, + "domain_name": { + "type": "string" + }, + "vlan_id": { + "type": "integer" + }, + "vlan_vlan_id": { + "type": "integer" + }, + "range_id": { + "type": "integer" + }, + "range_name": { + "type": "string" + }, + "vlan_name": { + "type": "string" + }, + "warnings": { + "enum": [ + "accept" + ], + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "da071151-1a68-42e2-aec4-0362db29d06e", + "created": "2026-08-25T15:04:04.147Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 150, + "reference": "be2cff86-866c-46f4-bce6-f6d027930390", + "type": "workflow", + "folder": "/VLAN", + "document": { + "name": "Update VLAN VLAN", + "description": "Update VLAN VLAN", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "vlan_vlan_edit", + "canvasName": "vlan_vlan_edit", + "summary": "vlan_vlan_edit", + "description": "vlan_vlan_edit", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "bodyContentType": "application/json", + "requestBodyPayload": "$var.job.spec" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "domain_id": { + "description": "The database identifier (ID) of the VLAN domain, a unique numeric key value automatically incremented when you add a VLAN domain. Use the ID to specify the VLAN domain of your choice.", + "type": "integer" + }, + "domain_name": { + "description": "The name of the VLAN domain.", + "type": "string" + }, + "vlan_id": { + "description": "The database identifier (ID) of the VLAN, a unique numeric key value automatically incremented when you add a VLAN. Use the ID to specify the VLAN of your choice.", + "type": "integer" + }, + "vlan_vlan_id": { + "description": "The VLAN identifier (ID) of the VLAN, a unique numeric key value within a VLAN domain. Use the ID to specify the VLAN of your choice.", + "type": "integer" + }, + "range_id": { + "description": "The database identifier (ID) of the VLAN range, a unique numeric key value automatically incremented when you add a VLAN range. Use the ID to specify the VLAN range of your choice.", + "type": "integer" + }, + "range_name": { + "description": "The name of the VLAN range.", + "type": "string" + }, + "vlan_name": { + "description": "The name of the VLAN, each VLAN must have a unique name.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "vlan_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "vlan_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + } + }, + "required": [ + "spec" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "spec": { + "properties": { + "domain_id": { + "description": "The database identifier (ID) of the VLAN domain, a unique numeric key value automatically incremented when you add a VLAN domain. Use the ID to specify the VLAN domain of your choice.", + "type": "integer" + }, + "domain_name": { + "description": "The name of the VLAN domain.", + "type": "string" + }, + "vlan_id": { + "description": "The database identifier (ID) of the VLAN, a unique numeric key value automatically incremented when you add a VLAN. Use the ID to specify the VLAN of your choice.", + "type": "integer" + }, + "vlan_vlan_id": { + "description": "The VLAN identifier (ID) of the VLAN, a unique numeric key value within a VLAN domain. Use the ID to specify the VLAN of your choice.", + "type": "integer" + }, + "range_id": { + "description": "The database identifier (ID) of the VLAN range, a unique numeric key value automatically incremented when you add a VLAN range. Use the ID to specify the VLAN range of your choice.", + "type": "integer" + }, + "range_name": { + "description": "The name of the VLAN range.", + "type": "string" + }, + "vlan_name": { + "description": "The name of the VLAN, each VLAN must have a unique name.", + "type": "string" + }, + "class_parameters_to_delete": { + "description": "class parameters you want to delete from the object", + "items": { + "type": "string" + }, + "type": "array" + }, + "vlan_class_name": { + "description": "The name of the class to apply to the object you are editing. You must specify the class file directory, e.g. my_directory/my_class.class . You cannot use the classes global and default, they are reserved by the system.", + "type": "string" + }, + "vlan_class_parameters": { + "description": "class parameters in json format", + "items": { + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + }, + "inheritance": { + "enum": [ + "set", + "inherited" + ], + "type": "string" + }, + "propagation": { + "enum": [ + "propagate", + "restrict" + ], + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "warnings": { + "description": "A way to bypass (accept) any enabled rule that would return warning messages. If the service returns an error message, you cannot bypass the enabled rules.", + "enum": [ + "accept" + ], + "type": "string" + } + }, + "type": "object" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "ed2b609e-df05-4c7f-bd4a-0b4e9cd6e737", + "created": "2026-08-25T15:04:04.178Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 151, + "reference": "658ee844-fdde-4195-b153-3c9fd04cf36a", + "type": "workflow", + "folder": "/VLAN", + "document": { + "name": "Get VLAN VLAN", + "description": "Get VLAN VLAN", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "vlan_vlan_info", + "canvasName": "vlan_vlan_info", + "summary": "vlan_vlan_info", + "description": "vlan_vlan_info", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "no_parent_class_param": "$var.job.no_parent_class_param", + "vlan_id": "$var.job.vlan_id" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "vlan_id": { + "type": "integer" + } + }, + "required": [ + "no_parent_class_param", + "vlan_id" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "no_parent_class_param": { + "type": "integer" + }, + "vlan_id": { + "type": "integer" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "68c5a89c-2878-4cca-b77b-6bf00efa406b", + "created": "2026-08-25T15:04:04.213Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + }, + { + "iid": 152, + "reference": "ea5afc02-d444-4f9a-8861-d01f44b56be9", + "type": "workflow", + "folder": "/VLAN", + "document": { + "name": "List VLAN VLANs", + "description": "List VLAN VLANs", + "type": "automation", + "font_size": 12, + "tasks": { + "workflow_start": { + "name": "workflow_start", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 0 + } + }, + "a1a1": { + "name": "vlan_vlan_list", + "canvasName": "vlan_vlan_list", + "summary": "vlan_vlan_list", + "description": "vlan_vlan_list", + "location": "Adapter", + "locationType": "EfficientIP SOLIDserver:latest", + "app": "EfficientIP SOLIDserver:latest", + "type": "automatic", + "displayName": "EfficientIP SOLIDserver", + "variables": { + "incoming": { + "adapter_id": "EfficientIP SOLIDserver", + "orderby": "$var.job.orderby", + "select": "$var.job.select", + "where": "$var.job.where", + "limit": "$var.job.limit", + "offset": "$var.job.offset", + "no_parent_class_param": "$var.job.no_parent_class_param", + "tags": "$var.job.tags" + }, + "outgoing": { + "response": null + }, + "error": "", + "decorators": [] + }, + "groups": [], + "actor": "Pronghorn", + "scheduled": false, + "nodeLocation": { + "x": 264, + "y": 150 + } + }, + "workflow_end": { + "name": "workflow_end", + "groups": [], + "nodeLocation": { + "x": 264, + "y": 300 + } + } + }, + "transitions": { + "workflow_start": { + "a1a1": { + "type": "standard", + "state": "success" + } + }, + "a1a1": { + "workflow_end": { + "type": "standard", + "state": "success" + } + }, + "workflow_end": {} + }, + "inputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + } + }, + "required": [ + "orderby", + "select", + "where", + "limit", + "offset", + "no_parent_class_param", + "tags" + ] + }, + "outputSchema": { + "type": "object", + "properties": { + "orderby": { + "type": "string" + }, + "select": { + "type": "string" + }, + "where": { + "type": "string" + }, + "limit": { + "type": "integer" + }, + "offset": { + "type": "integer" + }, + "no_parent_class_param": { + "type": "integer" + }, + "tags": { + "type": "string" + }, + "_id": { + "type": "string", + "pattern": "^[0-9a-f]{24}$" + }, + "initiator": { + "type": "string" + } + } + }, + "last_updated": "2026-08-25T15:04:38.451Z", + "last_updated_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "lastUpdatedVersion": "4.69.69", + "uuid": "272d6117-0310-49db-b55f-13e8d37bff6a", + "created": "2026-08-25T15:04:04.246Z", + "created_by": { + "provenance": "LDAP", + "username": "admin@itential", + "firstname": "admin@itential", + "inactive": false + }, + "createdVersion": "5.55.5", + "scenarios": [], + "canvasVersion": 3, + "tags": [], + "groups": [], + "migrationVersion": 8 + } + } + ], + "folders": [ + { + "nodeType": "folder", + "name": "DHCP", + "children": [ + { + "iid": 0, + "nodeType": "component" + }, + { + "iid": 1, + "nodeType": "component" + }, + { + "iid": 2, + "nodeType": "component" + }, + { + "iid": 3, + "nodeType": "component" + }, + { + "iid": 4, + "nodeType": "component" + }, + { + "iid": 5, + "nodeType": "component" + }, + { + "iid": 6, + "nodeType": "component" + }, + { + "iid": 7, + "nodeType": "component" + }, + { + "iid": 8, + "nodeType": "component" + }, + { + "iid": 9, + "nodeType": "component" + }, + { + "iid": 10, + "nodeType": "component" + }, + { + "iid": 11, + "nodeType": "component" + }, + { + "iid": 12, + "nodeType": "component" + }, + { + "iid": 13, + "nodeType": "component" + }, + { + "iid": 14, + "nodeType": "component" + }, + { + "iid": 15, + "nodeType": "component" + }, + { + "iid": 16, + "nodeType": "component" + }, + { + "iid": 17, + "nodeType": "component" + }, + { + "iid": 18, + "nodeType": "component" + }, + { + "iid": 19, + "nodeType": "component" + }, + { + "iid": 20, + "nodeType": "component" + }, + { + "iid": 21, + "nodeType": "component" + }, + { + "iid": 22, + "nodeType": "component" + }, + { + "iid": 23, + "nodeType": "component" + }, + { + "iid": 24, + "nodeType": "component" + }, + { + "iid": 25, + "nodeType": "component" + }, + { + "iid": 26, + "nodeType": "component" + }, + { + "iid": 27, + "nodeType": "component" + }, + { + "iid": 28, + "nodeType": "component" + }, + { + "iid": 29, + "nodeType": "component" + }, + { + "iid": 30, + "nodeType": "component" + }, + { + "iid": 31, + "nodeType": "component" + }, + { + "iid": 32, + "nodeType": "component" + }, + { + "iid": 33, + "nodeType": "component" + }, + { + "iid": 34, + "nodeType": "component" + }, + { + "iid": 35, + "nodeType": "component" + }, + { + "iid": 36, + "nodeType": "component" + }, + { + "iid": 37, + "nodeType": "component" + }, + { + "iid": 38, + "nodeType": "component" + }, + { + "iid": 39, + "nodeType": "component" + }, + { + "iid": 40, + "nodeType": "component" + }, + { + "iid": 41, + "nodeType": "component" + }, + { + "iid": 42, + "nodeType": "component" + }, + { + "iid": 43, + "nodeType": "component" + }, + { + "iid": 44, + "nodeType": "component" + }, + { + "iid": 45, + "nodeType": "component" + }, + { + "iid": 46, + "nodeType": "component" + }, + { + "iid": 47, + "nodeType": "component" + }, + { + "iid": 48, + "nodeType": "component" + }, + { + "iid": 49, + "nodeType": "component" + }, + { + "iid": 50, + "nodeType": "component" + }, + { + "iid": 51, + "nodeType": "component" + }, + { + "iid": 52, + "nodeType": "component" + }, + { + "iid": 53, + "nodeType": "component" + }, + { + "iid": 54, + "nodeType": "component" + }, + { + "iid": 55, + "nodeType": "component" + }, + { + "iid": 56, + "nodeType": "component" + }, + { + "iid": 57, + "nodeType": "component" + }, + { + "iid": 58, + "nodeType": "component" + }, + { + "iid": 59, + "nodeType": "component" + }, + { + "iid": 60, + "nodeType": "component" + }, + { + "iid": 61, + "nodeType": "component" + }, + { + "iid": 62, + "nodeType": "component" + } + ] + }, + { + "nodeType": "folder", + "name": "DNS", + "children": [ + { + "iid": 63, + "nodeType": "component" + }, + { + "iid": 64, + "nodeType": "component" + }, + { + "iid": 65, + "nodeType": "component" + }, + { + "iid": 66, + "nodeType": "component" + }, + { + "iid": 67, + "nodeType": "component" + }, + { + "iid": 68, + "nodeType": "component" + }, + { + "iid": 69, + "nodeType": "component" + }, + { + "iid": 70, + "nodeType": "component" + }, + { + "iid": 71, + "nodeType": "component" + }, + { + "iid": 72, + "nodeType": "component" + }, + { + "iid": 73, + "nodeType": "component" + }, + { + "iid": 74, + "nodeType": "component" + }, + { + "iid": 75, + "nodeType": "component" + }, + { + "iid": 76, + "nodeType": "component" + }, + { + "iid": 77, + "nodeType": "component" + }, + { + "iid": 78, + "nodeType": "component" + }, + { + "iid": 79, + "nodeType": "component" + }, + { + "iid": 80, + "nodeType": "component" + }, + { + "iid": 81, + "nodeType": "component" + }, + { + "iid": 82, + "nodeType": "component" + }, + { + "iid": 83, + "nodeType": "component" + }, + { + "iid": 84, + "nodeType": "component" + }, + { + "iid": 85, + "nodeType": "component" + }, + { + "iid": 86, + "nodeType": "component" + }, + { + "iid": 87, + "nodeType": "component" + }, + { + "iid": 88, + "nodeType": "component" + }, + { + "iid": 89, + "nodeType": "component" + }, + { + "iid": 90, + "nodeType": "component" + }, + { + "iid": 91, + "nodeType": "component" + }, + { + "iid": 92, + "nodeType": "component" + }, + { + "iid": 93, + "nodeType": "component" + }, + { + "iid": 94, + "nodeType": "component" + } + ] + }, + { + "nodeType": "folder", + "name": "IPAM", + "children": [ + { + "iid": 95, + "nodeType": "component" + }, + { + "iid": 96, + "nodeType": "component" + }, + { + "iid": 97, + "nodeType": "component" + }, + { + "iid": 98, + "nodeType": "component" + }, + { + "iid": 99, + "nodeType": "component" + }, + { + "iid": 100, + "nodeType": "component" + }, + { + "iid": 101, + "nodeType": "component" + }, + { + "iid": 102, + "nodeType": "component" + }, + { + "iid": 103, + "nodeType": "component" + }, + { + "iid": 104, + "nodeType": "component" + }, + { + "iid": 105, + "nodeType": "component" + }, + { + "iid": 106, + "nodeType": "component" + }, + { + "iid": 107, + "nodeType": "component" + }, + { + "iid": 108, + "nodeType": "component" + }, + { + "iid": 109, + "nodeType": "component" + }, + { + "iid": 110, + "nodeType": "component" + }, + { + "iid": 111, + "nodeType": "component" + }, + { + "iid": 112, + "nodeType": "component" + }, + { + "iid": 113, + "nodeType": "component" + }, + { + "iid": 114, + "nodeType": "component" + }, + { + "iid": 115, + "nodeType": "component" + }, + { + "iid": 116, + "nodeType": "component" + }, + { + "iid": 117, + "nodeType": "component" + }, + { + "iid": 118, + "nodeType": "component" + }, + { + "iid": 119, + "nodeType": "component" + }, + { + "iid": 120, + "nodeType": "component" + }, + { + "iid": 121, + "nodeType": "component" + }, + { + "iid": 122, + "nodeType": "component" + }, + { + "iid": 123, + "nodeType": "component" + }, + { + "iid": 124, + "nodeType": "component" + }, + { + "iid": 125, + "nodeType": "component" + }, + { + "iid": 126, + "nodeType": "component" + }, + { + "iid": 127, + "nodeType": "component" + }, + { + "iid": 128, + "nodeType": "component" + }, + { + "iid": 129, + "nodeType": "component" + }, + { + "iid": 130, + "nodeType": "component" + }, + { + "iid": 131, + "nodeType": "component" + }, + { + "iid": 132, + "nodeType": "component" + }, + { + "iid": 133, + "nodeType": "component" + }, + { + "iid": 134, + "nodeType": "component" + }, + { + "iid": 135, + "nodeType": "component" + }, + { + "iid": 136, + "nodeType": "component" + }, + { + "iid": 137, + "nodeType": "component" + } + ] + }, + { + "nodeType": "folder", + "name": "VLAN", + "children": [ + { + "iid": 138, + "nodeType": "component" + }, + { + "iid": 139, + "nodeType": "component" + }, + { + "iid": 140, + "nodeType": "component" + }, + { + "iid": 141, + "nodeType": "component" + }, + { + "iid": 142, + "nodeType": "component" + }, + { + "iid": 143, + "nodeType": "component" + }, + { + "iid": 144, + "nodeType": "component" + }, + { + "iid": 145, + "nodeType": "component" + }, + { + "iid": 146, + "nodeType": "component" + }, + { + "iid": 147, + "nodeType": "component" + }, + { + "iid": 148, + "nodeType": "component" + }, + { + "iid": 149, + "nodeType": "component" + }, + { + "iid": 150, + "nodeType": "component" + }, + { + "iid": 151, + "nodeType": "component" + }, + { + "iid": 152, + "nodeType": "component" + } + ] + } + ], + "createdBy": { + "_id": "699f3e2b85569c9f5d8e1f38", + "provenance": "LDAP", + "username": "admin@itential" + }, + "lastUpdatedBy": { + "_id": "699f3e2b85569c9f5d8e1f38", + "provenance": "LDAP", + "username": "admin@itential" + }, + "created": "2026-08-25T15:04:35.996Z", + "lastUpdated": "2026-08-25T15:04:35.996Z", + "iid": 49, + "thumbnail": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAUoAAABkCAYAAADg+Hn3AAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAhGVYSWZNTQAqAAAACAAFARIAAwAAAAEAAQAAARoABQAAAAEAAABKARsABQAAAAEAAABSASgAAwAAAAEAAgAAh2kABAAAAAEAAABaAAAAAAAAAEgAAAABAAAASAAAAAEAA6ABAAMAAAABAAEAAKACAAQAAAABAAABSqADAAQAAAABAAAAZAAAAABcVM/PAAAACXBIWXMAAAsTAAALEwEAmpwYAAACymlUWHRYTUw6Y29tLmFkb2JlLnhtcAAAAAAAPHg6eG1wbWV0YSB4bWxuczp4PSJhZG9iZTpuczptZXRhLyIgeDp4bXB0az0iWE1QIENvcmUgNi4wLjAiPgogICA8cmRmOlJERiB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPgogICAgICA8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIgogICAgICAgICAgICB4bWxuczp0aWZmPSJodHRwOi8vbnMuYWRvYmUuY29tL3RpZmYvMS4wLyIKICAgICAgICAgICAgeG1sbnM6ZXhpZj0iaHR0cDovL25zLmFkb2JlLmNvbS9leGlmLzEuMC8iPgogICAgICAgICA8dGlmZjpZUmVzb2x1dGlvbj43MjwvdGlmZjpZUmVzb2x1dGlvbj4KICAgICAgICAgPHRpZmY6UmVzb2x1dGlvblVuaXQ+MjwvdGlmZjpSZXNvbHV0aW9uVW5pdD4KICAgICAgICAgPHRpZmY6WFJlc29sdXRpb24+NzI8L3RpZmY6WFJlc29sdXRpb24+CiAgICAgICAgIDx0aWZmOk9yaWVudGF0aW9uPjE8L3RpZmY6T3JpZW50YXRpb24+CiAgICAgICAgIDxleGlmOlBpeGVsWERpbWVuc2lvbj4zMzA8L2V4aWY6UGl4ZWxYRGltZW5zaW9uPgogICAgICAgICA8ZXhpZjpDb2xvclNwYWNlPjE8L2V4aWY6Q29sb3JTcGFjZT4KICAgICAgICAgPGV4aWY6UGl4ZWxZRGltZW5zaW9uPjEyMDwvZXhpZjpQaXhlbFlEaW1lbnNpb24+CiAgICAgIDwvcmRmOkRlc2NyaXB0aW9uPgogICA8L3JkZjpSREY+CjwveDp4bXBtZXRhPgpwIzk+AABAAElEQVR4AXT9C4IjObIsidan76LeSmbns5mZqnwiogYyss8ZBOkOmKmpfQAHnWRk5J9//v/+r//7jz///POPf3/99QedX/z8+ccff/3iifjPX3/8+vMPfv7893R//vnXr3+RaSRSPU/wSf4AB572L7I6d3wndVgwRKutpjwlq590lLP/42/1Q+1IqNoIz4z+fxQZNg3Np/93fiYv3sPUB1tmf5V1Afz5d4H+9Rcl+VM/f/6iEH/8+9cvRn9THBR/6VkpFgx//YGTv6WQ9G8jAPPXH3/+RV+Q4j8JEFE2+EAgIPvk6K10gL/AViAhSpwaf05uiPaVGiIRGgfx5lf2f4rFKQRDDjHbzeY4GyP7ZVoMVOdLf7MUbuC2JhTxFRPBv2M/vXG0eobO0txuKEPdVg99eXLpZI90YSL/jgsvO8E/yN5gutM4CPM9fGw/ukmGPBxpfVqle8H99PiwIn/wh8+acij/Dddg8scliOdgp3c0wQe7mE7vSRsuP+eL9eVFt/rHZwDTZ/d0iVvziVkiywweZiCnJ1sEXfK4Ca3LpqZxkcz+1sLz6dmGH5YgFq7HrsI5KDIP+C4RTnSNkY7LVs2iCSGIjvlsKZirMf2+LkK55Fx3mo+zDgf95WM4jkDz8+uPf+VLfkJ2LAFc2+oQWqdi8vwfHFgKdgAN2xO44jTwikHmxifcunrFWIRiYuiZQLo4fv1yAzU2FYj1/69w7RzTim0FtI5knXvjMkAv+IfurBmglywuuvDwk4tdvwb0x69/pKfLAgoz8szRwNDFr5OMoV9I7GzJQPxy8RkXIf+DvcnrqNcQ1Gz9rSkYuPzJrQ3PvCjYv3/9Zan+/vMfXLWJmR+SdgpY2br+Zcc35l8W2Ea/VULy/6Jnc21MX+7WsvBqbmB6AGNVmhhi2wtTBQdIKf754/8l1yYFzJXOOcZbNQhbFeDDSWLIIcUOSYURQO6G2MrB/l/tWxxGL9dsUGXTNZSZZdOKeuFWzx70Yc4QSV375AZgfhWfkl5hGJtNd68j0fGIHvfsPjzFBxvY8h1FDAWC1XN6dSpjYhqGY8W6Y8IX2kEM40oVqjLTK9J3CmMtMXr4MjlA+Ln88MlAWZs3hJcKwq3JP5l4Y34M1re1y8tl1Ni78uIwz0Ukj13iIBYCb2648bFG7Q+q1KfLSu/f8W6SIL/YgL7pNFwuFgjAi/Ms1Xmdb0ajS0d3NoxCm0SJYG8MDKJJufodUh5LX+Kn5vLA3gUZu7ow4wZsJ50H/RCnNbg6gUY9jFe/qhpXtPdK8BYORrsW3bFMwGpMx1UiqsC1qTxcLBLH1yZrVMC8qrylqnJeXecdtm5DEqDGTbvJP/hCJb3JSGHF/+7Oy7CTcgIXwhSYV/P4032MsUFwcqJsf+d2E8bdXiV3f/oLvKtZCy926d4G/M/ulb07ldiNA6S3khIj+mvL0I0yywvLRQP4b4L7B9Xf0mj06x8PuiPRv9Cp/Q/ZgbZuTvO//3rbR4fA5AT8d6U2LiCg3TYpx1++CHjjWhz//oPd3zKsiNg1P+TihFVmTEyvBN2yVqeS45UFp2ZJ7YlK58XEqLis0d/xO84rwUpmUDzsA/aCuL4XWq936g2D9qbLGTAsw9HvZqQBpbW2qrcMGij42dB9WwHoHbK3JOiaQDg1YjjzaE14RqrmNatuFr57cLnZOgryyaBYb/lNOdxNA/aWGlRXBH1JbHSaHLpXqcKR42FkqkzaKsfASTKccukOXTLGFLZYQBSB5GBJuKGcXTwPhBdrrza5AcrLD0cmgkG2npGo/csAnGuxTy4Q8V9/72rIBo67+tRBoDU4u/RdO5svvU+Omjp0K4SkjcDNKZsdtzg+eKmyZvq44BgYY7Yy6nEQjjwc90odozLgU2lqvOKUT7oYfCcosOpYeJgLBz45u9AR+37PC9X1LYv3kUavm7+oDD4MNxfaoKoOyFYAywpY98gSD+9+3KrVPnIdiHhX78G1R9qBcAvTpcUm6UU4tvy2GpWI8ZpsBW4JuYkgdfpcPfTc5Y0SOFIzrMir+ULBW+H4VnYuF5t9tr1VEJZiWpgJjcFCGZvtFoZuetvLuCKSP6ZgfRACE+ErEfec7OPLeTfCVpqN69f/8VMGHfJSNONfbtBhEcBraL/Amj7czduvv/7Ffmmj5M6ezS+f3dMtKjZkdJsmzjhy0Ht0Z7zp45641wNU2nu7anr1y5Gutjx+/UMn7f9JLawJUGZ8+VKq4DYCu80ZkrgRKNtBFArDMrDR20vvXfhvDZS2xil2Jk2P/kaL8Pz5CqfwNM4D9rP9919AqZ3+8/PSszZxU2L903eob+7qOKyM1s39pTWjbWCW6F+sCmD5wrCsDDYCwqPPTQXycem/ZS8vffEuIpcUk/XHv3+zteLMae5MqblqIUEtnOh4Z4QjeTOuPr94ywXQ0DeFvFAu9k7q9GF9xns5wI4JzRfWyU4UlQ5pucXW9xwaKDXHqWGtSO1D66YwryHe0ZcNHjOWx4XjXYZNhwKBaIfu8a9MIA6SDjvxGEARR1psDAbRwI1HrAce2elLT64G3f/HMlshAM4W8yUnwaLgzO5Th5c5E0C84tvnGXNXqP40VhpzemOXRuGJGYDNobhlkD/I2DYiAOxEus8LqgByMKzpV7U65bSpuPxNhQeRuGViiztP4jz4WJEQkBD67iaQlxtGLDxnQf6tDpC2EZJPdm42eSUb960y652wehl0acs5d5u/3J1MkM2St+FVXLVxEq93pIZQgF0tdLvdMQ7L2KF+MbCxodexMSXaPGFnCM6HXUgLdGLj2qcK2D15AgPRgNh3pi/DP/jhY1hbdWmTZCwMBtMb0+1G4HYnSSc+LUeboA3gPGMrerj5qK8nIKaWfsI7ykaTQpDYjx9iQXLzQI+WK1fdDQDcepgSH+q80Gvh6ElUo3Ob6UdYjQQMbJi39wBZ7MbNq2I5NEESSoVJ9YLDaPlYhufiFjCdjtUJnpsuLubCmmyznPX2U+PQVmzbb6aMEGNCwl10BWIcAj0Ka4dHELM0py6DbQIKfVmWx5D8iAu8S8hY8oG4KmtvQu4snBlqXavfgmEo5jQv7m0gzSb6ZTqcfW3OZLo4I0Le8jUq40Mzg2qiaDFpAbSs7St98aRK2CFPNxncUZZsmyNdNssikYo0Cbu50DNDt+Yrt+e+MSgzLxBafbpe7d5aiadUeii6IJZUPp5G/722ZuemsXeD1lw7weMXb4PhKmapp/vJp6jAzU7bHF1QyMgNM4ReoO1SnOWV/FFfH6HWi6DeGxh7s5Add0h9eaNZPDsWnnlw19Bm6gsOrw6xnr1wAmUjdcGJq56UyelQ6cK3w25luF7PvXA5J5LsswIw1jaXIGgwOxfytdyTLKGquxJzRwpQMT54fEqmxDmUyltffTdhdJpDbH79Pxi4jBCp157T8mbYrqAdjdC8Q1YPDFBHexMwTjflyR9m59VB1Y80sxpcopBeCngq9lPhvtayEiXQaC7GhlqEw14DhC03hQISRHPjwEiNfTbPqzL5Jz8bZUmGGkaJPDmY36vFrKZj3X7nRpGzrQsC1btxbgwTc8E8ZqLQleHnmgjz3qyaux8btWY46gxR4zlm2KarXCcLsYTi6o4vznG8WJbW8Ur1ai8JS1cGzWotC3pdlHEvDGOZpTGaDkNzwtgwz1wQre1eMV0Yb5NWo7DcHNDsZ5svsA0S5sd49AeOM8Gi58sc4+NoHItnd88CoxAIVIOlq12b5BxYsLx77MIsEO9CZmH+qRqbZAJnsrkpibrxYP34fKtgFFeZ70sGgGXrJgCmO885EZ8WI1eLOAnZY8ze3DGatSqsGTL2KqfFcj4ZZC6lubj5P4hc3wqhPmyEsswFUWgsNmqttvFZZmpkEVKBg+NtRr7ShOWrmYRUMX/sfGZgLfZKvpU+nS6WB9RExzJ3Y+uduTkZDSffufshAYhqourystQ9mO9Fjk5/TgWbZqGWOwYG2AuNedA4yWMe8TDWNGGKHDecWH3IcVmaH1qp/kd7fM/uVTV+XDsWYzPf9SbzdZGAvNstrsOkFIhd+A6L7QP5wVNhGK92gCFTZr1k+GxoG8apKtoitOfzBeq5qDhH5/D4EOiiacXHM/PMNWY+0TBOxdismygXlnon7YU3unnWgDl1EJRhNYtjVxvkWjf3EjnogjZZN6TxXwzoxbZ2nCC9J8EqGpf+1pK+tmU+fBwvzOI2HGGYfJr7kGRTpfGAl2/ZERR12hiswwI5IiF1OYJYjkJTmBYDa+5NCXreehen+68F80ePQIzHVxPe2yGgobsYd+fpMuyWx9JRHG16k/eSBe/lLW7EeJRkoZsbLr66+oVlIbBSV+QdUG8M2fOFyBsUa+Bm18Z6lKgMp1lBzQz1ZQhelykdazs9Yb1PI3TTl9Z2eBqiXX1LZ7+wTJe+b0l5peYrmO1t6tJkhM7YZlRK1IyydLPoOsmvX3wZv5F1K17Jqa1U+PEGlMYc6NtJoPF51V9/r787UaQVDgz2Qty5Bv7YFjxX3S5yIHIJ9m6DL2/oicUOv7kD4oyRhzeneughxBHfTWGAVUEV7m7QnHXJeGB4YQD7gVXthqA17twqlvTPFTO9VLVI6R0Ns3kKToQgh/OUP0iLd4r01RDl9073CqBB8zs+c95FLf3yTuOU8TOrN7WX60XSVSLY2HxNbrnKYp+HxpT7VTSh84yOF0+U9/F7YOSe3WCagZsXOZ6e2P/ks1Be/AhE9sXo9UAIhMOxdxYWXydy0hiycDcjcPPtaYn5sSpvQHiitQiYNLGMtQmkuY9csf7JsZojl3LhgbWvBy3f3Wt0CLtudn9JpJJH6ikaRnIuI5elauj0pF8HF0yW2T1BMYyJAGivL/36OKnjAbOPMI/orNk13jMhKA/O29cMIQZdLmW+WojHgnzW/HVQefdSPlXL8H1MbwBlq0c3FKn179NJcIfYqBJsoNLb+ikYNH5EemONViZ5nLuS0itIwyntaLrpwUI+pMTr+imQAjsbVvRkhCUHP5uZxXAVGP8ttKIqYEulh21pLi4Wxa9/2cjcSCPm5EXDInUJFu8uoPwDbqV11/bCd2UZ6D8kZ6hsjHOJzM+IdP2PH8rz41v76gKkL9IICX4hJP7WKu7l4MEORXqbG0lpfcFydSP5Yi12gC9B+WYPUJqbvSqpjaT8dLyLHh2wrvToFmdQKYZvru9uTyfk4jT8fzXtLOsnnsYcUozbHCdwEzFYQQJOzvgxlIcptQbOXgNNOS9/9G0o50R5+HFWENG+MvCTT11BIqz7i+c7RrEwm4dXZYU6e+OVQ1vX3vlqoRen6tOLy0HOUKAqV2ouxnBYCn4Bt88WwZkQXwx9alQerqVdj/Dx0alCmjgMejFt3SFHI3VuPLS2l4lGitJ3iPyErQy45DDKxeJSFxAxJ1R6yMbqEHnbQxIdSO+a0cJxBWrQpKBB/OYtNIRQ4Eauc/U22uqD1CD0Wls/fB9uPbdLrlgVVWQuVL9Wc6wfnGNdCkukTVJWEDmx/5rXkG8vXUzoZf4EMRaQvkc8KecwIHe5vVe+RVwQWvBQstZdmew/ZUJrUDrxEWhnr19prLpmo2kDjm//85U5maqM5s+pKnmGTqy+50ZLBhdE0lWtxeavKrlY9e7C+A/dppHct3E2XqHB7IsssJroS0vmo/f+FhN5Cw2uYnBD1A55YyDovfgW7/xl2KQUhkLDPjf2T/IppRdONQM23LPZBokBnwwsa+y7IXWM3Kobo/lyxDpvx4Ya6qTqnAFG+tD0GTT6r4PctId8I9mSvzAd5Pc8w23ZykPdY0A2W8FGMuZJNUDcSTnPR8fIS6DcjRtyFnrjZYa/+HIQyV4GZF6b2TgsedQpPVwkUt80zhD83UAMyjEiTNoQiYriWs/axeB62Is32/UMeZF1jVwWnVexsxuHPMfR3f75ksKuxRFCVPQ5DT73XHvWQKyAbRZ0kPkdJQKWq0cerWe5JKXFax9dRQarE+l07PVnzbWmpxu6dpbTFpjWtW5P0KYXZ7Ry5cnj7GXPgAN7P3ohfgswCz3iyItRXVEWs8OQHtOJfJvoD6VdOXDjNAl/zdESWSffKI3jgJ/gEnOI4t2FWJQQMFkSI+/x7X6oRPo28pi9o3MxaD9fFtK+kSoy9WJRrcymGrEbkBAItNdEsEhZRpSBQNensymgenvyMU903DTaNJ2FHJPiqnWff86DHBD95W8BuAdLoh0vOrxLf5FDrE+04kUx6LNhlwWy+e3MuGiaCBcTlIqEeCg33TCgL6mELuDuaOorNl7lPJqJs7fAxfV/6JmmenUe19kpRdMByNwOVYHFG5PRffvKNgYN/PWD3OEYU5abcqkDPx+fEiQuS1TZHmmI4ErpmO3MI7N7VRv3lcoF8mqunXSN6zdSkE0vCFURtlycc23aBPXitlQEYTTMr1BryCOt9u4gniVjs9R7MWxSHc2AzejKf8sKrojiZr21sYV9OBGuJmE15yxnV+XbkOQRgociAcNwN0E5lRVNi8v1R57+wkbNAN+NhJtr19bpyMRSYS5vTn6smiULVAAPe8WL596v6dKosrEyCLY5B1X5sQyooNQ4evkTl9yfT+NQMywWzrdhelF0Sy2FLl9mkC+CgiPLcruCSJQ64UETIs/AM81X2HtfAb6rc+LH0HzniJ4BEK5J3K/lLGZduTF2O6PIYt4Ko+Pi8I6ulyNUW6X42WShw776GxFBzNxAuotD14waU29l1dvnafu5qfTt8Vvgq9VQgosB07PtFRRZQ/SluRlarAnUbr05jPK9CKBSsHzpU0vJaE2VduWCDMzWNjIXqcsGndekDW358O132HyeDsERcnYxYzfVfOUsP1dyv3uK7uJUN9HZmaNN0GK2OskU8WN954NjsSEN8LGMYQfRa9oI9zB7+lIAeKzz+Cn3B/fDIwbji5nCfbikHiVnLdTI7BVle7nRxal6p6zaF8OjdrDAYmAijFHu2dn3oxG8qIgdNougWesgcBon99kKkPPFHrHQ5OPqotakoU7QejLXwuKgrx7ykeHFK49mGb0LnBHS3PrZE5dYYbvjDY6W9e6/fNO+ewJJSsgODTOMXJQ48zJcAHtLjloHsIHIgAE9usWLfd6NOjkf6Ln+pG1u0sqhLGy7/6pDZLLkI12gww3/53/8OOX8SUD3cpPyXBWzg7kRUVK9CuTCPdocjMfDyijT+kayC+fyF0eLM6MKY8SwWHLrcnwh/XcvVNHisII05VDgGiB5d58qLIiTZIvrOgLLNgb2GcZiu3pWiD//ZTOutqxGF6Q+stE2n1gQB9FpH8j3Rkbhw1C2ETEw1D4TNK32hYUFk3eGpLhfHu+tvkEWfDtYvxBOAMZnuFKXFTI++kycf3pVykQNSpBUWXlqGWhvdVsSrFd/Is+WdJCVoa/DgWOaeyVukratqZ3DnTjd9ON6goMyDKnb4qY6paXASGgX+GIb/vbSAwx7TB/CJ1Wg7WflmLPczq+a5hK0OdjyB4KxpZt79dP5mqrMyjxdKtQxWG77h8vXpuAj657KWXX5b5/IZoFlDfc22niMrXWJT2MeZHeNUij5LD/6yMRo1to6/zkxcLVsUIUYISLXccuiq0FLfXkdGIq6uJBcAVg3/qK7m5j8cmplUcTwcPlUI7+Jd36R3slFroPcCspEMBhAx4icIIH6rcWEAFcZTMDxCy4Y0UxU//aJV+q47Mhp3t4d03GILKedIRyJZvTV0W4HwwA1/FnSv4L4neWZSQizBZ2pMa+XM3+dhBWnF27pIsQLaAlcDrbCpLsAvfqSVynUF7XIuZmV40LWNRhhNAbNWhJiJzq0GgroTjCUtqLXTLQVeRIjKyzV2wz3Oq9YHXS6kdtBi9nXPJTeTmvvP6UZVCw9DFwF6j6ftCNwnCw8sZ6MrwSp1DUAvecQawD46p8nHsCT3vpFZbpXQnl3446N//qwEMH6St1Gra+VzsiLEfX+BcxWk18XqTFXPdvXml7t1sgGfBFlp3DE1VtwlqY8504SxsdTd3arxeVVXeh73g5ZKHN2frY8ERmmycz2R+0Gf/O528Nzptnzxdmup62hGzCdyNzziQIlg2wc4c2h8WlYjMSgTN0sOtpfqVEqgaMYV4cwydFKlQ7Me33Nt7pDFoNUtqtPy5F1Nj9w+FqMYVW+V61NonLiMY/8w4HD+TwP/RqRfYGcwfnT9pYRti2f/Lc6WgvquvCw4WOf4nbHj8ZafnZ/ZPp0P5t73RSmH5uhaQVGcGEaoDwYcXS5KkDk6FPh0kIYeXODsodcArHSNn532aWgS0OIVrEDqIPbl0S9J4zqyJs9ZwVuzlqo/89pNNBQsghMp4i2tyjUVKM7cIX60uH+6e7S54KpQyyEM0JMRoiM6DVzLJwTmEtuJl1WcEl3mmP+QTLdl3RBTvrVYRc5hyg45lsftKIw88fjilbXK5hToKKSTkYBaQjaNSEVsDiVS9Vrh2/Fzbk7BoSePeXVfOnrQ/yqTSldajaRXB0uAQF2FTcB2LRJePUYnzaZjaskObgj9FBgvA45dRUhm8+PqfStL13HoT+FP850i0HZa3/5LwSWl3VNtYXyEF+TVgLw44z+8X/QdnYNPNxUB5Qjf4zNqfaj/6PLxXz64QaXRw/EXHdjhgjtH+eP7pNXwpcDMFe2MVKxr5nj49fBKiNMbEbJPh+AIdbgVbCeMvG12dT95PuoYG0tfDwSy/rDw8bQKHZs0E2pb0+HtQ7z5eZWHLvzYp25GdLuBSec+xGorfUxA0hWHncNBEPKchq5iwsz70W843Ox3W++dV0RCxoXn5F6OzPX48S00KOYJu6ghzQE3RmMMUOGSGWmyyLSOQGqTqW42bzxp1zqP7FEBbB5X1pZvnm55R9X2P5V84Z5yNuWwYHOs6RYvLvLbtmM3Vsl0mgTNy/LJ9N52tV8VBbVlJdLwpfYbFD4+KF3E3hjZ4q+Wtl7CbgVcqmen+PQ7vPUqA3vyLFwITzDSEsF6o8XUzv/iOcrnr4IaxfF0BdpTsaz19xewsBha5POZ30OxlEWz7mY17/zmUI4Oy2KJZasOfAj17M5HjdWn3D6s3a9H1BVsVcjekA+FvaMSUDnGaoXWFMeCVvFw3MH98SxZTv4bF5/HB+uOI/3+o1O5Gnd6x1vvtD48xDf7iwW40frvDD4oTPmCyta70JPkCbh+VCebpifNK8fMtx4Le/TPV5JXu5vc0sHMDnnd+k83Njmt9pC4ltN6HMgz0V1Dh3xxaFSSJrmnLCQMMqO8V6em+iS2+9ctjK+MaLppR48i+5zFRvbeADowxOHbiy1oc9YJxfrIvzeagggD0BuYsUFViqnSVve97a9+4JgvuDmRz1PfDhO9m41GMvmmz5zHR4h/zIHBgixE8IJXfkw/JFLI9m2GAD20lPds78gxS3sTTEU+vUBls3RTpuiHlXcWfGCEBNqAjdQQvRqn37VtPqvRY6NMzsHmGAXZmSuo0sHFiO0CpyV5/BcFtMj5vwzPpDFrCsJ9pYXp0yBd3WIPv77Ysd/eg7Wt8f7sz/0D6eLXMK5Nw6Gj8QkL7neb9m3pIZdXwQ4byPyq938RMnIza5YBDa9aFLuIsqvrnh2qgjOZePJZWXoQQ93R7H4oJd3SikcKrGYcRTd8XnhGg7HOGXMVLzWn9atkdqT5Ly4kmz44RBUJEpw8KwWI8rDizOsDpw/UaS/0cWiqNgwvlTieZF+VrWkekQw3GOFgUfzTqeovqSfGF6xP7NTgJFGa6+6nehcfXnjLCmR56fkGmfma+EuH81LrPkh4nM3974+xzdMtgBcurNDiwtf5Dkh82jHR8TxD5/hovuUFtl3f9CJyTVjQejrzK2ous0vR+QmNwuLSrw8+KNWhILu2TxU+GIh7ZKSAFQA7gLyw7Arzq1MjR605FeM29a4rJYv51Px1huAvjlJbCgzNSaj6ibGWEVKuKWyt5Nully8WHrdtjM5MfwBgcDqGK4P1NSPiHM+5ww/oZB+QldzzQ32Q4RsRPAtllABtKd9yNxYCiFhg8K4jwxzd2CCrMd5JZi8eErdLAQ1WyidCp2q3MNTrSL2CwX8SiQF7PcoYd3HfgfyZHH57MLKmB/N18eKZKX947ybADSrJbUGa14682WPE33i6PfinAv/ruXkLmztri7ZlHTuNiGMWTZ+kFKaqR+mFVFkr9TZuFKA6NoqEWlVMJIazu/6PD9IpbSBnSWiZLNNyiERxHLbT87R/J4M8aepqUH2tRX5bOseMYgHly/YE1weyE8SNs9XmHLO5mEuqmi9FlBaeE/88M+tLgrGkZ5PBtUR2ehAPz2/edALLwK3EltH9dUd7XvBPPtN3AF9ley6kxM/fXQjV+adja5lZAXuLTA9QXnRp0urs5emjpeyEXEBoLEjG/2gaJT3C+3B50Fft0lm+WLFnLZiEa4dDnPS3W6l291k7rrRaDMapTZ+Rmr8+ph/nGJjbG1dxuDCBuCnDPPJcV1dGHzwop8mfwO/46//eJdniJsXMvQLWOPBvC2BciDVFhYebrveSfkrfm4WRia6vczpJgiC79dynKgr6/ijEC4rhOHpjV7Tb9tm9iQi6jsrdHjo64Rprj8GYrNoou4kZn5ZQGcQydF8S7A/MvE4PfO05vItXc5ORxqyoGDTQUiAzk0vHOWvV7RMS/MszxneXajDF5MvabIWtAaGGrcVYMAycLZy7iT4V4hGXDC9F7E0q728LtQomka5aozeZ7CMP2ILhn+rEeHAk/I+R22aaJyMtc3kmTA4lvRFi4N55vgTfMN46L+18NzPRh8wPmcOU3y1impgFuFnuM5BjWI04xsNR8nPto1GK1e2jj7BPEvEdLWdr+W2fYbqNcX68YYhD1ffHGCIDk4vn6Y0lKuEcWtkayAnz4v102e2491ShL9AULrGrq9foMU3m9lOzbGHM01XXh90fBubEHmNUPerNr57mZF7ixd8Z12w07m5uSGSmKgo2ogeDULc7JtrEANtKXNk2Mp3W49HPTIIHdI/fmX6a0wBtDNz5cU3m4ppTJ+r9PZTUIMTy1z8CCU+uaA/5+/svxHRBd6aIZwSh8lxMLFuDfanrZVaCFhIR8fO1yrD2dBhEmPIfivtX+rekL31ytYdkkzYAxZ+netJPHFqQT5Mq/bODn70y//J/KuOp2v66xPXXdjo/FmlZkOcV+gfnI/fmLFdrFr5DZZhtmDiksy31V1kz3cbC6ZY7L0CnXj0AX6WUD1+Y7GFM8S1z13l7J5YnzJ/cfRWPSiue2DDbdlpw0NYNbVuD9ucjC49qM6IqucrwYUlizkIagkZDdc4RQjhWxvbDfvUBqbCVeeX/5UxEAdkS0kB7ew9jTFph9mhgVzdQf8n7kw+yyMkFo+Qcy8mCk7cP0FUTzCrAP0IELaH6Vefr/TnvdxJKtvFVpwf5+LF+qTnJUe/VekczCRzFJ1XOyfglJyf1zCjCBz3za86m2rbrfxcK3OO0r1/BYbxfFnRYmzbEKXcUnjuKu+12jXry78OmU03SXpOqfToPue3HvzMUBtgNS3ipNPG6yYrD80vORcjQ7jYFUZIHPrUqxIXZhwMW41FPeKPpxxqLtjgymeE0mQLWrOxuL1lVTDo/+N4Sjcot231vGVr15OWZcQf3+bH/vNt9FHqBwdN49zklYjEWpqj9SKjtijygBkK/fi55XxWDmC1ZNf/zDJjoa99+3DpgJOAn7b2V8FZpXuGxOMNGTYzQd4XLMaMuMk3jy9+JMhyhbyXLIYmRkNTiK6cBuot64tL/udTkm4ONEUuRTSe0VkqVRy4qGx2F2O/YqTumul/2qgMURfzfp2JfEcPSISxd+LwbbllaBJbM4D6UGeONFkNfnI8q/E40veC3tGNtL0GOXe0ASvdusVi2cPoPcS50gaBlNGq+6/gjXZtpfvgEH77X8zr5UFuQOabn+PaNYIO4fCvdC2seJXPIz2SvhlHOosVgj4Ohp18MekUL06J2gFi7M5T6Xe6kP8vLZufnGJ+8l3/fHxqYaDeV+zi3PLTsgQ+gbTRuhAwLz/jtAtrTrujbMyBd5RF7CbghREwRo25V0CvOfIO8+bQGg9v/+yuNLtrXQDZad7mo31ciI2x3ZsQwo5z5Lof/w83AHpc3RcRyFoq+PwgrZDj7Fe5ydv//sXf7StNgwHFE6AS9LklYUb8wQYDknB6cGEJ6PYueopEiJThcvA/61Jhe3v4CZ7c1IHz43ltZG908rdTfA0vyllLAYfJ2nCcANaLAXk99TwNzDwd2p7OTHSlXg7SL7mNUbD5//l/tEBfaMta/X+3Zfa4NNiTE6oMqhy2H2s2Fz+EsYqGJO0nBQNxrN9PH8r8gOWO124Yzyg+zM7K47NK9MvrcA6iPFyc6D5xHe6K2Sj+7FwZE4VfmIfhVHxfvUtvQuP49Nb5AT/Kk8z+GxdV+Wb3I+fhFjcML8mLwfRypF90+p9jF+BV67DP17cIPxURrKZPLJUsFdKQcvbhNWIfXThTZeF6y3uxeLAuDY4PfWticI9uICH+Kwdlz3R947lZQwC8uzdvEsT17MSQgTZ7pa42w/zYdRaXd8m1symvVHGAnyHu9MG4GZe8TTaHqmhC1nNUzwNxliL9PRizY/WXjzQXw2T6SZWyDK+mMLrCXJL592bFevEdAm/8LrYP1jr+6e9R9prF/YW3dn7Z7i9s0Ngs6Vr+/BFEuXen7mdbBmrzLfY/+GVs+LcGJDgia31er3pgfzQGXXw/RHZL9GQfAoTZmtXP5i1aih9nup9gtHMZentH9yJqYCUVYu94JjjsH9RMIN5WgteXRZuMPAnxLbKzJZLeoHDxd0X81ttZ24rQyz60P8OgzsTGzt+K1RpOrAPUiukWS9F+TD7prlzvCB7wqL0oxiOXvvIJJ35y3eQDGsyajGf+sppzg6imn2DiNhFtLao2tjb1dTf+cbxVFfjr81kivq5R2HWF2uyvt0Gwj+Dpz1gDM1GPKOk7E2hmHFKfiXm//JTPv73j/uDWmWa1Cj8BYOLG8UcjvOIAOEy6Cie7QmK6PD3N9ulSc3hXvwBI4z0/hfR4tKNu8iY/t6prn44+QVinTtiwDuy6eZnD9oxwxWWYkvphq3p6mdq1l2zZv403/rOTFaS76s9NbzzGhtqge/MUMysEdzY3127UdGoI56tdXqw4Lnd2hr3uzLKy0mV9+x0IgdDf5iy3/S39YWKO6j8x+T5Hd3xqy+ds0OuFS4iLe2+P9NzuqGf/+k77rlY23r7iAQZXBQH36ylpHFnrEi5t4VZResSqTcV6SPA9a//GdRSIinI45T9+n/OL11bja3Vvl9Z1QM80KRpLWUDa3m8SPI7ZsGCIFsxP7hi8GCyByfTaclJELrHw26QVpNSnVITghPVlJQInWkXHPvNcXMfPAE1RLHhx8UlEa/xcOPZ6ujbsG6lc/3ZFBWAVeuJ8I1Gr0dVMwTOOYzbmMQrrMYvepGh9UUgrWqx18Usv/ahWZ8fTz3biw5xWnOH+bM/wv8SP3Jge+Y8SjQHb5yd8UomKlJM5lOHUj+B8Zev0Z7HDy1nxqjH9Xu2CHtfyTxLH/H4K4tBaXfDyVruJPd7PepLO97zGqy3yVnBcDl3Ne2EXuS9tNAbnZz13d1dfIZsLNeBhMbyvoipO4yYdhHtO9sirdlzFe2/t735h2NWrtNz0Hld9EGwRu3ZyCpU1N4FWF1lNb0DoMEfHVc4IoH1zgMcgFrOjSeRWRZJbdrKGXNzrB24B+PsnVqvshPbXdvgvPHDelX0GUHgFs+y96+y3VtTYDORmYd0Fh5pQMk+snxxgsE1ydnoPxmExOsyu2SZDgfS/uI05/riTnJMLR4Dth/B1T/xhi9clSRG6XbHUs1zwM2zGEGhX4+7RlZJ5Qo1ukxTQHA3MvT8IjH1pFNtKcNpXoG4OtPGDkBqYpv/gW0OnOhtGsvtcgaZO8uLRbY2TD4C9q9XmxhGI6ZYj8G+HVklgxXr6Uv4mcZp09/P8RX8tC+mWHNLFLufxTvAZnlRXxzHA1vkDp/5iTvzVjoWX9y/wen5mmutm49UFvCbl8vRV4kWJXi5Ad8oDfS/a6vAU0oQ8YDZiVHDooe5EUzSyVMIk8LylqoCVY7yf1/5nL2q1dZX8mH0t+Hk6uY4T2b1ZlHgYN0EH5N8l8TaqCzjbNqEtmmLTlg6RtMRa4nIgNsz4OLgxEUehneyq0M6SwbYH/xR2CDh/xF0M8kx3qttAPS1IKwLmcZf9gsjFt+tm++LjjKfF9/HtpeGlmYDQXHmZb6WbsPa+qvQhfsoVO7L+l0L/EfSsiop+rnil6Q5JBlfUFhXGxRDv2NXXq/PpV4OMEBnWgpwnI3PD+ZT/2e4829kpuYQ/SsZvyUQ9jE4ELxhtLAeN5Onchqgg2Golz2JLqLZUXV7zuyUha9MhLIVqL6mv3adLepQpameoC/ml+gMeHrbxRoyh/BB8Nkj1iq2Zsahfq9v14GutOSrxpGvjfbh1tlgN5Noox53IYJ9y55/Dn/1PLDiRUd1v+hvr+X/qLrA0rw8OoNP2lWB8rddalT8b+I/Pb7Kz33odWp3AzN8l+4hWp1Vs/tP8wDvWtI39OJTMxQeYWVgT6RYlVHLNMg3w+vgGuoXCWULHN38PVU0wfhziKwVYO5OzEgOK46fNYzj0VGALUqzNpeub7fUda6/EGzk5eC7hPtiaXbxiMV/24QbPYqa3OW9OAOebU/TirE93n5EZxFtEI/B2hdoAwcrbu+40MTfljsTql08mpoijySJosusnS6nOb72d+/pQc+44x6gjCkiPDPjgzrN3UyinOFiGltvQ0HH65IbEx/BqLapnL9CL005t0adwvA74kTgZu5MMPMADp/spX7UtQtL0VlmzDtk3FfQKCvEAqRzx4M5VBhPQLJny51BxhSHn2yTN1jpKBkwz+GfNcQEpvBhFJHzBZsBhbR70MiZfLIzbIh8tfcf6f1aclYF74X8cO4eG5k2B54OaxcNEL5XlK/SxbC6wuaGQr9FGGJxU/xt94DdezWb65kCrQub8SQ/DJ5N0PCK/zdFHEsknouGt089AND2c81TeCP43bqHKPTg7PzFdiMiq4BSHhsu6foI6Ap0ai2tDf3LS17PLKSZl2R3vh8OxWJ8TGo/9xufswb/YZ+MZfPNtsIyzuX68h8W4EIVcPGJnj4zLyASf7771BqnP3pHTb4VuU4s0X5i55IqxAMXZKaj5JMQ5veUpkTYWlL4L78qHw/kkrh4jxh1+X4nvDCkgOPzscL+0L6UJ6t06rkWkjKF+PfN7lCAYC5vO3LX2f+2Co9/f8Y7KEZ9YdnV2dVERovajS9cO0YyyI1QY8H2Q8RsJx+fZ3jVTUN9d21uB8sxeszLBd3U4nsiOwj7qsp2X4/S0txCbzkpBd1HqN3qr9Jpe5eifHzpwVvx7Z7TdfQ05f5uhWYAD5R8Q6DNTa2VYWdI3I1/naPazp0/tisfdqjjyXjrDiq8Wk/l5oyGt2Ory4dTEq9G5tKvsgmz4Drr6fHTJFDm3L9a4AEopmXSuz9EiTZCSnBjku6WI6uJJLfbZrRZVHnF2+qTfSoLGGEb9PbYA5yo/ubrxp/+bjynLYTQJvl18PEPOyo3RHFb/2SswmvQpD6tMe1rXw3ofTqlscn1sf/LYfwT1Rb+AZtEqebFFtpjdTF8U9Z4vBrey6IE1iB72vxbF1kHrEk7vyLfXL+JxGScK7V266nmy9GL0snAuv1/yAPHPsLk5uFa2SbWZOr/4Ozrq6t3cjXXQlwGuUjdeRm24fpA597fS9YsIeX9qrXhEyAeHfv1S+Xa9nKmmwUTozef2wvwoh5O+jvIGLoOuLzjvW5g3X95Rrhga+aeUvBXEfU7OtiifOwNGvZJYLNz4n2PxH6yvHLkDYbh7GGZ80mrLgJ6HFPeLhQnTpZRCUHef9Cx5ggwtUi6+Bkf61D+xzl/2t28sOtmlNJvO9AuIAeky8p8pUd/bcOfAoFlaTpBGPi067VefZFzc6JuZVrhctDvx6sL6IB4xE+NDHp4Pc5HOJ6Btkjtr14Sqpe9igCgn82S5fmvS5g2Db46TuUa2lAwBQFjTkpRQ0S7XUaofh+OvJlsk76z24RaWxOPPMzE+fefPgXguhjg0fkC645rIpV7tnhyl0Iehu/GHQwCIHzgWMEVBcIkv7eeQeD/d1zmKx3kFUatIj1VMyrxPIcxmxeriqH44FNE/ltOJOL1cZ0mPPoptbNiA2RXyw07x7aL6s1atW/kUwOEySZdMdjHqtoQSj75rHQ7XGo634W1fWVTZsh9wbhNCJ1PT4w6RmYTw9dmnTrw0ldX3ytLCfci8VaDHZ9cgZz/m34R8fLJ7yih7NLvsEhnJ4pmPL8xxfjBBqh+tWwVy+UV2O09x9/WBwJwURV58Bz+n2C5Mw4rSyvgBOHod6I9qI+OfjUckA67yG48IjPlqvH/MXqGV0QB9SE4yQqU079AsXcLPKZWJZava2DYkqoFvoyApNBNdFTIr41nN2H6cDsX7y/J+2Gf/LBnBx6sXsoswnXKtvOvUnzxJCsIBw0vUTfXDqmq2YYZ84Sbq88b4NjQc6xgHVLBm9UqxT0CcXcXBFhsjv35aPseFUR9nAo1ENlq5cJ5sF0wL4sWxFEIWj0a1syiYcT25S+PTnv0PkV71azOryqQNoq90DJop87m+uKEW53C/HQXaWJ2rwRPIg23myKIa1/riHGNnTfeQae2g6ZFs6PH4H1/zgf5mINyD5WLZG4sXkkyqm+F6L243mZ96QOHkFn9P8zxf6rXhJoiem+Pj1pdGG3elcLlt1brXje0gylNiA9n+tXMir382N/GuMIdh26Tmohi8jkCCM5keeTcdjLTRowqbPLQ2QvoGK70iD9PTlXSxKgUSCMURSBEeEdr1IxnP4zOAbhMFx2tnzv5D7VhbbkbY4+B+XeOWRJe3Ug0E8DBgoYan00H7FSFDSC2+rxOHfTgTYMZ8uy5CxlE7SDIZAa95R3fudfObAWNFY7IAU2d4d8VszgbwZkUDXT4b667uyd6FUHLPV/w5MnY7EnTsYwde4qxFiZ58EJMQz8OPJ/yvYB3OGafrP06Ga6bsT/b2WVoY9lLL4HBVvqQR+JB7hhpcqR7+cT5jPSlb1HZZVDURDn1G3PFwSN8G9uptPIYYgpU0u3Ov7enLl756VkDU1Ztx8SN6XAtmTPOX0YB3HI/8wxm3RJ4/32QnmU+1KTllm9Ok//NAfI/vAm4F3wHR9O0a0X4Y47IeJf6YR3aiYY1i6+3r62D4fj119B/dj/ny/uFdJqI3B7rFAsHW5E2r4zFNF16M8vloeSk3vOOOt8NhuXa9YB53tncRzaf+uhssKWW75eIOIl/eSWwFu4cVUw51UjiSEwFw8XKTpLdqHBFLYzd6e8qM16hHYFVTKJksn2P1E3zrGX+ALDkc80iH+fQZ9q03zpt7bXivD5GfDrnZLOkWq28Xu3hRt5uacem8y6McELERGodlvKooNMuI2FguMQPlDmh5/UhOOZG8066+hqTpuf7pHw4xDuDyhlkdZ4bfqh1eXdLiOx/TgV0szotlECqCw64dR9pZKTpDr+7XV4Fqlhkz7DcHqJ+bavZCxF2zL6XnM03T221XSqMC4q4150kM6qffhzu4Km71FyeDqTcr6c6nclm9+Gy37Jb/4MlfIC7TlsAL7YNRc8LjLgLxMOTDRBeYkvEe9rwnH36hB3K1gW9O7BskoDg9y3V0Q/5GHTbOifMRGb1POB/dqLZCIj+NzLZ3NobTr2gNP3pU4lPZObjd12SSIl90phPoErzx9SUIX4nf3O+cHFJUx/c8bKzcQMLpT07H+nSc3W6ZghaLeLECuLFLIdb3IWx6vD315V/QX6xxy/+u0G2ECboEpej3NI+LfFtumHuHWQweuno5+9ZX3451a7vtJ4ExeXnjVb3LziXQ2A9SeNPnVd7YuOTzDa08BmSH0boC6PcC4WeTDPI1eWtsv0cZCj27lr4MiU0NPHTm0M0hIRcLIt9G62hf9xAzIx3tLblfKEEzW214CjA6B1azgBUXkB+C+SuRr/U3G9+glBjEt7MsMTyZWAM1xxXj8814OGSeKduzGyqlxoXnyco9zKqPqRu/X/hLg/pI6g8sD/pOu8NMbpy3cpa4/ELvsHO24Y3SWrYkwQizdHB44tMAjtnOhq7iWhrK7uA2vJYKQ+P94HTBiFVxuahRNlcJGVQGVNN+z8AursPf+HmQ2SkwTzl/dPJiLKZYC0CvMzaXnhuEQpes/S0rY0BeTPXCVELselt5xC9mWXJF5/XDI//ZHv6nzBK+alsM7W2d3yAJ1uknjOs52SCj6sNi/242cGIipINXHUXbZ3DK0CsDE/OdHb/6lC6BNt0M3DyUidefH+jNfr443s/j/Y67JPUhh085IPZHf9J3f5OOsdgnC8VchSdylGwBgtqI2EsWc1+4yMvYBfJ8dLPkmL++A4c1sU5at5fozLE/68YvReP5QRvEfxMzFPFRnG3wZ8/gKqSPbq2aAnOh83bv/ElY4+xGOW++IPiljBbGuv/2VCj/QgcZ/wwv3axNAV0+OODSZHtpoIfEvxYEjaH6s0OdZzMptmyS3PU4tFlak/H8Wrtpg/E9bAgPD0qB/OfrDfVzugqJqkh+yuV0docrJWxC+AlxLxCEdP8PN+lMCWbRcbSTP8nfQNlLQaWemXpOreoPVJxhqsBrr1F13833Kiwk6uP0Bb3GaY9Gxa15fDEid8npwsM+EFnwcBkWVJb6/QQC6hzG8Fw5NJpWbmsEm1bd06DL+T50EcqPmX0A9C2gk7i2s7FV2POVa7F0nILFh9WCQvHsZVkO9loccll7BTWjsO3c2kzwpCk/h0OV/1sPKZ/LO7+hfop/Zc6vOkOMq7PjF4fyb2P1NVb70oqPw7MY18M5oyYpx2Yg29AIiSPO/I0j3vPjRry8xM2nem0MoP66c0F/fAm3QgmgVcMlsryyw/T8cW5zdR167UHgPyX0rebukRDLAdy36jlwYvqC6DJD5zwWU1Wd/FZzcboysN1dowuNAEwPUwOZgTGZl0LzTOys0THnpaJiC9PExJhMLEPs34JIlFOVwLaapClSCRXrmX6yXGnnrxiiHDPhYIv4r/ar/iuVpnV2AiWpXVfD90cwdaTPXRmD/cT/tHvyR6cHN6Of8vEpMrB0wovC2SNYpFMo52mzotUIhEUWX5LTQidy7w3ULzn9C9R+G38z896jbobVavD1+nE61r4/Uk/E4vJPt5th6xKeg+5ANOScSS/Ti17BdB5FDlsYZL0Pa772j2fIszh3MaCoJlbMdmlsIB5/p9rFAP6RRiDSWQgpwcd59ZVv0sWd7cke0WECejj+zSdrvXl7Mz2UVdgLwhvv7HHs/z1esD9dvf7Df84oqucDQOX3fCMearP09SW0NXOwxi8Sr2YE/Yh7P/W12/Or6cL/TAXqmDy/uMbPON7pUad3I0oOOJtbcyrd6N4GOd5dEc0tXN5XIVcVTn8sz72NVtWdnAuWPpMgtf8C2PHFxO7Z2KW+NwQynMGYc9BVvbHAAMV/038iP2RyPmDbPvOWhe716nV8G2m8xWv8qAyhzbvZX7xJRWLHf1erYxei98PEzeiG9tRJRa+3xtxayuhBNXdaqY+9ENNYRarmzZ0fkUkQpgPCrJXaosiXSMHG8lb3mYSU+zfTwNFv6gE3OtGM7hjW4oC5uNssF98yR0fHFN/sJPfLJ2OqZBbOOHQ1Th3YL1RF3iXrhxz4NdTjEqTw2uu5VhT3gOPly7hpIRpzC35QTs6s0ayJTeYnNr1Qu06dTn0W1/vtItlGpu5jTifNBI2m9Oikf8Aizm42Zn65h93hxfYyHgNIOoUVj4OjO+E+zUEGkD+UX2ua1t1xZIXxuKrbkRURMe6tjSPbfFVrfX5yGGVTs2U7AccgBlyf0R4ZL+NUp//2C0NsBK2mi2GcieUEsP5tWBdUG5R0zqE8/njmsA1Q/JOnPb2yXQnDb2z/4QWEQRCfY+vR5lhQ0yvHsJ9PX5yb4cXFJAmRm45/sZC+Mgmzb3ryrTxRR/peRY/fGru3crJxri+RrjTRaX2dM7bPHagmcmnm55JdNDkMo1j4DDDZQIGt8LW244JBPz/iokOs6j9WHlVDL7HdDHFmY9C4zyGDAuJ6deOzMTJwjUs4Ot1YD+OWwhR3SysQ4WyzLOQbt5vabzcWq2PO62Z6Dj4c6T6ltXgYkUwxPbvnEFWV+BDaGVJXwej4RyigVGHNFPvBtW8kkExAbwV0yNPWUnHomKffcmvCeAgVCv6rbe0g1OeQ2QsjCK3aLE3rxYNMpMPXmii42hgQ/ozvwZbV4tl6+HLKY875fI45x3NxqP6oXqw/dMX05Azk2+w4cLRIXty3eL4lzEaccDwfd/kne4IQOShvh7Sf+fWJie4qoJpvdRfZYsnwYMo3f0+qYv2dXg7PdrVs5IGn06lLk188npWdbTgPyMV35hg+8W1oCtw4tH3P6Td2RSp/POOXT5vbJzLY54ZgGQ1/fcbvahN/yxXM6vBWa1znp3gWdv4lJR6y5nsdu25cTN77nHWx7sI5302Z77p9m509yXsLcgHeHSn6RJz/A2ev8sUt0lhPv3dujorXQIQxfq957uqCjQuQ36MYlhLfVXEbg5xIPIbzBCBHCJTZ51tvwnxXjj7IuLugMPh1K2+1Wla+dZHHT0sF6Sx2OLgVEI0Mt95GohObm10yTa/4mlA7hOFf2diAYbYKF+EH/8qjibYqTqmbeyRK35yEoSCcRRhvhowe3/EIp7sC2V1u5QfaWW0XLa3pF8NbZvPgUZ41Os8dgnEoY/ATo9dqdWYojaM0PDtYtRM61PzFVqGda9rLOgJA2yTkO4ecsm1OyaMzZDgw1McdGl1YjyqO7SfKSkwD78FcL9Rq6PoqILDEz0FWisWeGi77Rtia04TR1l/SxTfQcHnRZlgNoqg4Zn/jA4we6at3AjHrPOrhMIrgdMfxLmyx2d352Ub1QyZGnSul+WDgMmS4Z3M7THJtfaq/jeuDR7gNVP3X5rupaqP8Ntr/4sDVuPUpFxxtpjr79JFZe2Q9CbwzCG/s/uRX3YRfaL5n+mLbOG/IEnAj2k1XnNKw5Wir3I0K2/v2JR/I924ODD829X2WydgVaQ4ezNkmD72Z12fUJMlxTzruUE7CzGQiDCif3/5cq8JYz1B+auE/YeSlRVYM/Q69UESy87mBGXhMIiBxvxSaj6bDhRwmnKBzVTWXVs4W4FO/iApL/5cBsbw7MleWrS8vru/4Vcj+T9IgbLRV0goIoEmNDTE3NM7CZOwPe74nGqfLVaNNmIpXTbstSWbO4B5eNpw6+ULkYGprDo4zFxNyNDqW0T5Yyf1iQiXQJ4LxcbavyxN8cgMGVcO8q9cY96P41sEXZmW2zpC6SqI8Z8WOfrVafs/GPIa9MwrXy/iQtelxRj7EVpP9F6+lmAUY8fl6sY49RBz0Dvwi/+Jjxf6ABgH2w+1MNLhZB8b0nCNkm6n8v+DeBSrVtz3PM30vLEqfZlTz/JscEsdq2hDOwhx+f47pydS6esb1A0vxrJ9cdsIko39LuOWmv0Ho2T87HThG+WSKtlKVfX1t83z+Tq4eUPvacc79B5eSD+gAVnfVxUwVdj35hY0qP59MK9Tu8jE1J6flW2AyuEpReHcYtxAk8iTbxGrKLLf55WNUSQ0ivRPvQnDH34JAgxVj/pliELyto1xr4rj/CgI9ThHq2rjh9Y6ApqkBd5db5AwExy/G4PuAwhtO4OfMsts8wWjlezsta6hPJ0Ho5N7nHgvj9w3v3KGwBf6v7u5if9Plxzi6JznL2VY2q7NYKrz9QywMdQAAQABJREFUTYkFKMv5ssjOzC2pmfjysBy1w1KDD0/huhrTqD/uiZgo6nvVOuvLR8cRfcYr1OYV7ckHa6CJJNfeJGi3WUW1x0AoLGsxAnFWw4r/0SR8lfP91OIQQMYZT5Lj429jSzDO62LzI0Apro1n2GZKbn7M4YfD0POmfuswxnBoVld0M3sbbIJkXhvoBDyh3Zr50LnCBWH4uVykd/wUH/vF6jDVAR6u3FAU7cPI854A34aFCLmZcYxs/oxZHmXPLpn47IdLFxZ//40/7MNo79PWt+Cc3T/4Xcj5Uv7hevzERiI/4/AGy99NZFfr80l1lZDLyo2quHWCwvur9Met2BalmydqAJsBetXMjBHZ/2xeU2CHpCR2FWp4Kml1vVZMN5MfmWPs09EhVrdX1W4JDyaBa87GW2+OQO7aDPX+iV7T014yGlAaQrSPTQsfd92InqOqIa3Q57MNQz9+GeSOm88XD2cfbwi9ff6DwYSK36wO94DqBdE8m8HZPtltZMyw68CAejYjZ5blyaWxgJ57crCallTbHsUZQA3AXt91D5ipGuxijq1ozh16cIIwleXT4mXkt+TdjRrGEHrJ/zvLoNAW5HH2uXJmj/vZFeoszPDjW9wL/VEW2626L49M5CNIe852XR5qbv3YS/5w5/JjIN9WKJv1qOJ7i/zlbFWNc8TzVSy+gENuuRbP+s/PhfeGYNbe2eAq9Q/gR2cmV5wXx9M9fxJ+pgpq8y0fo3lg5QxmM7yqp07O4OWsJv2WT6OHUZMPjtu8jheDYRz/1LnZblV+9Odb+w+HMgYvzjbX7H7wPh7PxgZhnLOlUm6uyFJ9dFws1MTNT/yuHpXtTH7dqHSpinNTheqwELZjhbMo+tq5k92mTryOB5jIuXXsazrU86ng5J1QEYs1smly/Kf1VDzHkTvv3UyXdugCqQ+V/0aPtqUvqZFdeF0Z2v14WJmRjY+/HhTsuPvrOmfwrBzuijAImmMP3OvSeBt+/hKrzIDTz76rW9WT2S1dFe0pmx4Iu4vMIzNnjj/MKO1vtSh3hPzMg2cYtSmOpestePNiDABxsWDAPlt5lXa2Y8Mof3S9QP1noEMFDfs8mVvYIymexyMNAkPTUtL0+ngtHbAUzSQawZyYpOT2ESS6Xaw66vm/OIsFpDBbpk02W5x8CLIdsJg+cZ1Mo3B0unNlbOmk2fhiEY/cGMpRh7RHI14HQrL4gb3uXTunPz51P9sbn9f4PDj+8J5B2M9hFh97Oi0BsMY77foM2sjEWp/Onz4bjzJtxHkA8V1O3w0xHtT9OhKV+NhhIf7LMT/qf8fMtxuGvX7yObyebxPs9X8xDPs3A2YMxk9s3RGaD052U8aCijsUyAjkdCOcvZNvTBjzmMw7xSYWKnMDrMBwiiMb+koev6r0HR3FVYw31cmG8VrBGqzw1tAc5FdezHm6mQodhs8o/cQBNffKrnpKDuq0JpGdIaHzZUUQpy4sP8YsHJ1L71dKQUvE3htPyg14grurbEoFTfuNnLGlV28stWJoLopRWXZAdN9YAU/SKWE1D4P856VU5Kb5CfCQm954VGPmzx300t00guPjDlmOSnbuCfKizvlsJakXa2HuEDnllJu+/yqJVFseLa7l8kIx0Xd/r4wAefixA9ParGoMTwXwvKEzbjJ7PE79CLi7YpW0TMNnjnTyRsYUIGR4SXeXt7P+tVBmVlwaG2uaBZEYo3aLSjSj2Q8jeDh5uMPIphzlEGTqnrTrzOE1FbXTXkxPeqpKlfEHS+cze0eSk/nSWxe3MOSp7NsjCJdPqT3ZBwfC5QzsVvJsL64uLfvqPeyxs31ztY7qj3tnxvLy02ajf/uPC91HHufpRMml7GHq53I+fuIfTt5yOt5igYq34d4wpJObcZsegXvVOz+G6Tbz5s2tR/961PZqEA/g+0/B4GRzZS3EfR+QakSMyEbc5Ph2n2Wi6YIEM7XrCi8VfroAN8/Axn1HuXch9m9Okv6H+15D9WAaCfHH2cc2AW8sq44QxEZlL776HEhEilrWboY+Dmeedr2okw/6e18/JcWxrAB1vuESphzjMBJKdSUUez4qD0l5Brq7SHr0aQ9vHnIl1a86ngsZAaIO4cQKBXEbi79YPmuB6VExTYePUd7ixUzntlg8yJ7+ozPmyQLhEn+mS7uTeoQuE2upVMni4lh/cTVaTrGOh+6nzRqWJCpm8zDJ4xaAHoGp1sxthsGv+7/3My2zyvhZuASwvD6kc31O2oB1pq/O5uf4npy2HU85rqmV1D4B/y9DuIzqHtGKUlZEU42Gmj8qL3D14R7mv2QCxH82KvHKrlBxZPNZ3q5gSVv1LrfsPfvDpbANELx2CB7Hx07be86+D8py7NjPCuPPXn64MGC4vr7yB8+Tf/xGczGEb/kUE7NofJkXrZ8dyuWdZXUz6PD5CiO8ePxutMvGoVd84bnD2vMKV7CRghDFGXBX+mqAQG2orOfkWaV+GPRQFVRWm5hjb6n7q+KM+Vrb35dkJ9k/tiZWhk0kXr1zG68beu6VzYvsr5Kq/ObcC7d/pw04705L/YtMoJ8+7DI29WXhBW9rGpHq7ESeVs7JrGKhcx5SEgefU6VW1OtVahK4WfpgLSJBZnoe82OfVNb/zl5BrB5Gt1l9cebDOA8fqUsnHkZF7E1yXq2NXUqxroTPVm61455ebwvVMfFx9ENc4rmdNV94Me6qe/aYfdruxsbzQwx+vi7zBQBgNZj5J+4M33pQNz79fOzPY7SuI7Pn8ZOvuJSfvb21yW7BnRaNubn0VLsGroU2JkryOIyoMH+C7BfjsE5vZop/Ay+iJxtOAJzaHDYJg2mUL25DDHNn9cmmlmUb3vmNk8jfBpheHUbbgOSzf+dPHCDxKcanTl2d4h7XbL5jYQ9/JsX64ZYm3+BenAA//j++xxNEm7Ob300Ff7er6S62XXrDEXR3gpe/y/7Zj4qcCMg4bE+n4NP/X+Str0CZzf7iutJnr7YXX8kymq8wzykDdndFLTvPbJiWyQuMUWuNHo/WsEBdck/cdwymfmRdmFpKZ2JesdsJgIjbpjdiiQDf3WQklVGfYG+D7NeCEBnI/Dx/jE8sudM4/QlH+GyGFWA+TQO9KBB4ru92va45GsVV56SaVBBBRGl/9v71YzeyX3/55ZT9i2Od40+4WB6i2UBkTPe+YfHk8sU6GycL8faSi0P+1dsjrRyAoX/cUQmjQzNJVfpZDqOYNsQEzCEBKMASbXaMDUKwp3PyfCl+bMoeVJbpVH8iqa9OP+UG6uE21u5JAP7WluPTei4n/Z5vuW0/MZMge8IEIid44s/5JXEIJ8qIf4iL0U1KCu1muyvpCcwj3QEaQ/J4nIu3sairLxe83ppppufwDNq4bvzsdh6nV7HPn7zqH1aen/3hzoexnv5hxjVOg/mOjfYb1+wYPxlnr043GmxUo2PB0zuM03Z9AQ0DitDgowfnoHFMjodxqRrTtInD7eAY5VsQMxO8Juepo3hyzvyHZt287L9ymBY//OqQs5EZd3WkZrD++nofxflJvdjbFSNnfKCJRSDrjvS+0Q6OpMuYP6bB/x6+oL1xlCSbzvQI4CXUv4t+8gHzn0WXhT2tdzDcT7PL0wdfAJVtuQmYvN5tj+/yVWZMhnDWDOnR5pEs+rM9ChdoU+vnJrYXQiazS36HeE+XgXh3HM6LQeX8t6nwojRixHbM4ZG4G7X6jMkmF2rFm0f6t98q1EdIfVybOM7N/QSGtHwfFnmt6c2J8T6ttNUBjLLKoMkBzn0MireoHQqYcaW4/ldjaT5eFK8hqmLmhCRXHYatG/LZzmw5ra/VNiE5sLjauoyKF9iz9my2jS+eF5bnpwvBWCrjfrGb7xfnW2R9Hybs1QThbKfTrlpx9suMi4A3bF895mDmy/+pUN43dh0wLI7+F0P51Z/84bJB4Y964955XMNNLnZ60C8Oyqfcd5K+l8S4XxXSDmduAdp87x6zY4fhwnzvDMIYq3Ecn/HcI19Ok27GR+f6Fm1LW+dZnXL4h8N8cU7r6NuD1FGYj7TQSSv2lowgtrAz5Fd32tjuN+x0jwnK/SLj96JwUSF2N9KJ1bUkOvJ4Xcz3YuEmScukKs+h/GLTkvQf/4DoKzwkbtDB6JdFO+zJ3knLrDnbfX0vAqs4cXJzNgDmL7/zDcbNQeeiVNXP5ewAtgwk4+kJlB8ue2FViLe6XGb6qQaDerSmy9WRBEupkR8HEBdu4WOJjX84+tVMP9qcMkZt1MtnagE4MJwPJQxoBZqtff+e3WzSA5tTWQXzMIezjeszPD5JaYk7YJtgnlMi8cL0323L5c9nIzr3Y5v+oWK9WJO9ejLwV3CtgXbvmftFIrzyV+1wOc/3KyxXc7ZuknI426Lepl6kF9jXNdgmYuAuarqG+fCvn0Q5gq0k+nTU55mO9G1CyuFNTt+z8veC5zjb5I8T2XHFIZ9jlt7G9ven3D5+1Iv7yZOdvskNfW/zRRzX79j5Lqf8XCwZPl080BA1cq8EOk3Xy4u0ESJNScez/lTQzFVAJ4GTTp7ldE4Fpk1cNkzg6pTBrJ5+JJtkjVyQnPQ7oENmuotwfX8VnHpt8QxVvz+KoS1srGajV94QPi+s+1Zcyr11Hty3y60g/SLyP9ai2xJsE23IgbYdlwxNM/5i3cWvO2x9p650+++qERSbWEYFSN2ubGOV0rYdm86N5dLeAhVnZGgz7dRsiaLSbXzyaG7lEfB6SAkleg9s+RcFbT6uDVXyfafOQa2wVI+Q41RZZDec0v3LIC/fWza5NLeVIxoDNKwGBR1BMTyhXI/7cPq3K3s99Ib47lvtX65xz2xogVELcmbPVhez03gZzkOw/GSSZxEbPeQkT/Y9F9/btc5KU2NyGkU+qlkpNC5P5MX5rfGnf2NNn7F4Hrd8tUk5GceGYlrNjH/TK/9iWl5OjHg50TmL2dg/ucrJn2wC9YLVbZM014dZ3vkT3lPf6Bnoo03w4d0kn0wM/eJJ9vpP7li8PE/2zj94De98ff1dLCZF1cch3+RKnY3FbbSO1V/MjMQ6tn10h1FgPWra0Alvb4+b6ycXwJNJN2fBNxz+2aQE9DgzYdVkM6hvvRH/3pB4R+nLwCm60PxDvUn8Kso/CsEmdHo9hr3rzDGv4e3UV03xZTNgmwDWN6LTcomPmCKrLPY+m6RqdLk9CJxXenRzMTuycHfYVaJh6iUvLsVVHpilLBjr0U6bSStmRhW81ZEf/e9ZBfeCgGguNaZHK6btJvLjV6u0nn5uABCpbDuqHsN10RNefgpvc5hWfApi9mVaFD51W3iCvp3USr53iMdrBYw4Ow9rjqNnqNfQJ/tEcYCH+1hIA0Gn45OsjcY6PbvbeB7E89fmYsr3Y1Z7IM9fx3Cjc0z9VkcBi/0Uy6E4xtORwyef+hmdbJqbuGTfPnYM9mP/PZXctNNrdYs77myIoc0EV16ryhwDn7zx5IiGARj2jcUg0HZvyc823GE/3FHH/Tax3XWe/Hjk96lPN8NvjM8X8p+xHVbc49V6PFPGZ1eMvGfjuHw5fGXTq0D7m5zh/xjP/mYXkmwE0uRU4Okp6juedCfXqbi3IQrqjvKzGWWRFfPmEjNBv/XeekvjgeadXwtMD6TrVQR3rx064bdiuNly2TPCS3gxLna+74pdzeKPAs1KByi64Ivk3Q0++bxxxHcbya7Cr2EA41rWEur0N3v9IDMWw8yk80VnX3un87V5MM/IggupHAO9z20bBdhGMGx2srg5+PoyhODDXm9hjfdhVgZHaTVaI8wn8aXMR6FzahM6gjtlI16XZZTxGIpt0i9u0CJ008m2UTOAu7aihXXler4scZ+UyKFwa+WsF3eOABZLhvUSX4QPku+jmMwjPhZToh0+AjsvGnANl+Vn3rNYDr/P9jNdPMa/HMbYeN7aGOwmYz2YmUc9uwns7IKnL89hW0kMdn644wH49NoY29uAGqt//ACnn7+3WT372Y3v9/5ief6/eHwx6OfiS5ds8X6x5uTzuAiEbuMw1xfzbIbdWLRyW3L9ydBjvPaTfTAIaM9OsJIXQ8rs6yEf3lG9H7qtnrP30y4W6Ys7az+P/H0ZZSLllhn/vyqLMl5viQy5sb8W+m+3kb7LJH7b3SkaKl/2+u56a5IzptGEMwwE/sky3NQv6Kq7K8edVrdeEdkSrlVK/C4T8b69v89CF2Z5CdbuIzKDNjxjtHFCXZqeDe9t3+tnKsU4xNKIe943LkYwFctvusNow3MV1GjjSmA/lHIQbjFrniXXZ0xyyIKgODZK/0LNx1t5QsVMecYJJkXyfKUcf/EskgHCPCyDh/1suAaXEFr1AxwOkQTIrI2V+blJpks9jqCPw7ztG22deo6K+zt6gu/0BvpxMCY/s9xrqIo5eSkr4dJM3nTjr+lRsQg+eWmr749/8pdnsgVcJAhkVKmuzajhD/zTHc6p0+aWXOeNo7mP5IkU4Dgn91J4OP18Nz775zv5uB/Gt+766gueT2xfm5aSvh4GLrqfDTP9G3smjn7s89TunRl+7OLg8OGibA7CKORhPsqW11emOpVxCbmnnfoe6HUyv6aEUYRvPKMwwmmP9zMoJpm6+r7cGp3uY8f4XQZPta9arAAGLBluL13+bJKXmcSCtyqJsw3DjDP5k1/nWxarqj7bJPcbPwjvr6+yGWCEtjtR5MWrX9kv6+MQtkzd+LzjXXB+ZNjvaT71M13uSnvQufaqufJOCIb22Zy0WdSc+6BUNY3QjJjndgdF8s++8/N/OVQ57Nr9NIvb8pS5pf2t8UsCsMlZBKfbZi8U31DB8vSFlNMq5GGW8H8k+tIAgauak34NMQjHsOc3hnwAim2oRXxxp5m2VO0aGhyF6FlSAvWVdU6ZzC/45ItrnozrO55MPslt8lSaHZUn0uYUnMNnc/gPwau+2JG6odQ44YkfqXZ2oNoV47nM6YixhU95qxVdm0bFVb/nNi362pK/ty72k8eCDh7HybFb/3yrE4etX460+TUW55fM6LT54JSPn9Pv/ezAn7+H8xc2itfPNJ9/zn8zlsOm5vkuT+TL43ILo8PffRpdduLzP3ycJxv/4pocBU3f86/l9alvskHgvo56jfD//Dj8aG/Rv3yIfavnAPusTHMLzTqgJGBd1HGOaWtKXu4oKZ9vpPm48k/+bXZe0T95VFbYZc3//dNsxcaWZxIGyokdDEeV1C882CD5fyAM6jKLoUuj0HSJoRPWV93GEpEfVBq4Sxh4bg2qh1eWRLbucOvQv4SeLjH30/FHBubsjghu2KhMPOp+3yR12H8nuVow6tIBd3EZUvYSusDk0rFFse/A7tk55ulP+nThYUy6qi6ZMmJiOlPnJdjbBnn1BO9ng5u6m3+7s/6U5Xl5fh3bjIx5Xkp6v77d78cAw15wWmSpta1IxBfWVltd7jX9siCMcb4FnvkQLDrYrBGs5RIcavTiPi2jicHZeUtEiOla54yuJg5X1ZFML/i/5bPV2uccb6SPZJA9vecuh3TIAaUTQ6e46GxzYV0ch+P4PId9+If9ysNCHN/ZddcZr3htn93O+eMw2+PCe2MO/sjh+H2JMx7j/6mjr+TFefn+9DcdCnVx609ezgp/2CpkiH5nMY5f3Rw92cM6/sjrM8pug4d3Vchb+/1EXFtSGbo+WKG7auwzy4cvbgm6TBHepRbnj4OfUfrl7i1MvHpVunmeBy4YGrLzsrig/9Wf94FYV56kwAqcG8wy8xJQ7SbKmf8bog2V6vJL2zh1MxOqfwzHdOH9GMypydBewg0me/osL3XUEsLc+YwP/3ic1vc33TQYOj/mYFjH0sb3OIt5/guaMVHlKVvpryl9Tq2N+kNq4041IlH540xB6MYYX0VlOLJbjVKNTw+L057ytY+f2HbRdsd3F2FiLDcHcCDQtpCeL10gT0NfsVUrGEPntbW0UCy9w44JpFGeISO7POJbfDsmfDrjuLKEPbmWrbZnojIuNROeaIqOeR99yo0ToF9VFtNcogdnjiHt87SvvKc6OsUS9vpiMNxGM9nDxXc2j8er7F1pw83mp/z1h1sMkxkXeIKQ7+mN6av/KRe7PL426C/mOC7HOF7/5WTuTwbYeL9+1b2aiFp/5//qH4c6gdXwBz4x8vTJ7b+RXPd8slN5UmfjhYBFyCq+33VmMNU2mlDUyAXzW1PRKgLddfJDy20kamfXOznPfeg0ag2/QQKUW0EXLndgXT3v8nB6EnHarxRlHwEbJN8WL7aWjNl05WcU67x5I8JPnj1uxerjtVM7POMfnXVFL6xRhSW/2k7mvW0h8NnRv88ikx7/lTnO+iir8oo3Hwr4WKHoNKb9FvX0SM+4ebIWSTq/VdMkpToivb2qUDZfyzZGfk5ccG5RtveiVj/J9cCW0oXw6mclep1qfufzh+djkHsXdoINC75NCmJDdvM1xSvdLbg5bP5/fMMl9NHIma2dnE+zYxF2UU93EP0Ez0DLBE7LJHcc6OuL8TTixerF7rNrVA7mkbnnntbwcHdWbnMO7Lohvelr0zm79PS/m5r1nN/v5jb+7Djoy83sp238yrN9fJ5ff7px/o6b74f7afNiX25x4/f7i+6Tl7t55+tqQs7FefFwSi9Gq9/Hz2Yc0wUcTrzCa+O4VfBTzpzpMyOw1fsZuUmG3cVhLmvfK5KriI20Lcgtz9u9lPPEWvwEsbXx3nobHVDgfXkidVcVY366IXxj74MSc0hGDNiCMeouhv3hENf9x92nl5+ZoPQnVyVidC9jQ/BXcdTvEOR48vUVB/qpn0m3cM+eV5neZs/Br/319lWYNAjCF4kR0a1QjQjBVyZiqWSns8rZEHLy3fVdtVGpPtevCOJOiq9ypZhIFMb7DBTdtnc7jxxCM7jvwlYLjTPf65fAiZJ/dbi0BCpvZooc/NLX3xleLOrFl99Hd1kI/dH9RPwo0P3Yd+PxTYRsMwN4WAWP7nU+y+RAxd0MnFGn9U35kb308wH+e8cIw5luE4uxIO2pOvX6DOLi8DjVdwcm9vTx00/+bGBwQxLkpta/kMlmm5ZL422M5unTDalNTNvX1z7uwzMQm+1vmMc7HSZwHJZ+n2ueH/lcup7z9/iMT/mdXZdyND4Mp9mIkYfDT5l8Fg9p/OptX/nZae/zsAcb7uSchvG4xwQMzk3r6OLzn1J0u3egbOWw6avDFt6324baXze6FXhADbruHK/19yjN+P2FoDYA3nZ2ifhrPyj3d5IuHZ31y0FEhkhf9SRvszAmP75EIdbL0DBIA87VTkUfoQ7h3tzG1D+d1l6zZkqcDFoqo+MU/1fTb5elpmDsh/LbH0YOHPerS9ztvrEa+fVl04ehIC8e5er9P85xm1xYYFhUa/Na9hto6D99xLokRfk0Hjue/X1VtV+epKJeAoAA88yujUbDjSsHGjbySjNPmZvGypXjRb5Ajgs76+Db6vmHFif5yUZ7AxW1MN7ryAQIlfMMUejwTRBPXPpglLres9k5kvTifsrWV/azvehFx2stINdvz1gW889NbLF40cImMMH5bDwbvXrFeQGKG2fSyQto8rc5bsMZ7WRyfDcLOZ68L1Jw0Dg/32+pjc11Ll+bJbHUP5lzKubp0YJTJm4xaqd8G+/643123/z6VzzHx6nK7a+c0z9OuS1Cv7u5rhWaP+RT6zFYdnE9rHNTTHPwaiYGzdmvvxzo33ymDHXcRujDuTt+LTHof92yJ29Te/0EKj5xuOL5JUaL+ZpGtRO57k3IdiK/9abaaIiyP/Zgv7tDXDjb9FmKZjQ63pqaOM2xqvRyA+JABH6+V0OlWSOBeNWx4wXKNcrAjwltrNUXvss2vhwoBehey5gLGHfFFNcv/pWpgZIKq2aqrn7BI94JR10OxudHrEgb32cZCZ4sOwZZLmiPhkEi7nGuPI7bcFAU2yrsBo1OSUfSiufooPHiToZcXsugzBTGNc9pH+CwszSO8e1OTTOX4fg0scVJIOWpFsWVPr/hjic3HN62pr18xeaB5nwly/B44Z9nAT0wmseM3uH8ODy6aX7Ii4HxmJ3l4zm/GWRsFJeVXdpOxuJgc1ORUWwDGWr6bwy+Axve0/LzorW9C1tyNw1di/AsRnzn32TTPfxnI8tm34fOXts93/jd/X25v5jxzd/j7Jtx4lwcv3MNv7g/eJIPa24vF/rPL6LuJDubEyDr9fiNE3Fx1y1+RauJerHq9Dksg6e39/SJZ2c3fLLMOsSD7bt+jNm+cp8dEOjqDe22PCea3DygUX73RYah5Qfd2hPtekCO+pz4rbf31+DbsXzLHFDUwsnEDHobDLR7enQq3Pu665Sv5YbZvS+sGOCNo9R06lhT7AyG3cb9faA7G/5s0ODY/kn0R9/vmkhWY7kJ4GINadgh5kcPonS6MjkYYZeZYUvU3eOgIgp5vkGzQ4dREe/Oxm5ImquS1328fsP001wI4lVB2WcjjhTYHtFnnDDV68n9geHpSjIhUfgRq59l66U45PJzZ8ugIdLynvZkSLVTK64agrLO/qQ7+7IDyWM8z06OZuy5+XBDK/MnpsJg/EkErb5tul7/51HZ7AfSdPbPTvmzMOZd3Ld9qwCuP5fyWxJb7FrOtkuhvpjgcdrPDt3bOKfv4vvIxi1W2+neebrDp6MPUPlPvP09jeF7J/eREbQ2/a4k2N3pPZ7FPU76GL1432eNz664yK7L+fk09xcPOro/YlkfSJh0hxHY766Ax2r5nA7R8DOMc7IEoNR/MY2RNV2nE9R8avL/b+4MFxzJbSPsu13n/R84t5f6vgJIanZ9thP/CEdqkkChALJJqNXSzEzBhmI1RiwJy+CnN7KuTYm94PrQplNjqLqul6w+/MiXKeEijUnqrmC46QRrInQkCTXCLELA3YWcBfieS0z+Cvpv+W4lCz5kEAHIky+P06Ado90RBcIRrshZESn6wG+w+mR108cfMYxPoD6850fm6B1at9VgbZcWP0obAFwMyvQgzRxOBWIMOj8MHY8IJwaHkANMxugY167zKsfEoGkwRIJnJkuOeHKKCiYqLTgviBRT22BWdqtf4jNFhBcLsRHyU9ooaEGNnCYiG+VRJSoaYBw+CrwoOlzsMZ9Tl2Rdee1od2WKI0A9pkaQ8rK3/Ug0KurYp8G4ROXQdStVZKtoH5BxHEpYRnYgu7lHI2f5CddkE9UmO2TQdfOGHUwOraPLeJkL4qI+iev09woOjrXbpIhNZSSf9WlSjc/83tvlDTk/8qe9vvRrvNgTB/XGVM7GNDp4Mi3ladwxmSvL8sLpz+FLD97gqKNsXNNXNDLaAIzFJky1e+tRUcmLTW1pFa9y2tV1XdvOYWuXQTNV1op7MCt2AcMCuMthyNthTOzE6ir73r0Wikl+s637TpaNmjM0jiZqZ4yVakzqCXxj5D1pPCX84JmaOGImN6C1q0U5iJsWwYCzjdAyDpVW562BgK512/3yX8QNlSGBSUCOG6n3IyPbcEySh2caGy/d/U9r2C6OhrqJ0H5PmBt4case4eYi1Ek1kIswFjCZuP1QmKuzQm6yE79mMW0YsA6RdHnlDAk6x4+WMjpPDtTpE7ETwzECZOCQszEkRk4fBRLmRhjaJsBKRpe4iwUlAw2t7UekZY1sOz1gWKFTVHPI8/KlM5SF4svFVv7FJkZMt0zIht4N33iUD3bx+waDpEFpIosXcBF1s9NGNv1pkyB7ZVVdMRdX/Nvf9st3ZU1m9PNkpAz1+K2cfhNqde2je/tpx5Y5cxxR9q125PnBnq0aKvsbJ1wR1SYNOYkha0Isem0uBgtlg4OA2FuHbPCpaIqltTzIirE17VkzUbFG5QOXsvjT/pC5eMNNxCi6NnfvrQwW2iyttmdfiFfIv/CCJrheIsDFSw+S2OQQH34Qbt+PxcPITAGK2nuaeEqXX3vkbOxO0HPk7FjfkuO0kwJ57ZFNgTf2OOcu3wSB0kD2U2lGTTgtb2edh4PYDyLXZnn72dmqEG4gb942bu3KyULZSX0cEnpIjmbdwPi0H3/iq6olvuEmpFWmX2VrqZq+nEayCWV811dkx2kM6Mqb2GCugV6cSyD+AZNiyxgNnIKREJGxaf11cRlGsCzWnHDUOK1dCdOOf+cbrvQiF3IjylJZGR4p4RtyNuQWr/+nv+dPzuAV50CNzHEgX+4I63f0YyOWtgRjl/YmufJVea4O9VGfmzTxB4dvX8NnIjmyzpFJJwew/koD+GQtrxCPrFd7YqMHa3KMYGVNlvjKzMORePY3dzgX6qNgV9UWff3KEYNvWBlvdcjLFYao7A8XcseXudxYi408QNpwsUJJ4NgipLKd1nJGJF4I69IGUig6RtvILcW4tuhHXs7UdBLTDGXQVh4SigUIdF0zkw1cF0RcR+d4KCuBwB0AyZR+mONoRTPksP9oPBmDH+ZEz20/HXCvkpmbT3z+xh/mjSb3DLUBZSTeLNMLynhG4xAnTio/gMEWjoxGaFpcqUyUWLUQhUMkLIsqDmBTb/8ZIEJu0R11QecIvbfwOBXusJ1qWJezBB0Acb9JUqcAGjHdPBsp47Pj4jhhVVQVZ5L5idu0LCYMpnhxSGcewPS0r5JYEhMKRF+m4sQqPAdwQtvAVnuFgmYcoz9BE0JHBfSIx7HnLtJFMEvGo6/IXbGxCh7mchUDH/1Z1drVuwrU2nlmNKmWoy1p07JOBDN3JFn1Obj6ShPZzFf6s6rFKZdzY+wmLl1tGCdxWEOeDgvfvu3oYgAvdvv0qo2xKy8HPCbZwa0ukLEP7uWKH/liSITnK0WvLxPp8BPP0dXW2JYnOny+V5swnxeMiSMQ/VrjOf0+t11uhFGpMxmMXURYqet8FQSWsjaD0F65itouUJscrBV+aatjTRtzPwdwcQHuvmXet4Bj6Uk49WxH392tKvcouXcY9qxkfhpApsqoeR/NCudWppuAF9hoSFk44CySDPDTK0z3Q3pNP2hSOFv1GIXJMT2QbtKcKy5s/0gILIMUomgLt9OOWxN0PStX0wg54Re6xrJxUIWUhiuDOj1GjLuWg4iGCeDYt7GEu0lIDvW1AtUgozHJtxdbZxUUtm5gOxyYRcJBYd9Dens6Kjw6NaAlO/Oc4L3XqTyH4JmL7TY2vQxvMV0ygIt8E5nGemIOwHN8/BcwppFH7dwMFCtXRYI8cxuMXC/v4amGFft5Hm/cgwhHW/CCnZ7tousHub4Hhyv6TWp1bJIUVBvItIuazQQ7K/LUwdqnBpMaPLLiUqexyQkdH56sn8rTPwlssa9seMduuawf7sNFfPgfHXNCLPuhzSZoZOpmTAc/41w7cYwYzhxOPeNlwMqxG85UclPXT/qjTwWbWNprC0AMQgq+WEor3HZVnlpUW8RNh3PB6qSIyQEZ3fxGzaroKtwDPZVpqPFwHbs9I8uqzO8UMmN+os0QA3KtkkDiinuBRpTLRq4QM0remSOa/xuTlvepANaZ14VxwWpwuwRCiSW/Vx2S+Og2d9r4cIWv6/BlTXFgCSXx7Bjpr64jM6VXSsD4GoxABstj7qF1/53N7OzAubzYNJNpzcHRSMmcgJ16/UQU2lKJJ/Vo0KPjpVkZvgj9uKRD4UNy77nSVtA415/3NvLCxGvTTHFR+Ccm7MYHihSphx/VJrERFTRkBxscLMXUFe3bqpmeUNhA1gaxeBURieqIa99Fy1WyXAQ0OiwZ5nGMILgOh86WtneYQ6HyZ1Rt6gvfYxuxrTEwyQ4h08py5QzRlj+H3oGa9R77TQLW8IWryaQ2yFmJxfWt9uqpmyCxg3ueAWtnH9v7NhzcflrNOD5xT1+OJwb6M476T+KMrGNuzPp3DJXDzdQs3hhHf7GNPWHB3nkCIy62g0dPqfwTh1B5IbYhKrZC2lWkGjK3+GszkMVSs84P/gvWbkDiR0d1+m4Seo2ll4LVs/2/Sw6c1MM6SVbw2zWsV7x63eMn1tJnMSWx5umHHIg0OhUSviWPaadOz9klM90nSYLEHfr82fD2ECpmYoByxcduyhcXA03Te6INtlhBUTFLSkqQ7BOnHb5uEAPgCRPPbiO2sLGi1yJd26nlLYGWQNlRrYOKVDXaluI8qmMuhIfb2UJF6tMQigiQIc4zioanrB05eoIGBTa6EMPNHC0Judd5i6Q6AD8XdYhDQwgyjNC2srScYoBK6/d0q+/5NiJvZTizUcFLocKaI6iemPIpzoGNZtEOXSQxxPbwDN/K0VZUduLgyr029dMNXKTysYGzuNZNLrGFg7nOIgSj3OSDrNyuZnF9q2qiSb/y2IydNe08sUW/V5mV7VUnmDf5XZvFR20832MoFzOUS0Z9MEdplL842jFpkkQHHtnjBz32K6POQ+zOY/Vjix8w1mnTWvzYRuUYBYETOza2c6AeAHqa4qa9WvYCcc9qKKhwkBbs1BPolJVlBSRcklgxWwO7aDqzR1HMGq1Fj7lHmcSYq0pgOMvkTCKM17P54mm+Y8n64WozKItLZ5MfKyokTMBuVNq+EQu+ty0BMHSLg2DTSOfirCK8EeKMqDJOunl63YKfRhuduByqrziG/k02ovDjANSwlM/4AzGhTCwlh6V+9Mt+hpoYHFqajtjxodt5MICgKNqoSBxBShWA/tXDNrjUtnFBccyRYD+K8K1WjskyYl1GJ3Zg83afl0TC03lvH3QS8Us5lGlnbOAyL0rxm1IZ43ZEkRiQGCEz+AlTNUuB9SodHHl2od+5gtd3AQPqzMp45yixeGZm0pyBGaduCTeNCcH2Joa41LG6BqqI8MFQrl3b+FIXBb7w3qvM+miy6NUefvUVKj+gifEm1ftWt/PwfnCDHXhs+4wdfiau2tLPKo+QZe5VKDb2g49APD7H1qtFesRD/GNLsv/mWmc8cD1jmT5y5j+w2KMfTOadmXIO0lA+sQeijvSzeqPBIAU98wmINg3mVLvFyCBkMIMFp2Ht4dFk7FkOFHf14eJ0N250gWqDOuPLKptsRBqLrJ9JDG/6FGTr6672OkCeREn4cc/a3QiZMQpZqXFHQNNogxNPd0y4Ci2wowrEt+p9W20eVR/t71kqbhAEXPVhwbDz9ju9DbLOoosWSPnTMrTAJwTV2BsB9VhqhbC2Dbbo48cugwiGmACBp6mhNXAUdb7QGBmK8uhrQ++nckOK8WjLF9+coRQTB3HgLMVTS3vPYGeA7K5jBrq8+PbsGBC3MZhPWS6P4xoxKrGdD3nso6c38m1GvKd8VIRRJDHDl3LPXnSxvfLqEXTS0iDogHQ71vjVc7jZ9BQ2O/KIxp/djBfAzkKa6Y+Jjt30hZoEiNI5jgxu/PqMFXP3JgliBGMSEbeYta1+cRDB5WbRNvoQwAlHuUhi+FxdfYqJYWMaLC8S8C2X9fTFgpu35fJPf/j1wZhIqszBsd925wpdE11n0xh2LqIMnX5iXg65kHe8Rw5QXeJo0/mol/KQiIERS9dBgcpWjmhw1YJPi6UyxHQp7dcDKwQ1NYX22jG+LJ5VofY8AEa4fJybJVhbsC35FUnfEdOrlVeTDKYZhiuRKOxGwro8BRQiDP31HHQRYDFAd5Ow8MMz5uavOoSu9y5pPfSNYONqHjzqNMzWGBspAr3u1SuXwGyuiQ/ylo1h+6kbLfG01E34WD/8fzXPCvETVENKBgs1Y0NSiyDbtAuexv1AZ/VE6ulMlVuzfsumN32z/JfDzFs+WBIEmhRPSJjjnqGrbCjV5zjIDUsrxEuOEXYAw7GDkmrdoB2F6wG4ZXymjVoa5A2kFbrELx/HAa3bairssngwi8ceg4RYuxeDQ+Tl2Jphu5+ADpzNTwHDnJFgEK2+bcY0+vG/uE0e+zYUFD7Qq5ua/kmEyqoHU2x90O9b6chDVP29EvSKEJso1k4MfpFhg39tXx9wtc9y7RfTK2Ns9UNNHMg7J/ZnPtbfTEH9RRfkwces7cjgod+amdl2GtgkjnNOvuBFYDCN00x/29uAX5iHo12186Gfq1KXc4b4IbTXQ7AP/MgO4kPp/8xBlVDIdaxg2AXFhzOArzSya8wL0ucyB4n4oMUz9UxMt4G2PSAeLiDokzx2m5U2Pf3HovY9Bu8lF7UkHCxInIWdxUg3ScZF+PjcFQjDmpgYGDxT24SN3cp0z0jkVS4+B3ctkjFVjptT4HKaqFEooEonAXSWiAM69I3KQeT1iG9InbsFo9eZi21s4OZUXPrrC+HIHbn+ubJksJYx27lAs6oLMPAgTT7qS+wUCZ8xJArGUu1M3OlHunP86WLwDmPCooLlAk8rDeOQrv7YzJYFWXPYuCY5LGPwaH1miQoPH8utyWI91x764tPHVvtgw9FEknp4YINjkxtYMOcPUky/mPCG5F6lto0OG98uU0//+MIvP7G9b81rs5j98viJMXHJE3L48zhJz34OygKqfv0Gi//gaVB3/Mhqgx2tg5t+bdBdm2Lbj3h0re1DMnIbtCOqdCUr+xn7rhrGsQUO1msSlNLM09kEYNaO+q/KQ8lficigTYLMHgkQdYT5oJuv/jAlpAnOcjTuayaPT2pNRsBIrlxgufW4zyXCEctGNEQ14ZoU/cs62dJejAo9B9xBkp9YcVcH7lGnxo2D7A24KgTgLcUKQRyaiHFM0kBBJRiadNseI/UrQRkMKM1cLc5WGToj1WFzywQfoXLPYlq4E8TQbvEVx9uDCZeaCRw14TENjXWE8GRcag5VugyX02gDrJjBMQcFnyHztj6Q40u97r2QZnyOJKYEdHHYtccxDhLPrB2wV42CXVpQ5PVXPuyKLRdqxzsER+8uvP5pCQl+z8GYuLnrLBKEISQJNX7spo+zCJGbEODUZOqj++yzGqD1qjCG9DZhoeNUtz/yCOBfGZi9oiTB3U+5a2vS1ab94g3VcZAs6yN1iBl/+9T7LP7I0yBm9NYMXduLiyq68UlLP62xaZ+6HJVdPcTVDDY2lBcvRpwaupatjyBS5mz7R7+iEbijp81asUw/c5tt5a4x9lVTL9+kgVd127v4piZR9toL63xn3O2kMoJMihvFG2XlYOAW1cxaMMHnSMdNw0lIjPagksPbZvawREp+7iBwWkupbUPFrhcJuMmRtJ0YME3JAecUZnaadI/3jxeTjubA1tZhxN1L5WhysMSjw8ReNzM69GMkHjAzgXRNJSCeTpPdJqNyBQn54LUKpXedoaYNK5xDmZ5N5YTNYPEABqw+9NdehPj3fcDhAHTRtEhivS3dDWgCNzaiq6E4LJ0sZJJj3agi+nAh5Nqfxbn20cNFwjAad4hk3dhD5ulNmzHik6rzxkuplqPDf+dCTJZQV1FHgA0c9OBUquxJEsi1G5vhMClNG24TT2zh5wl3ryZ7BQi/yYs6HTBNdMSA3dqmlhd5cavr1WKxbXeumlB7GdHf1gnm+Il/ecLn6Vl+5q26+m98+BRnjGNDPOG785U2/X2OHgE4NPIMF53TVx8EpymFsZ3NAB7SKTS3Gwal6nuKj87GAF+b5TEmUgbK8bs6zb4YuRwXQC3o1t+5YHMAXcuOrZcl7MVME0c+H5A4R113a4Zmwk+j2RET2SetpR3Rs8WZ1qaJEJEI/wiFIk5t6ZigHRtsMVdnm5ZJM0djzpG6pms2HrGoAiMG74VY/izbiqEH04kKQH5iu1FrIy4ygeCCoYu1a6IhCJtDo27HwIw4aEoEtBxr2os1MP5APFfsgXECkLVtpGPYWWLo8xBDRE4XXuTtX3PK9op3guZ1hgDyygVF2tcPVLVXNsriNRK7GwOWz6LDitY/HBBM33YQ9Tl4J8L5dLwOHJaCTkwGGzFUE7ptLo9YPZTG2s2oW8FVLoaEh8S30AHZzoENzORoF+kmisrLrW780d77ktiRDK0jR/dxtRjnTX7lJ5Ymz5XXPzKTIHxiNr7pv74ZB7yMRZ+fXBtLdY0nMOMgvsY44wro6BgHOPjBbf22o3eurIdjZRjbLo/dEMGlHN342L4OXQ4DAnOUw+96QNiC/kMUQbxExI4cezAkjEmaco79VnAwR29B9hb/QCPTawLorPRlSodCe/nCWabEYfYic2SPSOnbwZt5YKGTSc7Kj7mppXpnjohIYqVI23f123MiFI67CJpBNMDfQOHhqpV66Nt2zhqWqiYefGPacdQIM+lsTHIqGQBbJiE644omGy7/6iKSGO48DaZG6RgTRjMZ6xqcQWAuCAnnIMkSqw6QSd+h7looZ7DhbFzY50kynPhIkNDJDBvYnQ2mwDZaZ6OfXc3puDOgYanDdH9PW1boo5v2w8hmYHGojp1Lw96Fe3bAWYYjVRcY2sQ13GiLAHBNVCOKK8QmtqMOR+ScI7RU4PU7R/ErT004i2vSqg1tsOj6DMvKYqSOWj+DC5APVl5ZrwaXK3Vsyo3t2g+fXG1vUrYOL1jajiY1N6nobszEyFjbx59IZdVVtvMFNo88GVfbO96IHSt6bEWlJgaMEDEXo2q/KhSgBmPz6FdRu/p1VYKvWTkBpj8izUZ0cBXencDKK+/lOoZP4ysnqq+y/G7iLGB+S5FPAYhy2dk7fvlxzTIQb1sawqC6/MeSPTvm8HI1MzchKy03HOm79Z1pDye8pG2iaLEBHA95bqJ1MxtHcewG5wjc7s5lwR5xNckiZJabTUYt0ZhOrqhfZFkFmBsYXDseaP1HaS+JgCcxEEfGiJhmxyLrQ6NuF8e8cPUT8ZiAM8V1lXae5VpOQBE43c5tIo5FYzcW7BvEYHkJPAOd0OLoxAB6hgVsC02eyqDcQtu8HO3xVcMJQ2T5K0dgK0JqjtVsHWGM2YSjsM0I6SufkyKkxtAu/IwB1Xmm0WSBLD/26xPO7WMgrijb9JtAmuTePsmqV5aDebgXBz8JzgSV2kQa2Sal4tYHfBe/HNo6nkl28bN8G/ti6Vc24398H5uNE07wjmPmQ9nTXszg0sX62GFLsQ4ZddutP/VCsVa5uGO/tq/glSFPOZxu0y/+RlbkPWJzlu9pXP3byn9h5L13/tw3f0x9v9SXTd00FihsXY1psG8RRWiW49qFnen3IasZLOmSnyS9JJgdRsy4SvJMJAMnVRksKQjiSZruMdp1hv8YMpI80262anJtfkR3fXgJ4S6ODNPR7sZ208KmAju33WWQKlr0KPHvP+UIDofol5SOcXbEsLKttfTQpiaPP8wyepykxZHZKi3cO+V/fsv1248seVELuCHcOOI1VP6RJtwz7x3ghMJw1gODgCPfPqj77FZnJ2bJdPDktOKUmQHs6J5hSTDMchkzo5f4zkBP0AQcPkKT7zFGgh07ewote/JVXlnOO75+gUU/7mV5k4kTGADz2mcdnEQxY1sdeES4oU3d5Ias/fvW+asOfZ+bEItlide2nE2A+IRfHzmsrrK5Ig1mudJ0q+jDbYAuVnLUHuzlXR2yO56jx+PgU32208dPIPpce2rKwU9bmXDiqHCgB9tzNHogCwCfQre7ezpTYUdB/57n009jdmiXU1YzCzxlTbWV5CtHbA9oAanhpiRRslcJq1thwZH22iAq17pw7gXNxsH9sEyeyOhyaqFTXqbl0xy3fjOIuUk7DzcvoHaNgy1qoeKPbvBdRkqOcOO4Q2da/KJjZOPJhqCAK4OGFj6NPoJRKYOaIgYdnexEBkMxtvZ6BksrED4n4uH0uwT/nVn5npuv+SPGeQs6LKGNrdONvzokLRFi+mSnjNcYcvCRA/YAuBLnfm5E6xax1rKgmNJMp6HwEPBWGCJRjmfamPifx4gEtriQD0U5nTmDaLRKnZrqQVK214ATevyskCaFAdxzWJkwYhPjFKhQHlnPRkQZAwkkJL3PNZzKAua/FGEDHtXarwyhsjSwMQ7aUEdQPLrRq6vcZBckyY65FKMP9sXg89u4sH3jVOZfjOR8/8Zv6OIHf9y3xDZxZoWhjG0UJrrI8Q/X/mUg2+l7L3J0i9n4exVLjBMDOGKkn13cdnmx1T5RpqmOcVHoE5t12ojp44dSObwjYz2gj2Yg6jhoq1UP2FDKkdr9+thVLQAM1JS3DaclQuSuAap0ji592q99Fn2mQofR3CLHdN/2RdwWiTIPdh8OOXE4SY98x3hz8KqDDcwHDDM2YU7h2EfQb0cCiKxssNYbbGPMwNZTlRGUcGagUmej/zpwBFE3QMKjE3lCHBfDxVebWIl1EaHJQf61GbojezCBEB8qadPAlRw5AwpRgJnadg7ix/JPXtIRkOTgoMocaJJDfTAKM1+HA2x4eHVoexzFIBfvcZ9Bx1UM8mAbGUoP9adfmoSCXv8I8rSvEkBEu6oMjldNFsFOqWElQkyxbKEF0rUxkyAv8oNLK0JcrQwT1PBZJKqW5kXjF/u1rM6kImM4RleKWsub5lp1ckQoky/dJhjiwEf78o0tPH1GnwZ4kyj49LU5tt/YPWSohIxnMBB5SY6dZ6k8wOT2D2HBWe7xEXvj0GfbvTLMck5MG//eczxXkSEJbbmIAfdypWaU+EQ+GFpvPPa1AZ+faTs/+PVZeZq3zyRt/7Ff2anR0UkhLus9sIyU79lXffHoKjIulhBLQJpRHL1IEbWZnafJ004MBUEVeebG/vLQ2TYN1u33Jj+3LaJhSJMZIyRfkNjhnFKMWBD8JFS+PEk9jzqABqaAvZ9JL/gI3HZg4cnzhCPzSu1cDF2S9GTxIYssCp4IOGEljCzDYlUNAwNCVTV4MkIEDCfQq8MkMh6IUbSbxnAou8LDGeD5gAMOOqzwLQWSlGxxcjofuqCZoijHxId+F2F0m2CIh8gGTqBl5gXsw1cQxVY6BFS7UDs+vIVSbMj8k3kTAQQ8ouSuQx5NBOweHKP4l0pMgwM806uVxh42chHiALSHy0yEo2PdlMlWAJ5H2cBHELWrFN14IVxk0hze2oLxiT7tYsNEPwfqk4yCUJ5LNJIOnLm32PCSFFe2NVhO4eHRHjt+yyO6EIjJAR/wrW1r5LU/usO3OmzqB5vji7bjmXEt/45BmxkPMrA50Aq0z2m7DLEPhqJ+cRVpqw7987QzmLUTFxBrsdwDWDsI3iUx8kWh/uBdhXUNHZFAqEhXlBGUPB2wHa9bKt3MnwTEaimdTT/MsYWWzTDxp24SzIiwc5OT+LrpgsvDl05MeGL7eko3V0AEnUAE7HRzXbRxN6ZuAVczXH0Uo/+gcK2XxJOzCjNlB4VOe13iYB6OSy0AHzt1dipts7AeC9Un1DPGjmamYX0zPBZpg4k5q45Chc48o2RdIskP8xU8sxSs89Kxee4QkpKun+GtyUxhmLh6bvqvE4YPHwcf2AWnDAj9PVITTQr3J6k4FGuYLKDjIFf4XCyJKQz0lxLjulD+NCP/6AnbAa4GSGFI4imPKyu1WOYt80Xbp8L2SRzOn1UOBJydiS9V2ETMqfLKSdzK5OXSIPC2AdN+E1IET4KE633LnH7e08JPIjzfh+RESVx8+doODDcTU2M1vmT56jahVpe/IrSL4ze+YG18GRdDqx0xp4OA53DTWxm4Yiqjv3p1dFPEq1v8yLWvQsyAmW79pWYdjumtV1AasdO0wvavyvrCDwUP7KXjyQAqL2KPi5g1vxF9IWTbRiQ9jbz1hoA+yyUtdqurg+6GkZ2Ry8OTLNn5wVSrY9tjkIpHe2Cga2KLLNcnWkRxNi5ivU9tP21CyU+OoGsgrYdxMWCrYHj/bxm5lGFBrGgmaFDI6qNWDhlc9AvR7kxbdXSzExgCc+aQmBJtGCJXtemo35fjiEw5qCQIgiFuEQxoBdR8uNLExCjymHlvfD0L0fC2HNLYSkNkJAblTlU6MpxxnfEpCX4FwdHMBaanrWchoo52PjAauro04DSnjEV6iHjCh946bUs62kTOoK591dhRWD8tiT9tuitCY1uZwz86pv1YMhcfWNZ74pQs9bd8mmVb3CYzZWSdk1D0w6mfpLl1bBdD8vWHeI4AAByfSURBVPMZf8hWzje+evVYrIkVvgD4AUdC9SqWOvbfuNnJiU2y/J57nfJmLOXveM/b++BTPpKkOGMOP8l09PmrQns2ScPOWYdfzogszQoxGo4Rt4+z97lKZKcdvzLNIfJVUYPbNbFyg4xu5Viie/u0VzoRh6sMX7FC51C7dn7CsWxTdoNBx3vmnIr84V5WSzJgwvAz7ygjMVTOTkZJ5kzJb+2wSWnaaOJpny2UFh0btrhdnZuFOQ1lGFPoAYutjZ2dBr3py4Hrm4Pn1e2UTmj9EIdI7MZ6AkDHkCTt8YmrUxHxRgMwo0LCuDUUj6mNwSakxG0uUjI67y5kAeLOA/53yERyHGnQcNOUHlEowZD+qsz2EEpALf1cbce0CxxHwzM4witXFH09cjYdGf2Uxqj3Wq0Te5EHjIhYDop2T4mxOb8MMqi4jMykI1MOkThRbmpmgPOdH2Y3KyoHPORBYjhl/KqiXYg4AnH3A9amhmAUZdDqQx4vRiNBweqiTxjlJXm0jZPaZniiiSkSriYPRnz0TTprq6ljII69l1juYENI2w9lwuSHTN/DSxS8wDKfTxy089nfJEnqXo0Sx++/k8QXn3p/0MlB3XjCc65ywfUDqGubMzVjy4AyVyRix778TGgK5y1XxC5fVpX+I59ky1bJlMYILLa26AQzbWQrh2j7Y7YW4llrW7CnvzzKY7Rc9BfTuRBxDusHwfIio/1ybHt14G8pWl2WLLdLUhwGy602zHpweaThlqEOLm3WuRatPNsIYlwV8g1p23jIzLpZIwOpOcPthxYMuFlKxfTYjGDh422htfysHNmhi+T6bGuPq9EpSFPHaCXARXgf93iRdKbjT17V/bNx9VSH2DQG4KfcKYoosR8yfTpwfpeQla3XNHXtcgUTiGRMmMY7seDVTV1orgwC0GQEQaXF5cswyZK+yRPujpuWQVnnVOju6GZ+o0SEC/3mYCqi1lDXu4LYUlnEgjQCM8NgqfS0kS6EtIsnWXRUvnplQ6TfB/aLFJ9PkDtZzirYRJZzhXuGkz9qq147bOHhQEy2W7MKESjDA23rwQ0eHBiSH3oSBbImK64E2/aKEJ0+ZGLK0ueQIMGNve0c/h6VV5sxkne4yo3tPueK8+iJKT7yXH/E1PjqRx9I9Dt4MNxvnTEZpXbo8dUkGbPTTtMEmSpzwDx3iSHHhtIKtitDjp+/KmP+ydNlLSl619KQvO2Xd3lWdvpp7DpUN4RTHRGNcme9d3U5lnnrLUVHJ12G5QcoT2yc4JziH/mb6E55E053j1dUYY2sUxdv7gT9I+sEsnCh9F7nYISwtmcqiTw9vFDb3bMgEcOg1HXbHJGPjhHGRooBNJdEj9zYM4p08cyj3tLEV/rB1TkvyfTnqhG6jtPI0mPQSrPwxrAfcoHERSPtQOggVhq7qJcnDZpypZ6GQhwaV0fk2Eo0Q9SxBBKGp6ydx5pGYwaDOhLua+4L17hjwAZsWJ3fE11k+C0zQTZc9cZcS/p8zckAWDFwg+1FJyMmqLEui1d7cLDsdJNNWmKWnFdAEkTW+UiNnn6evcqJZmWgCD9kfh0HDNiapA0LP8j6Q3j9qczEFMmboNqODDs4rdunvVh16MU8CWxl+E+7zyTJtPfPoqWp3dUvLzzY1Rbutb9+GQH4xTw1sfKMTltGC8fIkVGQdS6mj2zk1OHOmSqYeQfV3t1ti0e3BaDyFUytbQl+1nyRv13ab/+L8c/dDQANbSMvDB6709g+c0HJcuUbf7TiNGPOysrWUR0IDyYiXwTM1EXrrIwtsPzBGAwzQZjkKglCdxp92nSAiKkfemeEkoG1gcHY0UCmcWv4OJv78bJq9MYWKLsMZUpcvJTQ2OcAgvhScmUHgQ8FiB1zgIUo5jDEbTkqEO74NNiV+akTsoDTkK5TIglSOTnYUNxDVPo9Iudap7QC34kMjVNPBvmJBijn5Yx+jBGHWg5cMGUIuMpkYGift+bhAHXp2+0kkBE6GWLmZdM2BwbMUJyTdmzjaYLAf654d8wl9/ThkVOHj4AzRm24P6ftR1zYA6v9hx57C1FIdWttRhajTSrYm3CCN5GMrqE0uYCtbq7+1mZqvBHPx33IEJB4jh8xkYUI+X89nPi6MXR89M8V6okNXH0Vj2f87LjKE0jjHfmNAYGPjzmESybIVo8kbbiv7C4BoTn0VLtsEZ3ydra99YK+9hvZar/0FvyswYtMK3ogql2Lt921Xsy7htfm5dENJMPHXw9y03Rpu78ZdbpBeJn3JenAlkUPYogbTnYHG8SrtSYz59y1btQ4TYOtmVlnYiMouXtbj1FCuwaYYFBXmvMqZpKAoUF2s8Kd/vkwBxotYpzY7D7U+bXD3WQw8fY62pb4aKjpjhsjyIFwCpwKCPG6uweeeJWlxo6bv7nIyhUcOC7ik6lwkB5zApPdXY0bLwgw5G0DoDfXw7+HzC9r6sHzFYEwo08LD2umt7Jx9IVNpQACQNh4a/daV8fRoT5dZYZAaOmdQLO52HmW5SLM+PCGHmeVn+hmfJiuhboQeo5GWD2adVODnt3I6cJPHVoSA+DKmqyaTBbbBADjsYuNCUNT/Ode4fornTKpozgJK0b8vMlIztjCx/MkPPqR83ZbHnwOF3PWn3J7dYdeno1tamT4RDm1MdgbG9jij0IFlLhaI10ZrQI5FptjHkOvDDmF8dBmzaXFfVGXsXWvGNSDBScWJIKUrVkZt6z06q8usqs+YkQfHCwntChe/NPW5ksfkw+e6MWhSIO/HhR9lhXvl5pOquk6zjVX7shsWtQy08bKZKaw494dHjKKkzpYpWEMxtwZLYCgddW9oSQmwcKUQ7hCMh3B6UMNwnfA3tuTo5FKqOu4x+GUJTVeKeRgHI2hIRtvV0xMG0dTTXqFGBg6BTHAMSeMZyzyYKkSUw1Y6CeODqYXu4Qmhjh3zmj6pU9tGLwhz+j04ViQju6p0wwyKIAgct8I3xkjYC0V0OJ8oRQgugf7jCP4+a2gbiOI8vQcZHHUPjsChsChy7PzCVUKCdAyTnwHjgx6tueXAozllOrobOAiJxufPI7yAk1C6AzCBYmbzAGvfww/shy814acTmcLXdzOmQ6HbqbmdfgkxyjwTfLjLOclLle70Sr7PWcuV4/zNGHRji/wfPioXZoYcE+POezV5nBm7NwaYAquH2S1aRJsDMaPHGrrlUfGtCDjxzqYnVex1dWu2JjULkLsA1ew9gY0GABg1sdAFWb8XXNBhGraYDORTSjAxeqjPfs0P2ScQAveWmitdGu1r+IFrx3goZlqUdb/UPZFQZdB9YqScZFC3C5Z3dzHZT8zNey6SWCKjjt3I6uRkGIbUAswLqJcmIVHxCy7tdg9foHcHqM5vL4VDF1+t9l5NolzAQoiy+Zbf12RqcMpp5gcQOmRhis9vtsERYfRgWFf1TiN5x7L0TEtdIjX2pHw5SjHk0WPNDyjD2i2HGJNbOCXYsUYaY+MFcSqQsYxYscSF20xrjFBZNBWzjZ2HR/WXqbKxLKLiz0nAXEuUY3f/QMnwxdwnRvI+Iwukx+TnCM+QIt9wzZxoY1g53/c4oErahaQd2+Iq26pDSE5nBXD9CnTj9RppWAbBd+fwX8yMrBESE1MqfROBFjMUSxdJi/jl54UIyUBpQ1ViygYkaubdtTpfsjyf1I8td/CS0Ik0eABdhKiH95oF136Jicw8AShLC3+ayK6TZzWzmuY4pT13TliEI0LDtvYpkUfO9afpvSJaf2r1yRSfoiBY2vGRrf+bnvEKMZGGGbtl0K7aZYVLlGNw47zOuc+J1ufwxOVZ2FtNrahOBV6sJRtL0+lzzEAsWuwKvrjiE2/9su3sH+1xp4vnGdp5ZEq5H/m70PyEtFR8qoeVH5jIxBOKgFMFLzz0ybSbMDGxWrPkuYB7Ae3PGeCmLg0EWdqWa9VNCmnE5vuhFxk8b4YfdEl8YbiGIUdF+jridgxd6EFtBMIp+1i0QSYD5WGuWNKx9gQ4nerLMoGWvodSxFz3Dj7SQ7xqNhVcu07HOS4MQBXS50aZVUdEjjuG4bOuYxNOoAVZqihcgqCwEvwJWWiCTxCvW9AvFOPvVtSlpi01LzsyILiCy3SRdqxzG9HmTsAjXF2sC1DSwzWs1bkARqE7a6ZbnVcc5qxngAAzWkmMzAMjiYD5pWBwYUMPyRnepGRSGa80ALBPj86blv7xUfu2DqP/rZMfJCMmgA7BhOkPsrX5Jc28Q0fvm+7XsHJEx36jyRJn4gyBuSNo77LFZF6uOTmnNKwj6HzgAwxDz6FppFjxfCj2Dpt+2ugqYcXUwGSiy9f8UOuvhKAV8esZkxZO5ywW95O287/ANp+MWupDPWWAVF5mtNY9ah2C9ZiheCX439R93uUjDRzn7Hli1WZ6R0js8KAWRRcufhaFi8sUk8ddcL1fXGNCJ6WJ8W3ghFwJQMwR0vPg/OLT2QjijmgEUkFIP21JcmiHjtsi2dpTtNGSRRyUQhBX34Jsf1AplMRYoIkQV7JYN1y9b24J9TT1G2w/Ok1J8HZwKJjXF4NWNZReNGaGRDPaNLuvKdZl87PJE7JQOSPHpv0QSUJgukszxmMLx6hNfgeJx7m4sRCECkdd+A7L5GTXP2gZ2Kd08HY2K+QcD2UaDJAu6nT/rF/jigy5BS/DjhJtJLOP1zpA2vC6XsIaMqPrx1ETyMa4pTaRt7EavAmnPI2ScFR/jFyvsKrF/+tazhdImGGi6tk/UY4S+fIimPK1se08ZH9Unxkf8fnPIl52wHATdnkSA82bXM4cm1GLgJcn0PIiaiEqaNlXJNfq8nOmTmw37i1qzFmh/cRnTiRrfzU0zj9YFiDM7SDX+4yGCKiKWv9LMlHc9DApnNkaTBPvK/actluvKv739Z86h0XuVrIe0sviphy1o6142SjRMbQiQZl8Lwt5t0ZQP5qrecgmGhdeumby+Bx3ZdwdgZEWEIgq3J7SFISF+pMOZez0Rzoi6pYtm3eFAdQFY3uohJF6LAfdXEJec4wwBY0JOEI8qeAehXTwONJM1W+A64Rx2MPxtzuaNKBp4OJnFFKpg0OZVTMIf0c5rUBfOcEYMpMt2MjtSf4bO6JKbaMRZN+HYC9n3MCjmoGi+feKUmNiWmxl0xIUtx8w6fEMBgYv7vDzIbT7Y09XlPO0Hpqs5pJ6s6vs5k+JvjkYGbCjAyBgDDRp1CzqCRHLqAqeCFgWNB4rCF9dcpW3+GIDYwQeFLE6oNemJot02rY4IqhhjvPYDaeSZBUjYIwmargOCu+/S5z72XCByYGtWkfJ3kYFyPxKWfa1KOX1/7KF1v79AxcGxdacczRPPQbF9cX3Pjk8NZf2oJESGVLk2PHyFl+VupZmH1dKki9mh7UP32axxrlAqhTNsac+jecKv9Dx3X5Pc5y7cPZ0hdzuLoIu6kMiXXmDLPHvpFZ08uNySgzF4w/CN6q93Ur3RnODDVXl92onSS9BWOPNDto+zlg7e8KmYCwxQFBRMXbDK9SMxtjh4Fbtts8Zx6LFAmLYq/1gZxeCgmDxW5TFsU9ZFL07CVpRAw5fggCe41yvLvacUgWPQuZ0kDw5HpMfqlvvPIQw6Hw1DBEzC7iPhkcuhG/HSWo4O/pq6e84kXMtU5Oz298PJ5KztxDMXqP+M3TSlxe8ByUYXCvkbtshArET3NSMxrmP1HFAfheb9LpeAOAjmE0rJ0qxlJRPHRQ4VssjpQzSMfMdKeFJ+Gt7U6fM2JM+A41ayAXrhERLtOMDeGi5u1TpsOZUZ+B8QV1fheK2Al/fz+b5OcsYoNx+MQwLoD5jJMhrJ01fZ0uFkRkRT4f/BA31xpouiioiZvRegXMMPWFC7QoU6fhU95yEyd6a/SrGyynjxfQUB6eiNrpFNmtcuSrny4+v5b6GcXq4yXx4/KUn22rfl0fMA24DPpK4Tii9bXqr/2V/wfqpf6epcUq4s4QL5zOZarESv7jWnKGiQVbbl/6uHFZgwgzhGQbNgKxYd8SWxJBmJroGCsy+dNBmbKJI821hCXOgDhxeStrnw+NFHCVExnqJk7kKX7NJyyTPhheC/vvBKYIg3wEpeGB2eg4AN3VhddwJVajbxQISeXU0nmkH6wh0CTKgHI0vTfZMugIZ87UziFV0V6yB81ZIUfDRZn56ujrmPuZbCgo4PdkMWWdYl7SzJ/Zjjj1ARS6gCLIEzcYyBMQ2p0ABgNKGcsibylYLzJ4gAg2MBMK+nECsDMXhDOIM6+0MswmovDHmtGqy+pjBJIxJOQo1YNxRpY/fzQq64XcwhJleaBJHxmuEgpu0uBFOzU4woJmsMONXew5TPYhaZG37RJ3OPkk219RlAsGwwUnL3+0Ypp8GKBNKn2sb3hYbdbwhoInt8AaK3dV4A5m/DALziuxD18R6eCQKmVbF6Mwg4pOUHwxxpxI+nIWkmPtl0uBsrYqv9pthQN6jENbXrr6nMgWi6xyEH9dSnox218uNP8q12X5563l5Pzx1pY1kNVvyVB5j5SzxTJx3I6aM8XgO8vIA2GSY8ue6TRYzWQZejhzFnBowd5HDo7ScxSp+zAQOHPYCccI48YXOcsKQbybtGwSG9EkHIYhMYqUaRPj7RW7femqZ5HbxZTCQhqONIqk4qHDHBxu/4RElsZMxPjFwlWICdghsWtngME1FeE1BXFex9hBLLhM8FGH88xaZkRe7iXqCzfjkKH88IXF0xmefKATNd9i6CaOoJNoEM4RDufFSGrObZy4OQkrejjxulMV4/EIACkRNoyl4nJp9w2+YdUfuJrRaFtrZmA9OA0jjW2vvkxIgZB0TC7SwN2AwoYJUnwb0/pYn4y2c5F1AxHTRy2A009MkYHjDkbk3/Iiwe9lC4tG/wHwVaRNnNRQJLllhuGQp9Q1YJbmXTvA4zKNxkD8xIfvDWk5rdVmGzifuosEUnyVD1v7qSlwqqMNRunU7BCER9cFNSKxtJFey2Oi1ORIPCCYuJxnsOZjLc8prW/clVD7z4A+Rb+CFfGJWxn4jmYl/3699iRKRuQmzBRyddTkqBeSZ5IoS493IqCYqaCsM2amfdZRLKIjX+Xp1MDhFWAY6jE6bJibHtMi96YDeEqvcOEpyljUxXEHL7Xa9ImMd4qr9FzUYayGmHeI/OCxSXEXBczIGcmAEW2JaKREzoZzVxJc+hhOIecUmlrNXBGzWJilA4ZosAs1dshqyhCcKFc5Lw7jCEtQdh0RE1gpXI6gLya5RRK3vOUiKRFR8E1czDkhIeCAW6occ8rJg+xMQ0mbOkfOKiZ5v9ogNEKVp2/TQ7lTiIyyO11/YcJLCf246yQAmTHqd9GYSMjyRxukx4x7fCBMPIw5593pQezmBIUoNfOdWv4c0sQtUjng4ckxKEZl26+Cah6NPCBytZrxZSqdFlzhXA7bcOCLI3ZlbU27skyqL3zyIpMIsHY5OLuYOUW8Jh1bxrA81PxEQCJWHi7GyrTlCjSnl7M19qkxVj8yTotv9enHVlNnLAJkrWyc9sjoH9lpjMwZLpB1uWpmjLZL6bUHuooF/0KE3aPG6p+WxX+1XXf/lCAAsFx6ff/bH3kL7aeRpptounMCIEHaZw0nN7p9IjkrkYxDH0UaWU/tw+w7yl6kZo5CtOs/5rEJILK2YsxS5NThcMSwQamAY1ek1tgR/diLIVrfZKWXWHMYbWBpidmPHtCxaKcIDD2fVIs9BgAI/imE4dtt/KwKhnWZ5ccuV5vk7DcC7LMfGRIF4zzCBLYBKDLYHTdD4O0nC//PP/JSxWsYyxuGTrr4353oKGdnQWhonjLyJPDYcqiOlv/+AS5kLHD0lNAQFH7z7ARoIH+Y2Z5wA85BX2n6IgKP7SGL75g1rQgeP3ggSf/dZdOweA1iA+cYa+7hoTSOtBlFSQ0h3kBHwoNR4uRb1rPzYHiFdzSEHd6G7Z8ZaztH3GV6Yasss/wt76ti4ilsEuTKjWTIknBqeA2a7N0Zrn2GS0h5Yodb5PNcHX7qq9iZ5hJjHXzcECcT29gUX64A6qXcEDFX1moqh62Mt2Zsr1zmlRkLc71W1w6c0lFdRJcB/b5wf9pg12hpPQUh5SGS41P0qoW/h1/yPoCHWum6fCD/sLlphu/UZsU3jqxalppb1zzG6nPqo3G1ZmF4Uy+TmLfrHPGAkgWtfbejaYtlFJWK/Mm1nGvwwdbIqqnDvRXzFoLbokyT0PzwTeNes2DEGpwM5avoDMSlxS2FXFCRnTqVBi9XEgsD5NwRui1qB584CBNtDqMGwtAYNvdLM2a8F2iQIt6DnkKSrSZP8gIcPLlPSM3frnNaAFQGYCzHv9Hk1DBVwWQ0ZgRacDiExOW7AekR9/Jiou/QEKc0eYYkltgaW3jQeZrbwHnsnAzmwZI/m8dqMRNwjyMA/a/emEJpPy/AkzKqhpwp5pFDdExiTgUvzflTPxnOb/yCZzA/vBckjEtcDRhtdFCSQvURO1II41PeAUELOJCpc1skK4UkN4nOK0MowHgPMG10KOQ2VPuZboBhZOqSYfjBJ5sFTwmBfPnDnAk2TBDz5I7I+u0HTPWjLDDCRg4aU/qaps4onXlu6qDUX9mNURyjxxi790lQhy8N9gL6HGykbaGfRnV5IUBIh3FRb5m21dsePSLwXGtkbMmVu2jQJEiU4fSEYIN4ShHtrHjrxfxV/e9g/4rnV7rl5q13vo3Hm0YXXE4NZ8W5Z/kGx4AzdhKLN7gyZu5pkqBmPfq+NwJWvRdzWTTus7nvyeTERWRM5qQtqCleDEHkto0ANFdN+SrOqdNM0SIBukRjn6ssNyueXa3aJjS6wRMOxPVEvoqCmwsAqLY4uEgzBUHnUIv3VG/gzIT22Do9zbhSwbnjYiDQOGCYMn5XIaBo8MmcyHF9YmZs2IKvD4YcEm1j7FRGyVYiecc+OFhwigntNFFl2MxJ+h56nttDOE+T+EwLXFylnr21EwQxlokdJ+lY0doGwzIKziFzY0Rp0/LM+U4FLRHDjG2iyg7LISCYIyUidExe2b2YJish0g6DQCYWhskHQ+1GkXuGcJfa6fQUYM3EkKDEBmObDiKSW4Ihcwkg1DRRMq8pvkxET0gJhyCaEKPPRa197mUuBwRihpE44sHbCbYZZxyYrNNIDLjTJwf86h8Z7WyP378jaZhg09QdTcZg0CvPuhU94sMltgdklLKmET47CPG5gMuM5kBokySVBcu5zBTtKRUoBQie6dCfJmb/b4tfOM8UkvSYyvypIN5gOIQMkf+TmoG4M9Pkgi6dnJo/kgNJh8ydU897Eq4MjqR2VQeXn+DK5tFlwbxwpZQJiy51VOyCvHSbuLl8AW3J2k7P2GKSR0i1hZf8SXEI2IbD7QerheWYNvHHpaHApn58CM1hQolWb5rpL616LGVwBEUespSU5jDlGoCg9YPYNmqYKT3SYmwKToMewaLdoAABsM/JSIB5KJSMeSwmVshduEDKjnSAI0ROUmAg4uvOyPoqRhzRIInN0CtCEgFX7UwpqOCctlwGoSMZ5SKMVzeTStA5MbzRcFypOj7IOV9ZRKEh9RCNQsaR+CKbl25fhrm8IhzSblpA4ExqMpHmj92e15loy8ZqzuN52z0OzuAYRC/GHQpJrzc7GJtJN+GSzGgzMKKUnWSZXl0kXJgR+LNuUk/CIoMo9fwIJTSfqEjU2HOQXyWnvYz+l+kqxHm1CcYpuX4147Albd/PrCyUnsKeAFE2Jy4EQhe//acGU5Atm2yTTAZUxDSHhwTRlF9LV/tzbXxfxL+SfYH8n7r/A6isvic82r4AAAAAAElFTkSuQmCC", + "backgroundColor": "#FFFFFF", + "referencedComponentHashes": [] +} \ No newline at end of file