{ "openapi": "3.0.0", "info": { "title": "NFM-P Restful API endpoints", "description": "The NFM-P REST service provides a REST interface that allows OSS client applications to retrieve, create, update or delete managed objects that reside on the NFM-P server.
These operations are defined by the REST API endpoints below. Also, all NFM-P managed objects are defined by the SAMO API Information Model that provides information on each object’s properties, values, descriptions , types, inheritance and relationships. The NFM-P (SAMO) object Model is documented in the NSP NFM-P XML Reference

Access Information:

Prior to accessing the API services below, the API client must authenticate the NSP user via the Gateway.

Note:

Where URL encoding is required (see the individual API requests), UTF-8 character-set encoding is to be used. Below is a list of published URLs that can be used.

Deprecation notice:

Support for the ‘/nfm-p/rest/api/v1/auth’ API will be available up to NSP 22.11 and removed in NSP 23.03.\n Support for the ‘/nfm-p/rest/api/v1’ API will be available up to NSP 22.11 and removed in NSP 23.03.
\n

Disclaimer:

The NFM-P REST API was introduced in the 5620 SAM Release 14.0 R1. This interface definition including request specification and output is subject to change.

", "contact": {}, "version": "1.0.0" }, "servers": [ { "url": "https://{defaultHost}", "variables": { "defaultHost": { "default": "www.example.com/nfm-p/rest/api" } } }, { "url": "http://{defaultHost}", "variables": { "defaultHost": { "default": "www.example.com/nfm-p/rest/api" } } } ], "paths": { "/v2/autoconfig/AutoConfigScriptManager/configure": { "post": { "tags": [ "samo_autoconfig" ], "summary": "rest_autoconfig_AutoConfigScriptManager_configure", "description": "Create and modify a script through the script manager.

Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure on default instance autoconfig-manager of class autoconfig.AutoConfigScriptManager
This API follows hierarchical config model rules.

The newly created scripts full name.

", "operationId": "rest_autoconfig_AutoConfigScriptManager_configure", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/aapolicy/AAGroupPolicy/DeleteAllSystemResidentialDCPGroups/{instanceFullName}": { "delete": { "tags": [ "samo_aapolicy" ], "summary": "rest_aapolicy_AAGroupPolicy_DeleteAllSystemResidentialDCPGroups", "operationId": "rest_aapolicy_AAGroupPolicy_DeleteAllSystemResidentialDCPGroups", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/aapolicy/AAUrlFilter/resyncToUpdateOperStatus": { "post": { "tags": [ "samo_aapolicy" ], "summary": "rest_aapolicy_AAUrlFilter_resyncToUpdateOperStatus", "operationId": "rest_aapolicy_AAUrlFilter_resyncToUpdateOperStatus", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resyncToUpdateOperStatus" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/aapolicy/AAUrlListPolicy/removeDecryptKey/{instanceFullName}": { "post": { "tags": [ "samo_aapolicy" ], "summary": "rest_aapolicy_AAUrlListPolicy_removeDecryptKey", "operationId": "rest_aapolicy_AAUrlListPolicy_removeDecryptKey", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/aapolicy/AAUrlListPolicy/retrieveAAUrlListStatus": { "post": { "tags": [ "samo_aapolicy" ], "summary": "rest_aapolicy_AAUrlListPolicy_retrieveAAUrlListStatus", "description": "Method to retrieve AAUrlListStatus.

Intention : RETRIEVER
retrieveAAUrlListStatus:
class-level retriever API retrieveAAUrlListStatus
of class aapolicy.AAUrlListPolicy


", "operationId": "rest_aapolicy_AAUrlListPolicy_retrieveAAUrlListStatus", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveAAUrlListStatus" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveAAUrlListStatusResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/aapolicy/ApplicationFilter/renumId": { "post": { "tags": [ "samo_aapolicy" ], "summary": "rest_aapolicy_ApplicationFilter_renumId", "operationId": "rest_aapolicy_ApplicationFilter_renumId", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/renumId" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/aapolicy/ApplicationFilter/renumIds": { "post": { "tags": [ "samo_aapolicy" ], "summary": "rest_aapolicy_ApplicationFilter_renumIds", "operationId": "rest_aapolicy_ApplicationFilter_renumIds", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/renumIds" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/aapolicy/DbInfoTransitIpAddress/retrieveDbInfoTransitIpAddress": { "post": { "tags": [ "samo_aapolicy" ], "summary": "rest_aapolicy_DbInfoTransitIpAddress_retrieveDbInfoTransitIpAddress", "description": "Method to retrieve DbInfoTransitIpAddress.

Intention : RETRIEVER
retrieveDbInfoTransitIpAddress:
class-level retriever API retrieveDbInfoTransitIpAddress
of class aapolicy.DbInfoTransitIpAddress


", "operationId": "rest_aapolicy_DbInfoTransitIpAddress_retrieveDbInfoTransitIpAddress", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveDbInfoTransitIpAddress" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveDbInfoTransitIpAddressResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/aapolicy/DbInfoTransitPrefixAddress/retrieveDbInfoTransitPrefixAddress": { "post": { "tags": [ "samo_aapolicy" ], "summary": "rest_aapolicy_DbInfoTransitPrefixAddress_retrieveDbInfoTransitPrefixAddress", "description": "Method to retrieve DbInfoTransitPrefixAddress.

Intention : RETRIEVER
retrieveDbInfoTransitPrefixAddress:
class-level retriever API retrieveDbInfoTransitPrefixAddress
of class aapolicy.DbInfoTransitPrefixAddress


", "operationId": "rest_aapolicy_DbInfoTransitPrefixAddress_retrieveDbInfoTransitPrefixAddress", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveDbInfoTransitPrefixAddress" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveDbInfoTransitPrefixAddressResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/aapolicy/DbInfoTransitSubscriber/invokeResyncDbInfoTransitSubscriber": { "post": { "tags": [ "samo_aapolicy" ], "summary": "rest_aapolicy_DbInfoTransitSubscriber_invokeResyncDbInfoTransitSubscriber", "operationId": "rest_aapolicy_DbInfoTransitSubscriber_invokeResyncDbInfoTransitSubscriber", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invokeResyncDbInfoTransitSubscriber" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/aapolicy/DbInfoTransitSubscriberManager/retrieveTransitSubscribers": { "post": { "tags": [ "samo_aapolicy" ], "summary": "rest_aapolicy_DbInfoTransitSubscriberManager_retrieveTransitSubscribers", "description": "Method used to retrieve extended Transit Subscriber information from the network.
It can include also the information for the children classes as it is requested by invoker.

Intention : RETRIEVER
retrieveTransitSubscribers:
class-level retriever API retrieveTransitSubscribers on default instance tsmgr of class aapolicy.DbInfoTransitSubscriberManager

Transit Subscriber info object where only
persisted information about Transit Subscriber is set.

", "operationId": "rest_aapolicy_DbInfoTransitSubscriberManager_retrieveTransitSubscribers", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveTransitSubscribers" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveTransitSubscribersResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/synce/SyncEDomain/findSyncESites": { "post": { "tags": [ "samo_synce" ], "summary": "rest_synce_SyncEDomain_findSyncESites", "description": "Finds all Sync-E Sites belonging to this Sync-E Domain.

Intention : RETRIEVER
findSyncESites:
class-level [object finder] (retriever) API findSyncESites
of class synce.SyncEDomain


", "operationId": "rest_synce_SyncEDomain_findSyncESites", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findSyncESitesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/subscrauth/Policy/getServiceDependencyCount/{instanceFullName}": { "get": { "tags": [ "samo_subscrauth" ], "summary": "rest_subscrauth_Policy_getServiceDependencyCount", "description": "
Intention : RETRIEVER
getServiceDependencyCount:
instance-level retriever API getServiceDependencyCount
of class subscrauth.Policy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_subscrauth_Policy_getServiceDependencyCount", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getServiceDependencyCountResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/opticalacl/IpFilterEntry/renum": { "post": { "tags": [ "samo_opticalacl" ], "summary": "rest_opticalacl_IpFilterEntry_renum", "operationId": "rest_opticalacl_IpFilterEntry_renum", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/renum" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/atm/Interface/getAllConnectionProfile/{instanceFullName}": { "get": { "tags": [ "samo_atm" ], "summary": "rest_atm_Interface_getAllConnectionProfile", "description": "
Intention : RETRIEVER
getAllConnectionProfile:
instance-level retriever API getAllConnectionProfile
of class atm.Interface
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_atm_Interface_getAllConnectionProfile", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "aInPortPointer", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getAllConnectionProfileResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/neaudit/NeAudit/audit/{instanceFullName}": { "post": { "tags": [ "samo_neaudit" ], "summary": "rest_neaudit_NeAudit_audit", "operationId": "rest_neaudit_NeAudit_audit", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/neaudit/NeAuditManager/triggerNeAudit": { "post": { "tags": [ "samo_neaudit" ], "summary": "rest_neaudit_NeAuditManager_triggerNeAudit", "description": "This method starts a request for NE audit.

Intention : MODIFIER
triggerNeAudit:
class-level [functionality trigger] (modifier) API triggerNeAudit on default instance nea-mgr of class neaudit.NeAuditManager


", "operationId": "rest_neaudit_NeAuditManager_triggerNeAudit", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NeAuditParam" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/triggerNeAuditResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/neaudit/NeAuditManager/triggerNesAudit": { "post": { "tags": [ "samo_neaudit" ], "summary": "rest_neaudit_NeAuditManager_triggerNesAudit", "description": "This method starts a request for multiple NE audits.

Intention : MODIFIER
triggerNesAudit:
class-level [functionality trigger] (modifier) API triggerNesAudit on default instance nea-mgr of class neaudit.NeAuditManager


", "operationId": "rest_neaudit_NeAuditManager_triggerNesAudit", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NeAuditParam" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/triggerNesAuditResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/msappolicy/Policy/requestClearIdleOnlyMsaps": { "post": { "tags": [ "samo_msappolicy" ], "summary": "rest_msappolicy_Policy_requestClearIdleOnlyMsaps", "description": "Request clearing of idle MSAPs using this local policy.
When this method returns resources for the clear have been allocated
but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearIdleOnlyMsaps:
class-level modifier API requestClearIdleOnlyMsaps
of class msappolicy.Policy

A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_msappolicy_Policy_requestClearIdleOnlyMsaps", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearIdleOnlyMsaps" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearIdleOnlyMsapsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/msappolicy/Policy/requestClearMsaps/{instanceFullName}": { "post": { "tags": [ "samo_msappolicy" ], "summary": "rest_msappolicy_Policy_requestClearMsaps", "description": "Request clearing of MSAPs using this local policy.
When this method returns resources for the clear have been allocated
but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearMsaps:
instance-level modifier API requestClearMsaps
of class msappolicy.Policy
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_msappolicy_Policy_requestClearMsaps", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearMsapsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mvpls/L2AccessInterface/requestClearIgmpHostTracking/{instanceFullName}": { "post": { "tags": [ "samo_mvpls" ], "summary": "rest_mvpls_L2AccessInterface_requestClearIgmpHostTracking", "description": "Request clearing of all IGMP Host Tracking information for this L2 AccessInterface.
When this method returns resources for the clear have been allocated
but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearIgmpHostTracking:
instance-level modifier API requestClearIgmpHostTracking
of class mvpls.L2AccessInterface
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_mvpls_L2AccessInterface_requestClearIgmpHostTracking", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "boolean" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearIgmpHostTrackingResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mvpls/Site/requestClearIgmpHostTracking/{instanceFullName}": { "post": { "tags": [ "samo_mvpls" ], "summary": "rest_mvpls_Site_requestClearIgmpHostTracking", "description": "Request clearing of all IGMP Host Tracking information for this site.
When this method returns resources for the clear have been allocated
but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearIgmpHostTracking:
instance-level modifier API requestClearIgmpHostTracking
of class mvpls.Site
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_mvpls_Site_requestClearIgmpHostTracking", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "boolean" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearIgmpHostTrackingResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/nelicense/AbstractNELicense/installLicense/{instanceFullName}": { "post": { "tags": [ "samo_nelicense" ], "summary": "rest_nelicense_AbstractNELicense_installLicense", "operationId": "rest_nelicense_AbstractNELicense_installLicense", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/wpp/Portal/retrieveHost/{instanceFullName}": { "post": { "tags": [ "samo_wpp" ], "summary": "rest_wpp_Portal_retrieveHost", "description": "
Intention : RETRIEVER
retrieveHost:
instance-level retriever API retrieveHost
of class wpp.Portal
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_wpp_Portal_retrieveHost", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveHostResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/wpp/WppHost/requestClearWppHostsLoggingOut": { "post": { "tags": [ "samo_wpp" ], "summary": "rest_wpp_WppHost_requestClearWppHostsLoggingOut", "description": "Request clearing the logging out WPP host(s) with the specified parameters.
The siteId is required.
The svcId should be 0 for base routing instance or the ID of the VPRN service.
When this method returns resources for the clear have been allocated but the
clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearWppHostsLoggingOut:
class-level modifier API requestClearWppHostsLoggingOut
of class wpp.WppHost

A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_wpp_WppHost_requestClearWppHostsLoggingOut", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClearWppHostsLoggingOutStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearWppHostsLoggingOutResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/assurance/AssuranceEventManager/deregisterApplication": { "post": { "tags": [ "samo_assurance" ], "summary": "rest_assurance_AssuranceEventManager_deregisterApplication", "operationId": "rest_assurance_AssuranceEventManager_deregisterApplication", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/assurance/AssuranceEventManager/registerApplication": { "post": { "tags": [ "samo_assurance" ], "summary": "rest_assurance_AssuranceEventManager_registerApplication", "operationId": "rest_assurance_AssuranceEventManager_registerApplication", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/aengr/Match/renum": { "post": { "tags": [ "samo_aengr" ], "summary": "rest_aengr_Match_renum", "operationId": "rest_aengr_Match_renum", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/renum" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/aengr/Policy/retrieveHostSharedPccRuleEgressPolicy": { "post": { "tags": [ "samo_aengr" ], "summary": "rest_aengr_Policy_retrieveHostSharedPccRuleEgressPolicy", "description": "Method retrieves Host Shared QoS SAP Access Egress Policy from the network element. This method
has option to specify either retrieving its entries or not.

Intention : RETRIEVER
retrieveHostSharedPccRuleEgressPolicy:
class-level retriever API retrieveHostSharedPccRuleEgressPolicy
of class aengr.Policy


", "operationId": "rest_aengr_Policy_retrieveHostSharedPccRuleEgressPolicy", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RtrvHostSharedPccRuleEgrPolicyStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveHostSharedPccRuleEgressPolicyResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vll/L2AccessInterface/createDefaultTestHeadProfile/{instanceFullName}": { "post": { "tags": [ "samo_vll" ], "summary": "rest_vll_L2AccessInterface_createDefaultTestHeadProfile", "description": "
Intention : MODIFIER
createDefaultTestHeadProfile:
instance-level [administrative creation] (modifier) API createDefaultTestHeadProfile
of class vll.L2AccessInterface
DescendantInfo:
ipipe.L2AccessInterface
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_vll_L2AccessInterface_createDefaultTestHeadProfile", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createDefaultTestHeadProfileResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vll/L2AccessInterface/shutDown/{instanceFullName}": { "post": { "tags": [ "samo_vll" ], "summary": "rest_vll_L2AccessInterface_shutDown", "operationId": "rest_vll_L2AccessInterface_shutDown", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/vll/L2AccessInterface/switchToRedundantSaps": { "post": { "tags": [ "samo_vll" ], "summary": "rest_vll_L2AccessInterface_switchToRedundantSaps", "description": "For each SAP in the specified list, NFM-P will copy over its configuration and create a new SAP
on the backup port specified on it, and then it will be deleted.

Intention : MODIFIER
switchToRedundantSaps:
class-level modifier API switchToRedundantSaps
of class vll.L2AccessInterface
DescendantInfo:
ipipe.L2AccessInterface

If succeed, null returned. If failed, a list of error messages will be returned.

", "operationId": "rest_vll_L2AccessInterface_switchToRedundantSaps", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/switchToRedundantSapsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vll/L2AccessInterface/turnUp/{instanceFullName}": { "post": { "tags": [ "samo_vll" ], "summary": "rest_vll_L2AccessInterface_turnUp", "operationId": "rest_vll_L2AccessInterface_turnUp", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/vll/Vll/findDownstreamSdpBindings": { "get": { "tags": [ "samo_vll" ], "summary": "rest_vll_Vll_findDownstreamSdpBindings", "description": "Find the downstream sdp bindings in the VLL service starts
from the passed in spoke sdp binding.

Intention : RETRIEVER
findDownstreamSdpBindings:
class-level [object finder] (retriever) API findDownstreamSdpBindings
of class vll.Vll
DescendantInfo:
hpipe.Hpipe
DescendantInfo:
ipipe.Ipipe
DescendantInfo:
fpipe.Fpipe
DescendantInfo:
cpipe.Cpipe
DescendantInfo:
apipe.Apipe
DescendantInfo:
epipe.Epipe


", "operationId": "rest_vll_Vll_findDownstreamSdpBindings", "parameters": [ { "name": "spokeSdpBindingFullName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findDownstreamSdpBindingsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/lag/Interface/requestClearSubVlanStats": { "post": { "tags": [ "samo_lag" ], "summary": "rest_lag_Interface_requestClearSubVlanStats", "description": "Request clearing of Subscriber VLAN statistics.
Statistics will be for all service access points with the corresponding
lag id and outer encap value.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearSubVlanStats:
class-level modifier API requestClearSubVlanStats
of class lag.Interface

A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_lag_Interface_requestClearSubVlanStats", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearSubVlanStats" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearSubVlanStatsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/lag/Site/findLags/{instanceFullName}": { "post": { "tags": [ "samo_lag" ], "summary": "rest_lag_Site_findLags", "description": "
Intention : RETRIEVER
findLags:
instance-level [object finder] (retriever) API findLags
of class lag.Site
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_lag_Site_findLags", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findLagsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vwmsas/PrbsTest/cancelPrbsTestExection/{instanceFullName}": { "delete": { "tags": [ "samo_vwmsas" ], "summary": "rest_vwmsas_PrbsTest_cancelPrbsTestExection", "operationId": "rest_vwmsas_PrbsTest_cancelPrbsTestExection", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mpls/Crossconnect/configure": { "post": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_Crossconnect_configure", "description": "
Intention : MODIFIER
configure:
class-level [hierarchical administrative configuration/modification] (modifier) API configure
of class mpls.Crossconnect
This API follows hierarchical config model rules.


", "operationId": "rest_mpls_Crossconnect_configure", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configure" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mpls/DynamicLsp/findCrossconnects/{instanceFullName}": { "post": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_DynamicLsp_findCrossconnects", "description": "method to retrieve all crossconnects associated with this LSP, including detour bypass tunnels created crossconnects

Intention : RETRIEVER
findCrossconnects:
instance-level [object finder] (retriever) API findCrossconnects
of class mpls.DynamicLsp
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mpls_DynamicLsp_findCrossconnects", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findCrossconnectsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mpls/DynamicLsp/findRsvpSessions/{instanceFullName}": { "post": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_DynamicLsp_findRsvpSessions", "description": "
Intention : RETRIEVER
findRsvpSessions:
instance-level [object finder] (retriever) API findRsvpSessions
of class mpls.DynamicLsp
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mpls_DynamicLsp_findRsvpSessions", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findRsvpSessionsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mpls/Hop/findInterface/{instanceFullName}": { "get": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_Hop_findInterface", "description": "
Intention : RETRIEVER
findInterface:
instance-level [object finder] (retriever) API findInterface
of class mpls.Hop
DescendantInfo:
mpls.CSPFHop
DescendantInfo:
mpls.ProvisionedHop
DescendantInfo:
mpls.ActualHop
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mpls_Hop_findInterface", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findInterfaceResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mpls/Hop/findPort/{instanceFullName}": { "get": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_Hop_findPort", "description": "
Intention : RETRIEVER
findPort:
instance-level [object finder] (retriever) API findPort
of class mpls.Hop
DescendantInfo:
mpls.CSPFHop
DescendantInfo:
mpls.ProvisionedHop
DescendantInfo:
mpls.ActualHop
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mpls_Hop_findPort", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findPortResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mpls/IngStatsPolicy/shutDown/{instanceFullName}": { "post": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_IngStatsPolicy_shutDown", "operationId": "rest_mpls_IngStatsPolicy_shutDown", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mpls/IngStatsPolicy/turnUp/{instanceFullName}": { "post": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_IngStatsPolicy_turnUp", "operationId": "rest_mpls_IngStatsPolicy_turnUp", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mpls/Interface/configure/{instanceFullName}": { "post": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_Interface_configure", "operationId": "rest_mpls_Interface_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mpls/Lsp/findLdpTargetedPeers/{instanceFullName}": { "post": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_Lsp_findLdpTargetedPeers", "description": "
Intention : RETRIEVER
findLdpTargetedPeers:
instance-level [object finder] (retriever) API findLdpTargetedPeers
of class mpls.Lsp
DescendantInfo:
mpls.DynamicLsp
DescendantInfo:
mpls.BypassOnlyLsp
DescendantInfo:
mpls.StaticLsp
DescendantInfo:
mpls.SegmentRoutingTeLsp
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mpls_Lsp_findLdpTargetedPeers", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findLdpTargetedPeersResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mpls/Lsp/findServiceCircuits/{instanceFullName}": { "post": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_Lsp_findServiceCircuits", "description": "
Intention : RETRIEVER
findServiceCircuits:
instance-level [object finder] (retriever) API findServiceCircuits
of class mpls.Lsp
DescendantInfo:
mpls.DynamicLsp
DescendantInfo:
mpls.BypassOnlyLsp
DescendantInfo:
mpls.StaticLsp
DescendantInfo:
mpls.SegmentRoutingTeLsp
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mpls_Lsp_findServiceCircuits", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findServiceCircuitsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mpls/Lsp/findServicePaths/{instanceFullName}": { "post": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_Lsp_findServicePaths", "description": "
Intention : RETRIEVER
findServicePaths:
instance-level [object finder] (retriever) API findServicePaths
of class mpls.Lsp
DescendantInfo:
mpls.DynamicLsp
DescendantInfo:
mpls.BypassOnlyLsp
DescendantInfo:
mpls.StaticLsp
DescendantInfo:
mpls.SegmentRoutingTeLsp
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mpls_Lsp_findServicePaths", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findServicePathsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mpls/Lsp/findServices/{instanceFullName}": { "post": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_Lsp_findServices", "description": "
Intention : RETRIEVER
findServices:
instance-level [object finder] (retriever) API findServices
of class mpls.Lsp
DescendantInfo:
mpls.DynamicLsp
DescendantInfo:
mpls.BypassOnlyLsp
DescendantInfo:
mpls.StaticLsp
DescendantInfo:
mpls.SegmentRoutingTeLsp
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mpls_Lsp_findServices", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findServicesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mpls/Lsp/findSubscribers/{instanceFullName}": { "post": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_Lsp_findSubscribers", "description": "
Intention : RETRIEVER
findSubscribers:
instance-level [object finder] (retriever) API findSubscribers
of class mpls.Lsp
DescendantInfo:
mpls.DynamicLsp
DescendantInfo:
mpls.BypassOnlyLsp
DescendantInfo:
mpls.StaticLsp
DescendantInfo:
mpls.SegmentRoutingTeLsp
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mpls_Lsp_findSubscribers", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findSubscribersResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mpls/LspPathOptimizationPolicy/execute/{instanceFullName}": { "put": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_LspPathOptimizationPolicy_execute", "description": "Find LSP Path identified by the filter and inner Join Condition to DynamicLSP and Rule-Based Group
Binding and then flag them if possible.
Execute resignal of eligible and flagged lspPaths in accordance to this policy.

Intention : MODIFIER
execute:
instance-level modifier API execute
of class mpls.LspPathOptimizationPolicy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mpls_LspPathOptimizationPolicy_execute", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mpls/LspPathOptimizationPolicy/executeFromList/{instanceFullName}": { "put": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_LspPathOptimizationPolicy_executeFromList", "description": "Find LSP Path identified by the filter and inner Join Condition to DynamicLSP and Rule-Based Group
Binding and then flag them if possible.
Execute resignal of eligible and flagged lspPaths in accordance to this policy.

Intention : MODIFIER
executeFromList:
instance-level modifier API executeFromList
of class mpls.LspPathOptimizationPolicy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mpls_LspPathOptimizationPolicy_executeFromList", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeFromListResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mpls/LspPathOptimizationPolicy/findPathWithJoin/{instanceFullName}": { "post": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_LspPathOptimizationPolicy_findPathWithJoin", "description": "Find LSP Path identified by the filter and inner Join Condition to DynamicLSP and MPLS.Tunnel.

Intention : RETRIEVER
findPathWithJoin:
instance-level [object finder] (retriever) API findPathWithJoin
of class mpls.LspPathOptimizationPolicy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mpls_LspPathOptimizationPolicy_findPathWithJoin", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findPathWithJoin" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findPathWithJoinResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mpls/LspPathOptimizationPolicy/terminateCurrentExecution/{instanceFullName}": { "post": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_LspPathOptimizationPolicy_terminateCurrentExecution", "operationId": "rest_mpls_LspPathOptimizationPolicy_terminateCurrentExecution", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mpls/LspTemplateMvpn/findP2mpLsp/{instanceFullName}": { "post": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_LspTemplateMvpn_findP2mpLsp", "description": "
Intention : RETRIEVER
findP2mpLsp:
instance-level [object finder] (retriever) API findP2mpLsp
of class mpls.LspTemplateMvpn
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mpls_LspTemplateMvpn_findP2mpLsp", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findP2mpLspResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mpls/LspTemplateMvpn/findP2pLsp/{instanceFullName}": { "post": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_LspTemplateMvpn_findP2pLsp", "description": "
Intention : RETRIEVER
findP2pLsp:
instance-level [object finder] (retriever) API findP2pLsp
of class mpls.LspTemplateMvpn
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mpls_LspTemplateMvpn_findP2pLsp", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findP2pLspResponse1" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mpls/P2MPDynamicLsp/findCrossconnects/{instanceFullName}": { "post": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_P2MPDynamicLsp_findCrossconnects", "description": "method to retrieve all crossconnects associated with this LSP, including bypass tunnels created crossconnects

Intention : RETRIEVER
findCrossconnects:
instance-level [object finder] (retriever) API findCrossconnects
of class mpls.P2MPDynamicLsp
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mpls_P2MPDynamicLsp_findCrossconnects", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findCrossconnectsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mpls/P2MPDynamicLsp/findRsvpSessions/{instanceFullName}": { "post": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_P2MPDynamicLsp_findRsvpSessions", "description": "
Intention : RETRIEVER
findRsvpSessions:
instance-level [object finder] (retriever) API findRsvpSessions
of class mpls.P2MPDynamicLsp
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mpls_P2MPDynamicLsp_findRsvpSessions", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findRsvpSessionsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mpls/Policy/findAdminGroups": { "post": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_Policy_findAdminGroups", "description": "
Intention : RETRIEVER
findAdminGroups:
class-level [object finder] (retriever) API findAdminGroups
of class mpls.Policy


", "operationId": "rest_mpls_Policy_findAdminGroups", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAdminGroupsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mpls/Policy/findInterfaces/{instanceFullName}": { "post": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_Policy_findInterfaces", "description": "
Intention : RETRIEVER
findInterfaces:
instance-level [object finder] (retriever) API findInterfaces
of class mpls.Policy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mpls_Policy_findInterfaces", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findInterfacesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mpls/Policy/findLspPaths/{instanceFullName}": { "post": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_Policy_findLspPaths", "description": "
Intention : RETRIEVER
findLspPaths:
instance-level [object finder] (retriever) API findLspPaths
of class mpls.Policy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mpls_Policy_findLspPaths", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findLspPathsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mpls/Policy/findLsps/{instanceFullName}": { "post": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_Policy_findLsps", "description": "
Intention : RETRIEVER
findLsps:
instance-level [object finder] (retriever) API findLsps
of class mpls.Policy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mpls_Policy_findLsps", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findLspsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mpls/SharedRiskLinkGroup/findInterfaces/{instanceFullName}": { "post": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_SharedRiskLinkGroup_findInterfaces", "description": "
Intention : RETRIEVER
findInterfaces:
instance-level [object finder] (retriever) API findInterfaces
of class mpls.SharedRiskLinkGroup
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mpls_SharedRiskLinkGroup_findInterfaces", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findInterfacesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mpls/Site/configure/{instanceFullName}": { "post": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_Site_configure", "description": "
Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure
of class mpls.Site
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mpls_Site_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mpls/Tunnel/configure": { "post": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_Tunnel_configure", "description": "
Intention : MODIFIER
configure:
class-level [hierarchical administrative configuration/modification] (modifier) API configure
of class mpls.Tunnel
This API follows hierarchical config model rules.


", "operationId": "rest_mpls_Tunnel_configure", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TunnelConfigInfo" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mpls/Tunnel/configureTunnelAndPath": { "post": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_Tunnel_configureTunnelAndPath", "description": "Create the mpls.Tunnel and mpls.ProvisionedPath in
conjunction with each other. This method should only
be used to create, not modify, the tunnel and path.
Use the generic configure methods in generic.GenericObject.
NOTE: Only paths with hops are actually created. A hop-less
path will result in no object being created and the returned
pathDn being set to nothing.

Intention : MODIFIER
configureTunnelAndPath:
class-level [hierarchical administrative configuration/modification] (modifier) API configureTunnelAndPath
of class mpls.Tunnel
This API follows hierarchical config model rules.


", "operationId": "rest_mpls_Tunnel_configureTunnelAndPath", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureTunnelAndPath" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureTunnelAndPathResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mpls/Tunnel/findActualPath/{instanceFullName}": { "post": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_Tunnel_findActualPath", "description": "
Intention : RETRIEVER
findActualPath:
instance-level [object finder] (retriever) API findActualPath
of class mpls.Tunnel
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mpls_Tunnel_findActualPath", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findActualPathResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mpls/Tunnel/findLspPaths/{instanceFullName}": { "post": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_Tunnel_findLspPaths", "description": "
Intention : RETRIEVER
findLspPaths:
instance-level [object finder] (retriever) API findLspPaths
of class mpls.Tunnel
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mpls_Tunnel_findLspPaths", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findLspPathsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mpls/Tunnel/findLsps/{instanceFullName}": { "post": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_Tunnel_findLsps", "description": "
Intention : RETRIEVER
findLsps:
instance-level [object finder] (retriever) API findLsps
of class mpls.Tunnel
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mpls_Tunnel_findLsps", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findLsps" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findLspsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mpls/Tunnel/findP2mpLsps/{instanceFullName}": { "post": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_Tunnel_findP2mpLsps", "description": "
Intention : RETRIEVER
findP2mpLsps:
instance-level [object finder] (retriever) API findP2mpLsps
of class mpls.Tunnel
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mpls_Tunnel_findP2mpLsps", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findP2mpLsps" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findP2mpLspsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mpls/Tunnel/findProvisionedPath/{instanceFullName}": { "post": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_Tunnel_findProvisionedPath", "description": "
Intention : RETRIEVER
findProvisionedPath:
instance-level [object finder] (retriever) API findProvisionedPath
of class mpls.Tunnel
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mpls_Tunnel_findProvisionedPath", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findProvisionedPathResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mpls/Tunnel/findS2lPaths/{instanceFullName}": { "post": { "tags": [ "samo_mpls" ], "summary": "rest_mpls_Tunnel_findS2lPaths", "description": "
Intention : RETRIEVER
findS2lPaths:
instance-level [object finder] (retriever) API findS2lPaths
of class mpls.Tunnel
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mpls_Tunnel_findS2lPaths", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findS2lPathsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rp/AbstractAdminGroupPolicy/findAdminGroups": { "post": { "tags": [ "samo_rp" ], "summary": "rest_rp_AbstractAdminGroupPolicy_findAdminGroups", "description": "
Intention : RETRIEVER
findAdminGroups:
class-level [object finder] (retriever) API findAdminGroups
of class rp.AbstractAdminGroupPolicy
DescendantInfo:
rp.AdminGroupPolicy


", "operationId": "rest_rp_AbstractAdminGroupPolicy_findAdminGroups", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAdminGroups" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAdminGroupsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rp/AbstractAdminGroupPolicy/findInterfaces/{instanceFullName}": { "post": { "tags": [ "samo_rp" ], "summary": "rest_rp_AbstractAdminGroupPolicy_findInterfaces", "description": "
Intention : RETRIEVER
findInterfaces:
instance-level [object finder] (retriever) API findInterfaces
of class rp.AbstractAdminGroupPolicy
DescendantInfo:
rp.AdminGroupPolicy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_rp_AbstractAdminGroupPolicy_findInterfaces", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findInterfacesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rp/AbstractAdminGroupPolicy/findLspPaths/{instanceFullName}": { "post": { "tags": [ "samo_rp" ], "summary": "rest_rp_AbstractAdminGroupPolicy_findLspPaths", "description": "
Intention : RETRIEVER
findLspPaths:
instance-level [object finder] (retriever) API findLspPaths
of class rp.AbstractAdminGroupPolicy
DescendantInfo:
rp.AdminGroupPolicy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_rp_AbstractAdminGroupPolicy_findLspPaths", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findLspPathsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rp/AbstractAdminGroupPolicy/findLsps/{instanceFullName}": { "post": { "tags": [ "samo_rp" ], "summary": "rest_rp_AbstractAdminGroupPolicy_findLsps", "description": "
Intention : RETRIEVER
findLsps:
instance-level [object finder] (retriever) API findLsps
of class rp.AbstractAdminGroupPolicy
DescendantInfo:
rp.AdminGroupPolicy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_rp_AbstractAdminGroupPolicy_findLsps", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findLspsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rp/AbstractSrlgGroupPolicy/findInterfaces/{instanceFullName}": { "post": { "tags": [ "samo_rp" ], "summary": "rest_rp_AbstractSrlgGroupPolicy_findInterfaces", "description": "
Intention : RETRIEVER
findInterfaces:
instance-level [object finder] (retriever) API findInterfaces
of class rp.AbstractSrlgGroupPolicy
DescendantInfo:
rp.SrlgGroupPolicy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_rp_AbstractSrlgGroupPolicy_findInterfaces", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findInterfacesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rp/AdminGroupPolicy/findInterfaces/{instanceFullName}": { "post": { "tags": [ "samo_rp" ], "summary": "rest_rp_AdminGroupPolicy_findInterfaces", "description": "
Intention : RETRIEVER
findInterfaces:
instance-level [object finder] (retriever) API findInterfaces
of class rp.AdminGroupPolicy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_rp_AdminGroupPolicy_findInterfaces", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findInterfaces" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findInterfacesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rp/AdminGroupPolicy/findRouteNextHopPolicyTemplates/{instanceFullName}": { "post": { "tags": [ "samo_rp" ], "summary": "rest_rp_AdminGroupPolicy_findRouteNextHopPolicyTemplates", "description": "
Intention : RETRIEVER
findRouteNextHopPolicyTemplates:
instance-level [object finder] (retriever) API findRouteNextHopPolicyTemplates
of class rp.AdminGroupPolicy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_rp_AdminGroupPolicy_findRouteNextHopPolicyTemplates", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findRouteNextHopPolicyTemplatesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rp/CommunityMember/findMembers": { "post": { "tags": [ "samo_rp" ], "summary": "rest_rp_CommunityMember_findMembers", "description": "Find the community member instances with the specified type.

Intention : RETRIEVER
findMembers:
class-level [object finder] (retriever) API findMembers
of class rp.CommunityMember


", "operationId": "rest_rp_CommunityMember_findMembers", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findMembers" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findMembersResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rp/ExclusiveEdit/resetPolicyExclusive": { "post": { "tags": [ "samo_rp" ], "summary": "rest_rp_ExclusiveEdit_resetPolicyExclusive", "operationId": "rest_rp_ExclusiveEdit_resetPolicyExclusive", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/rp/ExclusiveEdit/resetPolicyExclusiveForSites": { "post": { "tags": [ "samo_rp" ], "summary": "rest_rp_ExclusiveEdit_resetPolicyExclusiveForSites", "operationId": "rest_rp_ExclusiveEdit_resetPolicyExclusiveForSites", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/rp/FromCriteria/expandPolicyStatement": { "post": { "tags": [ "samo_rp" ], "summary": "rest_rp_FromCriteria_expandPolicyStatement", "description": "
Intention : RETRIEVER
expandPolicyStatement:
class-level retriever API expandPolicyStatement
of class rp.FromCriteria

The result of the executed command (returned as a string).

", "operationId": "rest_rp_FromCriteria_expandPolicyStatement", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expandPolicyStatement" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expandPolicyStatementResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rp/FromCriteria/findInterfaces": { "post": { "tags": [ "samo_rp" ], "summary": "rest_rp_FromCriteria_findInterfaces", "description": "
Intention : RETRIEVER
findInterfaces:
class-level [object finder] (retriever) API findInterfaces
of class rp.FromCriteria


", "operationId": "rest_rp_FromCriteria_findInterfaces", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findInterfacesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rp/PolicyStatementEntry/renum": { "post": { "tags": [ "samo_rp" ], "summary": "rest_rp_PolicyStatementEntry_renum", "operationId": "rest_rp_PolicyStatementEntry_renum", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/renum" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/rp/SrlgGroupPolicy/findInterfaces/{instanceFullName}": { "post": { "tags": [ "samo_rp" ], "summary": "rest_rp_SrlgGroupPolicy_findInterfaces", "description": "
Intention : RETRIEVER
findInterfaces:
instance-level [object finder] (retriever) API findInterfaces
of class rp.SrlgGroupPolicy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_rp_SrlgGroupPolicy_findInterfaces", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findInterfaces" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findInterfacesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/hsm/HSMConfig/forceDelete/{instanceFullName}": { "post": { "tags": [ "samo_hsm" ], "summary": "rest_hsm_HSMConfig_forceDelete", "operationId": "rest_hsm_HSMConfig_forceDelete", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/hsm/HSMConfig/purgeStaleEntriesOnHsm/{instanceFullName}": { "post": { "tags": [ "samo_hsm" ], "summary": "rest_hsm_HSMConfig_purgeStaleEntriesOnHsm", "description": "Purge stale (non-referenced) entries, that were created through this HSMConfig, on the HSM.


Please note, HSM entries are identified by their labels. Normally NFM-P deletes an entry from the HSM if it is no longer needed. However if the deletion fails the entry may become stale on the HSM.
Stale entries in this HSMConfig need to be purged on the HSM explicitly through this method call.

Intention : MODIFIER
purgeStaleEntriesOnHsm:
instance-level modifier API purgeStaleEntriesOnHsm
of class hsm.HSMConfig
instanceFullName : distinguished/instance name of called object
Returns notExecuted(0) if no stale entries (identified by their labels) are associated with this HSMConfig, succeeded(1) if operation succeeds, failed(2) otherwise.

", "operationId": "rest_hsm_HSMConfig_purgeStaleEntriesOnHsm", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/purgeStaleEntriesOnHsmResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/hsm/HSMConfig/testConnectionToHsm/{instanceFullName}": { "post": { "tags": [ "samo_hsm" ], "summary": "rest_hsm_HSMConfig_testConnectionToHsm", "description": "Test the connection to the HSM. This method sends a test request to the HSM.

Intention : MODIFIER
testConnectionToHsm:
instance-level modifier API testConnectionToHsm
of class hsm.HSMConfig
instanceFullName : distinguished/instance name of called object
True if the test request was successfully executed; false otherwise.

", "operationId": "rest_hsm_HSMConfig_testConnectionToHsm", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/testConnectionToHsmResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ethernetoam/AbstractAccessInterfaceMip/resyncMip/{instanceFullName}": { "post": { "tags": [ "samo_ethernetoam" ], "summary": "rest_ethernetoam_AbstractAccessInterfaceMip_resyncMip", "operationId": "rest_ethernetoam_AbstractAccessInterfaceMip_resyncMip", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ethernetoam/AbstractMip/resync": { "post": { "tags": [ "samo_ethernetoam" ], "summary": "rest_ethernetoam_AbstractMip_resync", "operationId": "rest_ethernetoam_AbstractMip_resync", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ethernetoam/AbstractSdpBindingMip/resyncMip/{instanceFullName}": { "post": { "tags": [ "samo_ethernetoam" ], "summary": "rest_ethernetoam_AbstractSdpBindingMip_resyncMip", "operationId": "rest_ethernetoam_AbstractSdpBindingMip_resyncMip", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ethernetoam/CcTest/auditUnicastCCM/{instanceFullName}": { "post": { "tags": [ "samo_ethernetoam" ], "summary": "rest_ethernetoam_CcTest_auditUnicastCCM", "operationId": "rest_ethernetoam_CcTest_auditUnicastCCM", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ethernetoam/CcTest/discoverSubGroups/{instanceFullName}": { "post": { "tags": [ "samo_ethernetoam" ], "summary": "rest_ethernetoam_CcTest_discoverSubGroups", "operationId": "rest_ethernetoam_CcTest_discoverSubGroups", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ethernetoam/CcTest/discoverSubGroupsByDomainId/{instanceFullName}": { "post": { "tags": [ "samo_ethernetoam" ], "summary": "rest_ethernetoam_CcTest_discoverSubGroupsByDomainId", "operationId": "rest_ethernetoam_CcTest_discoverSubGroupsByDomainId", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ethernetoam/CcTest/resyncRemoteMepDb/{instanceFullName}": { "post": { "tags": [ "samo_ethernetoam" ], "summary": "rest_ethernetoam_CcTest_resyncRemoteMepDb", "operationId": "rest_ethernetoam_CcTest_resyncRemoteMepDb", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ethernetoam/CcTest/synchronizeMeps/{instanceFullName}": { "post": { "tags": [ "samo_ethernetoam" ], "summary": "rest_ethernetoam_CcTest_synchronizeMeps", "operationId": "rest_ethernetoam_CcTest_synchronizeMeps", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ethernetoam/CcmTest/cancelCcmTest/{instanceFullName}": { "delete": { "tags": [ "samo_ethernetoam" ], "summary": "rest_ethernetoam_CcmTest_cancelCcmTest", "operationId": "rest_ethernetoam_CcmTest_cancelCcmTest", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ethernetoam/CfmDmmSession/requestClearOamPmDmmRawStats/{instanceFullName}": { "post": { "tags": [ "samo_ethernetoam" ], "summary": "rest_ethernetoam_CfmDmmSession_requestClearOamPmDmmRawStats", "description": "Request clearing of Oam Pm Raw Stats.
When this method returns resources for the clear have been allocated
but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearOamPmDmmRawStats:
instance-level modifier API requestClearOamPmDmmRawStats
of class ethernetoam.CfmDmmSession
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_ethernetoam_CfmDmmSession_requestClearOamPmDmmRawStats", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearOamPmDmmRawStatsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ethernetoam/CfmLMTest/stopCfmlm/{instanceFullName}": { "post": { "tags": [ "samo_ethernetoam" ], "summary": "rest_ethernetoam_CfmLMTest_stopCfmlm", "operationId": "rest_ethernetoam_CfmLMTest_stopCfmlm", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ethernetoam/CfmLmmSession/requestClearOamPmLmmRawStats/{instanceFullName}": { "post": { "tags": [ "samo_ethernetoam" ], "summary": "rest_ethernetoam_CfmLmmSession_requestClearOamPmLmmRawStats", "description": "Request clearing of OAM PM Raw Stats.
When this method returns resources for the clear have been allocated
but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearOamPmLmmRawStats:
instance-level modifier API requestClearOamPmLmmRawStats
of class ethernetoam.CfmLmmSession
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_ethernetoam_CfmLmmSession_requestClearOamPmLmmRawStats", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearOamPmLmmRawStatsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ethernetoam/CfmLoopback/stopCfmLoopBackTest/{instanceFullName}": { "post": { "tags": [ "samo_ethernetoam" ], "summary": "rest_ethernetoam_CfmLoopback_stopCfmLoopBackTest", "operationId": "rest_ethernetoam_CfmLoopback_stopCfmLoopBackTest", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ethernetoam/CfmSlmSession/requestClearOamPmSlmRawStats/{instanceFullName}": { "post": { "tags": [ "samo_ethernetoam" ], "summary": "rest_ethernetoam_CfmSlmSession_requestClearOamPmSlmRawStats", "description": "Request clearing of OAM PM Raw Stats.
When this method returns resources for the clear have been allocated
but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearOamPmSlmRawStats:
instance-level modifier API requestClearOamPmSlmRawStats
of class ethernetoam.CfmSlmSession
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_ethernetoam_CfmSlmSession_requestClearOamPmSlmRawStats", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearOamPmSlmRawStatsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ethernetoam/CfmTwoWayDelayTest/stopCfmTwoWayDelayTest/{instanceFullName}": { "post": { "tags": [ "samo_ethernetoam" ], "summary": "rest_ethernetoam_CfmTwoWayDelayTest_stopCfmTwoWayDelayTest", "operationId": "rest_ethernetoam_CfmTwoWayDelayTest_stopCfmTwoWayDelayTest", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ethernetoam/CfmTwoWaySlm/stopCfmTwoWaySlm/{instanceFullName}": { "post": { "tags": [ "samo_ethernetoam" ], "summary": "rest_ethernetoam_CfmTwoWaySlm_stopCfmTwoWaySlm", "operationId": "rest_ethernetoam_CfmTwoWaySlm_stopCfmTwoWaySlm", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ethernetoam/MaintAssociation/clearAutoDiscoveredRemoteMep/{instanceFullName}": { "post": { "tags": [ "samo_ethernetoam" ], "summary": "rest_ethernetoam_MaintAssociation_clearAutoDiscoveredRemoteMep", "operationId": "rest_ethernetoam_MaintAssociation_clearAutoDiscoveredRemoteMep", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ethernetoam/Mep/resyncRemoteMepDb/{instanceFullName}": { "post": { "tags": [ "samo_ethernetoam" ], "summary": "rest_ethernetoam_Mep_resyncRemoteMepDb", "operationId": "rest_ethernetoam_Mep_resyncRemoteMepDb", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/schedule/ScheduleManager/getTimeZone": { "get": { "tags": [ "samo_schedule" ], "summary": "rest_schedule_ScheduleManager_getTimeZone", "description": "
Intention : RETRIEVER
getTimeZone:
class-level retriever API getTimeZone on default instance scheduleManager of class schedule.ScheduleManager


", "operationId": "rest_schedule_ScheduleManager_getTimeZone", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getTimeZoneResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/schedule/ScheduledTask/shutDown/{instanceFullName}": { "post": { "tags": [ "samo_schedule" ], "summary": "rest_schedule_ScheduledTask_shutDown", "operationId": "rest_schedule_ScheduledTask_shutDown", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/schedule/ScheduledTask/start/{instanceFullName}": { "post": { "tags": [ "samo_schedule" ], "summary": "rest_schedule_ScheduledTask_start", "operationId": "rest_schedule_ScheduledTask_start", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/schedule/ScheduledTask/stop/{instanceFullName}": { "post": { "tags": [ "samo_schedule" ], "summary": "rest_schedule_ScheduledTask_stop", "operationId": "rest_schedule_ScheduledTask_stop", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/schedule/ScheduledTask/turnUp/{instanceFullName}": { "post": { "tags": [ "samo_schedule" ], "summary": "rest_schedule_ScheduledTask_turnUp", "operationId": "rest_schedule_ScheduledTask_turnUp", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/simulator/ActionEvent/findServices/{instanceFullName}": { "post": { "tags": [ "samo_simulator" ], "summary": "rest_simulator_ActionEvent_findServices", "description": "Find all the associated Services with a path monitor.

Intention : RETRIEVER
findServices:
instance-level [object finder] (retriever) API findServices
of class simulator.ActionEvent
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_simulator_ActionEvent_findServices", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findServices" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findServicesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/simulator/Scenario/analyzeImpact/{instanceFullName}": { "post": { "tags": [ "samo_simulator" ], "summary": "rest_simulator_Scenario_analyzeImpact", "operationId": "rest_simulator_Scenario_analyzeImpact", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/simulator/Scenario/close/{instanceFullName}": { "post": { "tags": [ "samo_simulator" ], "summary": "rest_simulator_Scenario_close", "operationId": "rest_simulator_Scenario_close", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/simulator/Scenario/open/{instanceFullName}": { "post": { "tags": [ "samo_simulator" ], "summary": "rest_simulator_Scenario_open", "operationId": "rest_simulator_Scenario_open", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/simulator/Scenario/openAndImport/{instanceFullName}": { "post": { "tags": [ "samo_simulator" ], "summary": "rest_simulator_Scenario_openAndImport", "operationId": "rest_simulator_Scenario_openAndImport", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportStruct" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/flexiperf/FlexiPMPolicy/findFlexiNodes": { "get": { "tags": [ "samo_flexiperf" ], "summary": "rest_flexiperf_FlexiPMPolicy_findFlexiNodes", "description": "Find all managed Flexi eNodeBs for the specified Performance Management polling policy assigned.

Intention : RETRIEVER
findFlexiNodes:
class-level [object finder] (retriever) API findFlexiNodes
of class flexiperf.FlexiPMPolicy
DescendantInfo:
flexiperf.FlexiNodePMPolicy


", "operationId": "rest_flexiperf_FlexiPMPolicy_findFlexiNodes", "parameters": [ { "name": "policyId", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findFlexiNodesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/flexiperf/FlexiPMPolicy/invokeCatchup": { "post": { "tags": [ "samo_flexiperf" ], "summary": "rest_flexiperf_FlexiPMPolicy_invokeCatchup", "operationId": "rest_flexiperf_FlexiPMPolicy_invokeCatchup", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "integer", "format": "int32" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/flexiperf/FlexiPMPolicy/invokeFlexisCatchup": { "post": { "tags": [ "samo_flexiperf" ], "summary": "rest_flexiperf_FlexiPMPolicy_invokeFlexisCatchup", "operationId": "rest_flexiperf_FlexiPMPolicy_invokeFlexisCatchup", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invokeFlexisCatchup" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/monpath/BidirMonitoredIpPath/captureCurrentPath/{instanceFullName}": { "post": { "tags": [ "samo_monpath" ], "summary": "rest_monpath_BidirMonitoredIpPath_captureCurrentPath", "operationId": "rest_monpath_BidirMonitoredIpPath_captureCurrentPath", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/monpath/BidirMonitoredLspPath/captureCurrentPath/{instanceFullName}": { "post": { "tags": [ "samo_monpath" ], "summary": "rest_monpath_BidirMonitoredLspPath_captureCurrentPath", "operationId": "rest_monpath_BidirMonitoredLspPath_captureCurrentPath", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/monpath/MonitoredIpPath/captureCurrentPath/{instanceFullName}": { "post": { "tags": [ "samo_monpath" ], "summary": "rest_monpath_MonitoredIpPath_captureCurrentPath", "operationId": "rest_monpath_MonitoredIpPath_captureCurrentPath", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/monpath/MonitoredIpPath/findServices/{instanceFullName}": { "post": { "tags": [ "samo_monpath" ], "summary": "rest_monpath_MonitoredIpPath_findServices", "description": "Find all the associated Services with an IP path monitor.

Intention : RETRIEVER
findServices:
instance-level [object finder] (retriever) API findServices
of class monpath.MonitoredIpPath
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_monpath_MonitoredIpPath_findServices", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findServices" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findServicesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/monpath/MonitoredLspPath/captureCurrentPath/{instanceFullName}": { "post": { "tags": [ "samo_monpath" ], "summary": "rest_monpath_MonitoredLspPath_captureCurrentPath", "operationId": "rest_monpath_MonitoredLspPath_captureCurrentPath", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/monpath/MonitoredLspPath/findServices/{instanceFullName}": { "post": { "tags": [ "samo_monpath" ], "summary": "rest_monpath_MonitoredLspPath_findServices", "description": "Find all the associated Services with an IP path monitor.

Intention : RETRIEVER
findServices:
instance-level [object finder] (retriever) API findServices
of class monpath.MonitoredLspPath
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_monpath_MonitoredLspPath_findServices", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findServices" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findServicesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/monpath/MonitoredP2MPLspPath/captureCurrentPath/{instanceFullName}": { "post": { "tags": [ "samo_monpath" ], "summary": "rest_monpath_MonitoredP2MPLspPath_captureCurrentPath", "operationId": "rest_monpath_MonitoredP2MPLspPath_captureCurrentPath", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/monpath/MonitoredP2MPLspPath/findServices/{instanceFullName}": { "post": { "tags": [ "samo_monpath" ], "summary": "rest_monpath_MonitoredP2MPLspPath_findServices", "description": "Find all the associated Services with a P2MP LSP path monitor.

Intention : RETRIEVER
findServices:
instance-level [object finder] (retriever) API findServices
of class monpath.MonitoredP2MPLspPath
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_monpath_MonitoredP2MPLspPath_findServices", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findServices" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findServicesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/monpath/MonitoredPath/validatePath/{instanceFullName}": { "post": { "tags": [ "samo_monpath" ], "summary": "rest_monpath_MonitoredPath_validatePath", "description": "Used to trigger the execution of the OAM tests on this monitored
path.

Intention : RETRIEVER
validatePath:
instance-level retriever API validatePath
of class monpath.MonitoredPath
DescendantInfo:
monpath.UnidirMonitoredPath
DescendantInfo:
monpath.BidirMonitoredLspPath
DescendantInfo:
monpath.MonitoredLspPath
DescendantInfo:
monpath.MonitoredIpPath
DescendantInfo:
monpath.BidirMonitoredIpPath
DescendantInfo:
monpath.MonitoredP2MPLspPath
DescendantInfo:
monpath.MonitoredS2LPath
instanceFullName : distinguished/instance name of called object
Number of unidirectional paths which the OAM tests being executed on.
It could return two for bidirectional monitored path if both paths
have been assigned with STM policies. Return zero if there no paths
assigned an STM policy.

", "operationId": "rest_monpath_MonitoredPath_validatePath", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validatePathResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/monpath/MonitoredPath/validatePaths": { "post": { "tags": [ "samo_monpath" ], "summary": "rest_monpath_MonitoredPath_validatePaths", "description": "Used to trigger the execution of the OAM tests on multiple monitored
paths.

Intention : RETRIEVER
validatePaths:
class-level retriever API validatePaths
of class monpath.MonitoredPath
DescendantInfo:
monpath.UnidirMonitoredPath
DescendantInfo:
monpath.BidirMonitoredLspPath
DescendantInfo:
monpath.MonitoredLspPath
DescendantInfo:
monpath.MonitoredIpPath
DescendantInfo:
monpath.BidirMonitoredIpPath
DescendantInfo:
monpath.MonitoredP2MPLspPath
DescendantInfo:
monpath.MonitoredS2LPath

Number of unidirectional paths which the OAM tests being executed on.
The value is the number of all the unidirectional monitored path if it
has been assigned with STM policy. Return zero if there no paths assigned
an STM policy.

", "operationId": "rest_monpath_MonitoredPath_validatePaths", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validatePathsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/monpath/MonitoredPathManager/createBidirMonitoredPath": { "post": { "tags": [ "samo_monpath" ], "summary": "rest_monpath_MonitoredPathManager_createBidirMonitoredPath", "description": "Used to create multiple birdir lsp monitored paths from the passed in LSPs.

Intention : MODIFIER
createBidirMonitoredPath:
class-level [administrative creation] (modifier) API createBidirMonitoredPath on default instance monitored-path-mgr of class monpath.MonitoredPathManager


", "operationId": "rest_monpath_MonitoredPathManager_createBidirMonitoredPath", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createBidirMonitoredPathResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/monpath/MonitoredPathManager/createMonitoredPath": { "post": { "tags": [ "samo_monpath" ], "summary": "rest_monpath_MonitoredPathManager_createMonitoredPath", "operationId": "rest_monpath_MonitoredPathManager_createMonitoredPath", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createMonitoredPath" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/monpath/MonitoredS2LPath/captureCurrentPath/{instanceFullName}": { "post": { "tags": [ "samo_monpath" ], "summary": "rest_monpath_MonitoredS2LPath_captureCurrentPath", "operationId": "rest_monpath_MonitoredS2LPath_captureCurrentPath", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/monpath/MonitoredS2LPath/findServices/{instanceFullName}": { "post": { "tags": [ "samo_monpath" ], "summary": "rest_monpath_MonitoredS2LPath_findServices", "description": "Find all the associated Services with a P2MP S2L Path monitor.

Intention : RETRIEVER
findServices:
instance-level [object finder] (retriever) API findServices
of class monpath.MonitoredS2LPath
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_monpath_MonitoredS2LPath_findServices", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findServices" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findServicesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/pim/Site/configure/{instanceFullName}": { "post": { "tags": [ "samo_pim" ], "summary": "rest_pim_Site_configure", "description": "
Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure
of class pim.Site
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_pim_Site_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/pim/VirtualAnyCastRP/addAnyCastRPMember/{instanceFullName}": { "post": { "tags": [ "samo_pim" ], "summary": "rest_pim_VirtualAnyCastRP_addAnyCastRPMember", "operationId": "rest_pim_VirtualAnyCastRP_addAnyCastRPMember", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/addAnyCastRPMember" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/pim/VirtualAnyCastRP/findLocalAddress": { "post": { "tags": [ "samo_pim" ], "summary": "rest_pim_VirtualAnyCastRP_findLocalAddress", "description": "finds local addresses that can be added to an Virtual
Anycast RP

Intention : RETRIEVER
findLocalAddress:
class-level [object finder] (retriever) API findLocalAddress
of class pim.VirtualAnyCastRP


", "operationId": "rest_pim_VirtualAnyCastRP_findLocalAddress", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findLocalAddress" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findLocalAddressResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/pim/VirtualAnyCastRP/updateStatusFlags/{instanceFullName}": { "put": { "tags": [ "samo_pim" ], "summary": "rest_pim_VirtualAnyCastRP_updateStatusFlags", "operationId": "rest_pim_VirtualAnyCastRP_updateStatusFlags", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/radiusaccounting/Policy/findVPRNInstances": { "get": { "tags": [ "samo_radiusaccounting" ], "summary": "rest_radiusaccounting_Policy_findVPRNInstances", "description": "finds VPRN Instances that have site configured.

Intention : RETRIEVER
findVPRNInstances:
class-level [object finder] (retriever) API findVPRNInstances
of class radiusaccounting.Policy


", "operationId": "rest_radiusaccounting_Policy_findVPRNInstances", "parameters": [ { "name": "aInSiteID", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findVPRNInstancesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/db/AuxiliaryDbBackup/AuxDbBackup/{instanceFullName}": { "post": { "tags": [ "samo_db" ], "summary": "rest_db_AuxiliaryDbBackup_AuxDbBackup", "operationId": "rest_db_AuxiliaryDbBackup_AuxDbBackup", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/db/DatabaseManager/backup": { "post": { "tags": [ "samo_db" ], "summary": "rest_db_DatabaseManager_backup", "operationId": "rest_db_DatabaseManager_backup", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/db/DatabaseManager/getDbStatus": { "get": { "tags": [ "samo_db" ], "summary": "rest_db_DatabaseManager_getDbStatus", "description": "Determine the status of the Primary Standalone database.


  1. Value of 1 for UP
  2. Value of 2 for DOWN


Intention : RETRIEVER
getDbStatus:
instance-level retriever API getDbStatus on default instance database-manager of class db.DatabaseManager


", "operationId": "rest_db_DatabaseManager_getDbStatus", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getDbStatusResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/db/DatabaseManager/getProxyStatus": { "get": { "tags": [ "samo_db" ], "summary": "rest_db_DatabaseManager_getProxyStatus", "description": "Determine the status of the database proxies.

  1. Bit value 00 for Primary Proxy DOWN, Standby Proxy DOWN
  2. Bit value 01 for Primary Proxy UP, Standby Proxy DOWN
  3. Bit value 10 for Primary Proxy DOWN, Standby Proxy UP
  4. Bit value 11 for Primary Proxy UP, Standby Proxy UP


Intention : RETRIEVER
getProxyStatus:
instance-level retriever API getProxyStatus on default instance database-manager of class db.DatabaseManager


", "operationId": "rest_db_DatabaseManager_getProxyStatus", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getProxyStatusResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/db/DatabaseManager/getStandbyDbStatus": { "get": { "tags": [ "samo_db" ], "summary": "rest_db_DatabaseManager_getStandbyDbStatus", "description": "Determine the status of the Standby database.

  1. Value of 4 for UP
  2. Value of 5 for DOWN
  3. Value of 6 for OUT OF SYNC


Intention : RETRIEVER
getStandbyDbStatus:
instance-level retriever API getStandbyDbStatus on default instance database-manager of class db.DatabaseManager


", "operationId": "rest_db_DatabaseManager_getStandbyDbStatus", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getStandbyDbStatusResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/db/DatabaseManager/isDbRedundant": { "post": { "tags": [ "samo_db" ], "summary": "rest_db_DatabaseManager_isDbRedundant", "description": "Determine if the database is redundant (either Primary or Standby).

Intention : RETRIEVER
isDbRedundant:
instance-level retriever API isDbRedundant on default instance database-manager of class db.DatabaseManager


", "operationId": "rest_db_DatabaseManager_isDbRedundant", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/isDbRedundantResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/db/DatabaseManager/reinstantiateStandby": { "post": { "tags": [ "samo_db" ], "summary": "rest_db_DatabaseManager_reinstantiateStandby", "operationId": "rest_db_DatabaseManager_reinstantiateStandby", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/db/DatabaseManager/switchover": { "post": { "tags": [ "samo_db" ], "summary": "rest_db_DatabaseManager_switchover", "operationId": "rest_db_DatabaseManager_switchover", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/db/SizeConstrainedClass/listUnusedClasses": { "post": { "tags": [ "samo_db" ], "summary": "rest_db_SizeConstrainedClass_listUnusedClasses", "description": "
Intention : RETRIEVER
listUnusedClasses:
class-level retriever API listUnusedClasses
of class db.SizeConstrainedClass


", "operationId": "rest_db_SizeConstrainedClass_listUnusedClasses", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listUnusedClassesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/db/SizeConstraintPolicy/configure": { "post": { "tags": [ "samo_db" ], "summary": "rest_db_SizeConstraintPolicy_configure", "description": "
Intention : MODIFIER
configure:
class-level [hierarchical administrative configuration/modification] (modifier) API configure
of class db.SizeConstraintPolicy
This API follows hierarchical config model rules.


", "operationId": "rest_db_SizeConstraintPolicy_configure", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SizeConstraintPolicyConfigInfo" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/macsec/CASite/syncWithGlobal/{instanceFullName}": { "post": { "tags": [ "samo_macsec" ], "summary": "rest_macsec_CASite_syncWithGlobal", "operationId": "rest_macsec_CASite_syncWithGlobal", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/macsec/ConnectivityAssociation/addCASites": { "post": { "tags": [ "samo_macsec" ], "summary": "rest_macsec_ConnectivityAssociation_addCASites", "operationId": "rest_macsec_ConnectivityAssociation_addCASites", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/addCASites" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/macsec/ConnectivityAssociation/deleteCASites/{instanceFullName}": { "delete": { "tags": [ "samo_macsec" ], "summary": "rest_macsec_ConnectivityAssociation_deleteCASites", "operationId": "rest_macsec_ConnectivityAssociation_deleteCASites", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/macsec/ConnectivityAssociation/resetInProgressKeyingStatus/{instanceFullName}": { "post": { "tags": [ "samo_macsec" ], "summary": "rest_macsec_ConnectivityAssociation_resetInProgressKeyingStatus", "operationId": "rest_macsec_ConnectivityAssociation_resetInProgressKeyingStatus", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/macsec/MacSecScheduledTask/startRekey/{instanceFullName}": { "post": { "tags": [ "samo_macsec" ], "summary": "rest_macsec_MacSecScheduledTask_startRekey", "operationId": "rest_macsec_MacSecScheduledTask_startRekey", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/macsec/MacsecInterface/removeMacsecInterfacesFromCA": { "post": { "tags": [ "samo_macsec" ], "summary": "rest_macsec_MacsecInterface_removeMacsecInterfacesFromCA", "operationId": "rest_macsec_MacsecInterface_removeMacsecInterfacesFromCA", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/macsec/StaticCAK/createPsk/{instanceFullName}": { "post": { "tags": [ "samo_macsec" ], "summary": "rest_macsec_StaticCAK_createPsk", "operationId": "rest_macsec_StaticCAK_createPsk", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createPsk" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/macsec/StaticCAK/deletePsk/{instanceFullName}": { "delete": { "tags": [ "samo_macsec" ], "summary": "rest_macsec_StaticCAK_deletePsk", "operationId": "rest_macsec_StaticCAK_deletePsk", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/macsec/StaticCAK/distributePSKs/{instanceFullName}": { "post": { "tags": [ "samo_macsec" ], "summary": "rest_macsec_StaticCAK_distributePSKs", "operationId": "rest_macsec_StaticCAK_distributePSKs", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/macsec/StaticCAK/syncWithGlobal/{instanceFullName}": { "post": { "tags": [ "samo_macsec" ], "summary": "rest_macsec_StaticCAK_syncWithGlobal", "operationId": "rest_macsec_StaticCAK_syncWithGlobal", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/slope/QosPool/configure/{instanceFullName}": { "post": { "tags": [ "samo_slope" ], "summary": "rest_slope_QosPool_configure", "description": "
Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure
of class slope.QosPool
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_slope_QosPool_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QosPoolConfigInfo" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/tca/TCAPolicy/addMonitoredObjects/{instanceFullName}": { "post": { "tags": [ "samo_tca" ], "summary": "rest_tca_TCAPolicy_addMonitoredObjects", "operationId": "rest_tca_TCAPolicy_addMonitoredObjects", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/tca/TCAPolicy/addMonitoredObjectsUsingFilter/{instanceFullName}": { "post": { "tags": [ "samo_tca" ], "summary": "rest_tca_TCAPolicy_addMonitoredObjectsUsingFilter", "operationId": "rest_tca_TCAPolicy_addMonitoredObjectsUsingFilter", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/tca/TCAPolicy/removeMonitoredObjects/{instanceFullName}": { "post": { "tags": [ "samo_tca" ], "summary": "rest_tca_TCAPolicy_removeMonitoredObjects", "operationId": "rest_tca_TCAPolicy_removeMonitoredObjects", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/tca/TCAPolicy/removeMonitoredObjectsUsingFilter/{instanceFullName}": { "post": { "tags": [ "samo_tca" ], "summary": "rest_tca_TCAPolicy_removeMonitoredObjectsUsingFilter", "operationId": "rest_tca_TCAPolicy_removeMonitoredObjectsUsingFilter", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/l2fwd/AbstractMmrpEntry/resync": { "post": { "tags": [ "samo_l2fwd" ], "summary": "rest_l2fwd_AbstractMmrpEntry_resync", "operationId": "rest_l2fwd_AbstractMmrpEntry_resync", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/l2fwd/MldSiteMvr/findUserMvrSaps": { "post": { "tags": [ "samo_l2fwd" ], "summary": "rest_l2fwd_MldSiteMvr_findUserMvrSaps", "description": "
Intention : RETRIEVER
findUserMvrSaps:
class-level [object finder] (retriever) API findUserMvrSaps
of class l2fwd.MldSiteMvr

List of SAPS which are using these MVR VPLS Service(s).

", "operationId": "rest_l2fwd_MldSiteMvr_findUserMvrSaps", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findUserMvrSaps" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findUserMvrSapsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/l2fwd/MrpPolicyEntry/renum": { "post": { "tags": [ "samo_l2fwd" ], "summary": "rest_l2fwd_MrpPolicyEntry_renum", "operationId": "rest_l2fwd_MrpPolicyEntry_renum", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/renum" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/l2fwd/SiteMvr/findUserMvrSaps": { "post": { "tags": [ "samo_l2fwd" ], "summary": "rest_l2fwd_SiteMvr_findUserMvrSaps", "description": "
Intention : RETRIEVER
findUserMvrSaps:
class-level [object finder] (retriever) API findUserMvrSaps
of class l2fwd.SiteMvr

List of SAPS which are using these MVR VPLS Service(s).

", "operationId": "rest_l2fwd_SiteMvr_findUserMvrSaps", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findUserMvrSaps" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findUserMvrSapsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/niegr/EgressMatch/renum": { "post": { "tags": [ "samo_niegr" ], "summary": "rest_niegr_EgressMatch_renum", "operationId": "rest_niegr_EgressMatch_renum", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/renum" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/niegr/Match/renum": { "post": { "tags": [ "samo_niegr" ], "summary": "rest_niegr_Match_renum", "operationId": "rest_niegr_Match_renum", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/renum" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/niegr/Policy/findNetworkIpInterfaces/{instanceFullName}": { "post": { "tags": [ "samo_niegr" ], "summary": "rest_niegr_Policy_findNetworkIpInterfaces", "description": "
Intention : RETRIEVER
findNetworkIpInterfaces:
instance-level [object finder] (retriever) API findNetworkIpInterfaces
of class niegr.Policy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_niegr_Policy_findNetworkIpInterfaces", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findNetworkIpInterfacesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/connprof/ConnProfPolicy/getAllSonetChannels/{instanceFullName}": { "post": { "tags": [ "samo_connprof" ], "summary": "rest_connprof_ConnProfPolicy_getAllSonetChannels", "description": "
Intention : RETRIEVER
getAllSonetChannels:
instance-level retriever API getAllSonetChannels
of class connprof.ConnProfPolicy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_connprof_ConnProfPolicy_getAllSonetChannels", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getAllSonetChannelsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/connprof/ConnProfPolicy/getAllVlanRanegSAPs/{instanceFullName}": { "post": { "tags": [ "samo_connprof" ], "summary": "rest_connprof_ConnProfPolicy_getAllVlanRanegSAPs", "description": "
Intention : RETRIEVER
getAllVlanRanegSAPs:
instance-level retriever API getAllVlanRanegSAPs
of class connprof.ConnProfPolicy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_connprof_ConnProfPolicy_getAllVlanRanegSAPs", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getAllVlanRanegSAPsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/connprof/PssConnProfPolicy/getAllVlanRanegSAPs/{instanceFullName}": { "post": { "tags": [ "samo_connprof" ], "summary": "rest_connprof_PssConnProfPolicy_getAllVlanRanegSAPs", "description": "
Intention : RETRIEVER
getAllVlanRanegSAPs:
instance-level retriever API getAllVlanRanegSAPs
of class connprof.PssConnProfPolicy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_connprof_PssConnProfPolicy_getAllVlanRanegSAPs", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getAllVlanRanegSAPsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/connprof/VlanConnProfPolicy/getVlanConnProfSAPs/{instanceFullName}": { "post": { "tags": [ "samo_connprof" ], "summary": "rest_connprof_VlanConnProfPolicy_getVlanConnProfSAPs", "description": "
Intention : RETRIEVER
getVlanConnProfSAPs:
instance-level retriever API getVlanConnProfSAPs
of class connprof.VlanConnProfPolicy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_connprof_VlanConnProfPolicy_getVlanConnProfSAPs", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getVlanConnProfSAPs" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getVlanConnProfSAPsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/policy/Manager/audit": { "post": { "tags": [ "samo_policy" ], "summary": "rest_policy_Manager_audit", "operationId": "rest_policy_Manager_audit", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/policy/Manager/auditLocalPolicy": { "post": { "tags": [ "samo_policy" ], "summary": "rest_policy_Manager_auditLocalPolicy", "description": "Compare the differences between two local policies or between the local and global policy.

Intention : RETRIEVER
auditLocalPolicy:
class-level retriever API auditLocalPolicy
of class policy.Manager

The struct shows the list of properties which are different between two local policies or between the local and global policy.

", "operationId": "rest_policy_Manager_auditLocalPolicy", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/auditLocalPolicy" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/auditLocalPolicyResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/policy/Manager/auditLocalPolicyWithInApplicableAttributeOption": { "post": { "tags": [ "samo_policy" ], "summary": "rest_policy_Manager_auditLocalPolicyWithInApplicableAttributeOption", "description": "Compare the differences between two local policies or between the local and global policy.

Intention : RETRIEVER
auditLocalPolicyWithInApplicableAttributeOption:
class-level retriever API auditLocalPolicyWithInApplicableAttributeOption
of class policy.Manager

The struct shows the list of properties which are different between two local policies or between the local and global policy.

", "operationId": "rest_policy_Manager_auditLocalPolicyWithInApplicableAttributeOption", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/auditLocalPolicyWithInApplicableAttributeOption" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/auditLocalPolicyWithInApplicableAttributeOptionResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/policy/Manager/auditPolicies": { "post": { "tags": [ "samo_policy" ], "summary": "rest_policy_Manager_auditPolicies", "operationId": "rest_policy_Manager_auditPolicies", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditSelectedPoliciesInfo" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/policy/Manager/checkBulkDistributeWithinCapacity/{instanceFullName}": { "post": { "tags": [ "samo_policy" ], "summary": "rest_policy_Manager_checkBulkDistributeWithinCapacity", "description": "This method is used when multiple policies are selected for distribution.
It checks if the number of tasks created for bulk policy distribution is within configured capacity.

Intention : MODIFIER
checkBulkDistributeWithinCapacity:
instance-level modifier API checkBulkDistributeWithinCapacity
of class policy.Manager
instanceFullName : distinguished/instance name of called object
True if the number of tasks is within configured maximum, false otherwise.

", "operationId": "rest_policy_Manager_checkBulkDistributeWithinCapacity", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkBulkDistributeWithinCapacity" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkBulkDistributeWithinCapacityResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/policy/Manager/copyMovePolicyEntries": { "post": { "tags": [ "samo_policy" ], "summary": "rest_policy_Manager_copyMovePolicyEntries", "operationId": "rest_policy_Manager_copyMovePolicyEntries", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/copyMovePolicyEntries" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/policy/Manager/deleteExportedFile": { "delete": { "tags": [ "samo_policy" ], "summary": "rest_policy_Manager_deleteExportedFile", "operationId": "rest_policy_Manager_deleteExportedFile", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/policy/Manager/exportPolicies": { "post": { "tags": [ "samo_policy" ], "summary": "rest_policy_Manager_exportPolicies", "operationId": "rest_policy_Manager_exportPolicies", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/exportPolicies" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/policy/Manager/findExportPolicyFileInfo": { "get": { "tags": [ "samo_policy" ], "summary": "rest_policy_Manager_findExportPolicyFileInfo", "description": "Finds all exported policy file names for a given policy class, along with its description and exported NFM-P version.

Intention : RETRIEVER
findExportPolicyFileInfo:
class-level [object finder] (retriever) API findExportPolicyFileInfo
of class policy.Manager


", "operationId": "rest_policy_Manager_findExportPolicyFileInfo", "parameters": [ { "name": "policyClassName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findExportPolicyFileInfoResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/policy/Manager/findPolicy/{instanceFullName}": { "post": { "tags": [ "samo_policy" ], "summary": "rest_policy_Manager_findPolicy", "description": "Finds all policies managed by this instance of policy manager
and passing the filter specified as parameter.
If a policy type is not supported on a Network Element
the policy manager of that type may not exist on that
Network Element. In this case this method will throw an
'object not found' exception because the policy manager was not found.
One can use the method 'findPolicyOfType' as an alternative in this case.

Intention : RETRIEVER
findPolicy:
instance-level [object finder] (retriever) API findPolicy
of class policy.Manager
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_policy_Manager_findPolicy", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findPolicyResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/policy/Manager/findPolicyOfType": { "post": { "tags": [ "samo_policy" ], "summary": "rest_policy_Manager_findPolicyOfType", "description": "Finds all policies of a given policy type
and passing the filter specified as parameter.
This is a class-level method and does not require
that the given policy manager should exist. If the policy
manager does not exist this method will simply return
an empty list.

Intention : RETRIEVER
findPolicyOfType:
class-level [object finder] (retriever) API findPolicyOfType
of class policy.Manager


", "operationId": "rest_policy_Manager_findPolicyOfType", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findPolicyOfType" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findPolicyOfTypeResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/policy/Manager/getAuditStatus": { "get": { "tags": [ "samo_policy" ], "summary": "rest_policy_Manager_getAuditStatus", "description": "Return the summary of AuditStatus object (see AuditStatus for the details).

Intention : RETRIEVER
getAuditStatus:
class-level retriever API getAuditStatus
of class policy.Manager


", "operationId": "rest_policy_Manager_getAuditStatus", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getAuditStatusResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/policy/Manager/importPolicies": { "post": { "tags": [ "samo_policy" ], "summary": "rest_policy_Manager_importPolicies", "description": "
Intention : MODIFIER
importPolicies:
class-level modifier API importPolicies
of class policy.Manager


", "operationId": "rest_policy_Manager_importPolicies", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/importPolicies" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/importPoliciesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/policy/Manager/interruptAudit": { "post": { "tags": [ "samo_policy" ], "summary": "rest_policy_Manager_interruptAudit", "operationId": "rest_policy_Manager_interruptAudit", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "boolean" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/policy/Manager/previewPolicyList": { "post": { "tags": [ "samo_policy" ], "summary": "rest_policy_Manager_previewPolicyList", "description": "
Intention : RETRIEVER
previewPolicyList:
class-level retriever API previewPolicyList
of class policy.Manager


", "operationId": "rest_policy_Manager_previewPolicyList", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/previewPolicyListResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/policy/PolicyDefinition/distribute/{instanceFullName}": { "post": { "tags": [ "samo_policy" ], "summary": "rest_policy_PolicyDefinition_distribute", "description": "The global policy is distributed to the NEs specified in siteIds. If the distribution fails
NFM-P validation for one NE, the global policy would not be distributed to any NEs. The max
size of NEs which can be distributed is calculated from the policyDistributionMaxObjectLimit
divided by the number of items in the global policy. The policyDistributionMaxObjectLimit is
defined in nms-server.xml. Use {{policy.PolicyDefinition.distributeV2()}} for scaled distribution.

Intention : MODIFIER
distribute:
instance-level modifier API distribute
of class policy.PolicyDefinition
DescendantInfo:
rtr.SegmentRoutingMaintenancePolicy
DescendantInfo:
lte5g.PcfIdList
DescendantInfo:
mplstp.BFDTemplate
DescendantInfo:
ixrqos.VlanQosPolicy
DescendantInfo:
ressubscr.ShcvPolicy
DescendantInfo:
ltepolicyoptions.AssumePositiveActionProfile
DescendantInfo:
ixrqos.FcLspExpMap
DescendantInfo:
aclfilterli.LiIpv6Filter
DescendantInfo:
subscrexpmap.Policy
DescendantInfo:
sitesec.DCpuProtection
DescendantInfo:
rp.ASPathGroup
DescendantInfo:
diameter.DiameterAppPolicy
DescendantInfo:
aclfilter.AbstractFilterDefinition
DescendantInfo:
sasqos.Network
DescendantInfo:
lte.GtpProfile
DescendantInfo:
rp.PolicyStatement
DescendantInfo:
file.Policy
DescendantInfo:
lte.PfcpAPPeerList
DescendantInfo:
ethernetservice.UniProfile
DescendantInfo:
ltepolicyoptions.TrafficHashProfile
DescendantInfo:
sitesec.TlsCertificateProfile
DescendantInfo:
qosprofile.MlpppEgressQosProfile
DescendantInfo:
vs.AdvancedConfigPolicy
DescendantInfo:
sasqos.SchedulerPolicy
DescendantInfo:
aapolicy.AAUrlFilter
DescendantInfo:
genericne.MvQosPolicy
DescendantInfo:
sitesec.PkiCommonNameList
DescendantInfo:
ethernetservice.CustomL2Profile
DescendantInfo:
ltetwag.DiameterPeerGroupList
DescendantInfo:
postpolicermapping.PostPolicerMappingPolicy
DescendantInfo:
aengr.Policy
DescendantInfo:
sitesec.LocalUser
DescendantInfo:
rp.PrefixList
DescendantInfo:
lte5g.NfIdList
DescendantInfo:
rtr.RouteNextHopPolicyTemplate
DescendantInfo:
lte5g.QfiMappingProfile
DescendantInfo:
aapolicy.AbstractTransitPolicy
DescendantInfo:
aclfilter.AbstractExceptionFilter
DescendantInfo:
sasqos.DSCPClassification
DescendantInfo:
lte.WlanEmergencyProfile
DescendantInfo:
portscheduler.Policy
DescendantInfo:
vs.Policy
DescendantInfo:
lteggsn.GyAvpOptionProfile
DescendantInfo:
ixrqos.NetworkIngressPolicy
DescendantInfo:
ixrqos.FcDot1pMap
DescendantInfo:
sasqos.NQueue
DescendantInfo:
aapolicy.TetherDetection
DescendantInfo:
service.Y1564AcceptanceCriteriaProfile
DescendantInfo:
ltepolicyoptions.PolicyRule
DescendantInfo:
lte.Abspfcp
DescendantInfo:
mmepolicy.MMEEmergencyNumListPolicy
DescendantInfo:
sitesec.AOSSecurityPolicy
DescendantInfo:
lte.T6cProfile
DescendantInfo:
lte.EpdgGroupList
DescendantInfo:
slope.HsmdaSlopePolicy
DescendantInfo:
aapolicy.AaStatTcaFltrEntryCfg
DescendantInfo:
lte.SourceIpList
DescendantInfo:
sasqos.FcDscpMap
DescendantInfo:
lte.IPProfile
DescendantInfo:
ipsec.IPSecTransform
DescendantInfo:
subscrauth.Policy
DescendantInfo:
icmp.IcmpPingTemplate
DescendantInfo:
qosprefixlist.PrefixList
DescendantInfo:
sitesec.DoSProtection
DescendantInfo:
lte.DccaProfile
DescendantInfo:
filterprefixlist.PortList
DescendantInfo:
rtr.AdminTag
DescendantInfo:
aapolicy.AASessionFilter
DescendantInfo:
hsqos.HsSchedulerPolicy
DescendantInfo:
ltepolicyoptions.ServiceClassIndicator
DescendantInfo:
sitesec.UserProfile
DescendantInfo:
ltepolicyoptions.SruList
DescendantInfo:
lte.AllUesCallTrace
DescendantInfo:
sitesec.TlsServerCipherList
DescendantInfo:
ltegw.TariffChangeListProfilePolicyGroup
DescendantInfo:
aingr.Policy
DescendantInfo:
aapolicy.AbstractHttpRedirect
DescendantInfo:
ltetwag.StaProfile
DescendantInfo:
redirectfilter.RedirectPolicyBinding
DescendantInfo:
sasqos.FCMeterMap
DescendantInfo:
vrrp.Policy
DescendantInfo:
lte5g.SliceList
DescendantInfo:
sasqos.SlopePolicy
DescendantInfo:
todsuite.Policy
DescendantInfo:
diameter.DiameterPolicy
DescendantInfo:
sasqos.SystemResourceProfilePolicy
DescendantInfo:
genericne.MvAbstractPolicy
DescendantInfo:
aapolicy.TransitPrefixPolicy
DescendantInfo:
sitesec.EstAuthProfile
DescendantInfo:
hwaggshapersched.HwAggShaperSchedulerPolicy
DescendantInfo:
aossas.CPETestHeadGroupProfile
DescendantInfo:
lte5g.PrioAddrList
DescendantInfo:
rp.GlobalVariables
DescendantInfo:
lte5g.SliceInstanceList
DescendantInfo:
lte.DedicatedBearerIdleTimeOutProfile
DescendantInfo:
security.KeyChain
DescendantInfo:
lte.PcmdProfile
DescendantInfo:
lteepdg.SwmAvpOptionProfile
DescendantInfo:
mpls.SharedRiskLinkGroup
DescendantInfo:
sitesec.TlsClientCipherList
DescendantInfo:
lte.AmfIdList
DescendantInfo:
ltehomeagent.MobileIpv4Profile
DescendantInfo:
file.LogDefinition
DescendantInfo:
macsec.MacPolicy
DescendantInfo:
securitypolicy.Policy
DescendantInfo:
ltepolicyoptions.AbsPolicyOptionProfile
DescendantInfo:
aclfilter.IpExceptionFilter
DescendantInfo:
sasqos.Dot1pClassification
DescendantInfo:
ipsec.IkePolicy
DescendantInfo:
mpr.QueueMapPolicy
DescendantInfo:
aapolicy.ApplicationAssurancePolicyDefinition
DescendantInfo:
service.VplsSapTemplate
DescendantInfo:
ltegw.AbsListPolicyGroup
DescendantInfo:
lte.SDProfile
DescendantInfo:
aapolicy.SctpFilter
DescendantInfo:
lte.PlmnListPolicyGroup
DescendantInfo:
mpr.GneRadiusQosPolicy
DescendantInfo:
l2fwd.MrpPolicy
DescendantInfo:
sasqos.AccessIngress
DescendantInfo:
crdtctrl.CrdtCtrlPolicy
DescendantInfo:
lte.PortList
DescendantInfo:
lte5g.SbaNudmSdmProf
DescendantInfo:
rp.Damping
DescendantInfo:
aapolicy.TransitIpPolicy
DescendantInfo:
lte.SwmErrorMappingProfile
DescendantInfo:
firewall.Zone
DescendantInfo:
rp.ASPath
DescendantInfo:
ltepolicyoptions.UsgMonInfo
DescendantInfo:
sitesec.RadiusPolicy
DescendantInfo:
optical.AlarmProfile
DescendantInfo:
ipsec.CertProfile
DescendantInfo:
crdtctrl.CtgryMapPolicy
DescendantInfo:
lte.DiameterErrorMappingProfile
DescendantInfo:
ressubscr.HostTrackingPolicy
DescendantInfo:
sasqos.MplsLspExpClassification
DescendantInfo:
ressubscr.IgmpPolicy
DescendantInfo:
lte.AccountingPriorityProfile
DescendantInfo:
rp.RouteNextHopPolicyTemplate
DescendantInfo:
ressubscr.PimPolicy
DescendantInfo:
ltepolicyoptions.DynamicToInternalRuleMap
DescendantInfo:
netca.CardStatsTCAProfile
DescendantInfo:
subscrprofile.Policy
DescendantInfo:
aapolicy.HttpEnrich
DescendantInfo:
ltepolicyoptions.GxAvpOptionProfile
DescendantInfo:
sitesec.LdapPolicy
DescendantInfo:
aclfilter.FilterDefinition
DescendantInfo:
fpresource.FPResourcePolicy
DescendantInfo:
securitypolicy.Zone
DescendantInfo:
ltegw.SCTPProfile
DescendantInfo:
sasqos.QueueMgmtPolicy
DescendantInfo:
sasqos.FcLspExpMap
DescendantInfo:
ltepolicyoptions.TriggerRuleUnitProfile
DescendantInfo:
ressubscr.HttpRedirectPolicy
DescendantInfo:
service.Y1564FrameMixProfile
DescendantInfo:
ltepolicyoptions.PolicyRuleUnit
DescendantInfo:
firewall.MgmtAccessFirewall
DescendantInfo:
ltehomeagent.AbsHomeAgentProfile
DescendantInfo:
firewall.RuleSet
DescendantInfo:
netca.StatsTCAProfile
DescendantInfo:
genericne.MvPolicerPolicy
DescendantInfo:
rp.AbstractSrlgGroupPolicy
DescendantInfo:
lte5g.SbaNudmUecmProf
DescendantInfo:
sasqos.IngressCoSClassification
DescendantInfo:
rp.SrlgGroupPolicy
DescendantInfo:
aaa.RadiusScriptPolicy
DescendantInfo:
nat.SvcChainVasFilterPolicy
DescendantInfo:
aapolicy.DnsIpCache
DescendantInfo:
sasqos.NetworkIngress
DescendantInfo:
ltepolicyoptions.ChargingRuleUnit
DescendantInfo:
aapolicy.AAFlowCfgPolicy
DescendantInfo:
lte5g.HTTP2Profile
DescendantInfo:
sasqos.PortAccessIngress
DescendantInfo:
ltegw.PcscfGroupProfile
DescendantInfo:
multicast.IngrPathMgmtInfoPolicy
DescendantInfo:
sitesec.ManagementAccessFilter
DescendantInfo:
ltetwag.SwwTunnelProfile
DescendantInfo:
ethernetoam.MaintenanceDomain
DescendantInfo:
ipsec.RadiusAuthenticationPolicy
DescendantInfo:
aapolicy.AaStatTcaPolicerCfg
DescendantInfo:
ipsec.TrafficSelectorList
DescendantInfo:
atmpolicy.TrafficDescriptor
DescendantInfo:
sasqos.PortAccessEgress
DescendantInfo:
aapolicy.MpTcpProxy
DescendantInfo:
connprof.VlanConnProfPolicy
DescendantInfo:
opticalacl.IpPattern
DescendantInfo:
policing.PolicerControl
DescendantInfo:
sw.SoftwareRepositoryPolicy
DescendantInfo:
svt.TunnelAdminGroup
DescendantInfo:
optical.OcsAlarmProfile
DescendantInfo:
aclfilterli.BlockReservation
DescendantInfo:
genericne.MvMatchingRulePolicy
DescendantInfo:
mmepolicy.WMMInterfaceProfile
DescendantInfo:
calltrace.TraceProfile
DescendantInfo:
ltepolicyoptions.DhcpServerGroupProfile
DescendantInfo:
service.AbstractSapTemplate
DescendantInfo:
aapolicy.AaTcpValidationTca
DescendantInfo:
ltepmip.S6bAvpOptionProfile
DescendantInfo:
redirectfilter.RedirectPolicy
DescendantInfo:
service.EpipeSapTemplate
DescendantInfo:
lte.AbsGtpProfile
DescendantInfo:
ltegw.AvpOptionProfile
DescendantInfo:
nodelog.FirewallLog
DescendantInfo:
multicast.McastCacInterfacePolicy
DescendantInfo:
nodelog.FilterLog
DescendantInfo:
ixrqos.FcDSCPMap
DescendantInfo:
lte5g.NpcfProfile
DescendantInfo:
ltegw.AbsNodeSelPolicyGroup
DescendantInfo:
sitesec.PasswordPolicy
DescendantInfo:
nat.NatClassifier
DescendantInfo:
aaa.L2tpRadiusAccountingPolicy
DescendantInfo:
dynsvc.DynSvcPolicy
DescendantInfo:
ltepolicyoptions.UsgMonAction
DescendantInfo:
sitesec.TacacsPolicy
DescendantInfo:
ltepolicyoptions.StatsRuleUnit
DescendantInfo:
rp.Community
DescendantInfo:
securitypolicy.Bypass
DescendantInfo:
lte.DnsErrMapProfile
DescendantInfo:
nat.FirewallPolicy
DescendantInfo:
ipsec.IPSecClientDB
DescendantInfo:
lte.QciPolicy
DescendantInfo:
filterprefixlist.PrefixList
DescendantInfo:
netca.OCSStatsTCAProfile
DescendantInfo:
rmon.RemoteNetworkMonitoring
DescendantInfo:
aapolicy.AaFilterAbstract
DescendantInfo:
ltepmip.Pmipv6Profile
DescendantInfo:
lte5g.NrfProfile
DescendantInfo:
pppoe.PPPPolicy
DescendantInfo:
qgroup.EgressQGroupPolicy
DescendantInfo:
aaa.NatRadiusAccountingPolicy
DescendantInfo:
ressubscr.IpoePolicy
DescendantInfo:
securitypolicy.SecurityPolicyDefinition
DescendantInfo:
sitesec.RemoteAuthPolicy
DescendantInfo:
aosqos.QoSNetworkGroups
DescendantInfo:
aapolicy.GtpFilter
DescendantInfo:
lte.FqdnGroupProfile
DescendantInfo:
aclfilter.VlanFilter
DescendantInfo:
lte.DiameterPeerProfile
DescendantInfo:
mpr.RadioQOS
DescendantInfo:
portscheduler.HsmdaSchedulerPolicy
DescendantInfo:
lte5g.N1Profile
DescendantInfo:
lte.PfcpProfile
DescendantInfo:
securitypolicy.HostGroup
DescendantInfo:
ressubscr.RipPolicy
DescendantInfo:
aapolicy.AccessNetworkLocation
DescendantInfo:
lteepdg.IPSecProfile
DescendantInfo:
sitesec.TlsTrustAnchorProfile
DescendantInfo:
connprof.PssConnProfPolicy
DescendantInfo:
lte.DiameterRateLimProfile
DescendantInfo:
ltetwag.TwagChargingProfile
DescendantInfo:
ipsec.IPSecStaticSA
DescendantInfo:
ressubscr.MldPolicy
DescendantInfo:
nodelog.AbstractLog
DescendantInfo:
slaprofile.Policy
DescendantInfo:
wlangw.DsmIpFilterPolicy
DescendantInfo:
aapolicy.AaSubCongDetect
DescendantInfo:
opticalacl.OcsIpFilter
DescendantInfo:
lte.DnsProfile
DescendantInfo:
ipfix.IPFIXExportPolicy
DescendantInfo:
ixrqos.DSCPFCMap
DescendantInfo:
slope.Policy
DescendantInfo:
mpls.Policy
DescendantInfo:
rp.AbstractAdminGroupPolicy
DescendantInfo:
portscheduler.HsmdaWrrPolicy
DescendantInfo:
mmepolicy.MMEEmergencyNumListTblPolicy
DescendantInfo:
lteepdg.EpdgChargingProfile
DescendantInfo:
lte.ErrorMappingProfile
DescendantInfo:
lte.FqdnList
DescendantInfo:
lte.GxProfile
DescendantInfo:
lte.CloudDBProfile
DescendantInfo:
sasqos.Remark
DescendantInfo:
aclfilter.DhcpFilter
DescendantInfo:
slope.NamedPool
DescendantInfo:
qosprofile.McfrEgressQosProfile
DescendantInfo:
ipsec.IkeTransform
DescendantInfo:
lte5g.Oauth2Profile
DescendantInfo:
sitesec.TlsClientProfile
DescendantInfo:
aapolicy.AaStatTcaAbstract
DescendantInfo:
firewall.HostGroup
DescendantInfo:
ressubscr.BgpPeeringPolicy
DescendantInfo:
service.SvcActTestHeadAcceptanceCriteriaTemplate
DescendantInfo:
nodelog.SysLogTarget
DescendantInfo:
aaa.AcctOnOffGroup
DescendantInfo:
lte.UeCallTrace
DescendantInfo:
aclfilter.MacFilter
DescendantInfo:
sas.StreamingDelayTemplate
DescendantInfo:
lte.DefBearerQoSProfile
DescendantInfo:
rp.PolicyObjectBase
DescendantInfo:
service.Y1564TestHeadProfile
DescendantInfo:
igmp.SSMTranslatePolicy
DescendantInfo:
radiusaccounting.Policy
DescendantInfo:
aapolicy.AaTcpOpt
DescendantInfo:
service.SvcActTestHeadFrameSizeTemplate
DescendantInfo:
ipsec.TrustAnchorProfile
DescendantInfo:
ixrqos.PortQosPolicy
DescendantInfo:
nodelog.SecurityLog
DescendantInfo:
ixrqos.IngressClassification
DescendantInfo:
aapolicy.Policy
DescendantInfo:
ipsec.RadiusAccountingPolicy
DescendantInfo:
qosprofile.McfrIngressQosProfile
DescendantInfo:
ressubscr.HostLockoutPolicy
DescendantInfo:
ressubscr.SubMcastCacPolicy
DescendantInfo:
slope.HsmdaPoolPolicy
DescendantInfo:
opticalacl.IpFilter
DescendantInfo:
ixrqos.QueueMgmtPolicy
DescendantInfo:
policy.PSGGenericPolicy
DescendantInfo:
mmepolicy.MMESCTPProfile
DescendantInfo:
aapolicy.AARadiusAccountingPolicy
DescendantInfo:
lte.SgwChargingProfile
DescendantInfo:
multicast.EgressMcastGroup
DescendantInfo:
aapolicy.HttpErrorRedirect
DescendantInfo:
multicast.McastReportDestination
DescendantInfo:
firewall.CPMFirewall
DescendantInfo:
rtr.AbstractAdminGroupPolicy
DescendantInfo:
lte.TrustedPeerListPolicy
DescendantInfo:
lteli.DFPeer
DescendantInfo:
aosqos.QoSMacGroups
DescendantInfo:
ltepolicyoptions.ApnRateControl
DescendantInfo:
hsqos.HsAttachmentPolicy
DescendantInfo:
subscrident.Policy
DescendantInfo:
tod.Policy
DescendantInfo:
lteggsn.CdrAvpOptionProfile
DescendantInfo:
lte.OIOverList
DescendantInfo:
aapolicy.AAGroupPolicy
DescendantInfo:
lte.MMEGroupProfile
DescendantInfo:
lteradius.RadiusGroupProfile
DescendantInfo:
lteli.InterceptionTarget
DescendantInfo:
mmepolicy.MMEProfile
DescendantInfo:
lte.IkeRedList
DescendantInfo:
ltehomeagent.DNSRedirectServer
DescendantInfo:
qosprofile.MlpppIngressQosProfile
DescendantInfo:
dctr.PortProfile
DescendantInfo:
multicast.PackagePolicy
DescendantInfo:
lte.PgwSelectionCandidateList
DescendantInfo:
file.FileTransmissionProfile
DescendantInfo:
genericne.MvFilterPolicy
DescendantInfo:
mmepolicy.MMEGTPProfile
DescendantInfo:
genericne.MvForwardingClassPolicy
DescendantInfo:
ltetwag.DhcpServerProfile
DescendantInfo:
aclfilter.Ipv6ExceptionFilter
DescendantInfo:
aclfilter.DhcpV6Filter
DescendantInfo:
lteradius.RadiusProfile
DescendantInfo:
sitesec.TlsServerProfile
DescendantInfo:
nqueue.Policy
DescendantInfo:
sasqos.AccessEgress
DescendantInfo:
wlangw.DsmTrafficPolicer
DescendantInfo:
lte.UpPeerList
DescendantInfo:
netca.AbstractStatsTCAProfile
DescendantInfo:
sasqos.MpBwPolicy
DescendantInfo:
nat.NatPolicy
DescendantInfo:
ltepolicyoptions.QoSRuleUnit
DescendantInfo:
sas.BinGroup
DescendantInfo:
aapolicy.HttpNotif
DescendantInfo:
ethernetservice.SapProfile
DescendantInfo:
sitesec.CpmIpFilter
DescendantInfo:
mmepolicy.WMMSVCAgreementProfile
DescendantInfo:
connprof.ConnProfPolicy
DescendantInfo:
pae802_1x.RadiusServerPolicy
DescendantInfo:
aapolicy.AaStatTcaCfg
DescendantInfo:
sasqos.PortScheduler
DescendantInfo:
lte.IdiRealmList
DescendantInfo:
sitesec.CertificateAuthProfile
DescendantInfo:
qgroup.RedirectList
DescendantInfo:
ltepolicyoptions.PolicyRuleBase
DescendantInfo:
genericne.MVGenericPolicy
DescendantInfo:
rtr.AdminGroupPolicy
DescendantInfo:
aaa.RadiusServerPolicy
DescendantInfo:
securitypolicy.Profile
DescendantInfo:
lte.PpiMappingProfile
DescendantInfo:
rtr.SharedRiskLinkGroup
DescendantInfo:
aapolicy.AAPortList
DescendantInfo:
lte.AgwChargingProfile
DescendantInfo:
mpls.LspTemplateMvpn
DescendantInfo:
aossas.CPETestHeadProfile
DescendantInfo:
ltegw.ApnListPolicyGroup
DescendantInfo:
ancp.Policy
DescendantInfo:
lte.CCFHProfile
DescendantInfo:
aclfilter.AggregateFilter
DescendantInfo:
lte.IpAddressList
DescendantInfo:
dctr.Profile
DescendantInfo:
hsqos.HsPortPoolPolicy
DescendantInfo:
hsqos.HsPoolPolicy
DescendantInfo:
ltessg.TdfChargingProfile
DescendantInfo:
aaa.IsaRadiusPolicy
DescendantInfo:
ltepolicyoptions.TrafficRedirectProfile
DescendantInfo:
nat.UpnpPolicy
DescendantInfo:
pdnprofile.PacketDataNetworkProfilePolicy
DescendantInfo:
gtp.ApnPolicy
DescendantInfo:
rtr.AbstractSharedRiskLinkGroup
DescendantInfo:
aosqos.QoSCondition
DescendantInfo:
ltetwag.SwwRadiusProfile
DescendantInfo:
svt.PwTemplate
DescendantInfo:
filterprefixlist.ProtocolList
DescendantInfo:
rp.AdminGroupPolicy
DescendantInfo:
rtr.AdminTagPolicy
DescendantInfo:
ltehomeagent.FAHAPeerList
DescendantInfo:
mpls.SRLGStaticConfig
DescendantInfo:
accounting.Policy
DescendantInfo:
lte.PfcpTranslateProfile
DescendantInfo:
aapolicy.AaTcpValidation
DescendantInfo:
lte5g.CHFProfile
DescendantInfo:
opticalacl.AbstractIpFilter
DescendantInfo:
msappolicy.Policy
DescendantInfo:
wlangw.MgwProfile
DescendantInfo:
lte5g.AllowedNFDomainList
DescendantInfo:
mmepolicy.WMMPfmJobEntry
DescendantInfo:
aclfilterli.LiMacFilter
DescendantInfo:
securitypolicy.AppGroup
DescendantInfo:
aapolicy.AaCflowdGroupPolicy
DescendantInfo:
lte.PeerListPolicy
DescendantInfo:
fabricqos.FabricProfile
DescendantInfo:
firewall.FwPolicyDefinition
DescendantInfo:
multicast.McastCacPolicy
DescendantInfo:
rp.PolicyAccountingTemplate
DescendantInfo:
ipsec.AbstractTrustAnchorProfile
DescendantInfo:
aclfilter.GreTunnelTemplate
DescendantInfo:
lte.DiameterProfile
DescendantInfo:
lte.PgwChargingProfile
DescendantInfo:
sasqos.EgressRemarking
DescendantInfo:
aclfilterli.LiIpFilter
DescendantInfo:
ltepolicyoptions.UrrProfile
DescendantInfo:
service.Y1564PayloadProfile
DescendantInfo:
lte5g.UdmIdList
DescendantInfo:
sas.LinkMeasurementTemplate
DescendantInfo:
nat.NatPrefixList
DescendantInfo:
aaa.IsaRadiusPolicyBase
DescendantInfo:
lteradius.AbsRadiusProfile
DescendantInfo:
equipment.PortPolicy
DescendantInfo:
unpprofile.UNPProfile
DescendantInfo:
rtr.ReassemblyProfilePolicy
DescendantInfo:
lte.GtpPrimeServerGroupProfile
DescendantInfo:
lte.Profile
DescendantInfo:
layer2.L2Profile
DescendantInfo:
qosportlist.PortList
DescendantInfo:
lte.ClientProfile
DescendantInfo:
lte.OverloadControlProfile
DescendantInfo:
ressubscr.BrgProfile
DescendantInfo:
firewall.ServiceGroup
DescendantInfo:
vs.ServiceTypeDefinition
DescendantInfo:
qgroup.IngressQGroupPolicy
DescendantInfo:
lte.SubscriberMappingProfile
DescendantInfo:
lte5g.SMFAttributesProfile
DescendantInfo:
ltegw.UMTSQoSPolicy
DescendantInfo:
ltepolicyoptions.ActionRuleUnitProfile
DescendantInfo:
lte.S2bErrorMappingProfile
DescendantInfo:
dynsvc.DynSvcLocalAuthDb
DescendantInfo:
lte5g.EmerProfile
DescendantInfo:
aosqos.List
DescendantInfo:
shaperqos.ShaperPolicy
DescendantInfo:
sasqos.FcDot1pMap
DescendantInfo:
ltessg.SteeringProfile
DescendantInfo:
srpythonmgmt.PythonScript
DescendantInfo:
sasqos.MplsLspExpMap
DescendantInfo:
lte.CreditPoolProfile
DescendantInfo:
ltegw.UDPTunnelGroupProfile
DescendantInfo:
multicast.IngrPathMgmtBwPolicy
DescendantInfo:
aclfilter.Ipv6Filter
DescendantInfo:
aapolicy.AAPrefixListPolicy
DescendantInfo:
ipsec.IPSecTunnelTemplate
DescendantInfo:
nat.PcpPolicy
DescendantInfo:
mmepolicy.WMMPfmMeasGroupName
DescendantInfo:
aosqos.QoSAction
DescendantInfo:
lte5g.EventTriggerFBCProfile
DescendantInfo:
srpythonmgmt.PythonPolicy
DescendantInfo:
aclfilterli.LiFilter
DescendantInfo:
ixrqos.EgressRemarkPolicy
DescendantInfo:
diameter.DiameterPeerPolicy
DescendantInfo:
nat.AbstractNatPlcy
DescendantInfo:
aosqos.Policy
DescendantInfo:
aapolicy.AAPolicer
DescendantInfo:
aclfilter.IpFilter
DescendantInfo:
lte5g.SMFChargingProfile
DescendantInfo:
lte.TargetProfile
DescendantInfo:
lte.GroupLabel
DescendantInfo:
ixrqos.Dot1pFCMap
DescendantInfo:
lte5g.SMFServingAreaList
DescendantInfo:
squeue.Policy
DescendantInfo:
ltetwag.SlaacHostProfile
DescendantInfo:
aaa.RouteDownloadPolicy
DescendantInfo:
ltessg.AddressListProfile
DescendantInfo:
pppoe.PPPPolicyBase
DescendantInfo:
lte.AbsCallInsight
DescendantInfo:
nat.SvcChainEvpnPolicy
DescendantInfo:
aapolicy.AaStatTcaFilterCfg
DescendantInfo:
ltegw.QciListPolicyGroup
DescendantInfo:
aapolicy.AAUrlListPolicy
DescendantInfo:
aapolicy.HttpRedirect
DescendantInfo:
ixrqos.LspExpFCMap
DescendantInfo:
niegr.Policy
DescendantInfo:
securitypolicy.PolicerGroup
DescendantInfo:
aapolicy.AACertProfile
DescendantInfo:
securityqueue.SecurityQueuePolicy
DescendantInfo:
genericne.MvMultitermPolicy
DescendantInfo:
lte.TaiLaiListProfile
DescendantInfo:
nat.MapDomain
DescendantInfo:
nodelog.LogProfile
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_policy_PolicyDefinition_distribute", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/distributeResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/policy/PolicyDefinition/distributeUsingGroups/{instanceFullName}": { "post": { "tags": [ "samo_policy" ], "summary": "rest_policy_PolicyDefinition_distributeUsingGroups", "description": "The global policy is distributed to the NEs present in the groups. If the distribution fails for
one NE, the distribution continues for the rest of the NEs. A JMS message is sent back to
indicate the list of failed sites

Intention : MODIFIER
distributeUsingGroups:
instance-level modifier API distributeUsingGroups
of class policy.PolicyDefinition
DescendantInfo:
rtr.SegmentRoutingMaintenancePolicy
DescendantInfo:
lte5g.PcfIdList
DescendantInfo:
mplstp.BFDTemplate
DescendantInfo:
ixrqos.VlanQosPolicy
DescendantInfo:
ressubscr.ShcvPolicy
DescendantInfo:
ltepolicyoptions.AssumePositiveActionProfile
DescendantInfo:
ixrqos.FcLspExpMap
DescendantInfo:
aclfilterli.LiIpv6Filter
DescendantInfo:
subscrexpmap.Policy
DescendantInfo:
sitesec.DCpuProtection
DescendantInfo:
rp.ASPathGroup
DescendantInfo:
diameter.DiameterAppPolicy
DescendantInfo:
aclfilter.AbstractFilterDefinition
DescendantInfo:
sasqos.Network
DescendantInfo:
lte.GtpProfile
DescendantInfo:
rp.PolicyStatement
DescendantInfo:
file.Policy
DescendantInfo:
lte.PfcpAPPeerList
DescendantInfo:
ethernetservice.UniProfile
DescendantInfo:
ltepolicyoptions.TrafficHashProfile
DescendantInfo:
sitesec.TlsCertificateProfile
DescendantInfo:
qosprofile.MlpppEgressQosProfile
DescendantInfo:
vs.AdvancedConfigPolicy
DescendantInfo:
sasqos.SchedulerPolicy
DescendantInfo:
aapolicy.AAUrlFilter
DescendantInfo:
genericne.MvQosPolicy
DescendantInfo:
sitesec.PkiCommonNameList
DescendantInfo:
ethernetservice.CustomL2Profile
DescendantInfo:
ltetwag.DiameterPeerGroupList
DescendantInfo:
postpolicermapping.PostPolicerMappingPolicy
DescendantInfo:
aengr.Policy
DescendantInfo:
sitesec.LocalUser
DescendantInfo:
rp.PrefixList
DescendantInfo:
lte5g.NfIdList
DescendantInfo:
rtr.RouteNextHopPolicyTemplate
DescendantInfo:
lte5g.QfiMappingProfile
DescendantInfo:
aapolicy.AbstractTransitPolicy
DescendantInfo:
aclfilter.AbstractExceptionFilter
DescendantInfo:
sasqos.DSCPClassification
DescendantInfo:
lte.WlanEmergencyProfile
DescendantInfo:
portscheduler.Policy
DescendantInfo:
vs.Policy
DescendantInfo:
lteggsn.GyAvpOptionProfile
DescendantInfo:
ixrqos.NetworkIngressPolicy
DescendantInfo:
ixrqos.FcDot1pMap
DescendantInfo:
sasqos.NQueue
DescendantInfo:
aapolicy.TetherDetection
DescendantInfo:
service.Y1564AcceptanceCriteriaProfile
DescendantInfo:
ltepolicyoptions.PolicyRule
DescendantInfo:
lte.Abspfcp
DescendantInfo:
mmepolicy.MMEEmergencyNumListPolicy
DescendantInfo:
sitesec.AOSSecurityPolicy
DescendantInfo:
lte.T6cProfile
DescendantInfo:
lte.EpdgGroupList
DescendantInfo:
slope.HsmdaSlopePolicy
DescendantInfo:
aapolicy.AaStatTcaFltrEntryCfg
DescendantInfo:
lte.SourceIpList
DescendantInfo:
sasqos.FcDscpMap
DescendantInfo:
lte.IPProfile
DescendantInfo:
ipsec.IPSecTransform
DescendantInfo:
subscrauth.Policy
DescendantInfo:
icmp.IcmpPingTemplate
DescendantInfo:
qosprefixlist.PrefixList
DescendantInfo:
sitesec.DoSProtection
DescendantInfo:
lte.DccaProfile
DescendantInfo:
filterprefixlist.PortList
DescendantInfo:
rtr.AdminTag
DescendantInfo:
aapolicy.AASessionFilter
DescendantInfo:
hsqos.HsSchedulerPolicy
DescendantInfo:
ltepolicyoptions.ServiceClassIndicator
DescendantInfo:
sitesec.UserProfile
DescendantInfo:
ltepolicyoptions.SruList
DescendantInfo:
lte.AllUesCallTrace
DescendantInfo:
sitesec.TlsServerCipherList
DescendantInfo:
ltegw.TariffChangeListProfilePolicyGroup
DescendantInfo:
aingr.Policy
DescendantInfo:
aapolicy.AbstractHttpRedirect
DescendantInfo:
ltetwag.StaProfile
DescendantInfo:
redirectfilter.RedirectPolicyBinding
DescendantInfo:
sasqos.FCMeterMap
DescendantInfo:
vrrp.Policy
DescendantInfo:
lte5g.SliceList
DescendantInfo:
sasqos.SlopePolicy
DescendantInfo:
todsuite.Policy
DescendantInfo:
diameter.DiameterPolicy
DescendantInfo:
sasqos.SystemResourceProfilePolicy
DescendantInfo:
genericne.MvAbstractPolicy
DescendantInfo:
aapolicy.TransitPrefixPolicy
DescendantInfo:
sitesec.EstAuthProfile
DescendantInfo:
hwaggshapersched.HwAggShaperSchedulerPolicy
DescendantInfo:
aossas.CPETestHeadGroupProfile
DescendantInfo:
lte5g.PrioAddrList
DescendantInfo:
rp.GlobalVariables
DescendantInfo:
lte5g.SliceInstanceList
DescendantInfo:
lte.DedicatedBearerIdleTimeOutProfile
DescendantInfo:
security.KeyChain
DescendantInfo:
lte.PcmdProfile
DescendantInfo:
lteepdg.SwmAvpOptionProfile
DescendantInfo:
mpls.SharedRiskLinkGroup
DescendantInfo:
sitesec.TlsClientCipherList
DescendantInfo:
lte.AmfIdList
DescendantInfo:
ltehomeagent.MobileIpv4Profile
DescendantInfo:
file.LogDefinition
DescendantInfo:
macsec.MacPolicy
DescendantInfo:
securitypolicy.Policy
DescendantInfo:
ltepolicyoptions.AbsPolicyOptionProfile
DescendantInfo:
aclfilter.IpExceptionFilter
DescendantInfo:
sasqos.Dot1pClassification
DescendantInfo:
ipsec.IkePolicy
DescendantInfo:
mpr.QueueMapPolicy
DescendantInfo:
aapolicy.ApplicationAssurancePolicyDefinition
DescendantInfo:
service.VplsSapTemplate
DescendantInfo:
ltegw.AbsListPolicyGroup
DescendantInfo:
lte.SDProfile
DescendantInfo:
aapolicy.SctpFilter
DescendantInfo:
lte.PlmnListPolicyGroup
DescendantInfo:
mpr.GneRadiusQosPolicy
DescendantInfo:
l2fwd.MrpPolicy
DescendantInfo:
sasqos.AccessIngress
DescendantInfo:
crdtctrl.CrdtCtrlPolicy
DescendantInfo:
lte.PortList
DescendantInfo:
lte5g.SbaNudmSdmProf
DescendantInfo:
rp.Damping
DescendantInfo:
aapolicy.TransitIpPolicy
DescendantInfo:
lte.SwmErrorMappingProfile
DescendantInfo:
firewall.Zone
DescendantInfo:
rp.ASPath
DescendantInfo:
ltepolicyoptions.UsgMonInfo
DescendantInfo:
sitesec.RadiusPolicy
DescendantInfo:
optical.AlarmProfile
DescendantInfo:
ipsec.CertProfile
DescendantInfo:
crdtctrl.CtgryMapPolicy
DescendantInfo:
lte.DiameterErrorMappingProfile
DescendantInfo:
ressubscr.HostTrackingPolicy
DescendantInfo:
sasqos.MplsLspExpClassification
DescendantInfo:
ressubscr.IgmpPolicy
DescendantInfo:
lte.AccountingPriorityProfile
DescendantInfo:
rp.RouteNextHopPolicyTemplate
DescendantInfo:
ressubscr.PimPolicy
DescendantInfo:
ltepolicyoptions.DynamicToInternalRuleMap
DescendantInfo:
netca.CardStatsTCAProfile
DescendantInfo:
subscrprofile.Policy
DescendantInfo:
aapolicy.HttpEnrich
DescendantInfo:
ltepolicyoptions.GxAvpOptionProfile
DescendantInfo:
sitesec.LdapPolicy
DescendantInfo:
aclfilter.FilterDefinition
DescendantInfo:
fpresource.FPResourcePolicy
DescendantInfo:
securitypolicy.Zone
DescendantInfo:
ltegw.SCTPProfile
DescendantInfo:
sasqos.QueueMgmtPolicy
DescendantInfo:
sasqos.FcLspExpMap
DescendantInfo:
ltepolicyoptions.TriggerRuleUnitProfile
DescendantInfo:
ressubscr.HttpRedirectPolicy
DescendantInfo:
service.Y1564FrameMixProfile
DescendantInfo:
ltepolicyoptions.PolicyRuleUnit
DescendantInfo:
firewall.MgmtAccessFirewall
DescendantInfo:
ltehomeagent.AbsHomeAgentProfile
DescendantInfo:
firewall.RuleSet
DescendantInfo:
netca.StatsTCAProfile
DescendantInfo:
genericne.MvPolicerPolicy
DescendantInfo:
rp.AbstractSrlgGroupPolicy
DescendantInfo:
lte5g.SbaNudmUecmProf
DescendantInfo:
sasqos.IngressCoSClassification
DescendantInfo:
rp.SrlgGroupPolicy
DescendantInfo:
aaa.RadiusScriptPolicy
DescendantInfo:
nat.SvcChainVasFilterPolicy
DescendantInfo:
aapolicy.DnsIpCache
DescendantInfo:
sasqos.NetworkIngress
DescendantInfo:
ltepolicyoptions.ChargingRuleUnit
DescendantInfo:
aapolicy.AAFlowCfgPolicy
DescendantInfo:
lte5g.HTTP2Profile
DescendantInfo:
sasqos.PortAccessIngress
DescendantInfo:
ltegw.PcscfGroupProfile
DescendantInfo:
multicast.IngrPathMgmtInfoPolicy
DescendantInfo:
sitesec.ManagementAccessFilter
DescendantInfo:
ltetwag.SwwTunnelProfile
DescendantInfo:
ethernetoam.MaintenanceDomain
DescendantInfo:
ipsec.RadiusAuthenticationPolicy
DescendantInfo:
aapolicy.AaStatTcaPolicerCfg
DescendantInfo:
ipsec.TrafficSelectorList
DescendantInfo:
atmpolicy.TrafficDescriptor
DescendantInfo:
sasqos.PortAccessEgress
DescendantInfo:
aapolicy.MpTcpProxy
DescendantInfo:
connprof.VlanConnProfPolicy
DescendantInfo:
opticalacl.IpPattern
DescendantInfo:
policing.PolicerControl
DescendantInfo:
sw.SoftwareRepositoryPolicy
DescendantInfo:
svt.TunnelAdminGroup
DescendantInfo:
optical.OcsAlarmProfile
DescendantInfo:
aclfilterli.BlockReservation
DescendantInfo:
genericne.MvMatchingRulePolicy
DescendantInfo:
mmepolicy.WMMInterfaceProfile
DescendantInfo:
calltrace.TraceProfile
DescendantInfo:
ltepolicyoptions.DhcpServerGroupProfile
DescendantInfo:
service.AbstractSapTemplate
DescendantInfo:
aapolicy.AaTcpValidationTca
DescendantInfo:
ltepmip.S6bAvpOptionProfile
DescendantInfo:
redirectfilter.RedirectPolicy
DescendantInfo:
service.EpipeSapTemplate
DescendantInfo:
lte.AbsGtpProfile
DescendantInfo:
ltegw.AvpOptionProfile
DescendantInfo:
nodelog.FirewallLog
DescendantInfo:
multicast.McastCacInterfacePolicy
DescendantInfo:
nodelog.FilterLog
DescendantInfo:
ixrqos.FcDSCPMap
DescendantInfo:
lte5g.NpcfProfile
DescendantInfo:
ltegw.AbsNodeSelPolicyGroup
DescendantInfo:
sitesec.PasswordPolicy
DescendantInfo:
nat.NatClassifier
DescendantInfo:
aaa.L2tpRadiusAccountingPolicy
DescendantInfo:
dynsvc.DynSvcPolicy
DescendantInfo:
ltepolicyoptions.UsgMonAction
DescendantInfo:
sitesec.TacacsPolicy
DescendantInfo:
ltepolicyoptions.StatsRuleUnit
DescendantInfo:
rp.Community
DescendantInfo:
securitypolicy.Bypass
DescendantInfo:
lte.DnsErrMapProfile
DescendantInfo:
nat.FirewallPolicy
DescendantInfo:
ipsec.IPSecClientDB
DescendantInfo:
lte.QciPolicy
DescendantInfo:
filterprefixlist.PrefixList
DescendantInfo:
netca.OCSStatsTCAProfile
DescendantInfo:
rmon.RemoteNetworkMonitoring
DescendantInfo:
aapolicy.AaFilterAbstract
DescendantInfo:
ltepmip.Pmipv6Profile
DescendantInfo:
lte5g.NrfProfile
DescendantInfo:
pppoe.PPPPolicy
DescendantInfo:
qgroup.EgressQGroupPolicy
DescendantInfo:
aaa.NatRadiusAccountingPolicy
DescendantInfo:
ressubscr.IpoePolicy
DescendantInfo:
securitypolicy.SecurityPolicyDefinition
DescendantInfo:
sitesec.RemoteAuthPolicy
DescendantInfo:
aosqos.QoSNetworkGroups
DescendantInfo:
aapolicy.GtpFilter
DescendantInfo:
lte.FqdnGroupProfile
DescendantInfo:
aclfilter.VlanFilter
DescendantInfo:
lte.DiameterPeerProfile
DescendantInfo:
mpr.RadioQOS
DescendantInfo:
portscheduler.HsmdaSchedulerPolicy
DescendantInfo:
lte5g.N1Profile
DescendantInfo:
lte.PfcpProfile
DescendantInfo:
securitypolicy.HostGroup
DescendantInfo:
ressubscr.RipPolicy
DescendantInfo:
aapolicy.AccessNetworkLocation
DescendantInfo:
lteepdg.IPSecProfile
DescendantInfo:
sitesec.TlsTrustAnchorProfile
DescendantInfo:
connprof.PssConnProfPolicy
DescendantInfo:
lte.DiameterRateLimProfile
DescendantInfo:
ltetwag.TwagChargingProfile
DescendantInfo:
ipsec.IPSecStaticSA
DescendantInfo:
ressubscr.MldPolicy
DescendantInfo:
nodelog.AbstractLog
DescendantInfo:
slaprofile.Policy
DescendantInfo:
wlangw.DsmIpFilterPolicy
DescendantInfo:
aapolicy.AaSubCongDetect
DescendantInfo:
opticalacl.OcsIpFilter
DescendantInfo:
lte.DnsProfile
DescendantInfo:
ipfix.IPFIXExportPolicy
DescendantInfo:
ixrqos.DSCPFCMap
DescendantInfo:
slope.Policy
DescendantInfo:
mpls.Policy
DescendantInfo:
rp.AbstractAdminGroupPolicy
DescendantInfo:
portscheduler.HsmdaWrrPolicy
DescendantInfo:
mmepolicy.MMEEmergencyNumListTblPolicy
DescendantInfo:
lteepdg.EpdgChargingProfile
DescendantInfo:
lte.ErrorMappingProfile
DescendantInfo:
lte.FqdnList
DescendantInfo:
lte.GxProfile
DescendantInfo:
lte.CloudDBProfile
DescendantInfo:
sasqos.Remark
DescendantInfo:
aclfilter.DhcpFilter
DescendantInfo:
slope.NamedPool
DescendantInfo:
qosprofile.McfrEgressQosProfile
DescendantInfo:
ipsec.IkeTransform
DescendantInfo:
lte5g.Oauth2Profile
DescendantInfo:
sitesec.TlsClientProfile
DescendantInfo:
aapolicy.AaStatTcaAbstract
DescendantInfo:
firewall.HostGroup
DescendantInfo:
ressubscr.BgpPeeringPolicy
DescendantInfo:
service.SvcActTestHeadAcceptanceCriteriaTemplate
DescendantInfo:
nodelog.SysLogTarget
DescendantInfo:
aaa.AcctOnOffGroup
DescendantInfo:
lte.UeCallTrace
DescendantInfo:
aclfilter.MacFilter
DescendantInfo:
sas.StreamingDelayTemplate
DescendantInfo:
lte.DefBearerQoSProfile
DescendantInfo:
rp.PolicyObjectBase
DescendantInfo:
service.Y1564TestHeadProfile
DescendantInfo:
igmp.SSMTranslatePolicy
DescendantInfo:
radiusaccounting.Policy
DescendantInfo:
aapolicy.AaTcpOpt
DescendantInfo:
service.SvcActTestHeadFrameSizeTemplate
DescendantInfo:
ipsec.TrustAnchorProfile
DescendantInfo:
ixrqos.PortQosPolicy
DescendantInfo:
nodelog.SecurityLog
DescendantInfo:
ixrqos.IngressClassification
DescendantInfo:
aapolicy.Policy
DescendantInfo:
ipsec.RadiusAccountingPolicy
DescendantInfo:
qosprofile.McfrIngressQosProfile
DescendantInfo:
ressubscr.HostLockoutPolicy
DescendantInfo:
ressubscr.SubMcastCacPolicy
DescendantInfo:
slope.HsmdaPoolPolicy
DescendantInfo:
opticalacl.IpFilter
DescendantInfo:
ixrqos.QueueMgmtPolicy
DescendantInfo:
policy.PSGGenericPolicy
DescendantInfo:
mmepolicy.MMESCTPProfile
DescendantInfo:
aapolicy.AARadiusAccountingPolicy
DescendantInfo:
lte.SgwChargingProfile
DescendantInfo:
multicast.EgressMcastGroup
DescendantInfo:
aapolicy.HttpErrorRedirect
DescendantInfo:
multicast.McastReportDestination
DescendantInfo:
firewall.CPMFirewall
DescendantInfo:
rtr.AbstractAdminGroupPolicy
DescendantInfo:
lte.TrustedPeerListPolicy
DescendantInfo:
lteli.DFPeer
DescendantInfo:
aosqos.QoSMacGroups
DescendantInfo:
ltepolicyoptions.ApnRateControl
DescendantInfo:
hsqos.HsAttachmentPolicy
DescendantInfo:
subscrident.Policy
DescendantInfo:
tod.Policy
DescendantInfo:
lteggsn.CdrAvpOptionProfile
DescendantInfo:
lte.OIOverList
DescendantInfo:
aapolicy.AAGroupPolicy
DescendantInfo:
lte.MMEGroupProfile
DescendantInfo:
lteradius.RadiusGroupProfile
DescendantInfo:
lteli.InterceptionTarget
DescendantInfo:
mmepolicy.MMEProfile
DescendantInfo:
lte.IkeRedList
DescendantInfo:
ltehomeagent.DNSRedirectServer
DescendantInfo:
qosprofile.MlpppIngressQosProfile
DescendantInfo:
dctr.PortProfile
DescendantInfo:
multicast.PackagePolicy
DescendantInfo:
lte.PgwSelectionCandidateList
DescendantInfo:
file.FileTransmissionProfile
DescendantInfo:
genericne.MvFilterPolicy
DescendantInfo:
mmepolicy.MMEGTPProfile
DescendantInfo:
genericne.MvForwardingClassPolicy
DescendantInfo:
ltetwag.DhcpServerProfile
DescendantInfo:
aclfilter.Ipv6ExceptionFilter
DescendantInfo:
aclfilter.DhcpV6Filter
DescendantInfo:
lteradius.RadiusProfile
DescendantInfo:
sitesec.TlsServerProfile
DescendantInfo:
nqueue.Policy
DescendantInfo:
sasqos.AccessEgress
DescendantInfo:
wlangw.DsmTrafficPolicer
DescendantInfo:
lte.UpPeerList
DescendantInfo:
netca.AbstractStatsTCAProfile
DescendantInfo:
sasqos.MpBwPolicy
DescendantInfo:
nat.NatPolicy
DescendantInfo:
ltepolicyoptions.QoSRuleUnit
DescendantInfo:
sas.BinGroup
DescendantInfo:
aapolicy.HttpNotif
DescendantInfo:
ethernetservice.SapProfile
DescendantInfo:
sitesec.CpmIpFilter
DescendantInfo:
mmepolicy.WMMSVCAgreementProfile
DescendantInfo:
connprof.ConnProfPolicy
DescendantInfo:
pae802_1x.RadiusServerPolicy
DescendantInfo:
aapolicy.AaStatTcaCfg
DescendantInfo:
sasqos.PortScheduler
DescendantInfo:
lte.IdiRealmList
DescendantInfo:
sitesec.CertificateAuthProfile
DescendantInfo:
qgroup.RedirectList
DescendantInfo:
ltepolicyoptions.PolicyRuleBase
DescendantInfo:
genericne.MVGenericPolicy
DescendantInfo:
rtr.AdminGroupPolicy
DescendantInfo:
aaa.RadiusServerPolicy
DescendantInfo:
securitypolicy.Profile
DescendantInfo:
lte.PpiMappingProfile
DescendantInfo:
rtr.SharedRiskLinkGroup
DescendantInfo:
aapolicy.AAPortList
DescendantInfo:
lte.AgwChargingProfile
DescendantInfo:
mpls.LspTemplateMvpn
DescendantInfo:
aossas.CPETestHeadProfile
DescendantInfo:
ltegw.ApnListPolicyGroup
DescendantInfo:
ancp.Policy
DescendantInfo:
lte.CCFHProfile
DescendantInfo:
aclfilter.AggregateFilter
DescendantInfo:
lte.IpAddressList
DescendantInfo:
dctr.Profile
DescendantInfo:
hsqos.HsPortPoolPolicy
DescendantInfo:
hsqos.HsPoolPolicy
DescendantInfo:
ltessg.TdfChargingProfile
DescendantInfo:
aaa.IsaRadiusPolicy
DescendantInfo:
ltepolicyoptions.TrafficRedirectProfile
DescendantInfo:
nat.UpnpPolicy
DescendantInfo:
pdnprofile.PacketDataNetworkProfilePolicy
DescendantInfo:
gtp.ApnPolicy
DescendantInfo:
rtr.AbstractSharedRiskLinkGroup
DescendantInfo:
aosqos.QoSCondition
DescendantInfo:
ltetwag.SwwRadiusProfile
DescendantInfo:
svt.PwTemplate
DescendantInfo:
filterprefixlist.ProtocolList
DescendantInfo:
rp.AdminGroupPolicy
DescendantInfo:
rtr.AdminTagPolicy
DescendantInfo:
ltehomeagent.FAHAPeerList
DescendantInfo:
mpls.SRLGStaticConfig
DescendantInfo:
accounting.Policy
DescendantInfo:
lte.PfcpTranslateProfile
DescendantInfo:
aapolicy.AaTcpValidation
DescendantInfo:
lte5g.CHFProfile
DescendantInfo:
opticalacl.AbstractIpFilter
DescendantInfo:
msappolicy.Policy
DescendantInfo:
wlangw.MgwProfile
DescendantInfo:
lte5g.AllowedNFDomainList
DescendantInfo:
mmepolicy.WMMPfmJobEntry
DescendantInfo:
aclfilterli.LiMacFilter
DescendantInfo:
securitypolicy.AppGroup
DescendantInfo:
aapolicy.AaCflowdGroupPolicy
DescendantInfo:
lte.PeerListPolicy
DescendantInfo:
fabricqos.FabricProfile
DescendantInfo:
firewall.FwPolicyDefinition
DescendantInfo:
multicast.McastCacPolicy
DescendantInfo:
rp.PolicyAccountingTemplate
DescendantInfo:
ipsec.AbstractTrustAnchorProfile
DescendantInfo:
aclfilter.GreTunnelTemplate
DescendantInfo:
lte.DiameterProfile
DescendantInfo:
lte.PgwChargingProfile
DescendantInfo:
sasqos.EgressRemarking
DescendantInfo:
aclfilterli.LiIpFilter
DescendantInfo:
ltepolicyoptions.UrrProfile
DescendantInfo:
service.Y1564PayloadProfile
DescendantInfo:
lte5g.UdmIdList
DescendantInfo:
sas.LinkMeasurementTemplate
DescendantInfo:
nat.NatPrefixList
DescendantInfo:
aaa.IsaRadiusPolicyBase
DescendantInfo:
lteradius.AbsRadiusProfile
DescendantInfo:
equipment.PortPolicy
DescendantInfo:
unpprofile.UNPProfile
DescendantInfo:
rtr.ReassemblyProfilePolicy
DescendantInfo:
lte.GtpPrimeServerGroupProfile
DescendantInfo:
lte.Profile
DescendantInfo:
layer2.L2Profile
DescendantInfo:
qosportlist.PortList
DescendantInfo:
lte.ClientProfile
DescendantInfo:
lte.OverloadControlProfile
DescendantInfo:
ressubscr.BrgProfile
DescendantInfo:
firewall.ServiceGroup
DescendantInfo:
vs.ServiceTypeDefinition
DescendantInfo:
qgroup.IngressQGroupPolicy
DescendantInfo:
lte.SubscriberMappingProfile
DescendantInfo:
lte5g.SMFAttributesProfile
DescendantInfo:
ltegw.UMTSQoSPolicy
DescendantInfo:
ltepolicyoptions.ActionRuleUnitProfile
DescendantInfo:
lte.S2bErrorMappingProfile
DescendantInfo:
dynsvc.DynSvcLocalAuthDb
DescendantInfo:
lte5g.EmerProfile
DescendantInfo:
aosqos.List
DescendantInfo:
shaperqos.ShaperPolicy
DescendantInfo:
sasqos.FcDot1pMap
DescendantInfo:
ltessg.SteeringProfile
DescendantInfo:
srpythonmgmt.PythonScript
DescendantInfo:
sasqos.MplsLspExpMap
DescendantInfo:
lte.CreditPoolProfile
DescendantInfo:
ltegw.UDPTunnelGroupProfile
DescendantInfo:
multicast.IngrPathMgmtBwPolicy
DescendantInfo:
aclfilter.Ipv6Filter
DescendantInfo:
aapolicy.AAPrefixListPolicy
DescendantInfo:
ipsec.IPSecTunnelTemplate
DescendantInfo:
nat.PcpPolicy
DescendantInfo:
mmepolicy.WMMPfmMeasGroupName
DescendantInfo:
aosqos.QoSAction
DescendantInfo:
lte5g.EventTriggerFBCProfile
DescendantInfo:
srpythonmgmt.PythonPolicy
DescendantInfo:
aclfilterli.LiFilter
DescendantInfo:
ixrqos.EgressRemarkPolicy
DescendantInfo:
diameter.DiameterPeerPolicy
DescendantInfo:
nat.AbstractNatPlcy
DescendantInfo:
aosqos.Policy
DescendantInfo:
aapolicy.AAPolicer
DescendantInfo:
aclfilter.IpFilter
DescendantInfo:
lte5g.SMFChargingProfile
DescendantInfo:
lte.TargetProfile
DescendantInfo:
lte.GroupLabel
DescendantInfo:
ixrqos.Dot1pFCMap
DescendantInfo:
lte5g.SMFServingAreaList
DescendantInfo:
squeue.Policy
DescendantInfo:
ltetwag.SlaacHostProfile
DescendantInfo:
aaa.RouteDownloadPolicy
DescendantInfo:
ltessg.AddressListProfile
DescendantInfo:
pppoe.PPPPolicyBase
DescendantInfo:
lte.AbsCallInsight
DescendantInfo:
nat.SvcChainEvpnPolicy
DescendantInfo:
aapolicy.AaStatTcaFilterCfg
DescendantInfo:
ltegw.QciListPolicyGroup
DescendantInfo:
aapolicy.AAUrlListPolicy
DescendantInfo:
aapolicy.HttpRedirect
DescendantInfo:
ixrqos.LspExpFCMap
DescendantInfo:
niegr.Policy
DescendantInfo:
securitypolicy.PolicerGroup
DescendantInfo:
aapolicy.AACertProfile
DescendantInfo:
securityqueue.SecurityQueuePolicy
DescendantInfo:
genericne.MvMultitermPolicy
DescendantInfo:
lte.TaiLaiListProfile
DescendantInfo:
nat.MapDomain
DescendantInfo:
nodelog.LogProfile
instanceFullName : distinguished/instance name of called object
The full name of the global policy to be distributed.

", "operationId": "rest_policy_PolicyDefinition_distributeUsingGroups", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/distributeUsingGroupsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/policy/PolicyDefinition/distributeV2/{instanceFullName}": { "post": { "tags": [ "samo_policy" ], "summary": "rest_policy_PolicyDefinition_distributeV2", "description": "The global policy is distributed to the NEs specified in siteIds. If the distribution fails for
one NE, the distribution continues for the rest of NEs. The JMS message is sent back to
indicate the list of failed sites.

Intention : MODIFIER
distributeV2:
instance-level modifier API distributeV2
of class policy.PolicyDefinition
DescendantInfo:
rtr.SegmentRoutingMaintenancePolicy
DescendantInfo:
lte5g.PcfIdList
DescendantInfo:
mplstp.BFDTemplate
DescendantInfo:
ixrqos.VlanQosPolicy
DescendantInfo:
ressubscr.ShcvPolicy
DescendantInfo:
ltepolicyoptions.AssumePositiveActionProfile
DescendantInfo:
ixrqos.FcLspExpMap
DescendantInfo:
aclfilterli.LiIpv6Filter
DescendantInfo:
subscrexpmap.Policy
DescendantInfo:
sitesec.DCpuProtection
DescendantInfo:
rp.ASPathGroup
DescendantInfo:
diameter.DiameterAppPolicy
DescendantInfo:
aclfilter.AbstractFilterDefinition
DescendantInfo:
sasqos.Network
DescendantInfo:
lte.GtpProfile
DescendantInfo:
rp.PolicyStatement
DescendantInfo:
file.Policy
DescendantInfo:
lte.PfcpAPPeerList
DescendantInfo:
ethernetservice.UniProfile
DescendantInfo:
ltepolicyoptions.TrafficHashProfile
DescendantInfo:
sitesec.TlsCertificateProfile
DescendantInfo:
qosprofile.MlpppEgressQosProfile
DescendantInfo:
vs.AdvancedConfigPolicy
DescendantInfo:
sasqos.SchedulerPolicy
DescendantInfo:
aapolicy.AAUrlFilter
DescendantInfo:
genericne.MvQosPolicy
DescendantInfo:
sitesec.PkiCommonNameList
DescendantInfo:
ethernetservice.CustomL2Profile
DescendantInfo:
ltetwag.DiameterPeerGroupList
DescendantInfo:
postpolicermapping.PostPolicerMappingPolicy
DescendantInfo:
aengr.Policy
DescendantInfo:
sitesec.LocalUser
DescendantInfo:
rp.PrefixList
DescendantInfo:
lte5g.NfIdList
DescendantInfo:
rtr.RouteNextHopPolicyTemplate
DescendantInfo:
lte5g.QfiMappingProfile
DescendantInfo:
aapolicy.AbstractTransitPolicy
DescendantInfo:
aclfilter.AbstractExceptionFilter
DescendantInfo:
sasqos.DSCPClassification
DescendantInfo:
lte.WlanEmergencyProfile
DescendantInfo:
portscheduler.Policy
DescendantInfo:
vs.Policy
DescendantInfo:
lteggsn.GyAvpOptionProfile
DescendantInfo:
ixrqos.NetworkIngressPolicy
DescendantInfo:
ixrqos.FcDot1pMap
DescendantInfo:
sasqos.NQueue
DescendantInfo:
aapolicy.TetherDetection
DescendantInfo:
service.Y1564AcceptanceCriteriaProfile
DescendantInfo:
ltepolicyoptions.PolicyRule
DescendantInfo:
lte.Abspfcp
DescendantInfo:
mmepolicy.MMEEmergencyNumListPolicy
DescendantInfo:
sitesec.AOSSecurityPolicy
DescendantInfo:
lte.T6cProfile
DescendantInfo:
lte.EpdgGroupList
DescendantInfo:
slope.HsmdaSlopePolicy
DescendantInfo:
aapolicy.AaStatTcaFltrEntryCfg
DescendantInfo:
lte.SourceIpList
DescendantInfo:
sasqos.FcDscpMap
DescendantInfo:
lte.IPProfile
DescendantInfo:
ipsec.IPSecTransform
DescendantInfo:
subscrauth.Policy
DescendantInfo:
icmp.IcmpPingTemplate
DescendantInfo:
qosprefixlist.PrefixList
DescendantInfo:
sitesec.DoSProtection
DescendantInfo:
lte.DccaProfile
DescendantInfo:
filterprefixlist.PortList
DescendantInfo:
rtr.AdminTag
DescendantInfo:
aapolicy.AASessionFilter
DescendantInfo:
hsqos.HsSchedulerPolicy
DescendantInfo:
ltepolicyoptions.ServiceClassIndicator
DescendantInfo:
sitesec.UserProfile
DescendantInfo:
ltepolicyoptions.SruList
DescendantInfo:
lte.AllUesCallTrace
DescendantInfo:
sitesec.TlsServerCipherList
DescendantInfo:
ltegw.TariffChangeListProfilePolicyGroup
DescendantInfo:
aingr.Policy
DescendantInfo:
aapolicy.AbstractHttpRedirect
DescendantInfo:
ltetwag.StaProfile
DescendantInfo:
redirectfilter.RedirectPolicyBinding
DescendantInfo:
sasqos.FCMeterMap
DescendantInfo:
vrrp.Policy
DescendantInfo:
lte5g.SliceList
DescendantInfo:
sasqos.SlopePolicy
DescendantInfo:
todsuite.Policy
DescendantInfo:
diameter.DiameterPolicy
DescendantInfo:
sasqos.SystemResourceProfilePolicy
DescendantInfo:
genericne.MvAbstractPolicy
DescendantInfo:
aapolicy.TransitPrefixPolicy
DescendantInfo:
sitesec.EstAuthProfile
DescendantInfo:
hwaggshapersched.HwAggShaperSchedulerPolicy
DescendantInfo:
aossas.CPETestHeadGroupProfile
DescendantInfo:
lte5g.PrioAddrList
DescendantInfo:
rp.GlobalVariables
DescendantInfo:
lte5g.SliceInstanceList
DescendantInfo:
lte.DedicatedBearerIdleTimeOutProfile
DescendantInfo:
security.KeyChain
DescendantInfo:
lte.PcmdProfile
DescendantInfo:
lteepdg.SwmAvpOptionProfile
DescendantInfo:
mpls.SharedRiskLinkGroup
DescendantInfo:
sitesec.TlsClientCipherList
DescendantInfo:
lte.AmfIdList
DescendantInfo:
ltehomeagent.MobileIpv4Profile
DescendantInfo:
file.LogDefinition
DescendantInfo:
macsec.MacPolicy
DescendantInfo:
securitypolicy.Policy
DescendantInfo:
ltepolicyoptions.AbsPolicyOptionProfile
DescendantInfo:
aclfilter.IpExceptionFilter
DescendantInfo:
sasqos.Dot1pClassification
DescendantInfo:
ipsec.IkePolicy
DescendantInfo:
mpr.QueueMapPolicy
DescendantInfo:
aapolicy.ApplicationAssurancePolicyDefinition
DescendantInfo:
service.VplsSapTemplate
DescendantInfo:
ltegw.AbsListPolicyGroup
DescendantInfo:
lte.SDProfile
DescendantInfo:
aapolicy.SctpFilter
DescendantInfo:
lte.PlmnListPolicyGroup
DescendantInfo:
mpr.GneRadiusQosPolicy
DescendantInfo:
l2fwd.MrpPolicy
DescendantInfo:
sasqos.AccessIngress
DescendantInfo:
crdtctrl.CrdtCtrlPolicy
DescendantInfo:
lte.PortList
DescendantInfo:
lte5g.SbaNudmSdmProf
DescendantInfo:
rp.Damping
DescendantInfo:
aapolicy.TransitIpPolicy
DescendantInfo:
lte.SwmErrorMappingProfile
DescendantInfo:
firewall.Zone
DescendantInfo:
rp.ASPath
DescendantInfo:
ltepolicyoptions.UsgMonInfo
DescendantInfo:
sitesec.RadiusPolicy
DescendantInfo:
optical.AlarmProfile
DescendantInfo:
ipsec.CertProfile
DescendantInfo:
crdtctrl.CtgryMapPolicy
DescendantInfo:
lte.DiameterErrorMappingProfile
DescendantInfo:
ressubscr.HostTrackingPolicy
DescendantInfo:
sasqos.MplsLspExpClassification
DescendantInfo:
ressubscr.IgmpPolicy
DescendantInfo:
lte.AccountingPriorityProfile
DescendantInfo:
rp.RouteNextHopPolicyTemplate
DescendantInfo:
ressubscr.PimPolicy
DescendantInfo:
ltepolicyoptions.DynamicToInternalRuleMap
DescendantInfo:
netca.CardStatsTCAProfile
DescendantInfo:
subscrprofile.Policy
DescendantInfo:
aapolicy.HttpEnrich
DescendantInfo:
ltepolicyoptions.GxAvpOptionProfile
DescendantInfo:
sitesec.LdapPolicy
DescendantInfo:
aclfilter.FilterDefinition
DescendantInfo:
fpresource.FPResourcePolicy
DescendantInfo:
securitypolicy.Zone
DescendantInfo:
ltegw.SCTPProfile
DescendantInfo:
sasqos.QueueMgmtPolicy
DescendantInfo:
sasqos.FcLspExpMap
DescendantInfo:
ltepolicyoptions.TriggerRuleUnitProfile
DescendantInfo:
ressubscr.HttpRedirectPolicy
DescendantInfo:
service.Y1564FrameMixProfile
DescendantInfo:
ltepolicyoptions.PolicyRuleUnit
DescendantInfo:
firewall.MgmtAccessFirewall
DescendantInfo:
ltehomeagent.AbsHomeAgentProfile
DescendantInfo:
firewall.RuleSet
DescendantInfo:
netca.StatsTCAProfile
DescendantInfo:
genericne.MvPolicerPolicy
DescendantInfo:
rp.AbstractSrlgGroupPolicy
DescendantInfo:
lte5g.SbaNudmUecmProf
DescendantInfo:
sasqos.IngressCoSClassification
DescendantInfo:
rp.SrlgGroupPolicy
DescendantInfo:
aaa.RadiusScriptPolicy
DescendantInfo:
nat.SvcChainVasFilterPolicy
DescendantInfo:
aapolicy.DnsIpCache
DescendantInfo:
sasqos.NetworkIngress
DescendantInfo:
ltepolicyoptions.ChargingRuleUnit
DescendantInfo:
aapolicy.AAFlowCfgPolicy
DescendantInfo:
lte5g.HTTP2Profile
DescendantInfo:
sasqos.PortAccessIngress
DescendantInfo:
ltegw.PcscfGroupProfile
DescendantInfo:
multicast.IngrPathMgmtInfoPolicy
DescendantInfo:
sitesec.ManagementAccessFilter
DescendantInfo:
ltetwag.SwwTunnelProfile
DescendantInfo:
ethernetoam.MaintenanceDomain
DescendantInfo:
ipsec.RadiusAuthenticationPolicy
DescendantInfo:
aapolicy.AaStatTcaPolicerCfg
DescendantInfo:
ipsec.TrafficSelectorList
DescendantInfo:
atmpolicy.TrafficDescriptor
DescendantInfo:
sasqos.PortAccessEgress
DescendantInfo:
aapolicy.MpTcpProxy
DescendantInfo:
connprof.VlanConnProfPolicy
DescendantInfo:
opticalacl.IpPattern
DescendantInfo:
policing.PolicerControl
DescendantInfo:
sw.SoftwareRepositoryPolicy
DescendantInfo:
svt.TunnelAdminGroup
DescendantInfo:
optical.OcsAlarmProfile
DescendantInfo:
aclfilterli.BlockReservation
DescendantInfo:
genericne.MvMatchingRulePolicy
DescendantInfo:
mmepolicy.WMMInterfaceProfile
DescendantInfo:
calltrace.TraceProfile
DescendantInfo:
ltepolicyoptions.DhcpServerGroupProfile
DescendantInfo:
service.AbstractSapTemplate
DescendantInfo:
aapolicy.AaTcpValidationTca
DescendantInfo:
ltepmip.S6bAvpOptionProfile
DescendantInfo:
redirectfilter.RedirectPolicy
DescendantInfo:
service.EpipeSapTemplate
DescendantInfo:
lte.AbsGtpProfile
DescendantInfo:
ltegw.AvpOptionProfile
DescendantInfo:
nodelog.FirewallLog
DescendantInfo:
multicast.McastCacInterfacePolicy
DescendantInfo:
nodelog.FilterLog
DescendantInfo:
ixrqos.FcDSCPMap
DescendantInfo:
lte5g.NpcfProfile
DescendantInfo:
ltegw.AbsNodeSelPolicyGroup
DescendantInfo:
sitesec.PasswordPolicy
DescendantInfo:
nat.NatClassifier
DescendantInfo:
aaa.L2tpRadiusAccountingPolicy
DescendantInfo:
dynsvc.DynSvcPolicy
DescendantInfo:
ltepolicyoptions.UsgMonAction
DescendantInfo:
sitesec.TacacsPolicy
DescendantInfo:
ltepolicyoptions.StatsRuleUnit
DescendantInfo:
rp.Community
DescendantInfo:
securitypolicy.Bypass
DescendantInfo:
lte.DnsErrMapProfile
DescendantInfo:
nat.FirewallPolicy
DescendantInfo:
ipsec.IPSecClientDB
DescendantInfo:
lte.QciPolicy
DescendantInfo:
filterprefixlist.PrefixList
DescendantInfo:
netca.OCSStatsTCAProfile
DescendantInfo:
rmon.RemoteNetworkMonitoring
DescendantInfo:
aapolicy.AaFilterAbstract
DescendantInfo:
ltepmip.Pmipv6Profile
DescendantInfo:
lte5g.NrfProfile
DescendantInfo:
pppoe.PPPPolicy
DescendantInfo:
qgroup.EgressQGroupPolicy
DescendantInfo:
aaa.NatRadiusAccountingPolicy
DescendantInfo:
ressubscr.IpoePolicy
DescendantInfo:
securitypolicy.SecurityPolicyDefinition
DescendantInfo:
sitesec.RemoteAuthPolicy
DescendantInfo:
aosqos.QoSNetworkGroups
DescendantInfo:
aapolicy.GtpFilter
DescendantInfo:
lte.FqdnGroupProfile
DescendantInfo:
aclfilter.VlanFilter
DescendantInfo:
lte.DiameterPeerProfile
DescendantInfo:
mpr.RadioQOS
DescendantInfo:
portscheduler.HsmdaSchedulerPolicy
DescendantInfo:
lte5g.N1Profile
DescendantInfo:
lte.PfcpProfile
DescendantInfo:
securitypolicy.HostGroup
DescendantInfo:
ressubscr.RipPolicy
DescendantInfo:
aapolicy.AccessNetworkLocation
DescendantInfo:
lteepdg.IPSecProfile
DescendantInfo:
sitesec.TlsTrustAnchorProfile
DescendantInfo:
connprof.PssConnProfPolicy
DescendantInfo:
lte.DiameterRateLimProfile
DescendantInfo:
ltetwag.TwagChargingProfile
DescendantInfo:
ipsec.IPSecStaticSA
DescendantInfo:
ressubscr.MldPolicy
DescendantInfo:
nodelog.AbstractLog
DescendantInfo:
slaprofile.Policy
DescendantInfo:
wlangw.DsmIpFilterPolicy
DescendantInfo:
aapolicy.AaSubCongDetect
DescendantInfo:
opticalacl.OcsIpFilter
DescendantInfo:
lte.DnsProfile
DescendantInfo:
ipfix.IPFIXExportPolicy
DescendantInfo:
ixrqos.DSCPFCMap
DescendantInfo:
slope.Policy
DescendantInfo:
mpls.Policy
DescendantInfo:
rp.AbstractAdminGroupPolicy
DescendantInfo:
portscheduler.HsmdaWrrPolicy
DescendantInfo:
mmepolicy.MMEEmergencyNumListTblPolicy
DescendantInfo:
lteepdg.EpdgChargingProfile
DescendantInfo:
lte.ErrorMappingProfile
DescendantInfo:
lte.FqdnList
DescendantInfo:
lte.GxProfile
DescendantInfo:
lte.CloudDBProfile
DescendantInfo:
sasqos.Remark
DescendantInfo:
aclfilter.DhcpFilter
DescendantInfo:
slope.NamedPool
DescendantInfo:
qosprofile.McfrEgressQosProfile
DescendantInfo:
ipsec.IkeTransform
DescendantInfo:
lte5g.Oauth2Profile
DescendantInfo:
sitesec.TlsClientProfile
DescendantInfo:
aapolicy.AaStatTcaAbstract
DescendantInfo:
firewall.HostGroup
DescendantInfo:
ressubscr.BgpPeeringPolicy
DescendantInfo:
service.SvcActTestHeadAcceptanceCriteriaTemplate
DescendantInfo:
nodelog.SysLogTarget
DescendantInfo:
aaa.AcctOnOffGroup
DescendantInfo:
lte.UeCallTrace
DescendantInfo:
aclfilter.MacFilter
DescendantInfo:
sas.StreamingDelayTemplate
DescendantInfo:
lte.DefBearerQoSProfile
DescendantInfo:
rp.PolicyObjectBase
DescendantInfo:
service.Y1564TestHeadProfile
DescendantInfo:
igmp.SSMTranslatePolicy
DescendantInfo:
radiusaccounting.Policy
DescendantInfo:
aapolicy.AaTcpOpt
DescendantInfo:
service.SvcActTestHeadFrameSizeTemplate
DescendantInfo:
ipsec.TrustAnchorProfile
DescendantInfo:
ixrqos.PortQosPolicy
DescendantInfo:
nodelog.SecurityLog
DescendantInfo:
ixrqos.IngressClassification
DescendantInfo:
aapolicy.Policy
DescendantInfo:
ipsec.RadiusAccountingPolicy
DescendantInfo:
qosprofile.McfrIngressQosProfile
DescendantInfo:
ressubscr.HostLockoutPolicy
DescendantInfo:
ressubscr.SubMcastCacPolicy
DescendantInfo:
slope.HsmdaPoolPolicy
DescendantInfo:
opticalacl.IpFilter
DescendantInfo:
ixrqos.QueueMgmtPolicy
DescendantInfo:
policy.PSGGenericPolicy
DescendantInfo:
mmepolicy.MMESCTPProfile
DescendantInfo:
aapolicy.AARadiusAccountingPolicy
DescendantInfo:
lte.SgwChargingProfile
DescendantInfo:
multicast.EgressMcastGroup
DescendantInfo:
aapolicy.HttpErrorRedirect
DescendantInfo:
multicast.McastReportDestination
DescendantInfo:
firewall.CPMFirewall
DescendantInfo:
rtr.AbstractAdminGroupPolicy
DescendantInfo:
lte.TrustedPeerListPolicy
DescendantInfo:
lteli.DFPeer
DescendantInfo:
aosqos.QoSMacGroups
DescendantInfo:
ltepolicyoptions.ApnRateControl
DescendantInfo:
hsqos.HsAttachmentPolicy
DescendantInfo:
subscrident.Policy
DescendantInfo:
tod.Policy
DescendantInfo:
lteggsn.CdrAvpOptionProfile
DescendantInfo:
lte.OIOverList
DescendantInfo:
aapolicy.AAGroupPolicy
DescendantInfo:
lte.MMEGroupProfile
DescendantInfo:
lteradius.RadiusGroupProfile
DescendantInfo:
lteli.InterceptionTarget
DescendantInfo:
mmepolicy.MMEProfile
DescendantInfo:
lte.IkeRedList
DescendantInfo:
ltehomeagent.DNSRedirectServer
DescendantInfo:
qosprofile.MlpppIngressQosProfile
DescendantInfo:
dctr.PortProfile
DescendantInfo:
multicast.PackagePolicy
DescendantInfo:
lte.PgwSelectionCandidateList
DescendantInfo:
file.FileTransmissionProfile
DescendantInfo:
genericne.MvFilterPolicy
DescendantInfo:
mmepolicy.MMEGTPProfile
DescendantInfo:
genericne.MvForwardingClassPolicy
DescendantInfo:
ltetwag.DhcpServerProfile
DescendantInfo:
aclfilter.Ipv6ExceptionFilter
DescendantInfo:
aclfilter.DhcpV6Filter
DescendantInfo:
lteradius.RadiusProfile
DescendantInfo:
sitesec.TlsServerProfile
DescendantInfo:
nqueue.Policy
DescendantInfo:
sasqos.AccessEgress
DescendantInfo:
wlangw.DsmTrafficPolicer
DescendantInfo:
lte.UpPeerList
DescendantInfo:
netca.AbstractStatsTCAProfile
DescendantInfo:
sasqos.MpBwPolicy
DescendantInfo:
nat.NatPolicy
DescendantInfo:
ltepolicyoptions.QoSRuleUnit
DescendantInfo:
sas.BinGroup
DescendantInfo:
aapolicy.HttpNotif
DescendantInfo:
ethernetservice.SapProfile
DescendantInfo:
sitesec.CpmIpFilter
DescendantInfo:
mmepolicy.WMMSVCAgreementProfile
DescendantInfo:
connprof.ConnProfPolicy
DescendantInfo:
pae802_1x.RadiusServerPolicy
DescendantInfo:
aapolicy.AaStatTcaCfg
DescendantInfo:
sasqos.PortScheduler
DescendantInfo:
lte.IdiRealmList
DescendantInfo:
sitesec.CertificateAuthProfile
DescendantInfo:
qgroup.RedirectList
DescendantInfo:
ltepolicyoptions.PolicyRuleBase
DescendantInfo:
genericne.MVGenericPolicy
DescendantInfo:
rtr.AdminGroupPolicy
DescendantInfo:
aaa.RadiusServerPolicy
DescendantInfo:
securitypolicy.Profile
DescendantInfo:
lte.PpiMappingProfile
DescendantInfo:
rtr.SharedRiskLinkGroup
DescendantInfo:
aapolicy.AAPortList
DescendantInfo:
lte.AgwChargingProfile
DescendantInfo:
mpls.LspTemplateMvpn
DescendantInfo:
aossas.CPETestHeadProfile
DescendantInfo:
ltegw.ApnListPolicyGroup
DescendantInfo:
ancp.Policy
DescendantInfo:
lte.CCFHProfile
DescendantInfo:
aclfilter.AggregateFilter
DescendantInfo:
lte.IpAddressList
DescendantInfo:
dctr.Profile
DescendantInfo:
hsqos.HsPortPoolPolicy
DescendantInfo:
hsqos.HsPoolPolicy
DescendantInfo:
ltessg.TdfChargingProfile
DescendantInfo:
aaa.IsaRadiusPolicy
DescendantInfo:
ltepolicyoptions.TrafficRedirectProfile
DescendantInfo:
nat.UpnpPolicy
DescendantInfo:
pdnprofile.PacketDataNetworkProfilePolicy
DescendantInfo:
gtp.ApnPolicy
DescendantInfo:
rtr.AbstractSharedRiskLinkGroup
DescendantInfo:
aosqos.QoSCondition
DescendantInfo:
ltetwag.SwwRadiusProfile
DescendantInfo:
svt.PwTemplate
DescendantInfo:
filterprefixlist.ProtocolList
DescendantInfo:
rp.AdminGroupPolicy
DescendantInfo:
rtr.AdminTagPolicy
DescendantInfo:
ltehomeagent.FAHAPeerList
DescendantInfo:
mpls.SRLGStaticConfig
DescendantInfo:
accounting.Policy
DescendantInfo:
lte.PfcpTranslateProfile
DescendantInfo:
aapolicy.AaTcpValidation
DescendantInfo:
lte5g.CHFProfile
DescendantInfo:
opticalacl.AbstractIpFilter
DescendantInfo:
msappolicy.Policy
DescendantInfo:
wlangw.MgwProfile
DescendantInfo:
lte5g.AllowedNFDomainList
DescendantInfo:
mmepolicy.WMMPfmJobEntry
DescendantInfo:
aclfilterli.LiMacFilter
DescendantInfo:
securitypolicy.AppGroup
DescendantInfo:
aapolicy.AaCflowdGroupPolicy
DescendantInfo:
lte.PeerListPolicy
DescendantInfo:
fabricqos.FabricProfile
DescendantInfo:
firewall.FwPolicyDefinition
DescendantInfo:
multicast.McastCacPolicy
DescendantInfo:
rp.PolicyAccountingTemplate
DescendantInfo:
ipsec.AbstractTrustAnchorProfile
DescendantInfo:
aclfilter.GreTunnelTemplate
DescendantInfo:
lte.DiameterProfile
DescendantInfo:
lte.PgwChargingProfile
DescendantInfo:
sasqos.EgressRemarking
DescendantInfo:
aclfilterli.LiIpFilter
DescendantInfo:
ltepolicyoptions.UrrProfile
DescendantInfo:
service.Y1564PayloadProfile
DescendantInfo:
lte5g.UdmIdList
DescendantInfo:
sas.LinkMeasurementTemplate
DescendantInfo:
nat.NatPrefixList
DescendantInfo:
aaa.IsaRadiusPolicyBase
DescendantInfo:
lteradius.AbsRadiusProfile
DescendantInfo:
equipment.PortPolicy
DescendantInfo:
unpprofile.UNPProfile
DescendantInfo:
rtr.ReassemblyProfilePolicy
DescendantInfo:
lte.GtpPrimeServerGroupProfile
DescendantInfo:
lte.Profile
DescendantInfo:
layer2.L2Profile
DescendantInfo:
qosportlist.PortList
DescendantInfo:
lte.ClientProfile
DescendantInfo:
lte.OverloadControlProfile
DescendantInfo:
ressubscr.BrgProfile
DescendantInfo:
firewall.ServiceGroup
DescendantInfo:
vs.ServiceTypeDefinition
DescendantInfo:
qgroup.IngressQGroupPolicy
DescendantInfo:
lte.SubscriberMappingProfile
DescendantInfo:
lte5g.SMFAttributesProfile
DescendantInfo:
ltegw.UMTSQoSPolicy
DescendantInfo:
ltepolicyoptions.ActionRuleUnitProfile
DescendantInfo:
lte.S2bErrorMappingProfile
DescendantInfo:
dynsvc.DynSvcLocalAuthDb
DescendantInfo:
lte5g.EmerProfile
DescendantInfo:
aosqos.List
DescendantInfo:
shaperqos.ShaperPolicy
DescendantInfo:
sasqos.FcDot1pMap
DescendantInfo:
ltessg.SteeringProfile
DescendantInfo:
srpythonmgmt.PythonScript
DescendantInfo:
sasqos.MplsLspExpMap
DescendantInfo:
lte.CreditPoolProfile
DescendantInfo:
ltegw.UDPTunnelGroupProfile
DescendantInfo:
multicast.IngrPathMgmtBwPolicy
DescendantInfo:
aclfilter.Ipv6Filter
DescendantInfo:
aapolicy.AAPrefixListPolicy
DescendantInfo:
ipsec.IPSecTunnelTemplate
DescendantInfo:
nat.PcpPolicy
DescendantInfo:
mmepolicy.WMMPfmMeasGroupName
DescendantInfo:
aosqos.QoSAction
DescendantInfo:
lte5g.EventTriggerFBCProfile
DescendantInfo:
srpythonmgmt.PythonPolicy
DescendantInfo:
aclfilterli.LiFilter
DescendantInfo:
ixrqos.EgressRemarkPolicy
DescendantInfo:
diameter.DiameterPeerPolicy
DescendantInfo:
nat.AbstractNatPlcy
DescendantInfo:
aosqos.Policy
DescendantInfo:
aapolicy.AAPolicer
DescendantInfo:
aclfilter.IpFilter
DescendantInfo:
lte5g.SMFChargingProfile
DescendantInfo:
lte.TargetProfile
DescendantInfo:
lte.GroupLabel
DescendantInfo:
ixrqos.Dot1pFCMap
DescendantInfo:
lte5g.SMFServingAreaList
DescendantInfo:
squeue.Policy
DescendantInfo:
ltetwag.SlaacHostProfile
DescendantInfo:
aaa.RouteDownloadPolicy
DescendantInfo:
ltessg.AddressListProfile
DescendantInfo:
pppoe.PPPPolicyBase
DescendantInfo:
lte.AbsCallInsight
DescendantInfo:
nat.SvcChainEvpnPolicy
DescendantInfo:
aapolicy.AaStatTcaFilterCfg
DescendantInfo:
ltegw.QciListPolicyGroup
DescendantInfo:
aapolicy.AAUrlListPolicy
DescendantInfo:
aapolicy.HttpRedirect
DescendantInfo:
ixrqos.LspExpFCMap
DescendantInfo:
niegr.Policy
DescendantInfo:
securitypolicy.PolicerGroup
DescendantInfo:
aapolicy.AACertProfile
DescendantInfo:
securityqueue.SecurityQueuePolicy
DescendantInfo:
genericne.MvMultitermPolicy
DescendantInfo:
lte.TaiLaiListProfile
DescendantInfo:
nat.MapDomain
DescendantInfo:
nodelog.LogProfile
instanceFullName : distinguished/instance name of called object
The full name of the global policy to be distributed.

", "operationId": "rest_policy_PolicyDefinition_distributeV2", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/distributeV2" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/distributeV2Response" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/policy/PolicyDefinition/evaluatePolicy/{instanceFullName}": { "post": { "tags": [ "samo_policy" ], "summary": "rest_policy_PolicyDefinition_evaluatePolicy", "description": "
Intention : RETRIEVER
evaluatePolicy:
instance-level retriever API evaluatePolicy
of class policy.PolicyDefinition
DescendantInfo:
rtr.SegmentRoutingMaintenancePolicy
DescendantInfo:
lte5g.PcfIdList
DescendantInfo:
mplstp.BFDTemplate
DescendantInfo:
ixrqos.VlanQosPolicy
DescendantInfo:
ressubscr.ShcvPolicy
DescendantInfo:
ltepolicyoptions.AssumePositiveActionProfile
DescendantInfo:
ixrqos.FcLspExpMap
DescendantInfo:
aclfilterli.LiIpv6Filter
DescendantInfo:
subscrexpmap.Policy
DescendantInfo:
sitesec.DCpuProtection
DescendantInfo:
rp.ASPathGroup
DescendantInfo:
diameter.DiameterAppPolicy
DescendantInfo:
aclfilter.AbstractFilterDefinition
DescendantInfo:
sasqos.Network
DescendantInfo:
lte.GtpProfile
DescendantInfo:
rp.PolicyStatement
DescendantInfo:
file.Policy
DescendantInfo:
lte.PfcpAPPeerList
DescendantInfo:
ethernetservice.UniProfile
DescendantInfo:
ltepolicyoptions.TrafficHashProfile
DescendantInfo:
sitesec.TlsCertificateProfile
DescendantInfo:
qosprofile.MlpppEgressQosProfile
DescendantInfo:
vs.AdvancedConfigPolicy
DescendantInfo:
sasqos.SchedulerPolicy
DescendantInfo:
aapolicy.AAUrlFilter
DescendantInfo:
genericne.MvQosPolicy
DescendantInfo:
sitesec.PkiCommonNameList
DescendantInfo:
ethernetservice.CustomL2Profile
DescendantInfo:
ltetwag.DiameterPeerGroupList
DescendantInfo:
postpolicermapping.PostPolicerMappingPolicy
DescendantInfo:
aengr.Policy
DescendantInfo:
sitesec.LocalUser
DescendantInfo:
rp.PrefixList
DescendantInfo:
lte5g.NfIdList
DescendantInfo:
rtr.RouteNextHopPolicyTemplate
DescendantInfo:
lte5g.QfiMappingProfile
DescendantInfo:
aapolicy.AbstractTransitPolicy
DescendantInfo:
aclfilter.AbstractExceptionFilter
DescendantInfo:
sasqos.DSCPClassification
DescendantInfo:
lte.WlanEmergencyProfile
DescendantInfo:
portscheduler.Policy
DescendantInfo:
vs.Policy
DescendantInfo:
lteggsn.GyAvpOptionProfile
DescendantInfo:
ixrqos.NetworkIngressPolicy
DescendantInfo:
ixrqos.FcDot1pMap
DescendantInfo:
sasqos.NQueue
DescendantInfo:
aapolicy.TetherDetection
DescendantInfo:
service.Y1564AcceptanceCriteriaProfile
DescendantInfo:
ltepolicyoptions.PolicyRule
DescendantInfo:
lte.Abspfcp
DescendantInfo:
mmepolicy.MMEEmergencyNumListPolicy
DescendantInfo:
sitesec.AOSSecurityPolicy
DescendantInfo:
lte.T6cProfile
DescendantInfo:
lte.EpdgGroupList
DescendantInfo:
slope.HsmdaSlopePolicy
DescendantInfo:
aapolicy.AaStatTcaFltrEntryCfg
DescendantInfo:
lte.SourceIpList
DescendantInfo:
sasqos.FcDscpMap
DescendantInfo:
lte.IPProfile
DescendantInfo:
ipsec.IPSecTransform
DescendantInfo:
subscrauth.Policy
DescendantInfo:
icmp.IcmpPingTemplate
DescendantInfo:
qosprefixlist.PrefixList
DescendantInfo:
sitesec.DoSProtection
DescendantInfo:
lte.DccaProfile
DescendantInfo:
filterprefixlist.PortList
DescendantInfo:
rtr.AdminTag
DescendantInfo:
aapolicy.AASessionFilter
DescendantInfo:
hsqos.HsSchedulerPolicy
DescendantInfo:
ltepolicyoptions.ServiceClassIndicator
DescendantInfo:
sitesec.UserProfile
DescendantInfo:
ltepolicyoptions.SruList
DescendantInfo:
lte.AllUesCallTrace
DescendantInfo:
sitesec.TlsServerCipherList
DescendantInfo:
ltegw.TariffChangeListProfilePolicyGroup
DescendantInfo:
aingr.Policy
DescendantInfo:
aapolicy.AbstractHttpRedirect
DescendantInfo:
ltetwag.StaProfile
DescendantInfo:
redirectfilter.RedirectPolicyBinding
DescendantInfo:
sasqos.FCMeterMap
DescendantInfo:
vrrp.Policy
DescendantInfo:
lte5g.SliceList
DescendantInfo:
sasqos.SlopePolicy
DescendantInfo:
todsuite.Policy
DescendantInfo:
diameter.DiameterPolicy
DescendantInfo:
sasqos.SystemResourceProfilePolicy
DescendantInfo:
genericne.MvAbstractPolicy
DescendantInfo:
aapolicy.TransitPrefixPolicy
DescendantInfo:
sitesec.EstAuthProfile
DescendantInfo:
hwaggshapersched.HwAggShaperSchedulerPolicy
DescendantInfo:
aossas.CPETestHeadGroupProfile
DescendantInfo:
lte5g.PrioAddrList
DescendantInfo:
rp.GlobalVariables
DescendantInfo:
lte5g.SliceInstanceList
DescendantInfo:
lte.DedicatedBearerIdleTimeOutProfile
DescendantInfo:
security.KeyChain
DescendantInfo:
lte.PcmdProfile
DescendantInfo:
lteepdg.SwmAvpOptionProfile
DescendantInfo:
mpls.SharedRiskLinkGroup
DescendantInfo:
sitesec.TlsClientCipherList
DescendantInfo:
lte.AmfIdList
DescendantInfo:
ltehomeagent.MobileIpv4Profile
DescendantInfo:
file.LogDefinition
DescendantInfo:
macsec.MacPolicy
DescendantInfo:
securitypolicy.Policy
DescendantInfo:
ltepolicyoptions.AbsPolicyOptionProfile
DescendantInfo:
aclfilter.IpExceptionFilter
DescendantInfo:
sasqos.Dot1pClassification
DescendantInfo:
ipsec.IkePolicy
DescendantInfo:
mpr.QueueMapPolicy
DescendantInfo:
aapolicy.ApplicationAssurancePolicyDefinition
DescendantInfo:
service.VplsSapTemplate
DescendantInfo:
ltegw.AbsListPolicyGroup
DescendantInfo:
lte.SDProfile
DescendantInfo:
aapolicy.SctpFilter
DescendantInfo:
lte.PlmnListPolicyGroup
DescendantInfo:
mpr.GneRadiusQosPolicy
DescendantInfo:
l2fwd.MrpPolicy
DescendantInfo:
sasqos.AccessIngress
DescendantInfo:
crdtctrl.CrdtCtrlPolicy
DescendantInfo:
lte.PortList
DescendantInfo:
lte5g.SbaNudmSdmProf
DescendantInfo:
rp.Damping
DescendantInfo:
aapolicy.TransitIpPolicy
DescendantInfo:
lte.SwmErrorMappingProfile
DescendantInfo:
firewall.Zone
DescendantInfo:
rp.ASPath
DescendantInfo:
ltepolicyoptions.UsgMonInfo
DescendantInfo:
sitesec.RadiusPolicy
DescendantInfo:
optical.AlarmProfile
DescendantInfo:
ipsec.CertProfile
DescendantInfo:
crdtctrl.CtgryMapPolicy
DescendantInfo:
lte.DiameterErrorMappingProfile
DescendantInfo:
ressubscr.HostTrackingPolicy
DescendantInfo:
sasqos.MplsLspExpClassification
DescendantInfo:
ressubscr.IgmpPolicy
DescendantInfo:
lte.AccountingPriorityProfile
DescendantInfo:
rp.RouteNextHopPolicyTemplate
DescendantInfo:
ressubscr.PimPolicy
DescendantInfo:
ltepolicyoptions.DynamicToInternalRuleMap
DescendantInfo:
netca.CardStatsTCAProfile
DescendantInfo:
subscrprofile.Policy
DescendantInfo:
aapolicy.HttpEnrich
DescendantInfo:
ltepolicyoptions.GxAvpOptionProfile
DescendantInfo:
sitesec.LdapPolicy
DescendantInfo:
aclfilter.FilterDefinition
DescendantInfo:
fpresource.FPResourcePolicy
DescendantInfo:
securitypolicy.Zone
DescendantInfo:
ltegw.SCTPProfile
DescendantInfo:
sasqos.QueueMgmtPolicy
DescendantInfo:
sasqos.FcLspExpMap
DescendantInfo:
ltepolicyoptions.TriggerRuleUnitProfile
DescendantInfo:
ressubscr.HttpRedirectPolicy
DescendantInfo:
service.Y1564FrameMixProfile
DescendantInfo:
ltepolicyoptions.PolicyRuleUnit
DescendantInfo:
firewall.MgmtAccessFirewall
DescendantInfo:
ltehomeagent.AbsHomeAgentProfile
DescendantInfo:
firewall.RuleSet
DescendantInfo:
netca.StatsTCAProfile
DescendantInfo:
genericne.MvPolicerPolicy
DescendantInfo:
rp.AbstractSrlgGroupPolicy
DescendantInfo:
lte5g.SbaNudmUecmProf
DescendantInfo:
sasqos.IngressCoSClassification
DescendantInfo:
rp.SrlgGroupPolicy
DescendantInfo:
aaa.RadiusScriptPolicy
DescendantInfo:
nat.SvcChainVasFilterPolicy
DescendantInfo:
aapolicy.DnsIpCache
DescendantInfo:
sasqos.NetworkIngress
DescendantInfo:
ltepolicyoptions.ChargingRuleUnit
DescendantInfo:
aapolicy.AAFlowCfgPolicy
DescendantInfo:
lte5g.HTTP2Profile
DescendantInfo:
sasqos.PortAccessIngress
DescendantInfo:
ltegw.PcscfGroupProfile
DescendantInfo:
multicast.IngrPathMgmtInfoPolicy
DescendantInfo:
sitesec.ManagementAccessFilter
DescendantInfo:
ltetwag.SwwTunnelProfile
DescendantInfo:
ethernetoam.MaintenanceDomain
DescendantInfo:
ipsec.RadiusAuthenticationPolicy
DescendantInfo:
aapolicy.AaStatTcaPolicerCfg
DescendantInfo:
ipsec.TrafficSelectorList
DescendantInfo:
atmpolicy.TrafficDescriptor
DescendantInfo:
sasqos.PortAccessEgress
DescendantInfo:
aapolicy.MpTcpProxy
DescendantInfo:
connprof.VlanConnProfPolicy
DescendantInfo:
opticalacl.IpPattern
DescendantInfo:
policing.PolicerControl
DescendantInfo:
sw.SoftwareRepositoryPolicy
DescendantInfo:
svt.TunnelAdminGroup
DescendantInfo:
optical.OcsAlarmProfile
DescendantInfo:
aclfilterli.BlockReservation
DescendantInfo:
genericne.MvMatchingRulePolicy
DescendantInfo:
mmepolicy.WMMInterfaceProfile
DescendantInfo:
calltrace.TraceProfile
DescendantInfo:
ltepolicyoptions.DhcpServerGroupProfile
DescendantInfo:
service.AbstractSapTemplate
DescendantInfo:
aapolicy.AaTcpValidationTca
DescendantInfo:
ltepmip.S6bAvpOptionProfile
DescendantInfo:
redirectfilter.RedirectPolicy
DescendantInfo:
service.EpipeSapTemplate
DescendantInfo:
lte.AbsGtpProfile
DescendantInfo:
ltegw.AvpOptionProfile
DescendantInfo:
nodelog.FirewallLog
DescendantInfo:
multicast.McastCacInterfacePolicy
DescendantInfo:
nodelog.FilterLog
DescendantInfo:
ixrqos.FcDSCPMap
DescendantInfo:
lte5g.NpcfProfile
DescendantInfo:
ltegw.AbsNodeSelPolicyGroup
DescendantInfo:
sitesec.PasswordPolicy
DescendantInfo:
nat.NatClassifier
DescendantInfo:
aaa.L2tpRadiusAccountingPolicy
DescendantInfo:
dynsvc.DynSvcPolicy
DescendantInfo:
ltepolicyoptions.UsgMonAction
DescendantInfo:
sitesec.TacacsPolicy
DescendantInfo:
ltepolicyoptions.StatsRuleUnit
DescendantInfo:
rp.Community
DescendantInfo:
securitypolicy.Bypass
DescendantInfo:
lte.DnsErrMapProfile
DescendantInfo:
nat.FirewallPolicy
DescendantInfo:
ipsec.IPSecClientDB
DescendantInfo:
lte.QciPolicy
DescendantInfo:
filterprefixlist.PrefixList
DescendantInfo:
netca.OCSStatsTCAProfile
DescendantInfo:
rmon.RemoteNetworkMonitoring
DescendantInfo:
aapolicy.AaFilterAbstract
DescendantInfo:
ltepmip.Pmipv6Profile
DescendantInfo:
lte5g.NrfProfile
DescendantInfo:
pppoe.PPPPolicy
DescendantInfo:
qgroup.EgressQGroupPolicy
DescendantInfo:
aaa.NatRadiusAccountingPolicy
DescendantInfo:
ressubscr.IpoePolicy
DescendantInfo:
securitypolicy.SecurityPolicyDefinition
DescendantInfo:
sitesec.RemoteAuthPolicy
DescendantInfo:
aosqos.QoSNetworkGroups
DescendantInfo:
aapolicy.GtpFilter
DescendantInfo:
lte.FqdnGroupProfile
DescendantInfo:
aclfilter.VlanFilter
DescendantInfo:
lte.DiameterPeerProfile
DescendantInfo:
mpr.RadioQOS
DescendantInfo:
portscheduler.HsmdaSchedulerPolicy
DescendantInfo:
lte5g.N1Profile
DescendantInfo:
lte.PfcpProfile
DescendantInfo:
securitypolicy.HostGroup
DescendantInfo:
ressubscr.RipPolicy
DescendantInfo:
aapolicy.AccessNetworkLocation
DescendantInfo:
lteepdg.IPSecProfile
DescendantInfo:
sitesec.TlsTrustAnchorProfile
DescendantInfo:
connprof.PssConnProfPolicy
DescendantInfo:
lte.DiameterRateLimProfile
DescendantInfo:
ltetwag.TwagChargingProfile
DescendantInfo:
ipsec.IPSecStaticSA
DescendantInfo:
ressubscr.MldPolicy
DescendantInfo:
nodelog.AbstractLog
DescendantInfo:
slaprofile.Policy
DescendantInfo:
wlangw.DsmIpFilterPolicy
DescendantInfo:
aapolicy.AaSubCongDetect
DescendantInfo:
opticalacl.OcsIpFilter
DescendantInfo:
lte.DnsProfile
DescendantInfo:
ipfix.IPFIXExportPolicy
DescendantInfo:
ixrqos.DSCPFCMap
DescendantInfo:
slope.Policy
DescendantInfo:
mpls.Policy
DescendantInfo:
rp.AbstractAdminGroupPolicy
DescendantInfo:
portscheduler.HsmdaWrrPolicy
DescendantInfo:
mmepolicy.MMEEmergencyNumListTblPolicy
DescendantInfo:
lteepdg.EpdgChargingProfile
DescendantInfo:
lte.ErrorMappingProfile
DescendantInfo:
lte.FqdnList
DescendantInfo:
lte.GxProfile
DescendantInfo:
lte.CloudDBProfile
DescendantInfo:
sasqos.Remark
DescendantInfo:
aclfilter.DhcpFilter
DescendantInfo:
slope.NamedPool
DescendantInfo:
qosprofile.McfrEgressQosProfile
DescendantInfo:
ipsec.IkeTransform
DescendantInfo:
lte5g.Oauth2Profile
DescendantInfo:
sitesec.TlsClientProfile
DescendantInfo:
aapolicy.AaStatTcaAbstract
DescendantInfo:
firewall.HostGroup
DescendantInfo:
ressubscr.BgpPeeringPolicy
DescendantInfo:
service.SvcActTestHeadAcceptanceCriteriaTemplate
DescendantInfo:
nodelog.SysLogTarget
DescendantInfo:
aaa.AcctOnOffGroup
DescendantInfo:
lte.UeCallTrace
DescendantInfo:
aclfilter.MacFilter
DescendantInfo:
sas.StreamingDelayTemplate
DescendantInfo:
lte.DefBearerQoSProfile
DescendantInfo:
rp.PolicyObjectBase
DescendantInfo:
service.Y1564TestHeadProfile
DescendantInfo:
igmp.SSMTranslatePolicy
DescendantInfo:
radiusaccounting.Policy
DescendantInfo:
aapolicy.AaTcpOpt
DescendantInfo:
service.SvcActTestHeadFrameSizeTemplate
DescendantInfo:
ipsec.TrustAnchorProfile
DescendantInfo:
ixrqos.PortQosPolicy
DescendantInfo:
nodelog.SecurityLog
DescendantInfo:
ixrqos.IngressClassification
DescendantInfo:
aapolicy.Policy
DescendantInfo:
ipsec.RadiusAccountingPolicy
DescendantInfo:
qosprofile.McfrIngressQosProfile
DescendantInfo:
ressubscr.HostLockoutPolicy
DescendantInfo:
ressubscr.SubMcastCacPolicy
DescendantInfo:
slope.HsmdaPoolPolicy
DescendantInfo:
opticalacl.IpFilter
DescendantInfo:
ixrqos.QueueMgmtPolicy
DescendantInfo:
policy.PSGGenericPolicy
DescendantInfo:
mmepolicy.MMESCTPProfile
DescendantInfo:
aapolicy.AARadiusAccountingPolicy
DescendantInfo:
lte.SgwChargingProfile
DescendantInfo:
multicast.EgressMcastGroup
DescendantInfo:
aapolicy.HttpErrorRedirect
DescendantInfo:
multicast.McastReportDestination
DescendantInfo:
firewall.CPMFirewall
DescendantInfo:
rtr.AbstractAdminGroupPolicy
DescendantInfo:
lte.TrustedPeerListPolicy
DescendantInfo:
lteli.DFPeer
DescendantInfo:
aosqos.QoSMacGroups
DescendantInfo:
ltepolicyoptions.ApnRateControl
DescendantInfo:
hsqos.HsAttachmentPolicy
DescendantInfo:
subscrident.Policy
DescendantInfo:
tod.Policy
DescendantInfo:
lteggsn.CdrAvpOptionProfile
DescendantInfo:
lte.OIOverList
DescendantInfo:
aapolicy.AAGroupPolicy
DescendantInfo:
lte.MMEGroupProfile
DescendantInfo:
lteradius.RadiusGroupProfile
DescendantInfo:
lteli.InterceptionTarget
DescendantInfo:
mmepolicy.MMEProfile
DescendantInfo:
lte.IkeRedList
DescendantInfo:
ltehomeagent.DNSRedirectServer
DescendantInfo:
qosprofile.MlpppIngressQosProfile
DescendantInfo:
dctr.PortProfile
DescendantInfo:
multicast.PackagePolicy
DescendantInfo:
lte.PgwSelectionCandidateList
DescendantInfo:
file.FileTransmissionProfile
DescendantInfo:
genericne.MvFilterPolicy
DescendantInfo:
mmepolicy.MMEGTPProfile
DescendantInfo:
genericne.MvForwardingClassPolicy
DescendantInfo:
ltetwag.DhcpServerProfile
DescendantInfo:
aclfilter.Ipv6ExceptionFilter
DescendantInfo:
aclfilter.DhcpV6Filter
DescendantInfo:
lteradius.RadiusProfile
DescendantInfo:
sitesec.TlsServerProfile
DescendantInfo:
nqueue.Policy
DescendantInfo:
sasqos.AccessEgress
DescendantInfo:
wlangw.DsmTrafficPolicer
DescendantInfo:
lte.UpPeerList
DescendantInfo:
netca.AbstractStatsTCAProfile
DescendantInfo:
sasqos.MpBwPolicy
DescendantInfo:
nat.NatPolicy
DescendantInfo:
ltepolicyoptions.QoSRuleUnit
DescendantInfo:
sas.BinGroup
DescendantInfo:
aapolicy.HttpNotif
DescendantInfo:
ethernetservice.SapProfile
DescendantInfo:
sitesec.CpmIpFilter
DescendantInfo:
mmepolicy.WMMSVCAgreementProfile
DescendantInfo:
connprof.ConnProfPolicy
DescendantInfo:
pae802_1x.RadiusServerPolicy
DescendantInfo:
aapolicy.AaStatTcaCfg
DescendantInfo:
sasqos.PortScheduler
DescendantInfo:
lte.IdiRealmList
DescendantInfo:
sitesec.CertificateAuthProfile
DescendantInfo:
qgroup.RedirectList
DescendantInfo:
ltepolicyoptions.PolicyRuleBase
DescendantInfo:
genericne.MVGenericPolicy
DescendantInfo:
rtr.AdminGroupPolicy
DescendantInfo:
aaa.RadiusServerPolicy
DescendantInfo:
securitypolicy.Profile
DescendantInfo:
lte.PpiMappingProfile
DescendantInfo:
rtr.SharedRiskLinkGroup
DescendantInfo:
aapolicy.AAPortList
DescendantInfo:
lte.AgwChargingProfile
DescendantInfo:
mpls.LspTemplateMvpn
DescendantInfo:
aossas.CPETestHeadProfile
DescendantInfo:
ltegw.ApnListPolicyGroup
DescendantInfo:
ancp.Policy
DescendantInfo:
lte.CCFHProfile
DescendantInfo:
aclfilter.AggregateFilter
DescendantInfo:
lte.IpAddressList
DescendantInfo:
dctr.Profile
DescendantInfo:
hsqos.HsPortPoolPolicy
DescendantInfo:
hsqos.HsPoolPolicy
DescendantInfo:
ltessg.TdfChargingProfile
DescendantInfo:
aaa.IsaRadiusPolicy
DescendantInfo:
ltepolicyoptions.TrafficRedirectProfile
DescendantInfo:
nat.UpnpPolicy
DescendantInfo:
pdnprofile.PacketDataNetworkProfilePolicy
DescendantInfo:
gtp.ApnPolicy
DescendantInfo:
rtr.AbstractSharedRiskLinkGroup
DescendantInfo:
aosqos.QoSCondition
DescendantInfo:
ltetwag.SwwRadiusProfile
DescendantInfo:
svt.PwTemplate
DescendantInfo:
filterprefixlist.ProtocolList
DescendantInfo:
rp.AdminGroupPolicy
DescendantInfo:
rtr.AdminTagPolicy
DescendantInfo:
ltehomeagent.FAHAPeerList
DescendantInfo:
mpls.SRLGStaticConfig
DescendantInfo:
accounting.Policy
DescendantInfo:
lte.PfcpTranslateProfile
DescendantInfo:
aapolicy.AaTcpValidation
DescendantInfo:
lte5g.CHFProfile
DescendantInfo:
opticalacl.AbstractIpFilter
DescendantInfo:
msappolicy.Policy
DescendantInfo:
wlangw.MgwProfile
DescendantInfo:
lte5g.AllowedNFDomainList
DescendantInfo:
mmepolicy.WMMPfmJobEntry
DescendantInfo:
aclfilterli.LiMacFilter
DescendantInfo:
securitypolicy.AppGroup
DescendantInfo:
aapolicy.AaCflowdGroupPolicy
DescendantInfo:
lte.PeerListPolicy
DescendantInfo:
fabricqos.FabricProfile
DescendantInfo:
firewall.FwPolicyDefinition
DescendantInfo:
multicast.McastCacPolicy
DescendantInfo:
rp.PolicyAccountingTemplate
DescendantInfo:
ipsec.AbstractTrustAnchorProfile
DescendantInfo:
aclfilter.GreTunnelTemplate
DescendantInfo:
lte.DiameterProfile
DescendantInfo:
lte.PgwChargingProfile
DescendantInfo:
sasqos.EgressRemarking
DescendantInfo:
aclfilterli.LiIpFilter
DescendantInfo:
ltepolicyoptions.UrrProfile
DescendantInfo:
service.Y1564PayloadProfile
DescendantInfo:
lte5g.UdmIdList
DescendantInfo:
sas.LinkMeasurementTemplate
DescendantInfo:
nat.NatPrefixList
DescendantInfo:
aaa.IsaRadiusPolicyBase
DescendantInfo:
lteradius.AbsRadiusProfile
DescendantInfo:
equipment.PortPolicy
DescendantInfo:
unpprofile.UNPProfile
DescendantInfo:
rtr.ReassemblyProfilePolicy
DescendantInfo:
lte.GtpPrimeServerGroupProfile
DescendantInfo:
lte.Profile
DescendantInfo:
layer2.L2Profile
DescendantInfo:
qosportlist.PortList
DescendantInfo:
lte.ClientProfile
DescendantInfo:
lte.OverloadControlProfile
DescendantInfo:
ressubscr.BrgProfile
DescendantInfo:
firewall.ServiceGroup
DescendantInfo:
vs.ServiceTypeDefinition
DescendantInfo:
qgroup.IngressQGroupPolicy
DescendantInfo:
lte.SubscriberMappingProfile
DescendantInfo:
lte5g.SMFAttributesProfile
DescendantInfo:
ltegw.UMTSQoSPolicy
DescendantInfo:
ltepolicyoptions.ActionRuleUnitProfile
DescendantInfo:
lte.S2bErrorMappingProfile
DescendantInfo:
dynsvc.DynSvcLocalAuthDb
DescendantInfo:
lte5g.EmerProfile
DescendantInfo:
aosqos.List
DescendantInfo:
shaperqos.ShaperPolicy
DescendantInfo:
sasqos.FcDot1pMap
DescendantInfo:
ltessg.SteeringProfile
DescendantInfo:
srpythonmgmt.PythonScript
DescendantInfo:
sasqos.MplsLspExpMap
DescendantInfo:
lte.CreditPoolProfile
DescendantInfo:
ltegw.UDPTunnelGroupProfile
DescendantInfo:
multicast.IngrPathMgmtBwPolicy
DescendantInfo:
aclfilter.Ipv6Filter
DescendantInfo:
aapolicy.AAPrefixListPolicy
DescendantInfo:
ipsec.IPSecTunnelTemplate
DescendantInfo:
nat.PcpPolicy
DescendantInfo:
mmepolicy.WMMPfmMeasGroupName
DescendantInfo:
aosqos.QoSAction
DescendantInfo:
lte5g.EventTriggerFBCProfile
DescendantInfo:
srpythonmgmt.PythonPolicy
DescendantInfo:
aclfilterli.LiFilter
DescendantInfo:
ixrqos.EgressRemarkPolicy
DescendantInfo:
diameter.DiameterPeerPolicy
DescendantInfo:
nat.AbstractNatPlcy
DescendantInfo:
aosqos.Policy
DescendantInfo:
aapolicy.AAPolicer
DescendantInfo:
aclfilter.IpFilter
DescendantInfo:
lte5g.SMFChargingProfile
DescendantInfo:
lte.TargetProfile
DescendantInfo:
lte.GroupLabel
DescendantInfo:
ixrqos.Dot1pFCMap
DescendantInfo:
lte5g.SMFServingAreaList
DescendantInfo:
squeue.Policy
DescendantInfo:
ltetwag.SlaacHostProfile
DescendantInfo:
aaa.RouteDownloadPolicy
DescendantInfo:
ltessg.AddressListProfile
DescendantInfo:
pppoe.PPPPolicyBase
DescendantInfo:
lte.AbsCallInsight
DescendantInfo:
nat.SvcChainEvpnPolicy
DescendantInfo:
aapolicy.AaStatTcaFilterCfg
DescendantInfo:
ltegw.QciListPolicyGroup
DescendantInfo:
aapolicy.AAUrlListPolicy
DescendantInfo:
aapolicy.HttpRedirect
DescendantInfo:
ixrqos.LspExpFCMap
DescendantInfo:
niegr.Policy
DescendantInfo:
securitypolicy.PolicerGroup
DescendantInfo:
aapolicy.AACertProfile
DescendantInfo:
securityqueue.SecurityQueuePolicy
DescendantInfo:
genericne.MvMultitermPolicy
DescendantInfo:
lte.TaiLaiListProfile
DescendantInfo:
nat.MapDomain
DescendantInfo:
nodelog.LogProfile
instanceFullName : distinguished/instance name of called object
List of output config info objects.

", "operationId": "rest_policy_PolicyDefinition_evaluatePolicy", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/evaluatePolicyResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/policy/PolicyDefinition/findGlobal/{instanceFullName}": { "get": { "tags": [ "samo_policy" ], "summary": "rest_policy_PolicyDefinition_findGlobal", "description": "Find the global policy for this local definition.

Intention : RETRIEVER
findGlobal:
instance-level [object finder] (retriever) API findGlobal
of class policy.PolicyDefinition
DescendantInfo:
rtr.SegmentRoutingMaintenancePolicy
DescendantInfo:
lte5g.PcfIdList
DescendantInfo:
mplstp.BFDTemplate
DescendantInfo:
ixrqos.VlanQosPolicy
DescendantInfo:
ressubscr.ShcvPolicy
DescendantInfo:
ltepolicyoptions.AssumePositiveActionProfile
DescendantInfo:
ixrqos.FcLspExpMap
DescendantInfo:
aclfilterli.LiIpv6Filter
DescendantInfo:
subscrexpmap.Policy
DescendantInfo:
sitesec.DCpuProtection
DescendantInfo:
rp.ASPathGroup
DescendantInfo:
diameter.DiameterAppPolicy
DescendantInfo:
aclfilter.AbstractFilterDefinition
DescendantInfo:
sasqos.Network
DescendantInfo:
lte.GtpProfile
DescendantInfo:
rp.PolicyStatement
DescendantInfo:
file.Policy
DescendantInfo:
lte.PfcpAPPeerList
DescendantInfo:
ethernetservice.UniProfile
DescendantInfo:
ltepolicyoptions.TrafficHashProfile
DescendantInfo:
sitesec.TlsCertificateProfile
DescendantInfo:
qosprofile.MlpppEgressQosProfile
DescendantInfo:
vs.AdvancedConfigPolicy
DescendantInfo:
sasqos.SchedulerPolicy
DescendantInfo:
aapolicy.AAUrlFilter
DescendantInfo:
genericne.MvQosPolicy
DescendantInfo:
sitesec.PkiCommonNameList
DescendantInfo:
ethernetservice.CustomL2Profile
DescendantInfo:
ltetwag.DiameterPeerGroupList
DescendantInfo:
postpolicermapping.PostPolicerMappingPolicy
DescendantInfo:
aengr.Policy
DescendantInfo:
sitesec.LocalUser
DescendantInfo:
rp.PrefixList
DescendantInfo:
lte5g.NfIdList
DescendantInfo:
rtr.RouteNextHopPolicyTemplate
DescendantInfo:
lte5g.QfiMappingProfile
DescendantInfo:
aapolicy.AbstractTransitPolicy
DescendantInfo:
aclfilter.AbstractExceptionFilter
DescendantInfo:
sasqos.DSCPClassification
DescendantInfo:
lte.WlanEmergencyProfile
DescendantInfo:
portscheduler.Policy
DescendantInfo:
vs.Policy
DescendantInfo:
lteggsn.GyAvpOptionProfile
DescendantInfo:
ixrqos.NetworkIngressPolicy
DescendantInfo:
ixrqos.FcDot1pMap
DescendantInfo:
sasqos.NQueue
DescendantInfo:
aapolicy.TetherDetection
DescendantInfo:
service.Y1564AcceptanceCriteriaProfile
DescendantInfo:
ltepolicyoptions.PolicyRule
DescendantInfo:
lte.Abspfcp
DescendantInfo:
mmepolicy.MMEEmergencyNumListPolicy
DescendantInfo:
sitesec.AOSSecurityPolicy
DescendantInfo:
lte.T6cProfile
DescendantInfo:
lte.EpdgGroupList
DescendantInfo:
slope.HsmdaSlopePolicy
DescendantInfo:
aapolicy.AaStatTcaFltrEntryCfg
DescendantInfo:
lte.SourceIpList
DescendantInfo:
sasqos.FcDscpMap
DescendantInfo:
lte.IPProfile
DescendantInfo:
ipsec.IPSecTransform
DescendantInfo:
subscrauth.Policy
DescendantInfo:
icmp.IcmpPingTemplate
DescendantInfo:
qosprefixlist.PrefixList
DescendantInfo:
sitesec.DoSProtection
DescendantInfo:
lte.DccaProfile
DescendantInfo:
filterprefixlist.PortList
DescendantInfo:
rtr.AdminTag
DescendantInfo:
aapolicy.AASessionFilter
DescendantInfo:
hsqos.HsSchedulerPolicy
DescendantInfo:
ltepolicyoptions.ServiceClassIndicator
DescendantInfo:
sitesec.UserProfile
DescendantInfo:
ltepolicyoptions.SruList
DescendantInfo:
lte.AllUesCallTrace
DescendantInfo:
sitesec.TlsServerCipherList
DescendantInfo:
ltegw.TariffChangeListProfilePolicyGroup
DescendantInfo:
aingr.Policy
DescendantInfo:
aapolicy.AbstractHttpRedirect
DescendantInfo:
ltetwag.StaProfile
DescendantInfo:
redirectfilter.RedirectPolicyBinding
DescendantInfo:
sasqos.FCMeterMap
DescendantInfo:
vrrp.Policy
DescendantInfo:
lte5g.SliceList
DescendantInfo:
sasqos.SlopePolicy
DescendantInfo:
todsuite.Policy
DescendantInfo:
diameter.DiameterPolicy
DescendantInfo:
sasqos.SystemResourceProfilePolicy
DescendantInfo:
genericne.MvAbstractPolicy
DescendantInfo:
aapolicy.TransitPrefixPolicy
DescendantInfo:
sitesec.EstAuthProfile
DescendantInfo:
hwaggshapersched.HwAggShaperSchedulerPolicy
DescendantInfo:
aossas.CPETestHeadGroupProfile
DescendantInfo:
lte5g.PrioAddrList
DescendantInfo:
rp.GlobalVariables
DescendantInfo:
lte5g.SliceInstanceList
DescendantInfo:
lte.DedicatedBearerIdleTimeOutProfile
DescendantInfo:
security.KeyChain
DescendantInfo:
lte.PcmdProfile
DescendantInfo:
lteepdg.SwmAvpOptionProfile
DescendantInfo:
mpls.SharedRiskLinkGroup
DescendantInfo:
sitesec.TlsClientCipherList
DescendantInfo:
lte.AmfIdList
DescendantInfo:
ltehomeagent.MobileIpv4Profile
DescendantInfo:
file.LogDefinition
DescendantInfo:
macsec.MacPolicy
DescendantInfo:
securitypolicy.Policy
DescendantInfo:
ltepolicyoptions.AbsPolicyOptionProfile
DescendantInfo:
aclfilter.IpExceptionFilter
DescendantInfo:
sasqos.Dot1pClassification
DescendantInfo:
ipsec.IkePolicy
DescendantInfo:
mpr.QueueMapPolicy
DescendantInfo:
aapolicy.ApplicationAssurancePolicyDefinition
DescendantInfo:
service.VplsSapTemplate
DescendantInfo:
ltegw.AbsListPolicyGroup
DescendantInfo:
lte.SDProfile
DescendantInfo:
aapolicy.SctpFilter
DescendantInfo:
lte.PlmnListPolicyGroup
DescendantInfo:
mpr.GneRadiusQosPolicy
DescendantInfo:
l2fwd.MrpPolicy
DescendantInfo:
sasqos.AccessIngress
DescendantInfo:
crdtctrl.CrdtCtrlPolicy
DescendantInfo:
lte.PortList
DescendantInfo:
lte5g.SbaNudmSdmProf
DescendantInfo:
rp.Damping
DescendantInfo:
aapolicy.TransitIpPolicy
DescendantInfo:
lte.SwmErrorMappingProfile
DescendantInfo:
firewall.Zone
DescendantInfo:
rp.ASPath
DescendantInfo:
ltepolicyoptions.UsgMonInfo
DescendantInfo:
sitesec.RadiusPolicy
DescendantInfo:
optical.AlarmProfile
DescendantInfo:
ipsec.CertProfile
DescendantInfo:
crdtctrl.CtgryMapPolicy
DescendantInfo:
lte.DiameterErrorMappingProfile
DescendantInfo:
ressubscr.HostTrackingPolicy
DescendantInfo:
sasqos.MplsLspExpClassification
DescendantInfo:
ressubscr.IgmpPolicy
DescendantInfo:
lte.AccountingPriorityProfile
DescendantInfo:
rp.RouteNextHopPolicyTemplate
DescendantInfo:
ressubscr.PimPolicy
DescendantInfo:
ltepolicyoptions.DynamicToInternalRuleMap
DescendantInfo:
netca.CardStatsTCAProfile
DescendantInfo:
subscrprofile.Policy
DescendantInfo:
aapolicy.HttpEnrich
DescendantInfo:
ltepolicyoptions.GxAvpOptionProfile
DescendantInfo:
sitesec.LdapPolicy
DescendantInfo:
aclfilter.FilterDefinition
DescendantInfo:
fpresource.FPResourcePolicy
DescendantInfo:
securitypolicy.Zone
DescendantInfo:
ltegw.SCTPProfile
DescendantInfo:
sasqos.QueueMgmtPolicy
DescendantInfo:
sasqos.FcLspExpMap
DescendantInfo:
ltepolicyoptions.TriggerRuleUnitProfile
DescendantInfo:
ressubscr.HttpRedirectPolicy
DescendantInfo:
service.Y1564FrameMixProfile
DescendantInfo:
ltepolicyoptions.PolicyRuleUnit
DescendantInfo:
firewall.MgmtAccessFirewall
DescendantInfo:
ltehomeagent.AbsHomeAgentProfile
DescendantInfo:
firewall.RuleSet
DescendantInfo:
netca.StatsTCAProfile
DescendantInfo:
genericne.MvPolicerPolicy
DescendantInfo:
rp.AbstractSrlgGroupPolicy
DescendantInfo:
lte5g.SbaNudmUecmProf
DescendantInfo:
sasqos.IngressCoSClassification
DescendantInfo:
rp.SrlgGroupPolicy
DescendantInfo:
aaa.RadiusScriptPolicy
DescendantInfo:
nat.SvcChainVasFilterPolicy
DescendantInfo:
aapolicy.DnsIpCache
DescendantInfo:
sasqos.NetworkIngress
DescendantInfo:
ltepolicyoptions.ChargingRuleUnit
DescendantInfo:
aapolicy.AAFlowCfgPolicy
DescendantInfo:
lte5g.HTTP2Profile
DescendantInfo:
sasqos.PortAccessIngress
DescendantInfo:
ltegw.PcscfGroupProfile
DescendantInfo:
multicast.IngrPathMgmtInfoPolicy
DescendantInfo:
sitesec.ManagementAccessFilter
DescendantInfo:
ltetwag.SwwTunnelProfile
DescendantInfo:
ethernetoam.MaintenanceDomain
DescendantInfo:
ipsec.RadiusAuthenticationPolicy
DescendantInfo:
aapolicy.AaStatTcaPolicerCfg
DescendantInfo:
ipsec.TrafficSelectorList
DescendantInfo:
atmpolicy.TrafficDescriptor
DescendantInfo:
sasqos.PortAccessEgress
DescendantInfo:
aapolicy.MpTcpProxy
DescendantInfo:
connprof.VlanConnProfPolicy
DescendantInfo:
opticalacl.IpPattern
DescendantInfo:
policing.PolicerControl
DescendantInfo:
sw.SoftwareRepositoryPolicy
DescendantInfo:
svt.TunnelAdminGroup
DescendantInfo:
optical.OcsAlarmProfile
DescendantInfo:
aclfilterli.BlockReservation
DescendantInfo:
genericne.MvMatchingRulePolicy
DescendantInfo:
mmepolicy.WMMInterfaceProfile
DescendantInfo:
calltrace.TraceProfile
DescendantInfo:
ltepolicyoptions.DhcpServerGroupProfile
DescendantInfo:
service.AbstractSapTemplate
DescendantInfo:
aapolicy.AaTcpValidationTca
DescendantInfo:
ltepmip.S6bAvpOptionProfile
DescendantInfo:
redirectfilter.RedirectPolicy
DescendantInfo:
service.EpipeSapTemplate
DescendantInfo:
lte.AbsGtpProfile
DescendantInfo:
ltegw.AvpOptionProfile
DescendantInfo:
nodelog.FirewallLog
DescendantInfo:
multicast.McastCacInterfacePolicy
DescendantInfo:
nodelog.FilterLog
DescendantInfo:
ixrqos.FcDSCPMap
DescendantInfo:
lte5g.NpcfProfile
DescendantInfo:
ltegw.AbsNodeSelPolicyGroup
DescendantInfo:
sitesec.PasswordPolicy
DescendantInfo:
nat.NatClassifier
DescendantInfo:
aaa.L2tpRadiusAccountingPolicy
DescendantInfo:
dynsvc.DynSvcPolicy
DescendantInfo:
ltepolicyoptions.UsgMonAction
DescendantInfo:
sitesec.TacacsPolicy
DescendantInfo:
ltepolicyoptions.StatsRuleUnit
DescendantInfo:
rp.Community
DescendantInfo:
securitypolicy.Bypass
DescendantInfo:
lte.DnsErrMapProfile
DescendantInfo:
nat.FirewallPolicy
DescendantInfo:
ipsec.IPSecClientDB
DescendantInfo:
lte.QciPolicy
DescendantInfo:
filterprefixlist.PrefixList
DescendantInfo:
netca.OCSStatsTCAProfile
DescendantInfo:
rmon.RemoteNetworkMonitoring
DescendantInfo:
aapolicy.AaFilterAbstract
DescendantInfo:
ltepmip.Pmipv6Profile
DescendantInfo:
lte5g.NrfProfile
DescendantInfo:
pppoe.PPPPolicy
DescendantInfo:
qgroup.EgressQGroupPolicy
DescendantInfo:
aaa.NatRadiusAccountingPolicy
DescendantInfo:
ressubscr.IpoePolicy
DescendantInfo:
securitypolicy.SecurityPolicyDefinition
DescendantInfo:
sitesec.RemoteAuthPolicy
DescendantInfo:
aosqos.QoSNetworkGroups
DescendantInfo:
aapolicy.GtpFilter
DescendantInfo:
lte.FqdnGroupProfile
DescendantInfo:
aclfilter.VlanFilter
DescendantInfo:
lte.DiameterPeerProfile
DescendantInfo:
mpr.RadioQOS
DescendantInfo:
portscheduler.HsmdaSchedulerPolicy
DescendantInfo:
lte5g.N1Profile
DescendantInfo:
lte.PfcpProfile
DescendantInfo:
securitypolicy.HostGroup
DescendantInfo:
ressubscr.RipPolicy
DescendantInfo:
aapolicy.AccessNetworkLocation
DescendantInfo:
lteepdg.IPSecProfile
DescendantInfo:
sitesec.TlsTrustAnchorProfile
DescendantInfo:
connprof.PssConnProfPolicy
DescendantInfo:
lte.DiameterRateLimProfile
DescendantInfo:
ltetwag.TwagChargingProfile
DescendantInfo:
ipsec.IPSecStaticSA
DescendantInfo:
ressubscr.MldPolicy
DescendantInfo:
nodelog.AbstractLog
DescendantInfo:
slaprofile.Policy
DescendantInfo:
wlangw.DsmIpFilterPolicy
DescendantInfo:
aapolicy.AaSubCongDetect
DescendantInfo:
opticalacl.OcsIpFilter
DescendantInfo:
lte.DnsProfile
DescendantInfo:
ipfix.IPFIXExportPolicy
DescendantInfo:
ixrqos.DSCPFCMap
DescendantInfo:
slope.Policy
DescendantInfo:
mpls.Policy
DescendantInfo:
rp.AbstractAdminGroupPolicy
DescendantInfo:
portscheduler.HsmdaWrrPolicy
DescendantInfo:
mmepolicy.MMEEmergencyNumListTblPolicy
DescendantInfo:
lteepdg.EpdgChargingProfile
DescendantInfo:
lte.ErrorMappingProfile
DescendantInfo:
lte.FqdnList
DescendantInfo:
lte.GxProfile
DescendantInfo:
lte.CloudDBProfile
DescendantInfo:
sasqos.Remark
DescendantInfo:
aclfilter.DhcpFilter
DescendantInfo:
slope.NamedPool
DescendantInfo:
qosprofile.McfrEgressQosProfile
DescendantInfo:
ipsec.IkeTransform
DescendantInfo:
lte5g.Oauth2Profile
DescendantInfo:
sitesec.TlsClientProfile
DescendantInfo:
aapolicy.AaStatTcaAbstract
DescendantInfo:
firewall.HostGroup
DescendantInfo:
ressubscr.BgpPeeringPolicy
DescendantInfo:
service.SvcActTestHeadAcceptanceCriteriaTemplate
DescendantInfo:
nodelog.SysLogTarget
DescendantInfo:
aaa.AcctOnOffGroup
DescendantInfo:
lte.UeCallTrace
DescendantInfo:
aclfilter.MacFilter
DescendantInfo:
sas.StreamingDelayTemplate
DescendantInfo:
lte.DefBearerQoSProfile
DescendantInfo:
rp.PolicyObjectBase
DescendantInfo:
service.Y1564TestHeadProfile
DescendantInfo:
igmp.SSMTranslatePolicy
DescendantInfo:
radiusaccounting.Policy
DescendantInfo:
aapolicy.AaTcpOpt
DescendantInfo:
service.SvcActTestHeadFrameSizeTemplate
DescendantInfo:
ipsec.TrustAnchorProfile
DescendantInfo:
ixrqos.PortQosPolicy
DescendantInfo:
nodelog.SecurityLog
DescendantInfo:
ixrqos.IngressClassification
DescendantInfo:
aapolicy.Policy
DescendantInfo:
ipsec.RadiusAccountingPolicy
DescendantInfo:
qosprofile.McfrIngressQosProfile
DescendantInfo:
ressubscr.HostLockoutPolicy
DescendantInfo:
ressubscr.SubMcastCacPolicy
DescendantInfo:
slope.HsmdaPoolPolicy
DescendantInfo:
opticalacl.IpFilter
DescendantInfo:
ixrqos.QueueMgmtPolicy
DescendantInfo:
policy.PSGGenericPolicy
DescendantInfo:
mmepolicy.MMESCTPProfile
DescendantInfo:
aapolicy.AARadiusAccountingPolicy
DescendantInfo:
lte.SgwChargingProfile
DescendantInfo:
multicast.EgressMcastGroup
DescendantInfo:
aapolicy.HttpErrorRedirect
DescendantInfo:
multicast.McastReportDestination
DescendantInfo:
firewall.CPMFirewall
DescendantInfo:
rtr.AbstractAdminGroupPolicy
DescendantInfo:
lte.TrustedPeerListPolicy
DescendantInfo:
lteli.DFPeer
DescendantInfo:
aosqos.QoSMacGroups
DescendantInfo:
ltepolicyoptions.ApnRateControl
DescendantInfo:
hsqos.HsAttachmentPolicy
DescendantInfo:
subscrident.Policy
DescendantInfo:
tod.Policy
DescendantInfo:
lteggsn.CdrAvpOptionProfile
DescendantInfo:
lte.OIOverList
DescendantInfo:
aapolicy.AAGroupPolicy
DescendantInfo:
lte.MMEGroupProfile
DescendantInfo:
lteradius.RadiusGroupProfile
DescendantInfo:
lteli.InterceptionTarget
DescendantInfo:
mmepolicy.MMEProfile
DescendantInfo:
lte.IkeRedList
DescendantInfo:
ltehomeagent.DNSRedirectServer
DescendantInfo:
qosprofile.MlpppIngressQosProfile
DescendantInfo:
dctr.PortProfile
DescendantInfo:
multicast.PackagePolicy
DescendantInfo:
lte.PgwSelectionCandidateList
DescendantInfo:
file.FileTransmissionProfile
DescendantInfo:
genericne.MvFilterPolicy
DescendantInfo:
mmepolicy.MMEGTPProfile
DescendantInfo:
genericne.MvForwardingClassPolicy
DescendantInfo:
ltetwag.DhcpServerProfile
DescendantInfo:
aclfilter.Ipv6ExceptionFilter
DescendantInfo:
aclfilter.DhcpV6Filter
DescendantInfo:
lteradius.RadiusProfile
DescendantInfo:
sitesec.TlsServerProfile
DescendantInfo:
nqueue.Policy
DescendantInfo:
sasqos.AccessEgress
DescendantInfo:
wlangw.DsmTrafficPolicer
DescendantInfo:
lte.UpPeerList
DescendantInfo:
netca.AbstractStatsTCAProfile
DescendantInfo:
sasqos.MpBwPolicy
DescendantInfo:
nat.NatPolicy
DescendantInfo:
ltepolicyoptions.QoSRuleUnit
DescendantInfo:
sas.BinGroup
DescendantInfo:
aapolicy.HttpNotif
DescendantInfo:
ethernetservice.SapProfile
DescendantInfo:
sitesec.CpmIpFilter
DescendantInfo:
mmepolicy.WMMSVCAgreementProfile
DescendantInfo:
connprof.ConnProfPolicy
DescendantInfo:
pae802_1x.RadiusServerPolicy
DescendantInfo:
aapolicy.AaStatTcaCfg
DescendantInfo:
sasqos.PortScheduler
DescendantInfo:
lte.IdiRealmList
DescendantInfo:
sitesec.CertificateAuthProfile
DescendantInfo:
qgroup.RedirectList
DescendantInfo:
ltepolicyoptions.PolicyRuleBase
DescendantInfo:
genericne.MVGenericPolicy
DescendantInfo:
rtr.AdminGroupPolicy
DescendantInfo:
aaa.RadiusServerPolicy
DescendantInfo:
securitypolicy.Profile
DescendantInfo:
lte.PpiMappingProfile
DescendantInfo:
rtr.SharedRiskLinkGroup
DescendantInfo:
aapolicy.AAPortList
DescendantInfo:
lte.AgwChargingProfile
DescendantInfo:
mpls.LspTemplateMvpn
DescendantInfo:
aossas.CPETestHeadProfile
DescendantInfo:
ltegw.ApnListPolicyGroup
DescendantInfo:
ancp.Policy
DescendantInfo:
lte.CCFHProfile
DescendantInfo:
aclfilter.AggregateFilter
DescendantInfo:
lte.IpAddressList
DescendantInfo:
dctr.Profile
DescendantInfo:
hsqos.HsPortPoolPolicy
DescendantInfo:
hsqos.HsPoolPolicy
DescendantInfo:
ltessg.TdfChargingProfile
DescendantInfo:
aaa.IsaRadiusPolicy
DescendantInfo:
ltepolicyoptions.TrafficRedirectProfile
DescendantInfo:
nat.UpnpPolicy
DescendantInfo:
pdnprofile.PacketDataNetworkProfilePolicy
DescendantInfo:
gtp.ApnPolicy
DescendantInfo:
rtr.AbstractSharedRiskLinkGroup
DescendantInfo:
aosqos.QoSCondition
DescendantInfo:
ltetwag.SwwRadiusProfile
DescendantInfo:
svt.PwTemplate
DescendantInfo:
filterprefixlist.ProtocolList
DescendantInfo:
rp.AdminGroupPolicy
DescendantInfo:
rtr.AdminTagPolicy
DescendantInfo:
ltehomeagent.FAHAPeerList
DescendantInfo:
mpls.SRLGStaticConfig
DescendantInfo:
accounting.Policy
DescendantInfo:
lte.PfcpTranslateProfile
DescendantInfo:
aapolicy.AaTcpValidation
DescendantInfo:
lte5g.CHFProfile
DescendantInfo:
opticalacl.AbstractIpFilter
DescendantInfo:
msappolicy.Policy
DescendantInfo:
wlangw.MgwProfile
DescendantInfo:
lte5g.AllowedNFDomainList
DescendantInfo:
mmepolicy.WMMPfmJobEntry
DescendantInfo:
aclfilterli.LiMacFilter
DescendantInfo:
securitypolicy.AppGroup
DescendantInfo:
aapolicy.AaCflowdGroupPolicy
DescendantInfo:
lte.PeerListPolicy
DescendantInfo:
fabricqos.FabricProfile
DescendantInfo:
firewall.FwPolicyDefinition
DescendantInfo:
multicast.McastCacPolicy
DescendantInfo:
rp.PolicyAccountingTemplate
DescendantInfo:
ipsec.AbstractTrustAnchorProfile
DescendantInfo:
aclfilter.GreTunnelTemplate
DescendantInfo:
lte.DiameterProfile
DescendantInfo:
lte.PgwChargingProfile
DescendantInfo:
sasqos.EgressRemarking
DescendantInfo:
aclfilterli.LiIpFilter
DescendantInfo:
ltepolicyoptions.UrrProfile
DescendantInfo:
service.Y1564PayloadProfile
DescendantInfo:
lte5g.UdmIdList
DescendantInfo:
sas.LinkMeasurementTemplate
DescendantInfo:
nat.NatPrefixList
DescendantInfo:
aaa.IsaRadiusPolicyBase
DescendantInfo:
lteradius.AbsRadiusProfile
DescendantInfo:
equipment.PortPolicy
DescendantInfo:
unpprofile.UNPProfile
DescendantInfo:
rtr.ReassemblyProfilePolicy
DescendantInfo:
lte.GtpPrimeServerGroupProfile
DescendantInfo:
lte.Profile
DescendantInfo:
layer2.L2Profile
DescendantInfo:
qosportlist.PortList
DescendantInfo:
lte.ClientProfile
DescendantInfo:
lte.OverloadControlProfile
DescendantInfo:
ressubscr.BrgProfile
DescendantInfo:
firewall.ServiceGroup
DescendantInfo:
vs.ServiceTypeDefinition
DescendantInfo:
qgroup.IngressQGroupPolicy
DescendantInfo:
lte.SubscriberMappingProfile
DescendantInfo:
lte5g.SMFAttributesProfile
DescendantInfo:
ltegw.UMTSQoSPolicy
DescendantInfo:
ltepolicyoptions.ActionRuleUnitProfile
DescendantInfo:
lte.S2bErrorMappingProfile
DescendantInfo:
dynsvc.DynSvcLocalAuthDb
DescendantInfo:
lte5g.EmerProfile
DescendantInfo:
aosqos.List
DescendantInfo:
shaperqos.ShaperPolicy
DescendantInfo:
sasqos.FcDot1pMap
DescendantInfo:
ltessg.SteeringProfile
DescendantInfo:
srpythonmgmt.PythonScript
DescendantInfo:
sasqos.MplsLspExpMap
DescendantInfo:
lte.CreditPoolProfile
DescendantInfo:
ltegw.UDPTunnelGroupProfile
DescendantInfo:
multicast.IngrPathMgmtBwPolicy
DescendantInfo:
aclfilter.Ipv6Filter
DescendantInfo:
aapolicy.AAPrefixListPolicy
DescendantInfo:
ipsec.IPSecTunnelTemplate
DescendantInfo:
nat.PcpPolicy
DescendantInfo:
mmepolicy.WMMPfmMeasGroupName
DescendantInfo:
aosqos.QoSAction
DescendantInfo:
lte5g.EventTriggerFBCProfile
DescendantInfo:
srpythonmgmt.PythonPolicy
DescendantInfo:
aclfilterli.LiFilter
DescendantInfo:
ixrqos.EgressRemarkPolicy
DescendantInfo:
diameter.DiameterPeerPolicy
DescendantInfo:
nat.AbstractNatPlcy
DescendantInfo:
aosqos.Policy
DescendantInfo:
aapolicy.AAPolicer
DescendantInfo:
aclfilter.IpFilter
DescendantInfo:
lte5g.SMFChargingProfile
DescendantInfo:
lte.TargetProfile
DescendantInfo:
lte.GroupLabel
DescendantInfo:
ixrqos.Dot1pFCMap
DescendantInfo:
lte5g.SMFServingAreaList
DescendantInfo:
squeue.Policy
DescendantInfo:
ltetwag.SlaacHostProfile
DescendantInfo:
aaa.RouteDownloadPolicy
DescendantInfo:
ltessg.AddressListProfile
DescendantInfo:
pppoe.PPPPolicyBase
DescendantInfo:
lte.AbsCallInsight
DescendantInfo:
nat.SvcChainEvpnPolicy
DescendantInfo:
aapolicy.AaStatTcaFilterCfg
DescendantInfo:
ltegw.QciListPolicyGroup
DescendantInfo:
aapolicy.AAUrlListPolicy
DescendantInfo:
aapolicy.HttpRedirect
DescendantInfo:
ixrqos.LspExpFCMap
DescendantInfo:
niegr.Policy
DescendantInfo:
securitypolicy.PolicerGroup
DescendantInfo:
aapolicy.AACertProfile
DescendantInfo:
securityqueue.SecurityQueuePolicy
DescendantInfo:
genericne.MvMultitermPolicy
DescendantInfo:
lte.TaiLaiListProfile
DescendantInfo:
nat.MapDomain
DescendantInfo:
nodelog.LogProfile
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_policy_PolicyDefinition_findGlobal", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findGlobalResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/policy/PolicyDefinition/findLocal/{instanceFullName}": { "get": { "tags": [ "samo_policy" ], "summary": "rest_policy_PolicyDefinition_findLocal", "description": "Find all the local definitions under this global policy.

Intention : RETRIEVER
findLocal:
instance-level [object finder] (retriever) API findLocal
of class policy.PolicyDefinition
DescendantInfo:
rtr.SegmentRoutingMaintenancePolicy
DescendantInfo:
lte5g.PcfIdList
DescendantInfo:
mplstp.BFDTemplate
DescendantInfo:
ixrqos.VlanQosPolicy
DescendantInfo:
ressubscr.ShcvPolicy
DescendantInfo:
ltepolicyoptions.AssumePositiveActionProfile
DescendantInfo:
ixrqos.FcLspExpMap
DescendantInfo:
aclfilterli.LiIpv6Filter
DescendantInfo:
subscrexpmap.Policy
DescendantInfo:
sitesec.DCpuProtection
DescendantInfo:
rp.ASPathGroup
DescendantInfo:
diameter.DiameterAppPolicy
DescendantInfo:
aclfilter.AbstractFilterDefinition
DescendantInfo:
sasqos.Network
DescendantInfo:
lte.GtpProfile
DescendantInfo:
rp.PolicyStatement
DescendantInfo:
file.Policy
DescendantInfo:
lte.PfcpAPPeerList
DescendantInfo:
ethernetservice.UniProfile
DescendantInfo:
ltepolicyoptions.TrafficHashProfile
DescendantInfo:
sitesec.TlsCertificateProfile
DescendantInfo:
qosprofile.MlpppEgressQosProfile
DescendantInfo:
vs.AdvancedConfigPolicy
DescendantInfo:
sasqos.SchedulerPolicy
DescendantInfo:
aapolicy.AAUrlFilter
DescendantInfo:
genericne.MvQosPolicy
DescendantInfo:
sitesec.PkiCommonNameList
DescendantInfo:
ethernetservice.CustomL2Profile
DescendantInfo:
ltetwag.DiameterPeerGroupList
DescendantInfo:
postpolicermapping.PostPolicerMappingPolicy
DescendantInfo:
aengr.Policy
DescendantInfo:
sitesec.LocalUser
DescendantInfo:
rp.PrefixList
DescendantInfo:
lte5g.NfIdList
DescendantInfo:
rtr.RouteNextHopPolicyTemplate
DescendantInfo:
lte5g.QfiMappingProfile
DescendantInfo:
aapolicy.AbstractTransitPolicy
DescendantInfo:
aclfilter.AbstractExceptionFilter
DescendantInfo:
sasqos.DSCPClassification
DescendantInfo:
lte.WlanEmergencyProfile
DescendantInfo:
portscheduler.Policy
DescendantInfo:
vs.Policy
DescendantInfo:
lteggsn.GyAvpOptionProfile
DescendantInfo:
ixrqos.NetworkIngressPolicy
DescendantInfo:
ixrqos.FcDot1pMap
DescendantInfo:
sasqos.NQueue
DescendantInfo:
aapolicy.TetherDetection
DescendantInfo:
service.Y1564AcceptanceCriteriaProfile
DescendantInfo:
ltepolicyoptions.PolicyRule
DescendantInfo:
lte.Abspfcp
DescendantInfo:
mmepolicy.MMEEmergencyNumListPolicy
DescendantInfo:
sitesec.AOSSecurityPolicy
DescendantInfo:
lte.T6cProfile
DescendantInfo:
lte.EpdgGroupList
DescendantInfo:
slope.HsmdaSlopePolicy
DescendantInfo:
aapolicy.AaStatTcaFltrEntryCfg
DescendantInfo:
lte.SourceIpList
DescendantInfo:
sasqos.FcDscpMap
DescendantInfo:
lte.IPProfile
DescendantInfo:
ipsec.IPSecTransform
DescendantInfo:
subscrauth.Policy
DescendantInfo:
icmp.IcmpPingTemplate
DescendantInfo:
qosprefixlist.PrefixList
DescendantInfo:
sitesec.DoSProtection
DescendantInfo:
lte.DccaProfile
DescendantInfo:
filterprefixlist.PortList
DescendantInfo:
rtr.AdminTag
DescendantInfo:
aapolicy.AASessionFilter
DescendantInfo:
hsqos.HsSchedulerPolicy
DescendantInfo:
ltepolicyoptions.ServiceClassIndicator
DescendantInfo:
sitesec.UserProfile
DescendantInfo:
ltepolicyoptions.SruList
DescendantInfo:
lte.AllUesCallTrace
DescendantInfo:
sitesec.TlsServerCipherList
DescendantInfo:
ltegw.TariffChangeListProfilePolicyGroup
DescendantInfo:
aingr.Policy
DescendantInfo:
aapolicy.AbstractHttpRedirect
DescendantInfo:
ltetwag.StaProfile
DescendantInfo:
redirectfilter.RedirectPolicyBinding
DescendantInfo:
sasqos.FCMeterMap
DescendantInfo:
vrrp.Policy
DescendantInfo:
lte5g.SliceList
DescendantInfo:
sasqos.SlopePolicy
DescendantInfo:
todsuite.Policy
DescendantInfo:
diameter.DiameterPolicy
DescendantInfo:
sasqos.SystemResourceProfilePolicy
DescendantInfo:
genericne.MvAbstractPolicy
DescendantInfo:
aapolicy.TransitPrefixPolicy
DescendantInfo:
sitesec.EstAuthProfile
DescendantInfo:
hwaggshapersched.HwAggShaperSchedulerPolicy
DescendantInfo:
aossas.CPETestHeadGroupProfile
DescendantInfo:
lte5g.PrioAddrList
DescendantInfo:
rp.GlobalVariables
DescendantInfo:
lte5g.SliceInstanceList
DescendantInfo:
lte.DedicatedBearerIdleTimeOutProfile
DescendantInfo:
security.KeyChain
DescendantInfo:
lte.PcmdProfile
DescendantInfo:
lteepdg.SwmAvpOptionProfile
DescendantInfo:
mpls.SharedRiskLinkGroup
DescendantInfo:
sitesec.TlsClientCipherList
DescendantInfo:
lte.AmfIdList
DescendantInfo:
ltehomeagent.MobileIpv4Profile
DescendantInfo:
file.LogDefinition
DescendantInfo:
macsec.MacPolicy
DescendantInfo:
securitypolicy.Policy
DescendantInfo:
ltepolicyoptions.AbsPolicyOptionProfile
DescendantInfo:
aclfilter.IpExceptionFilter
DescendantInfo:
sasqos.Dot1pClassification
DescendantInfo:
ipsec.IkePolicy
DescendantInfo:
mpr.QueueMapPolicy
DescendantInfo:
aapolicy.ApplicationAssurancePolicyDefinition
DescendantInfo:
service.VplsSapTemplate
DescendantInfo:
ltegw.AbsListPolicyGroup
DescendantInfo:
lte.SDProfile
DescendantInfo:
aapolicy.SctpFilter
DescendantInfo:
lte.PlmnListPolicyGroup
DescendantInfo:
mpr.GneRadiusQosPolicy
DescendantInfo:
l2fwd.MrpPolicy
DescendantInfo:
sasqos.AccessIngress
DescendantInfo:
crdtctrl.CrdtCtrlPolicy
DescendantInfo:
lte.PortList
DescendantInfo:
lte5g.SbaNudmSdmProf
DescendantInfo:
rp.Damping
DescendantInfo:
aapolicy.TransitIpPolicy
DescendantInfo:
lte.SwmErrorMappingProfile
DescendantInfo:
firewall.Zone
DescendantInfo:
rp.ASPath
DescendantInfo:
ltepolicyoptions.UsgMonInfo
DescendantInfo:
sitesec.RadiusPolicy
DescendantInfo:
optical.AlarmProfile
DescendantInfo:
ipsec.CertProfile
DescendantInfo:
crdtctrl.CtgryMapPolicy
DescendantInfo:
lte.DiameterErrorMappingProfile
DescendantInfo:
ressubscr.HostTrackingPolicy
DescendantInfo:
sasqos.MplsLspExpClassification
DescendantInfo:
ressubscr.IgmpPolicy
DescendantInfo:
lte.AccountingPriorityProfile
DescendantInfo:
rp.RouteNextHopPolicyTemplate
DescendantInfo:
ressubscr.PimPolicy
DescendantInfo:
ltepolicyoptions.DynamicToInternalRuleMap
DescendantInfo:
netca.CardStatsTCAProfile
DescendantInfo:
subscrprofile.Policy
DescendantInfo:
aapolicy.HttpEnrich
DescendantInfo:
ltepolicyoptions.GxAvpOptionProfile
DescendantInfo:
sitesec.LdapPolicy
DescendantInfo:
aclfilter.FilterDefinition
DescendantInfo:
fpresource.FPResourcePolicy
DescendantInfo:
securitypolicy.Zone
DescendantInfo:
ltegw.SCTPProfile
DescendantInfo:
sasqos.QueueMgmtPolicy
DescendantInfo:
sasqos.FcLspExpMap
DescendantInfo:
ltepolicyoptions.TriggerRuleUnitProfile
DescendantInfo:
ressubscr.HttpRedirectPolicy
DescendantInfo:
service.Y1564FrameMixProfile
DescendantInfo:
ltepolicyoptions.PolicyRuleUnit
DescendantInfo:
firewall.MgmtAccessFirewall
DescendantInfo:
ltehomeagent.AbsHomeAgentProfile
DescendantInfo:
firewall.RuleSet
DescendantInfo:
netca.StatsTCAProfile
DescendantInfo:
genericne.MvPolicerPolicy
DescendantInfo:
rp.AbstractSrlgGroupPolicy
DescendantInfo:
lte5g.SbaNudmUecmProf
DescendantInfo:
sasqos.IngressCoSClassification
DescendantInfo:
rp.SrlgGroupPolicy
DescendantInfo:
aaa.RadiusScriptPolicy
DescendantInfo:
nat.SvcChainVasFilterPolicy
DescendantInfo:
aapolicy.DnsIpCache
DescendantInfo:
sasqos.NetworkIngress
DescendantInfo:
ltepolicyoptions.ChargingRuleUnit
DescendantInfo:
aapolicy.AAFlowCfgPolicy
DescendantInfo:
lte5g.HTTP2Profile
DescendantInfo:
sasqos.PortAccessIngress
DescendantInfo:
ltegw.PcscfGroupProfile
DescendantInfo:
multicast.IngrPathMgmtInfoPolicy
DescendantInfo:
sitesec.ManagementAccessFilter
DescendantInfo:
ltetwag.SwwTunnelProfile
DescendantInfo:
ethernetoam.MaintenanceDomain
DescendantInfo:
ipsec.RadiusAuthenticationPolicy
DescendantInfo:
aapolicy.AaStatTcaPolicerCfg
DescendantInfo:
ipsec.TrafficSelectorList
DescendantInfo:
atmpolicy.TrafficDescriptor
DescendantInfo:
sasqos.PortAccessEgress
DescendantInfo:
aapolicy.MpTcpProxy
DescendantInfo:
connprof.VlanConnProfPolicy
DescendantInfo:
opticalacl.IpPattern
DescendantInfo:
policing.PolicerControl
DescendantInfo:
sw.SoftwareRepositoryPolicy
DescendantInfo:
svt.TunnelAdminGroup
DescendantInfo:
optical.OcsAlarmProfile
DescendantInfo:
aclfilterli.BlockReservation
DescendantInfo:
genericne.MvMatchingRulePolicy
DescendantInfo:
mmepolicy.WMMInterfaceProfile
DescendantInfo:
calltrace.TraceProfile
DescendantInfo:
ltepolicyoptions.DhcpServerGroupProfile
DescendantInfo:
service.AbstractSapTemplate
DescendantInfo:
aapolicy.AaTcpValidationTca
DescendantInfo:
ltepmip.S6bAvpOptionProfile
DescendantInfo:
redirectfilter.RedirectPolicy
DescendantInfo:
service.EpipeSapTemplate
DescendantInfo:
lte.AbsGtpProfile
DescendantInfo:
ltegw.AvpOptionProfile
DescendantInfo:
nodelog.FirewallLog
DescendantInfo:
multicast.McastCacInterfacePolicy
DescendantInfo:
nodelog.FilterLog
DescendantInfo:
ixrqos.FcDSCPMap
DescendantInfo:
lte5g.NpcfProfile
DescendantInfo:
ltegw.AbsNodeSelPolicyGroup
DescendantInfo:
sitesec.PasswordPolicy
DescendantInfo:
nat.NatClassifier
DescendantInfo:
aaa.L2tpRadiusAccountingPolicy
DescendantInfo:
dynsvc.DynSvcPolicy
DescendantInfo:
ltepolicyoptions.UsgMonAction
DescendantInfo:
sitesec.TacacsPolicy
DescendantInfo:
ltepolicyoptions.StatsRuleUnit
DescendantInfo:
rp.Community
DescendantInfo:
securitypolicy.Bypass
DescendantInfo:
lte.DnsErrMapProfile
DescendantInfo:
nat.FirewallPolicy
DescendantInfo:
ipsec.IPSecClientDB
DescendantInfo:
lte.QciPolicy
DescendantInfo:
filterprefixlist.PrefixList
DescendantInfo:
netca.OCSStatsTCAProfile
DescendantInfo:
rmon.RemoteNetworkMonitoring
DescendantInfo:
aapolicy.AaFilterAbstract
DescendantInfo:
ltepmip.Pmipv6Profile
DescendantInfo:
lte5g.NrfProfile
DescendantInfo:
pppoe.PPPPolicy
DescendantInfo:
qgroup.EgressQGroupPolicy
DescendantInfo:
aaa.NatRadiusAccountingPolicy
DescendantInfo:
ressubscr.IpoePolicy
DescendantInfo:
securitypolicy.SecurityPolicyDefinition
DescendantInfo:
sitesec.RemoteAuthPolicy
DescendantInfo:
aosqos.QoSNetworkGroups
DescendantInfo:
aapolicy.GtpFilter
DescendantInfo:
lte.FqdnGroupProfile
DescendantInfo:
aclfilter.VlanFilter
DescendantInfo:
lte.DiameterPeerProfile
DescendantInfo:
mpr.RadioQOS
DescendantInfo:
portscheduler.HsmdaSchedulerPolicy
DescendantInfo:
lte5g.N1Profile
DescendantInfo:
lte.PfcpProfile
DescendantInfo:
securitypolicy.HostGroup
DescendantInfo:
ressubscr.RipPolicy
DescendantInfo:
aapolicy.AccessNetworkLocation
DescendantInfo:
lteepdg.IPSecProfile
DescendantInfo:
sitesec.TlsTrustAnchorProfile
DescendantInfo:
connprof.PssConnProfPolicy
DescendantInfo:
lte.DiameterRateLimProfile
DescendantInfo:
ltetwag.TwagChargingProfile
DescendantInfo:
ipsec.IPSecStaticSA
DescendantInfo:
ressubscr.MldPolicy
DescendantInfo:
nodelog.AbstractLog
DescendantInfo:
slaprofile.Policy
DescendantInfo:
wlangw.DsmIpFilterPolicy
DescendantInfo:
aapolicy.AaSubCongDetect
DescendantInfo:
opticalacl.OcsIpFilter
DescendantInfo:
lte.DnsProfile
DescendantInfo:
ipfix.IPFIXExportPolicy
DescendantInfo:
ixrqos.DSCPFCMap
DescendantInfo:
slope.Policy
DescendantInfo:
mpls.Policy
DescendantInfo:
rp.AbstractAdminGroupPolicy
DescendantInfo:
portscheduler.HsmdaWrrPolicy
DescendantInfo:
mmepolicy.MMEEmergencyNumListTblPolicy
DescendantInfo:
lteepdg.EpdgChargingProfile
DescendantInfo:
lte.ErrorMappingProfile
DescendantInfo:
lte.FqdnList
DescendantInfo:
lte.GxProfile
DescendantInfo:
lte.CloudDBProfile
DescendantInfo:
sasqos.Remark
DescendantInfo:
aclfilter.DhcpFilter
DescendantInfo:
slope.NamedPool
DescendantInfo:
qosprofile.McfrEgressQosProfile
DescendantInfo:
ipsec.IkeTransform
DescendantInfo:
lte5g.Oauth2Profile
DescendantInfo:
sitesec.TlsClientProfile
DescendantInfo:
aapolicy.AaStatTcaAbstract
DescendantInfo:
firewall.HostGroup
DescendantInfo:
ressubscr.BgpPeeringPolicy
DescendantInfo:
service.SvcActTestHeadAcceptanceCriteriaTemplate
DescendantInfo:
nodelog.SysLogTarget
DescendantInfo:
aaa.AcctOnOffGroup
DescendantInfo:
lte.UeCallTrace
DescendantInfo:
aclfilter.MacFilter
DescendantInfo:
sas.StreamingDelayTemplate
DescendantInfo:
lte.DefBearerQoSProfile
DescendantInfo:
rp.PolicyObjectBase
DescendantInfo:
service.Y1564TestHeadProfile
DescendantInfo:
igmp.SSMTranslatePolicy
DescendantInfo:
radiusaccounting.Policy
DescendantInfo:
aapolicy.AaTcpOpt
DescendantInfo:
service.SvcActTestHeadFrameSizeTemplate
DescendantInfo:
ipsec.TrustAnchorProfile
DescendantInfo:
ixrqos.PortQosPolicy
DescendantInfo:
nodelog.SecurityLog
DescendantInfo:
ixrqos.IngressClassification
DescendantInfo:
aapolicy.Policy
DescendantInfo:
ipsec.RadiusAccountingPolicy
DescendantInfo:
qosprofile.McfrIngressQosProfile
DescendantInfo:
ressubscr.HostLockoutPolicy
DescendantInfo:
ressubscr.SubMcastCacPolicy
DescendantInfo:
slope.HsmdaPoolPolicy
DescendantInfo:
opticalacl.IpFilter
DescendantInfo:
ixrqos.QueueMgmtPolicy
DescendantInfo:
policy.PSGGenericPolicy
DescendantInfo:
mmepolicy.MMESCTPProfile
DescendantInfo:
aapolicy.AARadiusAccountingPolicy
DescendantInfo:
lte.SgwChargingProfile
DescendantInfo:
multicast.EgressMcastGroup
DescendantInfo:
aapolicy.HttpErrorRedirect
DescendantInfo:
multicast.McastReportDestination
DescendantInfo:
firewall.CPMFirewall
DescendantInfo:
rtr.AbstractAdminGroupPolicy
DescendantInfo:
lte.TrustedPeerListPolicy
DescendantInfo:
lteli.DFPeer
DescendantInfo:
aosqos.QoSMacGroups
DescendantInfo:
ltepolicyoptions.ApnRateControl
DescendantInfo:
hsqos.HsAttachmentPolicy
DescendantInfo:
subscrident.Policy
DescendantInfo:
tod.Policy
DescendantInfo:
lteggsn.CdrAvpOptionProfile
DescendantInfo:
lte.OIOverList
DescendantInfo:
aapolicy.AAGroupPolicy
DescendantInfo:
lte.MMEGroupProfile
DescendantInfo:
lteradius.RadiusGroupProfile
DescendantInfo:
lteli.InterceptionTarget
DescendantInfo:
mmepolicy.MMEProfile
DescendantInfo:
lte.IkeRedList
DescendantInfo:
ltehomeagent.DNSRedirectServer
DescendantInfo:
qosprofile.MlpppIngressQosProfile
DescendantInfo:
dctr.PortProfile
DescendantInfo:
multicast.PackagePolicy
DescendantInfo:
lte.PgwSelectionCandidateList
DescendantInfo:
file.FileTransmissionProfile
DescendantInfo:
genericne.MvFilterPolicy
DescendantInfo:
mmepolicy.MMEGTPProfile
DescendantInfo:
genericne.MvForwardingClassPolicy
DescendantInfo:
ltetwag.DhcpServerProfile
DescendantInfo:
aclfilter.Ipv6ExceptionFilter
DescendantInfo:
aclfilter.DhcpV6Filter
DescendantInfo:
lteradius.RadiusProfile
DescendantInfo:
sitesec.TlsServerProfile
DescendantInfo:
nqueue.Policy
DescendantInfo:
sasqos.AccessEgress
DescendantInfo:
wlangw.DsmTrafficPolicer
DescendantInfo:
lte.UpPeerList
DescendantInfo:
netca.AbstractStatsTCAProfile
DescendantInfo:
sasqos.MpBwPolicy
DescendantInfo:
nat.NatPolicy
DescendantInfo:
ltepolicyoptions.QoSRuleUnit
DescendantInfo:
sas.BinGroup
DescendantInfo:
aapolicy.HttpNotif
DescendantInfo:
ethernetservice.SapProfile
DescendantInfo:
sitesec.CpmIpFilter
DescendantInfo:
mmepolicy.WMMSVCAgreementProfile
DescendantInfo:
connprof.ConnProfPolicy
DescendantInfo:
pae802_1x.RadiusServerPolicy
DescendantInfo:
aapolicy.AaStatTcaCfg
DescendantInfo:
sasqos.PortScheduler
DescendantInfo:
lte.IdiRealmList
DescendantInfo:
sitesec.CertificateAuthProfile
DescendantInfo:
qgroup.RedirectList
DescendantInfo:
ltepolicyoptions.PolicyRuleBase
DescendantInfo:
genericne.MVGenericPolicy
DescendantInfo:
rtr.AdminGroupPolicy
DescendantInfo:
aaa.RadiusServerPolicy
DescendantInfo:
securitypolicy.Profile
DescendantInfo:
lte.PpiMappingProfile
DescendantInfo:
rtr.SharedRiskLinkGroup
DescendantInfo:
aapolicy.AAPortList
DescendantInfo:
lte.AgwChargingProfile
DescendantInfo:
mpls.LspTemplateMvpn
DescendantInfo:
aossas.CPETestHeadProfile
DescendantInfo:
ltegw.ApnListPolicyGroup
DescendantInfo:
ancp.Policy
DescendantInfo:
lte.CCFHProfile
DescendantInfo:
aclfilter.AggregateFilter
DescendantInfo:
lte.IpAddressList
DescendantInfo:
dctr.Profile
DescendantInfo:
hsqos.HsPortPoolPolicy
DescendantInfo:
hsqos.HsPoolPolicy
DescendantInfo:
ltessg.TdfChargingProfile
DescendantInfo:
aaa.IsaRadiusPolicy
DescendantInfo:
ltepolicyoptions.TrafficRedirectProfile
DescendantInfo:
nat.UpnpPolicy
DescendantInfo:
pdnprofile.PacketDataNetworkProfilePolicy
DescendantInfo:
gtp.ApnPolicy
DescendantInfo:
rtr.AbstractSharedRiskLinkGroup
DescendantInfo:
aosqos.QoSCondition
DescendantInfo:
ltetwag.SwwRadiusProfile
DescendantInfo:
svt.PwTemplate
DescendantInfo:
filterprefixlist.ProtocolList
DescendantInfo:
rp.AdminGroupPolicy
DescendantInfo:
rtr.AdminTagPolicy
DescendantInfo:
ltehomeagent.FAHAPeerList
DescendantInfo:
mpls.SRLGStaticConfig
DescendantInfo:
accounting.Policy
DescendantInfo:
lte.PfcpTranslateProfile
DescendantInfo:
aapolicy.AaTcpValidation
DescendantInfo:
lte5g.CHFProfile
DescendantInfo:
opticalacl.AbstractIpFilter
DescendantInfo:
msappolicy.Policy
DescendantInfo:
wlangw.MgwProfile
DescendantInfo:
lte5g.AllowedNFDomainList
DescendantInfo:
mmepolicy.WMMPfmJobEntry
DescendantInfo:
aclfilterli.LiMacFilter
DescendantInfo:
securitypolicy.AppGroup
DescendantInfo:
aapolicy.AaCflowdGroupPolicy
DescendantInfo:
lte.PeerListPolicy
DescendantInfo:
fabricqos.FabricProfile
DescendantInfo:
firewall.FwPolicyDefinition
DescendantInfo:
multicast.McastCacPolicy
DescendantInfo:
rp.PolicyAccountingTemplate
DescendantInfo:
ipsec.AbstractTrustAnchorProfile
DescendantInfo:
aclfilter.GreTunnelTemplate
DescendantInfo:
lte.DiameterProfile
DescendantInfo:
lte.PgwChargingProfile
DescendantInfo:
sasqos.EgressRemarking
DescendantInfo:
aclfilterli.LiIpFilter
DescendantInfo:
ltepolicyoptions.UrrProfile
DescendantInfo:
service.Y1564PayloadProfile
DescendantInfo:
lte5g.UdmIdList
DescendantInfo:
sas.LinkMeasurementTemplate
DescendantInfo:
nat.NatPrefixList
DescendantInfo:
aaa.IsaRadiusPolicyBase
DescendantInfo:
lteradius.AbsRadiusProfile
DescendantInfo:
equipment.PortPolicy
DescendantInfo:
unpprofile.UNPProfile
DescendantInfo:
rtr.ReassemblyProfilePolicy
DescendantInfo:
lte.GtpPrimeServerGroupProfile
DescendantInfo:
lte.Profile
DescendantInfo:
layer2.L2Profile
DescendantInfo:
qosportlist.PortList
DescendantInfo:
lte.ClientProfile
DescendantInfo:
lte.OverloadControlProfile
DescendantInfo:
ressubscr.BrgProfile
DescendantInfo:
firewall.ServiceGroup
DescendantInfo:
vs.ServiceTypeDefinition
DescendantInfo:
qgroup.IngressQGroupPolicy
DescendantInfo:
lte.SubscriberMappingProfile
DescendantInfo:
lte5g.SMFAttributesProfile
DescendantInfo:
ltegw.UMTSQoSPolicy
DescendantInfo:
ltepolicyoptions.ActionRuleUnitProfile
DescendantInfo:
lte.S2bErrorMappingProfile
DescendantInfo:
dynsvc.DynSvcLocalAuthDb
DescendantInfo:
lte5g.EmerProfile
DescendantInfo:
aosqos.List
DescendantInfo:
shaperqos.ShaperPolicy
DescendantInfo:
sasqos.FcDot1pMap
DescendantInfo:
ltessg.SteeringProfile
DescendantInfo:
srpythonmgmt.PythonScript
DescendantInfo:
sasqos.MplsLspExpMap
DescendantInfo:
lte.CreditPoolProfile
DescendantInfo:
ltegw.UDPTunnelGroupProfile
DescendantInfo:
multicast.IngrPathMgmtBwPolicy
DescendantInfo:
aclfilter.Ipv6Filter
DescendantInfo:
aapolicy.AAPrefixListPolicy
DescendantInfo:
ipsec.IPSecTunnelTemplate
DescendantInfo:
nat.PcpPolicy
DescendantInfo:
mmepolicy.WMMPfmMeasGroupName
DescendantInfo:
aosqos.QoSAction
DescendantInfo:
lte5g.EventTriggerFBCProfile
DescendantInfo:
srpythonmgmt.PythonPolicy
DescendantInfo:
aclfilterli.LiFilter
DescendantInfo:
ixrqos.EgressRemarkPolicy
DescendantInfo:
diameter.DiameterPeerPolicy
DescendantInfo:
nat.AbstractNatPlcy
DescendantInfo:
aosqos.Policy
DescendantInfo:
aapolicy.AAPolicer
DescendantInfo:
aclfilter.IpFilter
DescendantInfo:
lte5g.SMFChargingProfile
DescendantInfo:
lte.TargetProfile
DescendantInfo:
lte.GroupLabel
DescendantInfo:
ixrqos.Dot1pFCMap
DescendantInfo:
lte5g.SMFServingAreaList
DescendantInfo:
squeue.Policy
DescendantInfo:
ltetwag.SlaacHostProfile
DescendantInfo:
aaa.RouteDownloadPolicy
DescendantInfo:
ltessg.AddressListProfile
DescendantInfo:
pppoe.PPPPolicyBase
DescendantInfo:
lte.AbsCallInsight
DescendantInfo:
nat.SvcChainEvpnPolicy
DescendantInfo:
aapolicy.AaStatTcaFilterCfg
DescendantInfo:
ltegw.QciListPolicyGroup
DescendantInfo:
aapolicy.AAUrlListPolicy
DescendantInfo:
aapolicy.HttpRedirect
DescendantInfo:
ixrqos.LspExpFCMap
DescendantInfo:
niegr.Policy
DescendantInfo:
securitypolicy.PolicerGroup
DescendantInfo:
aapolicy.AACertProfile
DescendantInfo:
securityqueue.SecurityQueuePolicy
DescendantInfo:
genericne.MvMultitermPolicy
DescendantInfo:
lte.TaiLaiListProfile
DescendantInfo:
nat.MapDomain
DescendantInfo:
nodelog.LogProfile
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_policy_PolicyDefinition_findLocal", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findLocalResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/policy/PolicyDefinition/findReleased/{instanceFullName}": { "get": { "tags": [ "samo_policy" ], "summary": "rest_policy_PolicyDefinition_findReleased", "description": "Find the most recent released policy.

Intention : RETRIEVER
findReleased:
instance-level [object finder] (retriever) API findReleased
of class policy.PolicyDefinition
DescendantInfo:
rtr.SegmentRoutingMaintenancePolicy
DescendantInfo:
lte5g.PcfIdList
DescendantInfo:
mplstp.BFDTemplate
DescendantInfo:
ixrqos.VlanQosPolicy
DescendantInfo:
ressubscr.ShcvPolicy
DescendantInfo:
ltepolicyoptions.AssumePositiveActionProfile
DescendantInfo:
ixrqos.FcLspExpMap
DescendantInfo:
aclfilterli.LiIpv6Filter
DescendantInfo:
subscrexpmap.Policy
DescendantInfo:
sitesec.DCpuProtection
DescendantInfo:
rp.ASPathGroup
DescendantInfo:
diameter.DiameterAppPolicy
DescendantInfo:
aclfilter.AbstractFilterDefinition
DescendantInfo:
sasqos.Network
DescendantInfo:
lte.GtpProfile
DescendantInfo:
rp.PolicyStatement
DescendantInfo:
file.Policy
DescendantInfo:
lte.PfcpAPPeerList
DescendantInfo:
ethernetservice.UniProfile
DescendantInfo:
ltepolicyoptions.TrafficHashProfile
DescendantInfo:
sitesec.TlsCertificateProfile
DescendantInfo:
qosprofile.MlpppEgressQosProfile
DescendantInfo:
vs.AdvancedConfigPolicy
DescendantInfo:
sasqos.SchedulerPolicy
DescendantInfo:
aapolicy.AAUrlFilter
DescendantInfo:
genericne.MvQosPolicy
DescendantInfo:
sitesec.PkiCommonNameList
DescendantInfo:
ethernetservice.CustomL2Profile
DescendantInfo:
ltetwag.DiameterPeerGroupList
DescendantInfo:
postpolicermapping.PostPolicerMappingPolicy
DescendantInfo:
aengr.Policy
DescendantInfo:
sitesec.LocalUser
DescendantInfo:
rp.PrefixList
DescendantInfo:
lte5g.NfIdList
DescendantInfo:
rtr.RouteNextHopPolicyTemplate
DescendantInfo:
lte5g.QfiMappingProfile
DescendantInfo:
aapolicy.AbstractTransitPolicy
DescendantInfo:
aclfilter.AbstractExceptionFilter
DescendantInfo:
sasqos.DSCPClassification
DescendantInfo:
lte.WlanEmergencyProfile
DescendantInfo:
portscheduler.Policy
DescendantInfo:
vs.Policy
DescendantInfo:
lteggsn.GyAvpOptionProfile
DescendantInfo:
ixrqos.NetworkIngressPolicy
DescendantInfo:
ixrqos.FcDot1pMap
DescendantInfo:
sasqos.NQueue
DescendantInfo:
aapolicy.TetherDetection
DescendantInfo:
service.Y1564AcceptanceCriteriaProfile
DescendantInfo:
ltepolicyoptions.PolicyRule
DescendantInfo:
lte.Abspfcp
DescendantInfo:
mmepolicy.MMEEmergencyNumListPolicy
DescendantInfo:
sitesec.AOSSecurityPolicy
DescendantInfo:
lte.T6cProfile
DescendantInfo:
lte.EpdgGroupList
DescendantInfo:
slope.HsmdaSlopePolicy
DescendantInfo:
aapolicy.AaStatTcaFltrEntryCfg
DescendantInfo:
lte.SourceIpList
DescendantInfo:
sasqos.FcDscpMap
DescendantInfo:
lte.IPProfile
DescendantInfo:
ipsec.IPSecTransform
DescendantInfo:
subscrauth.Policy
DescendantInfo:
icmp.IcmpPingTemplate
DescendantInfo:
qosprefixlist.PrefixList
DescendantInfo:
sitesec.DoSProtection
DescendantInfo:
lte.DccaProfile
DescendantInfo:
filterprefixlist.PortList
DescendantInfo:
rtr.AdminTag
DescendantInfo:
aapolicy.AASessionFilter
DescendantInfo:
hsqos.HsSchedulerPolicy
DescendantInfo:
ltepolicyoptions.ServiceClassIndicator
DescendantInfo:
sitesec.UserProfile
DescendantInfo:
ltepolicyoptions.SruList
DescendantInfo:
lte.AllUesCallTrace
DescendantInfo:
sitesec.TlsServerCipherList
DescendantInfo:
ltegw.TariffChangeListProfilePolicyGroup
DescendantInfo:
aingr.Policy
DescendantInfo:
aapolicy.AbstractHttpRedirect
DescendantInfo:
ltetwag.StaProfile
DescendantInfo:
redirectfilter.RedirectPolicyBinding
DescendantInfo:
sasqos.FCMeterMap
DescendantInfo:
vrrp.Policy
DescendantInfo:
lte5g.SliceList
DescendantInfo:
sasqos.SlopePolicy
DescendantInfo:
todsuite.Policy
DescendantInfo:
diameter.DiameterPolicy
DescendantInfo:
sasqos.SystemResourceProfilePolicy
DescendantInfo:
genericne.MvAbstractPolicy
DescendantInfo:
aapolicy.TransitPrefixPolicy
DescendantInfo:
sitesec.EstAuthProfile
DescendantInfo:
hwaggshapersched.HwAggShaperSchedulerPolicy
DescendantInfo:
aossas.CPETestHeadGroupProfile
DescendantInfo:
lte5g.PrioAddrList
DescendantInfo:
rp.GlobalVariables
DescendantInfo:
lte5g.SliceInstanceList
DescendantInfo:
lte.DedicatedBearerIdleTimeOutProfile
DescendantInfo:
security.KeyChain
DescendantInfo:
lte.PcmdProfile
DescendantInfo:
lteepdg.SwmAvpOptionProfile
DescendantInfo:
mpls.SharedRiskLinkGroup
DescendantInfo:
sitesec.TlsClientCipherList
DescendantInfo:
lte.AmfIdList
DescendantInfo:
ltehomeagent.MobileIpv4Profile
DescendantInfo:
file.LogDefinition
DescendantInfo:
macsec.MacPolicy
DescendantInfo:
securitypolicy.Policy
DescendantInfo:
ltepolicyoptions.AbsPolicyOptionProfile
DescendantInfo:
aclfilter.IpExceptionFilter
DescendantInfo:
sasqos.Dot1pClassification
DescendantInfo:
ipsec.IkePolicy
DescendantInfo:
mpr.QueueMapPolicy
DescendantInfo:
aapolicy.ApplicationAssurancePolicyDefinition
DescendantInfo:
service.VplsSapTemplate
DescendantInfo:
ltegw.AbsListPolicyGroup
DescendantInfo:
lte.SDProfile
DescendantInfo:
aapolicy.SctpFilter
DescendantInfo:
lte.PlmnListPolicyGroup
DescendantInfo:
mpr.GneRadiusQosPolicy
DescendantInfo:
l2fwd.MrpPolicy
DescendantInfo:
sasqos.AccessIngress
DescendantInfo:
crdtctrl.CrdtCtrlPolicy
DescendantInfo:
lte.PortList
DescendantInfo:
lte5g.SbaNudmSdmProf
DescendantInfo:
rp.Damping
DescendantInfo:
aapolicy.TransitIpPolicy
DescendantInfo:
lte.SwmErrorMappingProfile
DescendantInfo:
firewall.Zone
DescendantInfo:
rp.ASPath
DescendantInfo:
ltepolicyoptions.UsgMonInfo
DescendantInfo:
sitesec.RadiusPolicy
DescendantInfo:
optical.AlarmProfile
DescendantInfo:
ipsec.CertProfile
DescendantInfo:
crdtctrl.CtgryMapPolicy
DescendantInfo:
lte.DiameterErrorMappingProfile
DescendantInfo:
ressubscr.HostTrackingPolicy
DescendantInfo:
sasqos.MplsLspExpClassification
DescendantInfo:
ressubscr.IgmpPolicy
DescendantInfo:
lte.AccountingPriorityProfile
DescendantInfo:
rp.RouteNextHopPolicyTemplate
DescendantInfo:
ressubscr.PimPolicy
DescendantInfo:
ltepolicyoptions.DynamicToInternalRuleMap
DescendantInfo:
netca.CardStatsTCAProfile
DescendantInfo:
subscrprofile.Policy
DescendantInfo:
aapolicy.HttpEnrich
DescendantInfo:
ltepolicyoptions.GxAvpOptionProfile
DescendantInfo:
sitesec.LdapPolicy
DescendantInfo:
aclfilter.FilterDefinition
DescendantInfo:
fpresource.FPResourcePolicy
DescendantInfo:
securitypolicy.Zone
DescendantInfo:
ltegw.SCTPProfile
DescendantInfo:
sasqos.QueueMgmtPolicy
DescendantInfo:
sasqos.FcLspExpMap
DescendantInfo:
ltepolicyoptions.TriggerRuleUnitProfile
DescendantInfo:
ressubscr.HttpRedirectPolicy
DescendantInfo:
service.Y1564FrameMixProfile
DescendantInfo:
ltepolicyoptions.PolicyRuleUnit
DescendantInfo:
firewall.MgmtAccessFirewall
DescendantInfo:
ltehomeagent.AbsHomeAgentProfile
DescendantInfo:
firewall.RuleSet
DescendantInfo:
netca.StatsTCAProfile
DescendantInfo:
genericne.MvPolicerPolicy
DescendantInfo:
rp.AbstractSrlgGroupPolicy
DescendantInfo:
lte5g.SbaNudmUecmProf
DescendantInfo:
sasqos.IngressCoSClassification
DescendantInfo:
rp.SrlgGroupPolicy
DescendantInfo:
aaa.RadiusScriptPolicy
DescendantInfo:
nat.SvcChainVasFilterPolicy
DescendantInfo:
aapolicy.DnsIpCache
DescendantInfo:
sasqos.NetworkIngress
DescendantInfo:
ltepolicyoptions.ChargingRuleUnit
DescendantInfo:
aapolicy.AAFlowCfgPolicy
DescendantInfo:
lte5g.HTTP2Profile
DescendantInfo:
sasqos.PortAccessIngress
DescendantInfo:
ltegw.PcscfGroupProfile
DescendantInfo:
multicast.IngrPathMgmtInfoPolicy
DescendantInfo:
sitesec.ManagementAccessFilter
DescendantInfo:
ltetwag.SwwTunnelProfile
DescendantInfo:
ethernetoam.MaintenanceDomain
DescendantInfo:
ipsec.RadiusAuthenticationPolicy
DescendantInfo:
aapolicy.AaStatTcaPolicerCfg
DescendantInfo:
ipsec.TrafficSelectorList
DescendantInfo:
atmpolicy.TrafficDescriptor
DescendantInfo:
sasqos.PortAccessEgress
DescendantInfo:
aapolicy.MpTcpProxy
DescendantInfo:
connprof.VlanConnProfPolicy
DescendantInfo:
opticalacl.IpPattern
DescendantInfo:
policing.PolicerControl
DescendantInfo:
sw.SoftwareRepositoryPolicy
DescendantInfo:
svt.TunnelAdminGroup
DescendantInfo:
optical.OcsAlarmProfile
DescendantInfo:
aclfilterli.BlockReservation
DescendantInfo:
genericne.MvMatchingRulePolicy
DescendantInfo:
mmepolicy.WMMInterfaceProfile
DescendantInfo:
calltrace.TraceProfile
DescendantInfo:
ltepolicyoptions.DhcpServerGroupProfile
DescendantInfo:
service.AbstractSapTemplate
DescendantInfo:
aapolicy.AaTcpValidationTca
DescendantInfo:
ltepmip.S6bAvpOptionProfile
DescendantInfo:
redirectfilter.RedirectPolicy
DescendantInfo:
service.EpipeSapTemplate
DescendantInfo:
lte.AbsGtpProfile
DescendantInfo:
ltegw.AvpOptionProfile
DescendantInfo:
nodelog.FirewallLog
DescendantInfo:
multicast.McastCacInterfacePolicy
DescendantInfo:
nodelog.FilterLog
DescendantInfo:
ixrqos.FcDSCPMap
DescendantInfo:
lte5g.NpcfProfile
DescendantInfo:
ltegw.AbsNodeSelPolicyGroup
DescendantInfo:
sitesec.PasswordPolicy
DescendantInfo:
nat.NatClassifier
DescendantInfo:
aaa.L2tpRadiusAccountingPolicy
DescendantInfo:
dynsvc.DynSvcPolicy
DescendantInfo:
ltepolicyoptions.UsgMonAction
DescendantInfo:
sitesec.TacacsPolicy
DescendantInfo:
ltepolicyoptions.StatsRuleUnit
DescendantInfo:
rp.Community
DescendantInfo:
securitypolicy.Bypass
DescendantInfo:
lte.DnsErrMapProfile
DescendantInfo:
nat.FirewallPolicy
DescendantInfo:
ipsec.IPSecClientDB
DescendantInfo:
lte.QciPolicy
DescendantInfo:
filterprefixlist.PrefixList
DescendantInfo:
netca.OCSStatsTCAProfile
DescendantInfo:
rmon.RemoteNetworkMonitoring
DescendantInfo:
aapolicy.AaFilterAbstract
DescendantInfo:
ltepmip.Pmipv6Profile
DescendantInfo:
lte5g.NrfProfile
DescendantInfo:
pppoe.PPPPolicy
DescendantInfo:
qgroup.EgressQGroupPolicy
DescendantInfo:
aaa.NatRadiusAccountingPolicy
DescendantInfo:
ressubscr.IpoePolicy
DescendantInfo:
securitypolicy.SecurityPolicyDefinition
DescendantInfo:
sitesec.RemoteAuthPolicy
DescendantInfo:
aosqos.QoSNetworkGroups
DescendantInfo:
aapolicy.GtpFilter
DescendantInfo:
lte.FqdnGroupProfile
DescendantInfo:
aclfilter.VlanFilter
DescendantInfo:
lte.DiameterPeerProfile
DescendantInfo:
mpr.RadioQOS
DescendantInfo:
portscheduler.HsmdaSchedulerPolicy
DescendantInfo:
lte5g.N1Profile
DescendantInfo:
lte.PfcpProfile
DescendantInfo:
securitypolicy.HostGroup
DescendantInfo:
ressubscr.RipPolicy
DescendantInfo:
aapolicy.AccessNetworkLocation
DescendantInfo:
lteepdg.IPSecProfile
DescendantInfo:
sitesec.TlsTrustAnchorProfile
DescendantInfo:
connprof.PssConnProfPolicy
DescendantInfo:
lte.DiameterRateLimProfile
DescendantInfo:
ltetwag.TwagChargingProfile
DescendantInfo:
ipsec.IPSecStaticSA
DescendantInfo:
ressubscr.MldPolicy
DescendantInfo:
nodelog.AbstractLog
DescendantInfo:
slaprofile.Policy
DescendantInfo:
wlangw.DsmIpFilterPolicy
DescendantInfo:
aapolicy.AaSubCongDetect
DescendantInfo:
opticalacl.OcsIpFilter
DescendantInfo:
lte.DnsProfile
DescendantInfo:
ipfix.IPFIXExportPolicy
DescendantInfo:
ixrqos.DSCPFCMap
DescendantInfo:
slope.Policy
DescendantInfo:
mpls.Policy
DescendantInfo:
rp.AbstractAdminGroupPolicy
DescendantInfo:
portscheduler.HsmdaWrrPolicy
DescendantInfo:
mmepolicy.MMEEmergencyNumListTblPolicy
DescendantInfo:
lteepdg.EpdgChargingProfile
DescendantInfo:
lte.ErrorMappingProfile
DescendantInfo:
lte.FqdnList
DescendantInfo:
lte.GxProfile
DescendantInfo:
lte.CloudDBProfile
DescendantInfo:
sasqos.Remark
DescendantInfo:
aclfilter.DhcpFilter
DescendantInfo:
slope.NamedPool
DescendantInfo:
qosprofile.McfrEgressQosProfile
DescendantInfo:
ipsec.IkeTransform
DescendantInfo:
lte5g.Oauth2Profile
DescendantInfo:
sitesec.TlsClientProfile
DescendantInfo:
aapolicy.AaStatTcaAbstract
DescendantInfo:
firewall.HostGroup
DescendantInfo:
ressubscr.BgpPeeringPolicy
DescendantInfo:
service.SvcActTestHeadAcceptanceCriteriaTemplate
DescendantInfo:
nodelog.SysLogTarget
DescendantInfo:
aaa.AcctOnOffGroup
DescendantInfo:
lte.UeCallTrace
DescendantInfo:
aclfilter.MacFilter
DescendantInfo:
sas.StreamingDelayTemplate
DescendantInfo:
lte.DefBearerQoSProfile
DescendantInfo:
rp.PolicyObjectBase
DescendantInfo:
service.Y1564TestHeadProfile
DescendantInfo:
igmp.SSMTranslatePolicy
DescendantInfo:
radiusaccounting.Policy
DescendantInfo:
aapolicy.AaTcpOpt
DescendantInfo:
service.SvcActTestHeadFrameSizeTemplate
DescendantInfo:
ipsec.TrustAnchorProfile
DescendantInfo:
ixrqos.PortQosPolicy
DescendantInfo:
nodelog.SecurityLog
DescendantInfo:
ixrqos.IngressClassification
DescendantInfo:
aapolicy.Policy
DescendantInfo:
ipsec.RadiusAccountingPolicy
DescendantInfo:
qosprofile.McfrIngressQosProfile
DescendantInfo:
ressubscr.HostLockoutPolicy
DescendantInfo:
ressubscr.SubMcastCacPolicy
DescendantInfo:
slope.HsmdaPoolPolicy
DescendantInfo:
opticalacl.IpFilter
DescendantInfo:
ixrqos.QueueMgmtPolicy
DescendantInfo:
policy.PSGGenericPolicy
DescendantInfo:
mmepolicy.MMESCTPProfile
DescendantInfo:
aapolicy.AARadiusAccountingPolicy
DescendantInfo:
lte.SgwChargingProfile
DescendantInfo:
multicast.EgressMcastGroup
DescendantInfo:
aapolicy.HttpErrorRedirect
DescendantInfo:
multicast.McastReportDestination
DescendantInfo:
firewall.CPMFirewall
DescendantInfo:
rtr.AbstractAdminGroupPolicy
DescendantInfo:
lte.TrustedPeerListPolicy
DescendantInfo:
lteli.DFPeer
DescendantInfo:
aosqos.QoSMacGroups
DescendantInfo:
ltepolicyoptions.ApnRateControl
DescendantInfo:
hsqos.HsAttachmentPolicy
DescendantInfo:
subscrident.Policy
DescendantInfo:
tod.Policy
DescendantInfo:
lteggsn.CdrAvpOptionProfile
DescendantInfo:
lte.OIOverList
DescendantInfo:
aapolicy.AAGroupPolicy
DescendantInfo:
lte.MMEGroupProfile
DescendantInfo:
lteradius.RadiusGroupProfile
DescendantInfo:
lteli.InterceptionTarget
DescendantInfo:
mmepolicy.MMEProfile
DescendantInfo:
lte.IkeRedList
DescendantInfo:
ltehomeagent.DNSRedirectServer
DescendantInfo:
qosprofile.MlpppIngressQosProfile
DescendantInfo:
dctr.PortProfile
DescendantInfo:
multicast.PackagePolicy
DescendantInfo:
lte.PgwSelectionCandidateList
DescendantInfo:
file.FileTransmissionProfile
DescendantInfo:
genericne.MvFilterPolicy
DescendantInfo:
mmepolicy.MMEGTPProfile
DescendantInfo:
genericne.MvForwardingClassPolicy
DescendantInfo:
ltetwag.DhcpServerProfile
DescendantInfo:
aclfilter.Ipv6ExceptionFilter
DescendantInfo:
aclfilter.DhcpV6Filter
DescendantInfo:
lteradius.RadiusProfile
DescendantInfo:
sitesec.TlsServerProfile
DescendantInfo:
nqueue.Policy
DescendantInfo:
sasqos.AccessEgress
DescendantInfo:
wlangw.DsmTrafficPolicer
DescendantInfo:
lte.UpPeerList
DescendantInfo:
netca.AbstractStatsTCAProfile
DescendantInfo:
sasqos.MpBwPolicy
DescendantInfo:
nat.NatPolicy
DescendantInfo:
ltepolicyoptions.QoSRuleUnit
DescendantInfo:
sas.BinGroup
DescendantInfo:
aapolicy.HttpNotif
DescendantInfo:
ethernetservice.SapProfile
DescendantInfo:
sitesec.CpmIpFilter
DescendantInfo:
mmepolicy.WMMSVCAgreementProfile
DescendantInfo:
connprof.ConnProfPolicy
DescendantInfo:
pae802_1x.RadiusServerPolicy
DescendantInfo:
aapolicy.AaStatTcaCfg
DescendantInfo:
sasqos.PortScheduler
DescendantInfo:
lte.IdiRealmList
DescendantInfo:
sitesec.CertificateAuthProfile
DescendantInfo:
qgroup.RedirectList
DescendantInfo:
ltepolicyoptions.PolicyRuleBase
DescendantInfo:
genericne.MVGenericPolicy
DescendantInfo:
rtr.AdminGroupPolicy
DescendantInfo:
aaa.RadiusServerPolicy
DescendantInfo:
securitypolicy.Profile
DescendantInfo:
lte.PpiMappingProfile
DescendantInfo:
rtr.SharedRiskLinkGroup
DescendantInfo:
aapolicy.AAPortList
DescendantInfo:
lte.AgwChargingProfile
DescendantInfo:
mpls.LspTemplateMvpn
DescendantInfo:
aossas.CPETestHeadProfile
DescendantInfo:
ltegw.ApnListPolicyGroup
DescendantInfo:
ancp.Policy
DescendantInfo:
lte.CCFHProfile
DescendantInfo:
aclfilter.AggregateFilter
DescendantInfo:
lte.IpAddressList
DescendantInfo:
dctr.Profile
DescendantInfo:
hsqos.HsPortPoolPolicy
DescendantInfo:
hsqos.HsPoolPolicy
DescendantInfo:
ltessg.TdfChargingProfile
DescendantInfo:
aaa.IsaRadiusPolicy
DescendantInfo:
ltepolicyoptions.TrafficRedirectProfile
DescendantInfo:
nat.UpnpPolicy
DescendantInfo:
pdnprofile.PacketDataNetworkProfilePolicy
DescendantInfo:
gtp.ApnPolicy
DescendantInfo:
rtr.AbstractSharedRiskLinkGroup
DescendantInfo:
aosqos.QoSCondition
DescendantInfo:
ltetwag.SwwRadiusProfile
DescendantInfo:
svt.PwTemplate
DescendantInfo:
filterprefixlist.ProtocolList
DescendantInfo:
rp.AdminGroupPolicy
DescendantInfo:
rtr.AdminTagPolicy
DescendantInfo:
ltehomeagent.FAHAPeerList
DescendantInfo:
mpls.SRLGStaticConfig
DescendantInfo:
accounting.Policy
DescendantInfo:
lte.PfcpTranslateProfile
DescendantInfo:
aapolicy.AaTcpValidation
DescendantInfo:
lte5g.CHFProfile
DescendantInfo:
opticalacl.AbstractIpFilter
DescendantInfo:
msappolicy.Policy
DescendantInfo:
wlangw.MgwProfile
DescendantInfo:
lte5g.AllowedNFDomainList
DescendantInfo:
mmepolicy.WMMPfmJobEntry
DescendantInfo:
aclfilterli.LiMacFilter
DescendantInfo:
securitypolicy.AppGroup
DescendantInfo:
aapolicy.AaCflowdGroupPolicy
DescendantInfo:
lte.PeerListPolicy
DescendantInfo:
fabricqos.FabricProfile
DescendantInfo:
firewall.FwPolicyDefinition
DescendantInfo:
multicast.McastCacPolicy
DescendantInfo:
rp.PolicyAccountingTemplate
DescendantInfo:
ipsec.AbstractTrustAnchorProfile
DescendantInfo:
aclfilter.GreTunnelTemplate
DescendantInfo:
lte.DiameterProfile
DescendantInfo:
lte.PgwChargingProfile
DescendantInfo:
sasqos.EgressRemarking
DescendantInfo:
aclfilterli.LiIpFilter
DescendantInfo:
ltepolicyoptions.UrrProfile
DescendantInfo:
service.Y1564PayloadProfile
DescendantInfo:
lte5g.UdmIdList
DescendantInfo:
sas.LinkMeasurementTemplate
DescendantInfo:
nat.NatPrefixList
DescendantInfo:
aaa.IsaRadiusPolicyBase
DescendantInfo:
lteradius.AbsRadiusProfile
DescendantInfo:
equipment.PortPolicy
DescendantInfo:
unpprofile.UNPProfile
DescendantInfo:
rtr.ReassemblyProfilePolicy
DescendantInfo:
lte.GtpPrimeServerGroupProfile
DescendantInfo:
lte.Profile
DescendantInfo:
layer2.L2Profile
DescendantInfo:
qosportlist.PortList
DescendantInfo:
lte.ClientProfile
DescendantInfo:
lte.OverloadControlProfile
DescendantInfo:
ressubscr.BrgProfile
DescendantInfo:
firewall.ServiceGroup
DescendantInfo:
vs.ServiceTypeDefinition
DescendantInfo:
qgroup.IngressQGroupPolicy
DescendantInfo:
lte.SubscriberMappingProfile
DescendantInfo:
lte5g.SMFAttributesProfile
DescendantInfo:
ltegw.UMTSQoSPolicy
DescendantInfo:
ltepolicyoptions.ActionRuleUnitProfile
DescendantInfo:
lte.S2bErrorMappingProfile
DescendantInfo:
dynsvc.DynSvcLocalAuthDb
DescendantInfo:
lte5g.EmerProfile
DescendantInfo:
aosqos.List
DescendantInfo:
shaperqos.ShaperPolicy
DescendantInfo:
sasqos.FcDot1pMap
DescendantInfo:
ltessg.SteeringProfile
DescendantInfo:
srpythonmgmt.PythonScript
DescendantInfo:
sasqos.MplsLspExpMap
DescendantInfo:
lte.CreditPoolProfile
DescendantInfo:
ltegw.UDPTunnelGroupProfile
DescendantInfo:
multicast.IngrPathMgmtBwPolicy
DescendantInfo:
aclfilter.Ipv6Filter
DescendantInfo:
aapolicy.AAPrefixListPolicy
DescendantInfo:
ipsec.IPSecTunnelTemplate
DescendantInfo:
nat.PcpPolicy
DescendantInfo:
mmepolicy.WMMPfmMeasGroupName
DescendantInfo:
aosqos.QoSAction
DescendantInfo:
lte5g.EventTriggerFBCProfile
DescendantInfo:
srpythonmgmt.PythonPolicy
DescendantInfo:
aclfilterli.LiFilter
DescendantInfo:
ixrqos.EgressRemarkPolicy
DescendantInfo:
diameter.DiameterPeerPolicy
DescendantInfo:
nat.AbstractNatPlcy
DescendantInfo:
aosqos.Policy
DescendantInfo:
aapolicy.AAPolicer
DescendantInfo:
aclfilter.IpFilter
DescendantInfo:
lte5g.SMFChargingProfile
DescendantInfo:
lte.TargetProfile
DescendantInfo:
lte.GroupLabel
DescendantInfo:
ixrqos.Dot1pFCMap
DescendantInfo:
lte5g.SMFServingAreaList
DescendantInfo:
squeue.Policy
DescendantInfo:
ltetwag.SlaacHostProfile
DescendantInfo:
aaa.RouteDownloadPolicy
DescendantInfo:
ltessg.AddressListProfile
DescendantInfo:
pppoe.PPPPolicyBase
DescendantInfo:
lte.AbsCallInsight
DescendantInfo:
nat.SvcChainEvpnPolicy
DescendantInfo:
aapolicy.AaStatTcaFilterCfg
DescendantInfo:
ltegw.QciListPolicyGroup
DescendantInfo:
aapolicy.AAUrlListPolicy
DescendantInfo:
aapolicy.HttpRedirect
DescendantInfo:
ixrqos.LspExpFCMap
DescendantInfo:
niegr.Policy
DescendantInfo:
securitypolicy.PolicerGroup
DescendantInfo:
aapolicy.AACertProfile
DescendantInfo:
securityqueue.SecurityQueuePolicy
DescendantInfo:
genericne.MvMultitermPolicy
DescendantInfo:
lte.TaiLaiListProfile
DescendantInfo:
nat.MapDomain
DescendantInfo:
nodelog.LogProfile
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_policy_PolicyDefinition_findReleased", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findReleasedResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/policy/PolicyDefinition/getSyncTaskResult": { "get": { "tags": [ "samo_policy" ], "summary": "rest_policy_PolicyDefinition_getSyncTaskResult", "description": "Method to get sync task result

Intention : ACCESSOR
getSyncTaskResult:
class-level accessor API getSyncTaskResult
of class policy.PolicyDefinition
DescendantInfo:
rtr.SegmentRoutingMaintenancePolicy
DescendantInfo:
lte5g.PcfIdList
DescendantInfo:
mplstp.BFDTemplate
DescendantInfo:
ixrqos.VlanQosPolicy
DescendantInfo:
ressubscr.ShcvPolicy
DescendantInfo:
ltepolicyoptions.AssumePositiveActionProfile
DescendantInfo:
ixrqos.FcLspExpMap
DescendantInfo:
aclfilterli.LiIpv6Filter
DescendantInfo:
subscrexpmap.Policy
DescendantInfo:
sitesec.DCpuProtection
DescendantInfo:
rp.ASPathGroup
DescendantInfo:
diameter.DiameterAppPolicy
DescendantInfo:
aclfilter.AbstractFilterDefinition
DescendantInfo:
sasqos.Network
DescendantInfo:
lte.GtpProfile
DescendantInfo:
rp.PolicyStatement
DescendantInfo:
file.Policy
DescendantInfo:
lte.PfcpAPPeerList
DescendantInfo:
ethernetservice.UniProfile
DescendantInfo:
ltepolicyoptions.TrafficHashProfile
DescendantInfo:
sitesec.TlsCertificateProfile
DescendantInfo:
qosprofile.MlpppEgressQosProfile
DescendantInfo:
vs.AdvancedConfigPolicy
DescendantInfo:
sasqos.SchedulerPolicy
DescendantInfo:
aapolicy.AAUrlFilter
DescendantInfo:
genericne.MvQosPolicy
DescendantInfo:
sitesec.PkiCommonNameList
DescendantInfo:
ethernetservice.CustomL2Profile
DescendantInfo:
ltetwag.DiameterPeerGroupList
DescendantInfo:
postpolicermapping.PostPolicerMappingPolicy
DescendantInfo:
aengr.Policy
DescendantInfo:
sitesec.LocalUser
DescendantInfo:
rp.PrefixList
DescendantInfo:
lte5g.NfIdList
DescendantInfo:
rtr.RouteNextHopPolicyTemplate
DescendantInfo:
lte5g.QfiMappingProfile
DescendantInfo:
aapolicy.AbstractTransitPolicy
DescendantInfo:
aclfilter.AbstractExceptionFilter
DescendantInfo:
sasqos.DSCPClassification
DescendantInfo:
lte.WlanEmergencyProfile
DescendantInfo:
portscheduler.Policy
DescendantInfo:
vs.Policy
DescendantInfo:
lteggsn.GyAvpOptionProfile
DescendantInfo:
ixrqos.NetworkIngressPolicy
DescendantInfo:
ixrqos.FcDot1pMap
DescendantInfo:
sasqos.NQueue
DescendantInfo:
aapolicy.TetherDetection
DescendantInfo:
service.Y1564AcceptanceCriteriaProfile
DescendantInfo:
ltepolicyoptions.PolicyRule
DescendantInfo:
lte.Abspfcp
DescendantInfo:
mmepolicy.MMEEmergencyNumListPolicy
DescendantInfo:
sitesec.AOSSecurityPolicy
DescendantInfo:
lte.T6cProfile
DescendantInfo:
lte.EpdgGroupList
DescendantInfo:
slope.HsmdaSlopePolicy
DescendantInfo:
aapolicy.AaStatTcaFltrEntryCfg
DescendantInfo:
lte.SourceIpList
DescendantInfo:
sasqos.FcDscpMap
DescendantInfo:
lte.IPProfile
DescendantInfo:
ipsec.IPSecTransform
DescendantInfo:
subscrauth.Policy
DescendantInfo:
icmp.IcmpPingTemplate
DescendantInfo:
qosprefixlist.PrefixList
DescendantInfo:
sitesec.DoSProtection
DescendantInfo:
lte.DccaProfile
DescendantInfo:
filterprefixlist.PortList
DescendantInfo:
rtr.AdminTag
DescendantInfo:
aapolicy.AASessionFilter
DescendantInfo:
hsqos.HsSchedulerPolicy
DescendantInfo:
ltepolicyoptions.ServiceClassIndicator
DescendantInfo:
sitesec.UserProfile
DescendantInfo:
ltepolicyoptions.SruList
DescendantInfo:
lte.AllUesCallTrace
DescendantInfo:
sitesec.TlsServerCipherList
DescendantInfo:
ltegw.TariffChangeListProfilePolicyGroup
DescendantInfo:
aingr.Policy
DescendantInfo:
aapolicy.AbstractHttpRedirect
DescendantInfo:
ltetwag.StaProfile
DescendantInfo:
redirectfilter.RedirectPolicyBinding
DescendantInfo:
sasqos.FCMeterMap
DescendantInfo:
vrrp.Policy
DescendantInfo:
lte5g.SliceList
DescendantInfo:
sasqos.SlopePolicy
DescendantInfo:
todsuite.Policy
DescendantInfo:
diameter.DiameterPolicy
DescendantInfo:
sasqos.SystemResourceProfilePolicy
DescendantInfo:
genericne.MvAbstractPolicy
DescendantInfo:
aapolicy.TransitPrefixPolicy
DescendantInfo:
sitesec.EstAuthProfile
DescendantInfo:
hwaggshapersched.HwAggShaperSchedulerPolicy
DescendantInfo:
aossas.CPETestHeadGroupProfile
DescendantInfo:
lte5g.PrioAddrList
DescendantInfo:
rp.GlobalVariables
DescendantInfo:
lte5g.SliceInstanceList
DescendantInfo:
lte.DedicatedBearerIdleTimeOutProfile
DescendantInfo:
security.KeyChain
DescendantInfo:
lte.PcmdProfile
DescendantInfo:
lteepdg.SwmAvpOptionProfile
DescendantInfo:
mpls.SharedRiskLinkGroup
DescendantInfo:
sitesec.TlsClientCipherList
DescendantInfo:
lte.AmfIdList
DescendantInfo:
ltehomeagent.MobileIpv4Profile
DescendantInfo:
file.LogDefinition
DescendantInfo:
macsec.MacPolicy
DescendantInfo:
securitypolicy.Policy
DescendantInfo:
ltepolicyoptions.AbsPolicyOptionProfile
DescendantInfo:
aclfilter.IpExceptionFilter
DescendantInfo:
sasqos.Dot1pClassification
DescendantInfo:
ipsec.IkePolicy
DescendantInfo:
mpr.QueueMapPolicy
DescendantInfo:
aapolicy.ApplicationAssurancePolicyDefinition
DescendantInfo:
service.VplsSapTemplate
DescendantInfo:
ltegw.AbsListPolicyGroup
DescendantInfo:
lte.SDProfile
DescendantInfo:
aapolicy.SctpFilter
DescendantInfo:
lte.PlmnListPolicyGroup
DescendantInfo:
mpr.GneRadiusQosPolicy
DescendantInfo:
l2fwd.MrpPolicy
DescendantInfo:
sasqos.AccessIngress
DescendantInfo:
crdtctrl.CrdtCtrlPolicy
DescendantInfo:
lte.PortList
DescendantInfo:
lte5g.SbaNudmSdmProf
DescendantInfo:
rp.Damping
DescendantInfo:
aapolicy.TransitIpPolicy
DescendantInfo:
lte.SwmErrorMappingProfile
DescendantInfo:
firewall.Zone
DescendantInfo:
rp.ASPath
DescendantInfo:
ltepolicyoptions.UsgMonInfo
DescendantInfo:
sitesec.RadiusPolicy
DescendantInfo:
optical.AlarmProfile
DescendantInfo:
ipsec.CertProfile
DescendantInfo:
crdtctrl.CtgryMapPolicy
DescendantInfo:
lte.DiameterErrorMappingProfile
DescendantInfo:
ressubscr.HostTrackingPolicy
DescendantInfo:
sasqos.MplsLspExpClassification
DescendantInfo:
ressubscr.IgmpPolicy
DescendantInfo:
lte.AccountingPriorityProfile
DescendantInfo:
rp.RouteNextHopPolicyTemplate
DescendantInfo:
ressubscr.PimPolicy
DescendantInfo:
ltepolicyoptions.DynamicToInternalRuleMap
DescendantInfo:
netca.CardStatsTCAProfile
DescendantInfo:
subscrprofile.Policy
DescendantInfo:
aapolicy.HttpEnrich
DescendantInfo:
ltepolicyoptions.GxAvpOptionProfile
DescendantInfo:
sitesec.LdapPolicy
DescendantInfo:
aclfilter.FilterDefinition
DescendantInfo:
fpresource.FPResourcePolicy
DescendantInfo:
securitypolicy.Zone
DescendantInfo:
ltegw.SCTPProfile
DescendantInfo:
sasqos.QueueMgmtPolicy
DescendantInfo:
sasqos.FcLspExpMap
DescendantInfo:
ltepolicyoptions.TriggerRuleUnitProfile
DescendantInfo:
ressubscr.HttpRedirectPolicy
DescendantInfo:
service.Y1564FrameMixProfile
DescendantInfo:
ltepolicyoptions.PolicyRuleUnit
DescendantInfo:
firewall.MgmtAccessFirewall
DescendantInfo:
ltehomeagent.AbsHomeAgentProfile
DescendantInfo:
firewall.RuleSet
DescendantInfo:
netca.StatsTCAProfile
DescendantInfo:
genericne.MvPolicerPolicy
DescendantInfo:
rp.AbstractSrlgGroupPolicy
DescendantInfo:
lte5g.SbaNudmUecmProf
DescendantInfo:
sasqos.IngressCoSClassification
DescendantInfo:
rp.SrlgGroupPolicy
DescendantInfo:
aaa.RadiusScriptPolicy
DescendantInfo:
nat.SvcChainVasFilterPolicy
DescendantInfo:
aapolicy.DnsIpCache
DescendantInfo:
sasqos.NetworkIngress
DescendantInfo:
ltepolicyoptions.ChargingRuleUnit
DescendantInfo:
aapolicy.AAFlowCfgPolicy
DescendantInfo:
lte5g.HTTP2Profile
DescendantInfo:
sasqos.PortAccessIngress
DescendantInfo:
ltegw.PcscfGroupProfile
DescendantInfo:
multicast.IngrPathMgmtInfoPolicy
DescendantInfo:
sitesec.ManagementAccessFilter
DescendantInfo:
ltetwag.SwwTunnelProfile
DescendantInfo:
ethernetoam.MaintenanceDomain
DescendantInfo:
ipsec.RadiusAuthenticationPolicy
DescendantInfo:
aapolicy.AaStatTcaPolicerCfg
DescendantInfo:
ipsec.TrafficSelectorList
DescendantInfo:
atmpolicy.TrafficDescriptor
DescendantInfo:
sasqos.PortAccessEgress
DescendantInfo:
aapolicy.MpTcpProxy
DescendantInfo:
connprof.VlanConnProfPolicy
DescendantInfo:
opticalacl.IpPattern
DescendantInfo:
policing.PolicerControl
DescendantInfo:
sw.SoftwareRepositoryPolicy
DescendantInfo:
svt.TunnelAdminGroup
DescendantInfo:
optical.OcsAlarmProfile
DescendantInfo:
aclfilterli.BlockReservation
DescendantInfo:
genericne.MvMatchingRulePolicy
DescendantInfo:
mmepolicy.WMMInterfaceProfile
DescendantInfo:
calltrace.TraceProfile
DescendantInfo:
ltepolicyoptions.DhcpServerGroupProfile
DescendantInfo:
service.AbstractSapTemplate
DescendantInfo:
aapolicy.AaTcpValidationTca
DescendantInfo:
ltepmip.S6bAvpOptionProfile
DescendantInfo:
redirectfilter.RedirectPolicy
DescendantInfo:
service.EpipeSapTemplate
DescendantInfo:
lte.AbsGtpProfile
DescendantInfo:
ltegw.AvpOptionProfile
DescendantInfo:
nodelog.FirewallLog
DescendantInfo:
multicast.McastCacInterfacePolicy
DescendantInfo:
nodelog.FilterLog
DescendantInfo:
ixrqos.FcDSCPMap
DescendantInfo:
lte5g.NpcfProfile
DescendantInfo:
ltegw.AbsNodeSelPolicyGroup
DescendantInfo:
sitesec.PasswordPolicy
DescendantInfo:
nat.NatClassifier
DescendantInfo:
aaa.L2tpRadiusAccountingPolicy
DescendantInfo:
dynsvc.DynSvcPolicy
DescendantInfo:
ltepolicyoptions.UsgMonAction
DescendantInfo:
sitesec.TacacsPolicy
DescendantInfo:
ltepolicyoptions.StatsRuleUnit
DescendantInfo:
rp.Community
DescendantInfo:
securitypolicy.Bypass
DescendantInfo:
lte.DnsErrMapProfile
DescendantInfo:
nat.FirewallPolicy
DescendantInfo:
ipsec.IPSecClientDB
DescendantInfo:
lte.QciPolicy
DescendantInfo:
filterprefixlist.PrefixList
DescendantInfo:
netca.OCSStatsTCAProfile
DescendantInfo:
rmon.RemoteNetworkMonitoring
DescendantInfo:
aapolicy.AaFilterAbstract
DescendantInfo:
ltepmip.Pmipv6Profile
DescendantInfo:
lte5g.NrfProfile
DescendantInfo:
pppoe.PPPPolicy
DescendantInfo:
qgroup.EgressQGroupPolicy
DescendantInfo:
aaa.NatRadiusAccountingPolicy
DescendantInfo:
ressubscr.IpoePolicy
DescendantInfo:
securitypolicy.SecurityPolicyDefinition
DescendantInfo:
sitesec.RemoteAuthPolicy
DescendantInfo:
aosqos.QoSNetworkGroups
DescendantInfo:
aapolicy.GtpFilter
DescendantInfo:
lte.FqdnGroupProfile
DescendantInfo:
aclfilter.VlanFilter
DescendantInfo:
lte.DiameterPeerProfile
DescendantInfo:
mpr.RadioQOS
DescendantInfo:
portscheduler.HsmdaSchedulerPolicy
DescendantInfo:
lte5g.N1Profile
DescendantInfo:
lte.PfcpProfile
DescendantInfo:
securitypolicy.HostGroup
DescendantInfo:
ressubscr.RipPolicy
DescendantInfo:
aapolicy.AccessNetworkLocation
DescendantInfo:
lteepdg.IPSecProfile
DescendantInfo:
sitesec.TlsTrustAnchorProfile
DescendantInfo:
connprof.PssConnProfPolicy
DescendantInfo:
lte.DiameterRateLimProfile
DescendantInfo:
ltetwag.TwagChargingProfile
DescendantInfo:
ipsec.IPSecStaticSA
DescendantInfo:
ressubscr.MldPolicy
DescendantInfo:
nodelog.AbstractLog
DescendantInfo:
slaprofile.Policy
DescendantInfo:
wlangw.DsmIpFilterPolicy
DescendantInfo:
aapolicy.AaSubCongDetect
DescendantInfo:
opticalacl.OcsIpFilter
DescendantInfo:
lte.DnsProfile
DescendantInfo:
ipfix.IPFIXExportPolicy
DescendantInfo:
ixrqos.DSCPFCMap
DescendantInfo:
slope.Policy
DescendantInfo:
mpls.Policy
DescendantInfo:
rp.AbstractAdminGroupPolicy
DescendantInfo:
portscheduler.HsmdaWrrPolicy
DescendantInfo:
mmepolicy.MMEEmergencyNumListTblPolicy
DescendantInfo:
lteepdg.EpdgChargingProfile
DescendantInfo:
lte.ErrorMappingProfile
DescendantInfo:
lte.FqdnList
DescendantInfo:
lte.GxProfile
DescendantInfo:
lte.CloudDBProfile
DescendantInfo:
sasqos.Remark
DescendantInfo:
aclfilter.DhcpFilter
DescendantInfo:
slope.NamedPool
DescendantInfo:
qosprofile.McfrEgressQosProfile
DescendantInfo:
ipsec.IkeTransform
DescendantInfo:
lte5g.Oauth2Profile
DescendantInfo:
sitesec.TlsClientProfile
DescendantInfo:
aapolicy.AaStatTcaAbstract
DescendantInfo:
firewall.HostGroup
DescendantInfo:
ressubscr.BgpPeeringPolicy
DescendantInfo:
service.SvcActTestHeadAcceptanceCriteriaTemplate
DescendantInfo:
nodelog.SysLogTarget
DescendantInfo:
aaa.AcctOnOffGroup
DescendantInfo:
lte.UeCallTrace
DescendantInfo:
aclfilter.MacFilter
DescendantInfo:
sas.StreamingDelayTemplate
DescendantInfo:
lte.DefBearerQoSProfile
DescendantInfo:
rp.PolicyObjectBase
DescendantInfo:
service.Y1564TestHeadProfile
DescendantInfo:
igmp.SSMTranslatePolicy
DescendantInfo:
radiusaccounting.Policy
DescendantInfo:
aapolicy.AaTcpOpt
DescendantInfo:
service.SvcActTestHeadFrameSizeTemplate
DescendantInfo:
ipsec.TrustAnchorProfile
DescendantInfo:
ixrqos.PortQosPolicy
DescendantInfo:
nodelog.SecurityLog
DescendantInfo:
ixrqos.IngressClassification
DescendantInfo:
aapolicy.Policy
DescendantInfo:
ipsec.RadiusAccountingPolicy
DescendantInfo:
qosprofile.McfrIngressQosProfile
DescendantInfo:
ressubscr.HostLockoutPolicy
DescendantInfo:
ressubscr.SubMcastCacPolicy
DescendantInfo:
slope.HsmdaPoolPolicy
DescendantInfo:
opticalacl.IpFilter
DescendantInfo:
ixrqos.QueueMgmtPolicy
DescendantInfo:
policy.PSGGenericPolicy
DescendantInfo:
mmepolicy.MMESCTPProfile
DescendantInfo:
aapolicy.AARadiusAccountingPolicy
DescendantInfo:
lte.SgwChargingProfile
DescendantInfo:
multicast.EgressMcastGroup
DescendantInfo:
aapolicy.HttpErrorRedirect
DescendantInfo:
multicast.McastReportDestination
DescendantInfo:
firewall.CPMFirewall
DescendantInfo:
rtr.AbstractAdminGroupPolicy
DescendantInfo:
lte.TrustedPeerListPolicy
DescendantInfo:
lteli.DFPeer
DescendantInfo:
aosqos.QoSMacGroups
DescendantInfo:
ltepolicyoptions.ApnRateControl
DescendantInfo:
hsqos.HsAttachmentPolicy
DescendantInfo:
subscrident.Policy
DescendantInfo:
tod.Policy
DescendantInfo:
lteggsn.CdrAvpOptionProfile
DescendantInfo:
lte.OIOverList
DescendantInfo:
aapolicy.AAGroupPolicy
DescendantInfo:
lte.MMEGroupProfile
DescendantInfo:
lteradius.RadiusGroupProfile
DescendantInfo:
lteli.InterceptionTarget
DescendantInfo:
mmepolicy.MMEProfile
DescendantInfo:
lte.IkeRedList
DescendantInfo:
ltehomeagent.DNSRedirectServer
DescendantInfo:
qosprofile.MlpppIngressQosProfile
DescendantInfo:
dctr.PortProfile
DescendantInfo:
multicast.PackagePolicy
DescendantInfo:
lte.PgwSelectionCandidateList
DescendantInfo:
file.FileTransmissionProfile
DescendantInfo:
genericne.MvFilterPolicy
DescendantInfo:
mmepolicy.MMEGTPProfile
DescendantInfo:
genericne.MvForwardingClassPolicy
DescendantInfo:
ltetwag.DhcpServerProfile
DescendantInfo:
aclfilter.Ipv6ExceptionFilter
DescendantInfo:
aclfilter.DhcpV6Filter
DescendantInfo:
lteradius.RadiusProfile
DescendantInfo:
sitesec.TlsServerProfile
DescendantInfo:
nqueue.Policy
DescendantInfo:
sasqos.AccessEgress
DescendantInfo:
wlangw.DsmTrafficPolicer
DescendantInfo:
lte.UpPeerList
DescendantInfo:
netca.AbstractStatsTCAProfile
DescendantInfo:
sasqos.MpBwPolicy
DescendantInfo:
nat.NatPolicy
DescendantInfo:
ltepolicyoptions.QoSRuleUnit
DescendantInfo:
sas.BinGroup
DescendantInfo:
aapolicy.HttpNotif
DescendantInfo:
ethernetservice.SapProfile
DescendantInfo:
sitesec.CpmIpFilter
DescendantInfo:
mmepolicy.WMMSVCAgreementProfile
DescendantInfo:
connprof.ConnProfPolicy
DescendantInfo:
pae802_1x.RadiusServerPolicy
DescendantInfo:
aapolicy.AaStatTcaCfg
DescendantInfo:
sasqos.PortScheduler
DescendantInfo:
lte.IdiRealmList
DescendantInfo:
sitesec.CertificateAuthProfile
DescendantInfo:
qgroup.RedirectList
DescendantInfo:
ltepolicyoptions.PolicyRuleBase
DescendantInfo:
genericne.MVGenericPolicy
DescendantInfo:
rtr.AdminGroupPolicy
DescendantInfo:
aaa.RadiusServerPolicy
DescendantInfo:
securitypolicy.Profile
DescendantInfo:
lte.PpiMappingProfile
DescendantInfo:
rtr.SharedRiskLinkGroup
DescendantInfo:
aapolicy.AAPortList
DescendantInfo:
lte.AgwChargingProfile
DescendantInfo:
mpls.LspTemplateMvpn
DescendantInfo:
aossas.CPETestHeadProfile
DescendantInfo:
ltegw.ApnListPolicyGroup
DescendantInfo:
ancp.Policy
DescendantInfo:
lte.CCFHProfile
DescendantInfo:
aclfilter.AggregateFilter
DescendantInfo:
lte.IpAddressList
DescendantInfo:
dctr.Profile
DescendantInfo:
hsqos.HsPortPoolPolicy
DescendantInfo:
hsqos.HsPoolPolicy
DescendantInfo:
ltessg.TdfChargingProfile
DescendantInfo:
aaa.IsaRadiusPolicy
DescendantInfo:
ltepolicyoptions.TrafficRedirectProfile
DescendantInfo:
nat.UpnpPolicy
DescendantInfo:
pdnprofile.PacketDataNetworkProfilePolicy
DescendantInfo:
gtp.ApnPolicy
DescendantInfo:
rtr.AbstractSharedRiskLinkGroup
DescendantInfo:
aosqos.QoSCondition
DescendantInfo:
ltetwag.SwwRadiusProfile
DescendantInfo:
svt.PwTemplate
DescendantInfo:
filterprefixlist.ProtocolList
DescendantInfo:
rp.AdminGroupPolicy
DescendantInfo:
rtr.AdminTagPolicy
DescendantInfo:
ltehomeagent.FAHAPeerList
DescendantInfo:
mpls.SRLGStaticConfig
DescendantInfo:
accounting.Policy
DescendantInfo:
lte.PfcpTranslateProfile
DescendantInfo:
aapolicy.AaTcpValidation
DescendantInfo:
lte5g.CHFProfile
DescendantInfo:
opticalacl.AbstractIpFilter
DescendantInfo:
msappolicy.Policy
DescendantInfo:
wlangw.MgwProfile
DescendantInfo:
lte5g.AllowedNFDomainList
DescendantInfo:
mmepolicy.WMMPfmJobEntry
DescendantInfo:
aclfilterli.LiMacFilter
DescendantInfo:
securitypolicy.AppGroup
DescendantInfo:
aapolicy.AaCflowdGroupPolicy
DescendantInfo:
lte.PeerListPolicy
DescendantInfo:
fabricqos.FabricProfile
DescendantInfo:
firewall.FwPolicyDefinition
DescendantInfo:
multicast.McastCacPolicy
DescendantInfo:
rp.PolicyAccountingTemplate
DescendantInfo:
ipsec.AbstractTrustAnchorProfile
DescendantInfo:
aclfilter.GreTunnelTemplate
DescendantInfo:
lte.DiameterProfile
DescendantInfo:
lte.PgwChargingProfile
DescendantInfo:
sasqos.EgressRemarking
DescendantInfo:
aclfilterli.LiIpFilter
DescendantInfo:
ltepolicyoptions.UrrProfile
DescendantInfo:
service.Y1564PayloadProfile
DescendantInfo:
lte5g.UdmIdList
DescendantInfo:
sas.LinkMeasurementTemplate
DescendantInfo:
nat.NatPrefixList
DescendantInfo:
aaa.IsaRadiusPolicyBase
DescendantInfo:
lteradius.AbsRadiusProfile
DescendantInfo:
equipment.PortPolicy
DescendantInfo:
unpprofile.UNPProfile
DescendantInfo:
rtr.ReassemblyProfilePolicy
DescendantInfo:
lte.GtpPrimeServerGroupProfile
DescendantInfo:
lte.Profile
DescendantInfo:
layer2.L2Profile
DescendantInfo:
qosportlist.PortList
DescendantInfo:
lte.ClientProfile
DescendantInfo:
lte.OverloadControlProfile
DescendantInfo:
ressubscr.BrgProfile
DescendantInfo:
firewall.ServiceGroup
DescendantInfo:
vs.ServiceTypeDefinition
DescendantInfo:
qgroup.IngressQGroupPolicy
DescendantInfo:
lte.SubscriberMappingProfile
DescendantInfo:
lte5g.SMFAttributesProfile
DescendantInfo:
ltegw.UMTSQoSPolicy
DescendantInfo:
ltepolicyoptions.ActionRuleUnitProfile
DescendantInfo:
lte.S2bErrorMappingProfile
DescendantInfo:
dynsvc.DynSvcLocalAuthDb
DescendantInfo:
lte5g.EmerProfile
DescendantInfo:
aosqos.List
DescendantInfo:
shaperqos.ShaperPolicy
DescendantInfo:
sasqos.FcDot1pMap
DescendantInfo:
ltessg.SteeringProfile
DescendantInfo:
srpythonmgmt.PythonScript
DescendantInfo:
sasqos.MplsLspExpMap
DescendantInfo:
lte.CreditPoolProfile
DescendantInfo:
ltegw.UDPTunnelGroupProfile
DescendantInfo:
multicast.IngrPathMgmtBwPolicy
DescendantInfo:
aclfilter.Ipv6Filter
DescendantInfo:
aapolicy.AAPrefixListPolicy
DescendantInfo:
ipsec.IPSecTunnelTemplate
DescendantInfo:
nat.PcpPolicy
DescendantInfo:
mmepolicy.WMMPfmMeasGroupName
DescendantInfo:
aosqos.QoSAction
DescendantInfo:
lte5g.EventTriggerFBCProfile
DescendantInfo:
srpythonmgmt.PythonPolicy
DescendantInfo:
aclfilterli.LiFilter
DescendantInfo:
ixrqos.EgressRemarkPolicy
DescendantInfo:
diameter.DiameterPeerPolicy
DescendantInfo:
nat.AbstractNatPlcy
DescendantInfo:
aosqos.Policy
DescendantInfo:
aapolicy.AAPolicer
DescendantInfo:
aclfilter.IpFilter
DescendantInfo:
lte5g.SMFChargingProfile
DescendantInfo:
lte.TargetProfile
DescendantInfo:
lte.GroupLabel
DescendantInfo:
ixrqos.Dot1pFCMap
DescendantInfo:
lte5g.SMFServingAreaList
DescendantInfo:
squeue.Policy
DescendantInfo:
ltetwag.SlaacHostProfile
DescendantInfo:
aaa.RouteDownloadPolicy
DescendantInfo:
ltessg.AddressListProfile
DescendantInfo:
pppoe.PPPPolicyBase
DescendantInfo:
lte.AbsCallInsight
DescendantInfo:
nat.SvcChainEvpnPolicy
DescendantInfo:
aapolicy.AaStatTcaFilterCfg
DescendantInfo:
ltegw.QciListPolicyGroup
DescendantInfo:
aapolicy.AAUrlListPolicy
DescendantInfo:
aapolicy.HttpRedirect
DescendantInfo:
ixrqos.LspExpFCMap
DescendantInfo:
niegr.Policy
DescendantInfo:
securitypolicy.PolicerGroup
DescendantInfo:
aapolicy.AACertProfile
DescendantInfo:
securityqueue.SecurityQueuePolicy
DescendantInfo:
genericne.MvMultitermPolicy
DescendantInfo:
lte.TaiLaiListProfile
DescendantInfo:
nat.MapDomain
DescendantInfo:
nodelog.LogProfile


", "operationId": "rest_policy_PolicyDefinition_getSyncTaskResult", "parameters": [ { "name": "distinguishedName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getSyncTaskResultResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/policy/PolicyDefinition/resetToReleasedPolicy/{instanceFullName}": { "post": { "tags": [ "samo_policy" ], "summary": "rest_policy_PolicyDefinition_resetToReleasedPolicy", "description": "Reset the global policy to the most recent released policy. The local policies are not affected.

Intention : MODIFIER
resetToReleasedPolicy:
instance-level modifier API resetToReleasedPolicy
of class policy.PolicyDefinition
DescendantInfo:
rtr.SegmentRoutingMaintenancePolicy
DescendantInfo:
lte5g.PcfIdList
DescendantInfo:
mplstp.BFDTemplate
DescendantInfo:
ixrqos.VlanQosPolicy
DescendantInfo:
ressubscr.ShcvPolicy
DescendantInfo:
ltepolicyoptions.AssumePositiveActionProfile
DescendantInfo:
ixrqos.FcLspExpMap
DescendantInfo:
aclfilterli.LiIpv6Filter
DescendantInfo:
subscrexpmap.Policy
DescendantInfo:
sitesec.DCpuProtection
DescendantInfo:
rp.ASPathGroup
DescendantInfo:
diameter.DiameterAppPolicy
DescendantInfo:
aclfilter.AbstractFilterDefinition
DescendantInfo:
sasqos.Network
DescendantInfo:
lte.GtpProfile
DescendantInfo:
rp.PolicyStatement
DescendantInfo:
file.Policy
DescendantInfo:
lte.PfcpAPPeerList
DescendantInfo:
ethernetservice.UniProfile
DescendantInfo:
ltepolicyoptions.TrafficHashProfile
DescendantInfo:
sitesec.TlsCertificateProfile
DescendantInfo:
qosprofile.MlpppEgressQosProfile
DescendantInfo:
vs.AdvancedConfigPolicy
DescendantInfo:
sasqos.SchedulerPolicy
DescendantInfo:
aapolicy.AAUrlFilter
DescendantInfo:
genericne.MvQosPolicy
DescendantInfo:
sitesec.PkiCommonNameList
DescendantInfo:
ethernetservice.CustomL2Profile
DescendantInfo:
ltetwag.DiameterPeerGroupList
DescendantInfo:
postpolicermapping.PostPolicerMappingPolicy
DescendantInfo:
aengr.Policy
DescendantInfo:
sitesec.LocalUser
DescendantInfo:
rp.PrefixList
DescendantInfo:
lte5g.NfIdList
DescendantInfo:
rtr.RouteNextHopPolicyTemplate
DescendantInfo:
lte5g.QfiMappingProfile
DescendantInfo:
aapolicy.AbstractTransitPolicy
DescendantInfo:
aclfilter.AbstractExceptionFilter
DescendantInfo:
sasqos.DSCPClassification
DescendantInfo:
lte.WlanEmergencyProfile
DescendantInfo:
portscheduler.Policy
DescendantInfo:
vs.Policy
DescendantInfo:
lteggsn.GyAvpOptionProfile
DescendantInfo:
ixrqos.NetworkIngressPolicy
DescendantInfo:
ixrqos.FcDot1pMap
DescendantInfo:
sasqos.NQueue
DescendantInfo:
aapolicy.TetherDetection
DescendantInfo:
service.Y1564AcceptanceCriteriaProfile
DescendantInfo:
ltepolicyoptions.PolicyRule
DescendantInfo:
lte.Abspfcp
DescendantInfo:
mmepolicy.MMEEmergencyNumListPolicy
DescendantInfo:
sitesec.AOSSecurityPolicy
DescendantInfo:
lte.T6cProfile
DescendantInfo:
lte.EpdgGroupList
DescendantInfo:
slope.HsmdaSlopePolicy
DescendantInfo:
aapolicy.AaStatTcaFltrEntryCfg
DescendantInfo:
lte.SourceIpList
DescendantInfo:
sasqos.FcDscpMap
DescendantInfo:
lte.IPProfile
DescendantInfo:
ipsec.IPSecTransform
DescendantInfo:
subscrauth.Policy
DescendantInfo:
icmp.IcmpPingTemplate
DescendantInfo:
qosprefixlist.PrefixList
DescendantInfo:
sitesec.DoSProtection
DescendantInfo:
lte.DccaProfile
DescendantInfo:
filterprefixlist.PortList
DescendantInfo:
rtr.AdminTag
DescendantInfo:
aapolicy.AASessionFilter
DescendantInfo:
hsqos.HsSchedulerPolicy
DescendantInfo:
ltepolicyoptions.ServiceClassIndicator
DescendantInfo:
sitesec.UserProfile
DescendantInfo:
ltepolicyoptions.SruList
DescendantInfo:
lte.AllUesCallTrace
DescendantInfo:
sitesec.TlsServerCipherList
DescendantInfo:
ltegw.TariffChangeListProfilePolicyGroup
DescendantInfo:
aingr.Policy
DescendantInfo:
aapolicy.AbstractHttpRedirect
DescendantInfo:
ltetwag.StaProfile
DescendantInfo:
redirectfilter.RedirectPolicyBinding
DescendantInfo:
sasqos.FCMeterMap
DescendantInfo:
vrrp.Policy
DescendantInfo:
lte5g.SliceList
DescendantInfo:
sasqos.SlopePolicy
DescendantInfo:
todsuite.Policy
DescendantInfo:
diameter.DiameterPolicy
DescendantInfo:
sasqos.SystemResourceProfilePolicy
DescendantInfo:
genericne.MvAbstractPolicy
DescendantInfo:
aapolicy.TransitPrefixPolicy
DescendantInfo:
sitesec.EstAuthProfile
DescendantInfo:
hwaggshapersched.HwAggShaperSchedulerPolicy
DescendantInfo:
aossas.CPETestHeadGroupProfile
DescendantInfo:
lte5g.PrioAddrList
DescendantInfo:
rp.GlobalVariables
DescendantInfo:
lte5g.SliceInstanceList
DescendantInfo:
lte.DedicatedBearerIdleTimeOutProfile
DescendantInfo:
security.KeyChain
DescendantInfo:
lte.PcmdProfile
DescendantInfo:
lteepdg.SwmAvpOptionProfile
DescendantInfo:
mpls.SharedRiskLinkGroup
DescendantInfo:
sitesec.TlsClientCipherList
DescendantInfo:
lte.AmfIdList
DescendantInfo:
ltehomeagent.MobileIpv4Profile
DescendantInfo:
file.LogDefinition
DescendantInfo:
macsec.MacPolicy
DescendantInfo:
securitypolicy.Policy
DescendantInfo:
ltepolicyoptions.AbsPolicyOptionProfile
DescendantInfo:
aclfilter.IpExceptionFilter
DescendantInfo:
sasqos.Dot1pClassification
DescendantInfo:
ipsec.IkePolicy
DescendantInfo:
mpr.QueueMapPolicy
DescendantInfo:
aapolicy.ApplicationAssurancePolicyDefinition
DescendantInfo:
service.VplsSapTemplate
DescendantInfo:
ltegw.AbsListPolicyGroup
DescendantInfo:
lte.SDProfile
DescendantInfo:
aapolicy.SctpFilter
DescendantInfo:
lte.PlmnListPolicyGroup
DescendantInfo:
mpr.GneRadiusQosPolicy
DescendantInfo:
l2fwd.MrpPolicy
DescendantInfo:
sasqos.AccessIngress
DescendantInfo:
crdtctrl.CrdtCtrlPolicy
DescendantInfo:
lte.PortList
DescendantInfo:
lte5g.SbaNudmSdmProf
DescendantInfo:
rp.Damping
DescendantInfo:
aapolicy.TransitIpPolicy
DescendantInfo:
lte.SwmErrorMappingProfile
DescendantInfo:
firewall.Zone
DescendantInfo:
rp.ASPath
DescendantInfo:
ltepolicyoptions.UsgMonInfo
DescendantInfo:
sitesec.RadiusPolicy
DescendantInfo:
optical.AlarmProfile
DescendantInfo:
ipsec.CertProfile
DescendantInfo:
crdtctrl.CtgryMapPolicy
DescendantInfo:
lte.DiameterErrorMappingProfile
DescendantInfo:
ressubscr.HostTrackingPolicy
DescendantInfo:
sasqos.MplsLspExpClassification
DescendantInfo:
ressubscr.IgmpPolicy
DescendantInfo:
lte.AccountingPriorityProfile
DescendantInfo:
rp.RouteNextHopPolicyTemplate
DescendantInfo:
ressubscr.PimPolicy
DescendantInfo:
ltepolicyoptions.DynamicToInternalRuleMap
DescendantInfo:
netca.CardStatsTCAProfile
DescendantInfo:
subscrprofile.Policy
DescendantInfo:
aapolicy.HttpEnrich
DescendantInfo:
ltepolicyoptions.GxAvpOptionProfile
DescendantInfo:
sitesec.LdapPolicy
DescendantInfo:
aclfilter.FilterDefinition
DescendantInfo:
fpresource.FPResourcePolicy
DescendantInfo:
securitypolicy.Zone
DescendantInfo:
ltegw.SCTPProfile
DescendantInfo:
sasqos.QueueMgmtPolicy
DescendantInfo:
sasqos.FcLspExpMap
DescendantInfo:
ltepolicyoptions.TriggerRuleUnitProfile
DescendantInfo:
ressubscr.HttpRedirectPolicy
DescendantInfo:
service.Y1564FrameMixProfile
DescendantInfo:
ltepolicyoptions.PolicyRuleUnit
DescendantInfo:
firewall.MgmtAccessFirewall
DescendantInfo:
ltehomeagent.AbsHomeAgentProfile
DescendantInfo:
firewall.RuleSet
DescendantInfo:
netca.StatsTCAProfile
DescendantInfo:
genericne.MvPolicerPolicy
DescendantInfo:
rp.AbstractSrlgGroupPolicy
DescendantInfo:
lte5g.SbaNudmUecmProf
DescendantInfo:
sasqos.IngressCoSClassification
DescendantInfo:
rp.SrlgGroupPolicy
DescendantInfo:
aaa.RadiusScriptPolicy
DescendantInfo:
nat.SvcChainVasFilterPolicy
DescendantInfo:
aapolicy.DnsIpCache
DescendantInfo:
sasqos.NetworkIngress
DescendantInfo:
ltepolicyoptions.ChargingRuleUnit
DescendantInfo:
aapolicy.AAFlowCfgPolicy
DescendantInfo:
lte5g.HTTP2Profile
DescendantInfo:
sasqos.PortAccessIngress
DescendantInfo:
ltegw.PcscfGroupProfile
DescendantInfo:
multicast.IngrPathMgmtInfoPolicy
DescendantInfo:
sitesec.ManagementAccessFilter
DescendantInfo:
ltetwag.SwwTunnelProfile
DescendantInfo:
ethernetoam.MaintenanceDomain
DescendantInfo:
ipsec.RadiusAuthenticationPolicy
DescendantInfo:
aapolicy.AaStatTcaPolicerCfg
DescendantInfo:
ipsec.TrafficSelectorList
DescendantInfo:
atmpolicy.TrafficDescriptor
DescendantInfo:
sasqos.PortAccessEgress
DescendantInfo:
aapolicy.MpTcpProxy
DescendantInfo:
connprof.VlanConnProfPolicy
DescendantInfo:
opticalacl.IpPattern
DescendantInfo:
policing.PolicerControl
DescendantInfo:
sw.SoftwareRepositoryPolicy
DescendantInfo:
svt.TunnelAdminGroup
DescendantInfo:
optical.OcsAlarmProfile
DescendantInfo:
aclfilterli.BlockReservation
DescendantInfo:
genericne.MvMatchingRulePolicy
DescendantInfo:
mmepolicy.WMMInterfaceProfile
DescendantInfo:
calltrace.TraceProfile
DescendantInfo:
ltepolicyoptions.DhcpServerGroupProfile
DescendantInfo:
service.AbstractSapTemplate
DescendantInfo:
aapolicy.AaTcpValidationTca
DescendantInfo:
ltepmip.S6bAvpOptionProfile
DescendantInfo:
redirectfilter.RedirectPolicy
DescendantInfo:
service.EpipeSapTemplate
DescendantInfo:
lte.AbsGtpProfile
DescendantInfo:
ltegw.AvpOptionProfile
DescendantInfo:
nodelog.FirewallLog
DescendantInfo:
multicast.McastCacInterfacePolicy
DescendantInfo:
nodelog.FilterLog
DescendantInfo:
ixrqos.FcDSCPMap
DescendantInfo:
lte5g.NpcfProfile
DescendantInfo:
ltegw.AbsNodeSelPolicyGroup
DescendantInfo:
sitesec.PasswordPolicy
DescendantInfo:
nat.NatClassifier
DescendantInfo:
aaa.L2tpRadiusAccountingPolicy
DescendantInfo:
dynsvc.DynSvcPolicy
DescendantInfo:
ltepolicyoptions.UsgMonAction
DescendantInfo:
sitesec.TacacsPolicy
DescendantInfo:
ltepolicyoptions.StatsRuleUnit
DescendantInfo:
rp.Community
DescendantInfo:
securitypolicy.Bypass
DescendantInfo:
lte.DnsErrMapProfile
DescendantInfo:
nat.FirewallPolicy
DescendantInfo:
ipsec.IPSecClientDB
DescendantInfo:
lte.QciPolicy
DescendantInfo:
filterprefixlist.PrefixList
DescendantInfo:
netca.OCSStatsTCAProfile
DescendantInfo:
rmon.RemoteNetworkMonitoring
DescendantInfo:
aapolicy.AaFilterAbstract
DescendantInfo:
ltepmip.Pmipv6Profile
DescendantInfo:
lte5g.NrfProfile
DescendantInfo:
pppoe.PPPPolicy
DescendantInfo:
qgroup.EgressQGroupPolicy
DescendantInfo:
aaa.NatRadiusAccountingPolicy
DescendantInfo:
ressubscr.IpoePolicy
DescendantInfo:
securitypolicy.SecurityPolicyDefinition
DescendantInfo:
sitesec.RemoteAuthPolicy
DescendantInfo:
aosqos.QoSNetworkGroups
DescendantInfo:
aapolicy.GtpFilter
DescendantInfo:
lte.FqdnGroupProfile
DescendantInfo:
aclfilter.VlanFilter
DescendantInfo:
lte.DiameterPeerProfile
DescendantInfo:
mpr.RadioQOS
DescendantInfo:
portscheduler.HsmdaSchedulerPolicy
DescendantInfo:
lte5g.N1Profile
DescendantInfo:
lte.PfcpProfile
DescendantInfo:
securitypolicy.HostGroup
DescendantInfo:
ressubscr.RipPolicy
DescendantInfo:
aapolicy.AccessNetworkLocation
DescendantInfo:
lteepdg.IPSecProfile
DescendantInfo:
sitesec.TlsTrustAnchorProfile
DescendantInfo:
connprof.PssConnProfPolicy
DescendantInfo:
lte.DiameterRateLimProfile
DescendantInfo:
ltetwag.TwagChargingProfile
DescendantInfo:
ipsec.IPSecStaticSA
DescendantInfo:
ressubscr.MldPolicy
DescendantInfo:
nodelog.AbstractLog
DescendantInfo:
slaprofile.Policy
DescendantInfo:
wlangw.DsmIpFilterPolicy
DescendantInfo:
aapolicy.AaSubCongDetect
DescendantInfo:
opticalacl.OcsIpFilter
DescendantInfo:
lte.DnsProfile
DescendantInfo:
ipfix.IPFIXExportPolicy
DescendantInfo:
ixrqos.DSCPFCMap
DescendantInfo:
slope.Policy
DescendantInfo:
mpls.Policy
DescendantInfo:
rp.AbstractAdminGroupPolicy
DescendantInfo:
portscheduler.HsmdaWrrPolicy
DescendantInfo:
mmepolicy.MMEEmergencyNumListTblPolicy
DescendantInfo:
lteepdg.EpdgChargingProfile
DescendantInfo:
lte.ErrorMappingProfile
DescendantInfo:
lte.FqdnList
DescendantInfo:
lte.GxProfile
DescendantInfo:
lte.CloudDBProfile
DescendantInfo:
sasqos.Remark
DescendantInfo:
aclfilter.DhcpFilter
DescendantInfo:
slope.NamedPool
DescendantInfo:
qosprofile.McfrEgressQosProfile
DescendantInfo:
ipsec.IkeTransform
DescendantInfo:
lte5g.Oauth2Profile
DescendantInfo:
sitesec.TlsClientProfile
DescendantInfo:
aapolicy.AaStatTcaAbstract
DescendantInfo:
firewall.HostGroup
DescendantInfo:
ressubscr.BgpPeeringPolicy
DescendantInfo:
service.SvcActTestHeadAcceptanceCriteriaTemplate
DescendantInfo:
nodelog.SysLogTarget
DescendantInfo:
aaa.AcctOnOffGroup
DescendantInfo:
lte.UeCallTrace
DescendantInfo:
aclfilter.MacFilter
DescendantInfo:
sas.StreamingDelayTemplate
DescendantInfo:
lte.DefBearerQoSProfile
DescendantInfo:
rp.PolicyObjectBase
DescendantInfo:
service.Y1564TestHeadProfile
DescendantInfo:
igmp.SSMTranslatePolicy
DescendantInfo:
radiusaccounting.Policy
DescendantInfo:
aapolicy.AaTcpOpt
DescendantInfo:
service.SvcActTestHeadFrameSizeTemplate
DescendantInfo:
ipsec.TrustAnchorProfile
DescendantInfo:
ixrqos.PortQosPolicy
DescendantInfo:
nodelog.SecurityLog
DescendantInfo:
ixrqos.IngressClassification
DescendantInfo:
aapolicy.Policy
DescendantInfo:
ipsec.RadiusAccountingPolicy
DescendantInfo:
qosprofile.McfrIngressQosProfile
DescendantInfo:
ressubscr.HostLockoutPolicy
DescendantInfo:
ressubscr.SubMcastCacPolicy
DescendantInfo:
slope.HsmdaPoolPolicy
DescendantInfo:
opticalacl.IpFilter
DescendantInfo:
ixrqos.QueueMgmtPolicy
DescendantInfo:
policy.PSGGenericPolicy
DescendantInfo:
mmepolicy.MMESCTPProfile
DescendantInfo:
aapolicy.AARadiusAccountingPolicy
DescendantInfo:
lte.SgwChargingProfile
DescendantInfo:
multicast.EgressMcastGroup
DescendantInfo:
aapolicy.HttpErrorRedirect
DescendantInfo:
multicast.McastReportDestination
DescendantInfo:
firewall.CPMFirewall
DescendantInfo:
rtr.AbstractAdminGroupPolicy
DescendantInfo:
lte.TrustedPeerListPolicy
DescendantInfo:
lteli.DFPeer
DescendantInfo:
aosqos.QoSMacGroups
DescendantInfo:
ltepolicyoptions.ApnRateControl
DescendantInfo:
hsqos.HsAttachmentPolicy
DescendantInfo:
subscrident.Policy
DescendantInfo:
tod.Policy
DescendantInfo:
lteggsn.CdrAvpOptionProfile
DescendantInfo:
lte.OIOverList
DescendantInfo:
aapolicy.AAGroupPolicy
DescendantInfo:
lte.MMEGroupProfile
DescendantInfo:
lteradius.RadiusGroupProfile
DescendantInfo:
lteli.InterceptionTarget
DescendantInfo:
mmepolicy.MMEProfile
DescendantInfo:
lte.IkeRedList
DescendantInfo:
ltehomeagent.DNSRedirectServer
DescendantInfo:
qosprofile.MlpppIngressQosProfile
DescendantInfo:
dctr.PortProfile
DescendantInfo:
multicast.PackagePolicy
DescendantInfo:
lte.PgwSelectionCandidateList
DescendantInfo:
file.FileTransmissionProfile
DescendantInfo:
genericne.MvFilterPolicy
DescendantInfo:
mmepolicy.MMEGTPProfile
DescendantInfo:
genericne.MvForwardingClassPolicy
DescendantInfo:
ltetwag.DhcpServerProfile
DescendantInfo:
aclfilter.Ipv6ExceptionFilter
DescendantInfo:
aclfilter.DhcpV6Filter
DescendantInfo:
lteradius.RadiusProfile
DescendantInfo:
sitesec.TlsServerProfile
DescendantInfo:
nqueue.Policy
DescendantInfo:
sasqos.AccessEgress
DescendantInfo:
wlangw.DsmTrafficPolicer
DescendantInfo:
lte.UpPeerList
DescendantInfo:
netca.AbstractStatsTCAProfile
DescendantInfo:
sasqos.MpBwPolicy
DescendantInfo:
nat.NatPolicy
DescendantInfo:
ltepolicyoptions.QoSRuleUnit
DescendantInfo:
sas.BinGroup
DescendantInfo:
aapolicy.HttpNotif
DescendantInfo:
ethernetservice.SapProfile
DescendantInfo:
sitesec.CpmIpFilter
DescendantInfo:
mmepolicy.WMMSVCAgreementProfile
DescendantInfo:
connprof.ConnProfPolicy
DescendantInfo:
pae802_1x.RadiusServerPolicy
DescendantInfo:
aapolicy.AaStatTcaCfg
DescendantInfo:
sasqos.PortScheduler
DescendantInfo:
lte.IdiRealmList
DescendantInfo:
sitesec.CertificateAuthProfile
DescendantInfo:
qgroup.RedirectList
DescendantInfo:
ltepolicyoptions.PolicyRuleBase
DescendantInfo:
genericne.MVGenericPolicy
DescendantInfo:
rtr.AdminGroupPolicy
DescendantInfo:
aaa.RadiusServerPolicy
DescendantInfo:
securitypolicy.Profile
DescendantInfo:
lte.PpiMappingProfile
DescendantInfo:
rtr.SharedRiskLinkGroup
DescendantInfo:
aapolicy.AAPortList
DescendantInfo:
lte.AgwChargingProfile
DescendantInfo:
mpls.LspTemplateMvpn
DescendantInfo:
aossas.CPETestHeadProfile
DescendantInfo:
ltegw.ApnListPolicyGroup
DescendantInfo:
ancp.Policy
DescendantInfo:
lte.CCFHProfile
DescendantInfo:
aclfilter.AggregateFilter
DescendantInfo:
lte.IpAddressList
DescendantInfo:
dctr.Profile
DescendantInfo:
hsqos.HsPortPoolPolicy
DescendantInfo:
hsqos.HsPoolPolicy
DescendantInfo:
ltessg.TdfChargingProfile
DescendantInfo:
aaa.IsaRadiusPolicy
DescendantInfo:
ltepolicyoptions.TrafficRedirectProfile
DescendantInfo:
nat.UpnpPolicy
DescendantInfo:
pdnprofile.PacketDataNetworkProfilePolicy
DescendantInfo:
gtp.ApnPolicy
DescendantInfo:
rtr.AbstractSharedRiskLinkGroup
DescendantInfo:
aosqos.QoSCondition
DescendantInfo:
ltetwag.SwwRadiusProfile
DescendantInfo:
svt.PwTemplate
DescendantInfo:
filterprefixlist.ProtocolList
DescendantInfo:
rp.AdminGroupPolicy
DescendantInfo:
rtr.AdminTagPolicy
DescendantInfo:
ltehomeagent.FAHAPeerList
DescendantInfo:
mpls.SRLGStaticConfig
DescendantInfo:
accounting.Policy
DescendantInfo:
lte.PfcpTranslateProfile
DescendantInfo:
aapolicy.AaTcpValidation
DescendantInfo:
lte5g.CHFProfile
DescendantInfo:
opticalacl.AbstractIpFilter
DescendantInfo:
msappolicy.Policy
DescendantInfo:
wlangw.MgwProfile
DescendantInfo:
lte5g.AllowedNFDomainList
DescendantInfo:
mmepolicy.WMMPfmJobEntry
DescendantInfo:
aclfilterli.LiMacFilter
DescendantInfo:
securitypolicy.AppGroup
DescendantInfo:
aapolicy.AaCflowdGroupPolicy
DescendantInfo:
lte.PeerListPolicy
DescendantInfo:
fabricqos.FabricProfile
DescendantInfo:
firewall.FwPolicyDefinition
DescendantInfo:
multicast.McastCacPolicy
DescendantInfo:
rp.PolicyAccountingTemplate
DescendantInfo:
ipsec.AbstractTrustAnchorProfile
DescendantInfo:
aclfilter.GreTunnelTemplate
DescendantInfo:
lte.DiameterProfile
DescendantInfo:
lte.PgwChargingProfile
DescendantInfo:
sasqos.EgressRemarking
DescendantInfo:
aclfilterli.LiIpFilter
DescendantInfo:
ltepolicyoptions.UrrProfile
DescendantInfo:
service.Y1564PayloadProfile
DescendantInfo:
lte5g.UdmIdList
DescendantInfo:
sas.LinkMeasurementTemplate
DescendantInfo:
nat.NatPrefixList
DescendantInfo:
aaa.IsaRadiusPolicyBase
DescendantInfo:
lteradius.AbsRadiusProfile
DescendantInfo:
equipment.PortPolicy
DescendantInfo:
unpprofile.UNPProfile
DescendantInfo:
rtr.ReassemblyProfilePolicy
DescendantInfo:
lte.GtpPrimeServerGroupProfile
DescendantInfo:
lte.Profile
DescendantInfo:
layer2.L2Profile
DescendantInfo:
qosportlist.PortList
DescendantInfo:
lte.ClientProfile
DescendantInfo:
lte.OverloadControlProfile
DescendantInfo:
ressubscr.BrgProfile
DescendantInfo:
firewall.ServiceGroup
DescendantInfo:
vs.ServiceTypeDefinition
DescendantInfo:
qgroup.IngressQGroupPolicy
DescendantInfo:
lte.SubscriberMappingProfile
DescendantInfo:
lte5g.SMFAttributesProfile
DescendantInfo:
ltegw.UMTSQoSPolicy
DescendantInfo:
ltepolicyoptions.ActionRuleUnitProfile
DescendantInfo:
lte.S2bErrorMappingProfile
DescendantInfo:
dynsvc.DynSvcLocalAuthDb
DescendantInfo:
lte5g.EmerProfile
DescendantInfo:
aosqos.List
DescendantInfo:
shaperqos.ShaperPolicy
DescendantInfo:
sasqos.FcDot1pMap
DescendantInfo:
ltessg.SteeringProfile
DescendantInfo:
srpythonmgmt.PythonScript
DescendantInfo:
sasqos.MplsLspExpMap
DescendantInfo:
lte.CreditPoolProfile
DescendantInfo:
ltegw.UDPTunnelGroupProfile
DescendantInfo:
multicast.IngrPathMgmtBwPolicy
DescendantInfo:
aclfilter.Ipv6Filter
DescendantInfo:
aapolicy.AAPrefixListPolicy
DescendantInfo:
ipsec.IPSecTunnelTemplate
DescendantInfo:
nat.PcpPolicy
DescendantInfo:
mmepolicy.WMMPfmMeasGroupName
DescendantInfo:
aosqos.QoSAction
DescendantInfo:
lte5g.EventTriggerFBCProfile
DescendantInfo:
srpythonmgmt.PythonPolicy
DescendantInfo:
aclfilterli.LiFilter
DescendantInfo:
ixrqos.EgressRemarkPolicy
DescendantInfo:
diameter.DiameterPeerPolicy
DescendantInfo:
nat.AbstractNatPlcy
DescendantInfo:
aosqos.Policy
DescendantInfo:
aapolicy.AAPolicer
DescendantInfo:
aclfilter.IpFilter
DescendantInfo:
lte5g.SMFChargingProfile
DescendantInfo:
lte.TargetProfile
DescendantInfo:
lte.GroupLabel
DescendantInfo:
ixrqos.Dot1pFCMap
DescendantInfo:
lte5g.SMFServingAreaList
DescendantInfo:
squeue.Policy
DescendantInfo:
ltetwag.SlaacHostProfile
DescendantInfo:
aaa.RouteDownloadPolicy
DescendantInfo:
ltessg.AddressListProfile
DescendantInfo:
pppoe.PPPPolicyBase
DescendantInfo:
lte.AbsCallInsight
DescendantInfo:
nat.SvcChainEvpnPolicy
DescendantInfo:
aapolicy.AaStatTcaFilterCfg
DescendantInfo:
ltegw.QciListPolicyGroup
DescendantInfo:
aapolicy.AAUrlListPolicy
DescendantInfo:
aapolicy.HttpRedirect
DescendantInfo:
ixrqos.LspExpFCMap
DescendantInfo:
niegr.Policy
DescendantInfo:
securitypolicy.PolicerGroup
DescendantInfo:
aapolicy.AACertProfile
DescendantInfo:
securityqueue.SecurityQueuePolicy
DescendantInfo:
genericne.MvMultitermPolicy
DescendantInfo:
lte.TaiLaiListProfile
DescendantInfo:
nat.MapDomain
DescendantInfo:
nodelog.LogProfile
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_policy_PolicyDefinition_resetToReleasedPolicy", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resetToReleasedPolicyResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/policy/PolicyDefinition/setConfigurationModeToDraft/{instanceFullName}": { "post": { "tags": [ "samo_policy" ], "summary": "rest_policy_PolicyDefinition_setConfigurationModeToDraft", "description": "Set configuration mode to Draft. It is only applicable for the global policy.

Intention : MODIFIER
setConfigurationModeToDraft:
instance-level modifier API setConfigurationModeToDraft
of class policy.PolicyDefinition
DescendantInfo:
rtr.SegmentRoutingMaintenancePolicy
DescendantInfo:
lte5g.PcfIdList
DescendantInfo:
mplstp.BFDTemplate
DescendantInfo:
ixrqos.VlanQosPolicy
DescendantInfo:
ressubscr.ShcvPolicy
DescendantInfo:
ltepolicyoptions.AssumePositiveActionProfile
DescendantInfo:
ixrqos.FcLspExpMap
DescendantInfo:
aclfilterli.LiIpv6Filter
DescendantInfo:
subscrexpmap.Policy
DescendantInfo:
sitesec.DCpuProtection
DescendantInfo:
rp.ASPathGroup
DescendantInfo:
diameter.DiameterAppPolicy
DescendantInfo:
aclfilter.AbstractFilterDefinition
DescendantInfo:
sasqos.Network
DescendantInfo:
lte.GtpProfile
DescendantInfo:
rp.PolicyStatement
DescendantInfo:
file.Policy
DescendantInfo:
lte.PfcpAPPeerList
DescendantInfo:
ethernetservice.UniProfile
DescendantInfo:
ltepolicyoptions.TrafficHashProfile
DescendantInfo:
sitesec.TlsCertificateProfile
DescendantInfo:
qosprofile.MlpppEgressQosProfile
DescendantInfo:
vs.AdvancedConfigPolicy
DescendantInfo:
sasqos.SchedulerPolicy
DescendantInfo:
aapolicy.AAUrlFilter
DescendantInfo:
genericne.MvQosPolicy
DescendantInfo:
sitesec.PkiCommonNameList
DescendantInfo:
ethernetservice.CustomL2Profile
DescendantInfo:
ltetwag.DiameterPeerGroupList
DescendantInfo:
postpolicermapping.PostPolicerMappingPolicy
DescendantInfo:
aengr.Policy
DescendantInfo:
sitesec.LocalUser
DescendantInfo:
rp.PrefixList
DescendantInfo:
lte5g.NfIdList
DescendantInfo:
rtr.RouteNextHopPolicyTemplate
DescendantInfo:
lte5g.QfiMappingProfile
DescendantInfo:
aapolicy.AbstractTransitPolicy
DescendantInfo:
aclfilter.AbstractExceptionFilter
DescendantInfo:
sasqos.DSCPClassification
DescendantInfo:
lte.WlanEmergencyProfile
DescendantInfo:
portscheduler.Policy
DescendantInfo:
vs.Policy
DescendantInfo:
lteggsn.GyAvpOptionProfile
DescendantInfo:
ixrqos.NetworkIngressPolicy
DescendantInfo:
ixrqos.FcDot1pMap
DescendantInfo:
sasqos.NQueue
DescendantInfo:
aapolicy.TetherDetection
DescendantInfo:
service.Y1564AcceptanceCriteriaProfile
DescendantInfo:
ltepolicyoptions.PolicyRule
DescendantInfo:
lte.Abspfcp
DescendantInfo:
mmepolicy.MMEEmergencyNumListPolicy
DescendantInfo:
sitesec.AOSSecurityPolicy
DescendantInfo:
lte.T6cProfile
DescendantInfo:
lte.EpdgGroupList
DescendantInfo:
slope.HsmdaSlopePolicy
DescendantInfo:
aapolicy.AaStatTcaFltrEntryCfg
DescendantInfo:
lte.SourceIpList
DescendantInfo:
sasqos.FcDscpMap
DescendantInfo:
lte.IPProfile
DescendantInfo:
ipsec.IPSecTransform
DescendantInfo:
subscrauth.Policy
DescendantInfo:
icmp.IcmpPingTemplate
DescendantInfo:
qosprefixlist.PrefixList
DescendantInfo:
sitesec.DoSProtection
DescendantInfo:
lte.DccaProfile
DescendantInfo:
filterprefixlist.PortList
DescendantInfo:
rtr.AdminTag
DescendantInfo:
aapolicy.AASessionFilter
DescendantInfo:
hsqos.HsSchedulerPolicy
DescendantInfo:
ltepolicyoptions.ServiceClassIndicator
DescendantInfo:
sitesec.UserProfile
DescendantInfo:
ltepolicyoptions.SruList
DescendantInfo:
lte.AllUesCallTrace
DescendantInfo:
sitesec.TlsServerCipherList
DescendantInfo:
ltegw.TariffChangeListProfilePolicyGroup
DescendantInfo:
aingr.Policy
DescendantInfo:
aapolicy.AbstractHttpRedirect
DescendantInfo:
ltetwag.StaProfile
DescendantInfo:
redirectfilter.RedirectPolicyBinding
DescendantInfo:
sasqos.FCMeterMap
DescendantInfo:
vrrp.Policy
DescendantInfo:
lte5g.SliceList
DescendantInfo:
sasqos.SlopePolicy
DescendantInfo:
todsuite.Policy
DescendantInfo:
diameter.DiameterPolicy
DescendantInfo:
sasqos.SystemResourceProfilePolicy
DescendantInfo:
genericne.MvAbstractPolicy
DescendantInfo:
aapolicy.TransitPrefixPolicy
DescendantInfo:
sitesec.EstAuthProfile
DescendantInfo:
hwaggshapersched.HwAggShaperSchedulerPolicy
DescendantInfo:
aossas.CPETestHeadGroupProfile
DescendantInfo:
lte5g.PrioAddrList
DescendantInfo:
rp.GlobalVariables
DescendantInfo:
lte5g.SliceInstanceList
DescendantInfo:
lte.DedicatedBearerIdleTimeOutProfile
DescendantInfo:
security.KeyChain
DescendantInfo:
lte.PcmdProfile
DescendantInfo:
lteepdg.SwmAvpOptionProfile
DescendantInfo:
mpls.SharedRiskLinkGroup
DescendantInfo:
sitesec.TlsClientCipherList
DescendantInfo:
lte.AmfIdList
DescendantInfo:
ltehomeagent.MobileIpv4Profile
DescendantInfo:
file.LogDefinition
DescendantInfo:
macsec.MacPolicy
DescendantInfo:
securitypolicy.Policy
DescendantInfo:
ltepolicyoptions.AbsPolicyOptionProfile
DescendantInfo:
aclfilter.IpExceptionFilter
DescendantInfo:
sasqos.Dot1pClassification
DescendantInfo:
ipsec.IkePolicy
DescendantInfo:
mpr.QueueMapPolicy
DescendantInfo:
aapolicy.ApplicationAssurancePolicyDefinition
DescendantInfo:
service.VplsSapTemplate
DescendantInfo:
ltegw.AbsListPolicyGroup
DescendantInfo:
lte.SDProfile
DescendantInfo:
aapolicy.SctpFilter
DescendantInfo:
lte.PlmnListPolicyGroup
DescendantInfo:
mpr.GneRadiusQosPolicy
DescendantInfo:
l2fwd.MrpPolicy
DescendantInfo:
sasqos.AccessIngress
DescendantInfo:
crdtctrl.CrdtCtrlPolicy
DescendantInfo:
lte.PortList
DescendantInfo:
lte5g.SbaNudmSdmProf
DescendantInfo:
rp.Damping
DescendantInfo:
aapolicy.TransitIpPolicy
DescendantInfo:
lte.SwmErrorMappingProfile
DescendantInfo:
firewall.Zone
DescendantInfo:
rp.ASPath
DescendantInfo:
ltepolicyoptions.UsgMonInfo
DescendantInfo:
sitesec.RadiusPolicy
DescendantInfo:
optical.AlarmProfile
DescendantInfo:
ipsec.CertProfile
DescendantInfo:
crdtctrl.CtgryMapPolicy
DescendantInfo:
lte.DiameterErrorMappingProfile
DescendantInfo:
ressubscr.HostTrackingPolicy
DescendantInfo:
sasqos.MplsLspExpClassification
DescendantInfo:
ressubscr.IgmpPolicy
DescendantInfo:
lte.AccountingPriorityProfile
DescendantInfo:
rp.RouteNextHopPolicyTemplate
DescendantInfo:
ressubscr.PimPolicy
DescendantInfo:
ltepolicyoptions.DynamicToInternalRuleMap
DescendantInfo:
netca.CardStatsTCAProfile
DescendantInfo:
subscrprofile.Policy
DescendantInfo:
aapolicy.HttpEnrich
DescendantInfo:
ltepolicyoptions.GxAvpOptionProfile
DescendantInfo:
sitesec.LdapPolicy
DescendantInfo:
aclfilter.FilterDefinition
DescendantInfo:
fpresource.FPResourcePolicy
DescendantInfo:
securitypolicy.Zone
DescendantInfo:
ltegw.SCTPProfile
DescendantInfo:
sasqos.QueueMgmtPolicy
DescendantInfo:
sasqos.FcLspExpMap
DescendantInfo:
ltepolicyoptions.TriggerRuleUnitProfile
DescendantInfo:
ressubscr.HttpRedirectPolicy
DescendantInfo:
service.Y1564FrameMixProfile
DescendantInfo:
ltepolicyoptions.PolicyRuleUnit
DescendantInfo:
firewall.MgmtAccessFirewall
DescendantInfo:
ltehomeagent.AbsHomeAgentProfile
DescendantInfo:
firewall.RuleSet
DescendantInfo:
netca.StatsTCAProfile
DescendantInfo:
genericne.MvPolicerPolicy
DescendantInfo:
rp.AbstractSrlgGroupPolicy
DescendantInfo:
lte5g.SbaNudmUecmProf
DescendantInfo:
sasqos.IngressCoSClassification
DescendantInfo:
rp.SrlgGroupPolicy
DescendantInfo:
aaa.RadiusScriptPolicy
DescendantInfo:
nat.SvcChainVasFilterPolicy
DescendantInfo:
aapolicy.DnsIpCache
DescendantInfo:
sasqos.NetworkIngress
DescendantInfo:
ltepolicyoptions.ChargingRuleUnit
DescendantInfo:
aapolicy.AAFlowCfgPolicy
DescendantInfo:
lte5g.HTTP2Profile
DescendantInfo:
sasqos.PortAccessIngress
DescendantInfo:
ltegw.PcscfGroupProfile
DescendantInfo:
multicast.IngrPathMgmtInfoPolicy
DescendantInfo:
sitesec.ManagementAccessFilter
DescendantInfo:
ltetwag.SwwTunnelProfile
DescendantInfo:
ethernetoam.MaintenanceDomain
DescendantInfo:
ipsec.RadiusAuthenticationPolicy
DescendantInfo:
aapolicy.AaStatTcaPolicerCfg
DescendantInfo:
ipsec.TrafficSelectorList
DescendantInfo:
atmpolicy.TrafficDescriptor
DescendantInfo:
sasqos.PortAccessEgress
DescendantInfo:
aapolicy.MpTcpProxy
DescendantInfo:
connprof.VlanConnProfPolicy
DescendantInfo:
opticalacl.IpPattern
DescendantInfo:
policing.PolicerControl
DescendantInfo:
sw.SoftwareRepositoryPolicy
DescendantInfo:
svt.TunnelAdminGroup
DescendantInfo:
optical.OcsAlarmProfile
DescendantInfo:
aclfilterli.BlockReservation
DescendantInfo:
genericne.MvMatchingRulePolicy
DescendantInfo:
mmepolicy.WMMInterfaceProfile
DescendantInfo:
calltrace.TraceProfile
DescendantInfo:
ltepolicyoptions.DhcpServerGroupProfile
DescendantInfo:
service.AbstractSapTemplate
DescendantInfo:
aapolicy.AaTcpValidationTca
DescendantInfo:
ltepmip.S6bAvpOptionProfile
DescendantInfo:
redirectfilter.RedirectPolicy
DescendantInfo:
service.EpipeSapTemplate
DescendantInfo:
lte.AbsGtpProfile
DescendantInfo:
ltegw.AvpOptionProfile
DescendantInfo:
nodelog.FirewallLog
DescendantInfo:
multicast.McastCacInterfacePolicy
DescendantInfo:
nodelog.FilterLog
DescendantInfo:
ixrqos.FcDSCPMap
DescendantInfo:
lte5g.NpcfProfile
DescendantInfo:
ltegw.AbsNodeSelPolicyGroup
DescendantInfo:
sitesec.PasswordPolicy
DescendantInfo:
nat.NatClassifier
DescendantInfo:
aaa.L2tpRadiusAccountingPolicy
DescendantInfo:
dynsvc.DynSvcPolicy
DescendantInfo:
ltepolicyoptions.UsgMonAction
DescendantInfo:
sitesec.TacacsPolicy
DescendantInfo:
ltepolicyoptions.StatsRuleUnit
DescendantInfo:
rp.Community
DescendantInfo:
securitypolicy.Bypass
DescendantInfo:
lte.DnsErrMapProfile
DescendantInfo:
nat.FirewallPolicy
DescendantInfo:
ipsec.IPSecClientDB
DescendantInfo:
lte.QciPolicy
DescendantInfo:
filterprefixlist.PrefixList
DescendantInfo:
netca.OCSStatsTCAProfile
DescendantInfo:
rmon.RemoteNetworkMonitoring
DescendantInfo:
aapolicy.AaFilterAbstract
DescendantInfo:
ltepmip.Pmipv6Profile
DescendantInfo:
lte5g.NrfProfile
DescendantInfo:
pppoe.PPPPolicy
DescendantInfo:
qgroup.EgressQGroupPolicy
DescendantInfo:
aaa.NatRadiusAccountingPolicy
DescendantInfo:
ressubscr.IpoePolicy
DescendantInfo:
securitypolicy.SecurityPolicyDefinition
DescendantInfo:
sitesec.RemoteAuthPolicy
DescendantInfo:
aosqos.QoSNetworkGroups
DescendantInfo:
aapolicy.GtpFilter
DescendantInfo:
lte.FqdnGroupProfile
DescendantInfo:
aclfilter.VlanFilter
DescendantInfo:
lte.DiameterPeerProfile
DescendantInfo:
mpr.RadioQOS
DescendantInfo:
portscheduler.HsmdaSchedulerPolicy
DescendantInfo:
lte5g.N1Profile
DescendantInfo:
lte.PfcpProfile
DescendantInfo:
securitypolicy.HostGroup
DescendantInfo:
ressubscr.RipPolicy
DescendantInfo:
aapolicy.AccessNetworkLocation
DescendantInfo:
lteepdg.IPSecProfile
DescendantInfo:
sitesec.TlsTrustAnchorProfile
DescendantInfo:
connprof.PssConnProfPolicy
DescendantInfo:
lte.DiameterRateLimProfile
DescendantInfo:
ltetwag.TwagChargingProfile
DescendantInfo:
ipsec.IPSecStaticSA
DescendantInfo:
ressubscr.MldPolicy
DescendantInfo:
nodelog.AbstractLog
DescendantInfo:
slaprofile.Policy
DescendantInfo:
wlangw.DsmIpFilterPolicy
DescendantInfo:
aapolicy.AaSubCongDetect
DescendantInfo:
opticalacl.OcsIpFilter
DescendantInfo:
lte.DnsProfile
DescendantInfo:
ipfix.IPFIXExportPolicy
DescendantInfo:
ixrqos.DSCPFCMap
DescendantInfo:
slope.Policy
DescendantInfo:
mpls.Policy
DescendantInfo:
rp.AbstractAdminGroupPolicy
DescendantInfo:
portscheduler.HsmdaWrrPolicy
DescendantInfo:
mmepolicy.MMEEmergencyNumListTblPolicy
DescendantInfo:
lteepdg.EpdgChargingProfile
DescendantInfo:
lte.ErrorMappingProfile
DescendantInfo:
lte.FqdnList
DescendantInfo:
lte.GxProfile
DescendantInfo:
lte.CloudDBProfile
DescendantInfo:
sasqos.Remark
DescendantInfo:
aclfilter.DhcpFilter
DescendantInfo:
slope.NamedPool
DescendantInfo:
qosprofile.McfrEgressQosProfile
DescendantInfo:
ipsec.IkeTransform
DescendantInfo:
lte5g.Oauth2Profile
DescendantInfo:
sitesec.TlsClientProfile
DescendantInfo:
aapolicy.AaStatTcaAbstract
DescendantInfo:
firewall.HostGroup
DescendantInfo:
ressubscr.BgpPeeringPolicy
DescendantInfo:
service.SvcActTestHeadAcceptanceCriteriaTemplate
DescendantInfo:
nodelog.SysLogTarget
DescendantInfo:
aaa.AcctOnOffGroup
DescendantInfo:
lte.UeCallTrace
DescendantInfo:
aclfilter.MacFilter
DescendantInfo:
sas.StreamingDelayTemplate
DescendantInfo:
lte.DefBearerQoSProfile
DescendantInfo:
rp.PolicyObjectBase
DescendantInfo:
service.Y1564TestHeadProfile
DescendantInfo:
igmp.SSMTranslatePolicy
DescendantInfo:
radiusaccounting.Policy
DescendantInfo:
aapolicy.AaTcpOpt
DescendantInfo:
service.SvcActTestHeadFrameSizeTemplate
DescendantInfo:
ipsec.TrustAnchorProfile
DescendantInfo:
ixrqos.PortQosPolicy
DescendantInfo:
nodelog.SecurityLog
DescendantInfo:
ixrqos.IngressClassification
DescendantInfo:
aapolicy.Policy
DescendantInfo:
ipsec.RadiusAccountingPolicy
DescendantInfo:
qosprofile.McfrIngressQosProfile
DescendantInfo:
ressubscr.HostLockoutPolicy
DescendantInfo:
ressubscr.SubMcastCacPolicy
DescendantInfo:
slope.HsmdaPoolPolicy
DescendantInfo:
opticalacl.IpFilter
DescendantInfo:
ixrqos.QueueMgmtPolicy
DescendantInfo:
policy.PSGGenericPolicy
DescendantInfo:
mmepolicy.MMESCTPProfile
DescendantInfo:
aapolicy.AARadiusAccountingPolicy
DescendantInfo:
lte.SgwChargingProfile
DescendantInfo:
multicast.EgressMcastGroup
DescendantInfo:
aapolicy.HttpErrorRedirect
DescendantInfo:
multicast.McastReportDestination
DescendantInfo:
firewall.CPMFirewall
DescendantInfo:
rtr.AbstractAdminGroupPolicy
DescendantInfo:
lte.TrustedPeerListPolicy
DescendantInfo:
lteli.DFPeer
DescendantInfo:
aosqos.QoSMacGroups
DescendantInfo:
ltepolicyoptions.ApnRateControl
DescendantInfo:
hsqos.HsAttachmentPolicy
DescendantInfo:
subscrident.Policy
DescendantInfo:
tod.Policy
DescendantInfo:
lteggsn.CdrAvpOptionProfile
DescendantInfo:
lte.OIOverList
DescendantInfo:
aapolicy.AAGroupPolicy
DescendantInfo:
lte.MMEGroupProfile
DescendantInfo:
lteradius.RadiusGroupProfile
DescendantInfo:
lteli.InterceptionTarget
DescendantInfo:
mmepolicy.MMEProfile
DescendantInfo:
lte.IkeRedList
DescendantInfo:
ltehomeagent.DNSRedirectServer
DescendantInfo:
qosprofile.MlpppIngressQosProfile
DescendantInfo:
dctr.PortProfile
DescendantInfo:
multicast.PackagePolicy
DescendantInfo:
lte.PgwSelectionCandidateList
DescendantInfo:
file.FileTransmissionProfile
DescendantInfo:
genericne.MvFilterPolicy
DescendantInfo:
mmepolicy.MMEGTPProfile
DescendantInfo:
genericne.MvForwardingClassPolicy
DescendantInfo:
ltetwag.DhcpServerProfile
DescendantInfo:
aclfilter.Ipv6ExceptionFilter
DescendantInfo:
aclfilter.DhcpV6Filter
DescendantInfo:
lteradius.RadiusProfile
DescendantInfo:
sitesec.TlsServerProfile
DescendantInfo:
nqueue.Policy
DescendantInfo:
sasqos.AccessEgress
DescendantInfo:
wlangw.DsmTrafficPolicer
DescendantInfo:
lte.UpPeerList
DescendantInfo:
netca.AbstractStatsTCAProfile
DescendantInfo:
sasqos.MpBwPolicy
DescendantInfo:
nat.NatPolicy
DescendantInfo:
ltepolicyoptions.QoSRuleUnit
DescendantInfo:
sas.BinGroup
DescendantInfo:
aapolicy.HttpNotif
DescendantInfo:
ethernetservice.SapProfile
DescendantInfo:
sitesec.CpmIpFilter
DescendantInfo:
mmepolicy.WMMSVCAgreementProfile
DescendantInfo:
connprof.ConnProfPolicy
DescendantInfo:
pae802_1x.RadiusServerPolicy
DescendantInfo:
aapolicy.AaStatTcaCfg
DescendantInfo:
sasqos.PortScheduler
DescendantInfo:
lte.IdiRealmList
DescendantInfo:
sitesec.CertificateAuthProfile
DescendantInfo:
qgroup.RedirectList
DescendantInfo:
ltepolicyoptions.PolicyRuleBase
DescendantInfo:
genericne.MVGenericPolicy
DescendantInfo:
rtr.AdminGroupPolicy
DescendantInfo:
aaa.RadiusServerPolicy
DescendantInfo:
securitypolicy.Profile
DescendantInfo:
lte.PpiMappingProfile
DescendantInfo:
rtr.SharedRiskLinkGroup
DescendantInfo:
aapolicy.AAPortList
DescendantInfo:
lte.AgwChargingProfile
DescendantInfo:
mpls.LspTemplateMvpn
DescendantInfo:
aossas.CPETestHeadProfile
DescendantInfo:
ltegw.ApnListPolicyGroup
DescendantInfo:
ancp.Policy
DescendantInfo:
lte.CCFHProfile
DescendantInfo:
aclfilter.AggregateFilter
DescendantInfo:
lte.IpAddressList
DescendantInfo:
dctr.Profile
DescendantInfo:
hsqos.HsPortPoolPolicy
DescendantInfo:
hsqos.HsPoolPolicy
DescendantInfo:
ltessg.TdfChargingProfile
DescendantInfo:
aaa.IsaRadiusPolicy
DescendantInfo:
ltepolicyoptions.TrafficRedirectProfile
DescendantInfo:
nat.UpnpPolicy
DescendantInfo:
pdnprofile.PacketDataNetworkProfilePolicy
DescendantInfo:
gtp.ApnPolicy
DescendantInfo:
rtr.AbstractSharedRiskLinkGroup
DescendantInfo:
aosqos.QoSCondition
DescendantInfo:
ltetwag.SwwRadiusProfile
DescendantInfo:
svt.PwTemplate
DescendantInfo:
filterprefixlist.ProtocolList
DescendantInfo:
rp.AdminGroupPolicy
DescendantInfo:
rtr.AdminTagPolicy
DescendantInfo:
ltehomeagent.FAHAPeerList
DescendantInfo:
mpls.SRLGStaticConfig
DescendantInfo:
accounting.Policy
DescendantInfo:
lte.PfcpTranslateProfile
DescendantInfo:
aapolicy.AaTcpValidation
DescendantInfo:
lte5g.CHFProfile
DescendantInfo:
opticalacl.AbstractIpFilter
DescendantInfo:
msappolicy.Policy
DescendantInfo:
wlangw.MgwProfile
DescendantInfo:
lte5g.AllowedNFDomainList
DescendantInfo:
mmepolicy.WMMPfmJobEntry
DescendantInfo:
aclfilterli.LiMacFilter
DescendantInfo:
securitypolicy.AppGroup
DescendantInfo:
aapolicy.AaCflowdGroupPolicy
DescendantInfo:
lte.PeerListPolicy
DescendantInfo:
fabricqos.FabricProfile
DescendantInfo:
firewall.FwPolicyDefinition
DescendantInfo:
multicast.McastCacPolicy
DescendantInfo:
rp.PolicyAccountingTemplate
DescendantInfo:
ipsec.AbstractTrustAnchorProfile
DescendantInfo:
aclfilter.GreTunnelTemplate
DescendantInfo:
lte.DiameterProfile
DescendantInfo:
lte.PgwChargingProfile
DescendantInfo:
sasqos.EgressRemarking
DescendantInfo:
aclfilterli.LiIpFilter
DescendantInfo:
ltepolicyoptions.UrrProfile
DescendantInfo:
service.Y1564PayloadProfile
DescendantInfo:
lte5g.UdmIdList
DescendantInfo:
sas.LinkMeasurementTemplate
DescendantInfo:
nat.NatPrefixList
DescendantInfo:
aaa.IsaRadiusPolicyBase
DescendantInfo:
lteradius.AbsRadiusProfile
DescendantInfo:
equipment.PortPolicy
DescendantInfo:
unpprofile.UNPProfile
DescendantInfo:
rtr.ReassemblyProfilePolicy
DescendantInfo:
lte.GtpPrimeServerGroupProfile
DescendantInfo:
lte.Profile
DescendantInfo:
layer2.L2Profile
DescendantInfo:
qosportlist.PortList
DescendantInfo:
lte.ClientProfile
DescendantInfo:
lte.OverloadControlProfile
DescendantInfo:
ressubscr.BrgProfile
DescendantInfo:
firewall.ServiceGroup
DescendantInfo:
vs.ServiceTypeDefinition
DescendantInfo:
qgroup.IngressQGroupPolicy
DescendantInfo:
lte.SubscriberMappingProfile
DescendantInfo:
lte5g.SMFAttributesProfile
DescendantInfo:
ltegw.UMTSQoSPolicy
DescendantInfo:
ltepolicyoptions.ActionRuleUnitProfile
DescendantInfo:
lte.S2bErrorMappingProfile
DescendantInfo:
dynsvc.DynSvcLocalAuthDb
DescendantInfo:
lte5g.EmerProfile
DescendantInfo:
aosqos.List
DescendantInfo:
shaperqos.ShaperPolicy
DescendantInfo:
sasqos.FcDot1pMap
DescendantInfo:
ltessg.SteeringProfile
DescendantInfo:
srpythonmgmt.PythonScript
DescendantInfo:
sasqos.MplsLspExpMap
DescendantInfo:
lte.CreditPoolProfile
DescendantInfo:
ltegw.UDPTunnelGroupProfile
DescendantInfo:
multicast.IngrPathMgmtBwPolicy
DescendantInfo:
aclfilter.Ipv6Filter
DescendantInfo:
aapolicy.AAPrefixListPolicy
DescendantInfo:
ipsec.IPSecTunnelTemplate
DescendantInfo:
nat.PcpPolicy
DescendantInfo:
mmepolicy.WMMPfmMeasGroupName
DescendantInfo:
aosqos.QoSAction
DescendantInfo:
lte5g.EventTriggerFBCProfile
DescendantInfo:
srpythonmgmt.PythonPolicy
DescendantInfo:
aclfilterli.LiFilter
DescendantInfo:
ixrqos.EgressRemarkPolicy
DescendantInfo:
diameter.DiameterPeerPolicy
DescendantInfo:
nat.AbstractNatPlcy
DescendantInfo:
aosqos.Policy
DescendantInfo:
aapolicy.AAPolicer
DescendantInfo:
aclfilter.IpFilter
DescendantInfo:
lte5g.SMFChargingProfile
DescendantInfo:
lte.TargetProfile
DescendantInfo:
lte.GroupLabel
DescendantInfo:
ixrqos.Dot1pFCMap
DescendantInfo:
lte5g.SMFServingAreaList
DescendantInfo:
squeue.Policy
DescendantInfo:
ltetwag.SlaacHostProfile
DescendantInfo:
aaa.RouteDownloadPolicy
DescendantInfo:
ltessg.AddressListProfile
DescendantInfo:
pppoe.PPPPolicyBase
DescendantInfo:
lte.AbsCallInsight
DescendantInfo:
nat.SvcChainEvpnPolicy
DescendantInfo:
aapolicy.AaStatTcaFilterCfg
DescendantInfo:
ltegw.QciListPolicyGroup
DescendantInfo:
aapolicy.AAUrlListPolicy
DescendantInfo:
aapolicy.HttpRedirect
DescendantInfo:
ixrqos.LspExpFCMap
DescendantInfo:
niegr.Policy
DescendantInfo:
securitypolicy.PolicerGroup
DescendantInfo:
aapolicy.AACertProfile
DescendantInfo:
securityqueue.SecurityQueuePolicy
DescendantInfo:
genericne.MvMultitermPolicy
DescendantInfo:
lte.TaiLaiListProfile
DescendantInfo:
nat.MapDomain
DescendantInfo:
nodelog.LogProfile
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_policy_PolicyDefinition_setConfigurationModeToDraft", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setConfigurationModeToDraftResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/policy/PolicyDefinition/setConfigurationModeToReleased/{instanceFullName}": { "post": { "tags": [ "samo_policy" ], "summary": "rest_policy_PolicyDefinition_setConfigurationModeToReleased", "description": "Sets the configuration mode to Released and distributes the global policy to
the local definitions network-wide. It is only applicable for the global policy.

Intention : MODIFIER
setConfigurationModeToReleased:
instance-level modifier API setConfigurationModeToReleased
of class policy.PolicyDefinition
DescendantInfo:
rtr.SegmentRoutingMaintenancePolicy
DescendantInfo:
lte5g.PcfIdList
DescendantInfo:
mplstp.BFDTemplate
DescendantInfo:
ixrqos.VlanQosPolicy
DescendantInfo:
ressubscr.ShcvPolicy
DescendantInfo:
ltepolicyoptions.AssumePositiveActionProfile
DescendantInfo:
ixrqos.FcLspExpMap
DescendantInfo:
aclfilterli.LiIpv6Filter
DescendantInfo:
subscrexpmap.Policy
DescendantInfo:
sitesec.DCpuProtection
DescendantInfo:
rp.ASPathGroup
DescendantInfo:
diameter.DiameterAppPolicy
DescendantInfo:
aclfilter.AbstractFilterDefinition
DescendantInfo:
sasqos.Network
DescendantInfo:
lte.GtpProfile
DescendantInfo:
rp.PolicyStatement
DescendantInfo:
file.Policy
DescendantInfo:
lte.PfcpAPPeerList
DescendantInfo:
ethernetservice.UniProfile
DescendantInfo:
ltepolicyoptions.TrafficHashProfile
DescendantInfo:
sitesec.TlsCertificateProfile
DescendantInfo:
qosprofile.MlpppEgressQosProfile
DescendantInfo:
vs.AdvancedConfigPolicy
DescendantInfo:
sasqos.SchedulerPolicy
DescendantInfo:
aapolicy.AAUrlFilter
DescendantInfo:
genericne.MvQosPolicy
DescendantInfo:
sitesec.PkiCommonNameList
DescendantInfo:
ethernetservice.CustomL2Profile
DescendantInfo:
ltetwag.DiameterPeerGroupList
DescendantInfo:
postpolicermapping.PostPolicerMappingPolicy
DescendantInfo:
aengr.Policy
DescendantInfo:
sitesec.LocalUser
DescendantInfo:
rp.PrefixList
DescendantInfo:
lte5g.NfIdList
DescendantInfo:
rtr.RouteNextHopPolicyTemplate
DescendantInfo:
lte5g.QfiMappingProfile
DescendantInfo:
aapolicy.AbstractTransitPolicy
DescendantInfo:
aclfilter.AbstractExceptionFilter
DescendantInfo:
sasqos.DSCPClassification
DescendantInfo:
lte.WlanEmergencyProfile
DescendantInfo:
portscheduler.Policy
DescendantInfo:
vs.Policy
DescendantInfo:
lteggsn.GyAvpOptionProfile
DescendantInfo:
ixrqos.NetworkIngressPolicy
DescendantInfo:
ixrqos.FcDot1pMap
DescendantInfo:
sasqos.NQueue
DescendantInfo:
aapolicy.TetherDetection
DescendantInfo:
service.Y1564AcceptanceCriteriaProfile
DescendantInfo:
ltepolicyoptions.PolicyRule
DescendantInfo:
lte.Abspfcp
DescendantInfo:
mmepolicy.MMEEmergencyNumListPolicy
DescendantInfo:
sitesec.AOSSecurityPolicy
DescendantInfo:
lte.T6cProfile
DescendantInfo:
lte.EpdgGroupList
DescendantInfo:
slope.HsmdaSlopePolicy
DescendantInfo:
aapolicy.AaStatTcaFltrEntryCfg
DescendantInfo:
lte.SourceIpList
DescendantInfo:
sasqos.FcDscpMap
DescendantInfo:
lte.IPProfile
DescendantInfo:
ipsec.IPSecTransform
DescendantInfo:
subscrauth.Policy
DescendantInfo:
icmp.IcmpPingTemplate
DescendantInfo:
qosprefixlist.PrefixList
DescendantInfo:
sitesec.DoSProtection
DescendantInfo:
lte.DccaProfile
DescendantInfo:
filterprefixlist.PortList
DescendantInfo:
rtr.AdminTag
DescendantInfo:
aapolicy.AASessionFilter
DescendantInfo:
hsqos.HsSchedulerPolicy
DescendantInfo:
ltepolicyoptions.ServiceClassIndicator
DescendantInfo:
sitesec.UserProfile
DescendantInfo:
ltepolicyoptions.SruList
DescendantInfo:
lte.AllUesCallTrace
DescendantInfo:
sitesec.TlsServerCipherList
DescendantInfo:
ltegw.TariffChangeListProfilePolicyGroup
DescendantInfo:
aingr.Policy
DescendantInfo:
aapolicy.AbstractHttpRedirect
DescendantInfo:
ltetwag.StaProfile
DescendantInfo:
redirectfilter.RedirectPolicyBinding
DescendantInfo:
sasqos.FCMeterMap
DescendantInfo:
vrrp.Policy
DescendantInfo:
lte5g.SliceList
DescendantInfo:
sasqos.SlopePolicy
DescendantInfo:
todsuite.Policy
DescendantInfo:
diameter.DiameterPolicy
DescendantInfo:
sasqos.SystemResourceProfilePolicy
DescendantInfo:
genericne.MvAbstractPolicy
DescendantInfo:
aapolicy.TransitPrefixPolicy
DescendantInfo:
sitesec.EstAuthProfile
DescendantInfo:
hwaggshapersched.HwAggShaperSchedulerPolicy
DescendantInfo:
aossas.CPETestHeadGroupProfile
DescendantInfo:
lte5g.PrioAddrList
DescendantInfo:
rp.GlobalVariables
DescendantInfo:
lte5g.SliceInstanceList
DescendantInfo:
lte.DedicatedBearerIdleTimeOutProfile
DescendantInfo:
security.KeyChain
DescendantInfo:
lte.PcmdProfile
DescendantInfo:
lteepdg.SwmAvpOptionProfile
DescendantInfo:
mpls.SharedRiskLinkGroup
DescendantInfo:
sitesec.TlsClientCipherList
DescendantInfo:
lte.AmfIdList
DescendantInfo:
ltehomeagent.MobileIpv4Profile
DescendantInfo:
file.LogDefinition
DescendantInfo:
macsec.MacPolicy
DescendantInfo:
securitypolicy.Policy
DescendantInfo:
ltepolicyoptions.AbsPolicyOptionProfile
DescendantInfo:
aclfilter.IpExceptionFilter
DescendantInfo:
sasqos.Dot1pClassification
DescendantInfo:
ipsec.IkePolicy
DescendantInfo:
mpr.QueueMapPolicy
DescendantInfo:
aapolicy.ApplicationAssurancePolicyDefinition
DescendantInfo:
service.VplsSapTemplate
DescendantInfo:
ltegw.AbsListPolicyGroup
DescendantInfo:
lte.SDProfile
DescendantInfo:
aapolicy.SctpFilter
DescendantInfo:
lte.PlmnListPolicyGroup
DescendantInfo:
mpr.GneRadiusQosPolicy
DescendantInfo:
l2fwd.MrpPolicy
DescendantInfo:
sasqos.AccessIngress
DescendantInfo:
crdtctrl.CrdtCtrlPolicy
DescendantInfo:
lte.PortList
DescendantInfo:
lte5g.SbaNudmSdmProf
DescendantInfo:
rp.Damping
DescendantInfo:
aapolicy.TransitIpPolicy
DescendantInfo:
lte.SwmErrorMappingProfile
DescendantInfo:
firewall.Zone
DescendantInfo:
rp.ASPath
DescendantInfo:
ltepolicyoptions.UsgMonInfo
DescendantInfo:
sitesec.RadiusPolicy
DescendantInfo:
optical.AlarmProfile
DescendantInfo:
ipsec.CertProfile
DescendantInfo:
crdtctrl.CtgryMapPolicy
DescendantInfo:
lte.DiameterErrorMappingProfile
DescendantInfo:
ressubscr.HostTrackingPolicy
DescendantInfo:
sasqos.MplsLspExpClassification
DescendantInfo:
ressubscr.IgmpPolicy
DescendantInfo:
lte.AccountingPriorityProfile
DescendantInfo:
rp.RouteNextHopPolicyTemplate
DescendantInfo:
ressubscr.PimPolicy
DescendantInfo:
ltepolicyoptions.DynamicToInternalRuleMap
DescendantInfo:
netca.CardStatsTCAProfile
DescendantInfo:
subscrprofile.Policy
DescendantInfo:
aapolicy.HttpEnrich
DescendantInfo:
ltepolicyoptions.GxAvpOptionProfile
DescendantInfo:
sitesec.LdapPolicy
DescendantInfo:
aclfilter.FilterDefinition
DescendantInfo:
fpresource.FPResourcePolicy
DescendantInfo:
securitypolicy.Zone
DescendantInfo:
ltegw.SCTPProfile
DescendantInfo:
sasqos.QueueMgmtPolicy
DescendantInfo:
sasqos.FcLspExpMap
DescendantInfo:
ltepolicyoptions.TriggerRuleUnitProfile
DescendantInfo:
ressubscr.HttpRedirectPolicy
DescendantInfo:
service.Y1564FrameMixProfile
DescendantInfo:
ltepolicyoptions.PolicyRuleUnit
DescendantInfo:
firewall.MgmtAccessFirewall
DescendantInfo:
ltehomeagent.AbsHomeAgentProfile
DescendantInfo:
firewall.RuleSet
DescendantInfo:
netca.StatsTCAProfile
DescendantInfo:
genericne.MvPolicerPolicy
DescendantInfo:
rp.AbstractSrlgGroupPolicy
DescendantInfo:
lte5g.SbaNudmUecmProf
DescendantInfo:
sasqos.IngressCoSClassification
DescendantInfo:
rp.SrlgGroupPolicy
DescendantInfo:
aaa.RadiusScriptPolicy
DescendantInfo:
nat.SvcChainVasFilterPolicy
DescendantInfo:
aapolicy.DnsIpCache
DescendantInfo:
sasqos.NetworkIngress
DescendantInfo:
ltepolicyoptions.ChargingRuleUnit
DescendantInfo:
aapolicy.AAFlowCfgPolicy
DescendantInfo:
lte5g.HTTP2Profile
DescendantInfo:
sasqos.PortAccessIngress
DescendantInfo:
ltegw.PcscfGroupProfile
DescendantInfo:
multicast.IngrPathMgmtInfoPolicy
DescendantInfo:
sitesec.ManagementAccessFilter
DescendantInfo:
ltetwag.SwwTunnelProfile
DescendantInfo:
ethernetoam.MaintenanceDomain
DescendantInfo:
ipsec.RadiusAuthenticationPolicy
DescendantInfo:
aapolicy.AaStatTcaPolicerCfg
DescendantInfo:
ipsec.TrafficSelectorList
DescendantInfo:
atmpolicy.TrafficDescriptor
DescendantInfo:
sasqos.PortAccessEgress
DescendantInfo:
aapolicy.MpTcpProxy
DescendantInfo:
connprof.VlanConnProfPolicy
DescendantInfo:
opticalacl.IpPattern
DescendantInfo:
policing.PolicerControl
DescendantInfo:
sw.SoftwareRepositoryPolicy
DescendantInfo:
svt.TunnelAdminGroup
DescendantInfo:
optical.OcsAlarmProfile
DescendantInfo:
aclfilterli.BlockReservation
DescendantInfo:
genericne.MvMatchingRulePolicy
DescendantInfo:
mmepolicy.WMMInterfaceProfile
DescendantInfo:
calltrace.TraceProfile
DescendantInfo:
ltepolicyoptions.DhcpServerGroupProfile
DescendantInfo:
service.AbstractSapTemplate
DescendantInfo:
aapolicy.AaTcpValidationTca
DescendantInfo:
ltepmip.S6bAvpOptionProfile
DescendantInfo:
redirectfilter.RedirectPolicy
DescendantInfo:
service.EpipeSapTemplate
DescendantInfo:
lte.AbsGtpProfile
DescendantInfo:
ltegw.AvpOptionProfile
DescendantInfo:
nodelog.FirewallLog
DescendantInfo:
multicast.McastCacInterfacePolicy
DescendantInfo:
nodelog.FilterLog
DescendantInfo:
ixrqos.FcDSCPMap
DescendantInfo:
lte5g.NpcfProfile
DescendantInfo:
ltegw.AbsNodeSelPolicyGroup
DescendantInfo:
sitesec.PasswordPolicy
DescendantInfo:
nat.NatClassifier
DescendantInfo:
aaa.L2tpRadiusAccountingPolicy
DescendantInfo:
dynsvc.DynSvcPolicy
DescendantInfo:
ltepolicyoptions.UsgMonAction
DescendantInfo:
sitesec.TacacsPolicy
DescendantInfo:
ltepolicyoptions.StatsRuleUnit
DescendantInfo:
rp.Community
DescendantInfo:
securitypolicy.Bypass
DescendantInfo:
lte.DnsErrMapProfile
DescendantInfo:
nat.FirewallPolicy
DescendantInfo:
ipsec.IPSecClientDB
DescendantInfo:
lte.QciPolicy
DescendantInfo:
filterprefixlist.PrefixList
DescendantInfo:
netca.OCSStatsTCAProfile
DescendantInfo:
rmon.RemoteNetworkMonitoring
DescendantInfo:
aapolicy.AaFilterAbstract
DescendantInfo:
ltepmip.Pmipv6Profile
DescendantInfo:
lte5g.NrfProfile
DescendantInfo:
pppoe.PPPPolicy
DescendantInfo:
qgroup.EgressQGroupPolicy
DescendantInfo:
aaa.NatRadiusAccountingPolicy
DescendantInfo:
ressubscr.IpoePolicy
DescendantInfo:
securitypolicy.SecurityPolicyDefinition
DescendantInfo:
sitesec.RemoteAuthPolicy
DescendantInfo:
aosqos.QoSNetworkGroups
DescendantInfo:
aapolicy.GtpFilter
DescendantInfo:
lte.FqdnGroupProfile
DescendantInfo:
aclfilter.VlanFilter
DescendantInfo:
lte.DiameterPeerProfile
DescendantInfo:
mpr.RadioQOS
DescendantInfo:
portscheduler.HsmdaSchedulerPolicy
DescendantInfo:
lte5g.N1Profile
DescendantInfo:
lte.PfcpProfile
DescendantInfo:
securitypolicy.HostGroup
DescendantInfo:
ressubscr.RipPolicy
DescendantInfo:
aapolicy.AccessNetworkLocation
DescendantInfo:
lteepdg.IPSecProfile
DescendantInfo:
sitesec.TlsTrustAnchorProfile
DescendantInfo:
connprof.PssConnProfPolicy
DescendantInfo:
lte.DiameterRateLimProfile
DescendantInfo:
ltetwag.TwagChargingProfile
DescendantInfo:
ipsec.IPSecStaticSA
DescendantInfo:
ressubscr.MldPolicy
DescendantInfo:
nodelog.AbstractLog
DescendantInfo:
slaprofile.Policy
DescendantInfo:
wlangw.DsmIpFilterPolicy
DescendantInfo:
aapolicy.AaSubCongDetect
DescendantInfo:
opticalacl.OcsIpFilter
DescendantInfo:
lte.DnsProfile
DescendantInfo:
ipfix.IPFIXExportPolicy
DescendantInfo:
ixrqos.DSCPFCMap
DescendantInfo:
slope.Policy
DescendantInfo:
mpls.Policy
DescendantInfo:
rp.AbstractAdminGroupPolicy
DescendantInfo:
portscheduler.HsmdaWrrPolicy
DescendantInfo:
mmepolicy.MMEEmergencyNumListTblPolicy
DescendantInfo:
lteepdg.EpdgChargingProfile
DescendantInfo:
lte.ErrorMappingProfile
DescendantInfo:
lte.FqdnList
DescendantInfo:
lte.GxProfile
DescendantInfo:
lte.CloudDBProfile
DescendantInfo:
sasqos.Remark
DescendantInfo:
aclfilter.DhcpFilter
DescendantInfo:
slope.NamedPool
DescendantInfo:
qosprofile.McfrEgressQosProfile
DescendantInfo:
ipsec.IkeTransform
DescendantInfo:
lte5g.Oauth2Profile
DescendantInfo:
sitesec.TlsClientProfile
DescendantInfo:
aapolicy.AaStatTcaAbstract
DescendantInfo:
firewall.HostGroup
DescendantInfo:
ressubscr.BgpPeeringPolicy
DescendantInfo:
service.SvcActTestHeadAcceptanceCriteriaTemplate
DescendantInfo:
nodelog.SysLogTarget
DescendantInfo:
aaa.AcctOnOffGroup
DescendantInfo:
lte.UeCallTrace
DescendantInfo:
aclfilter.MacFilter
DescendantInfo:
sas.StreamingDelayTemplate
DescendantInfo:
lte.DefBearerQoSProfile
DescendantInfo:
rp.PolicyObjectBase
DescendantInfo:
service.Y1564TestHeadProfile
DescendantInfo:
igmp.SSMTranslatePolicy
DescendantInfo:
radiusaccounting.Policy
DescendantInfo:
aapolicy.AaTcpOpt
DescendantInfo:
service.SvcActTestHeadFrameSizeTemplate
DescendantInfo:
ipsec.TrustAnchorProfile
DescendantInfo:
ixrqos.PortQosPolicy
DescendantInfo:
nodelog.SecurityLog
DescendantInfo:
ixrqos.IngressClassification
DescendantInfo:
aapolicy.Policy
DescendantInfo:
ipsec.RadiusAccountingPolicy
DescendantInfo:
qosprofile.McfrIngressQosProfile
DescendantInfo:
ressubscr.HostLockoutPolicy
DescendantInfo:
ressubscr.SubMcastCacPolicy
DescendantInfo:
slope.HsmdaPoolPolicy
DescendantInfo:
opticalacl.IpFilter
DescendantInfo:
ixrqos.QueueMgmtPolicy
DescendantInfo:
policy.PSGGenericPolicy
DescendantInfo:
mmepolicy.MMESCTPProfile
DescendantInfo:
aapolicy.AARadiusAccountingPolicy
DescendantInfo:
lte.SgwChargingProfile
DescendantInfo:
multicast.EgressMcastGroup
DescendantInfo:
aapolicy.HttpErrorRedirect
DescendantInfo:
multicast.McastReportDestination
DescendantInfo:
firewall.CPMFirewall
DescendantInfo:
rtr.AbstractAdminGroupPolicy
DescendantInfo:
lte.TrustedPeerListPolicy
DescendantInfo:
lteli.DFPeer
DescendantInfo:
aosqos.QoSMacGroups
DescendantInfo:
ltepolicyoptions.ApnRateControl
DescendantInfo:
hsqos.HsAttachmentPolicy
DescendantInfo:
subscrident.Policy
DescendantInfo:
tod.Policy
DescendantInfo:
lteggsn.CdrAvpOptionProfile
DescendantInfo:
lte.OIOverList
DescendantInfo:
aapolicy.AAGroupPolicy
DescendantInfo:
lte.MMEGroupProfile
DescendantInfo:
lteradius.RadiusGroupProfile
DescendantInfo:
lteli.InterceptionTarget
DescendantInfo:
mmepolicy.MMEProfile
DescendantInfo:
lte.IkeRedList
DescendantInfo:
ltehomeagent.DNSRedirectServer
DescendantInfo:
qosprofile.MlpppIngressQosProfile
DescendantInfo:
dctr.PortProfile
DescendantInfo:
multicast.PackagePolicy
DescendantInfo:
lte.PgwSelectionCandidateList
DescendantInfo:
file.FileTransmissionProfile
DescendantInfo:
genericne.MvFilterPolicy
DescendantInfo:
mmepolicy.MMEGTPProfile
DescendantInfo:
genericne.MvForwardingClassPolicy
DescendantInfo:
ltetwag.DhcpServerProfile
DescendantInfo:
aclfilter.Ipv6ExceptionFilter
DescendantInfo:
aclfilter.DhcpV6Filter
DescendantInfo:
lteradius.RadiusProfile
DescendantInfo:
sitesec.TlsServerProfile
DescendantInfo:
nqueue.Policy
DescendantInfo:
sasqos.AccessEgress
DescendantInfo:
wlangw.DsmTrafficPolicer
DescendantInfo:
lte.UpPeerList
DescendantInfo:
netca.AbstractStatsTCAProfile
DescendantInfo:
sasqos.MpBwPolicy
DescendantInfo:
nat.NatPolicy
DescendantInfo:
ltepolicyoptions.QoSRuleUnit
DescendantInfo:
sas.BinGroup
DescendantInfo:
aapolicy.HttpNotif
DescendantInfo:
ethernetservice.SapProfile
DescendantInfo:
sitesec.CpmIpFilter
DescendantInfo:
mmepolicy.WMMSVCAgreementProfile
DescendantInfo:
connprof.ConnProfPolicy
DescendantInfo:
pae802_1x.RadiusServerPolicy
DescendantInfo:
aapolicy.AaStatTcaCfg
DescendantInfo:
sasqos.PortScheduler
DescendantInfo:
lte.IdiRealmList
DescendantInfo:
sitesec.CertificateAuthProfile
DescendantInfo:
qgroup.RedirectList
DescendantInfo:
ltepolicyoptions.PolicyRuleBase
DescendantInfo:
genericne.MVGenericPolicy
DescendantInfo:
rtr.AdminGroupPolicy
DescendantInfo:
aaa.RadiusServerPolicy
DescendantInfo:
securitypolicy.Profile
DescendantInfo:
lte.PpiMappingProfile
DescendantInfo:
rtr.SharedRiskLinkGroup
DescendantInfo:
aapolicy.AAPortList
DescendantInfo:
lte.AgwChargingProfile
DescendantInfo:
mpls.LspTemplateMvpn
DescendantInfo:
aossas.CPETestHeadProfile
DescendantInfo:
ltegw.ApnListPolicyGroup
DescendantInfo:
ancp.Policy
DescendantInfo:
lte.CCFHProfile
DescendantInfo:
aclfilter.AggregateFilter
DescendantInfo:
lte.IpAddressList
DescendantInfo:
dctr.Profile
DescendantInfo:
hsqos.HsPortPoolPolicy
DescendantInfo:
hsqos.HsPoolPolicy
DescendantInfo:
ltessg.TdfChargingProfile
DescendantInfo:
aaa.IsaRadiusPolicy
DescendantInfo:
ltepolicyoptions.TrafficRedirectProfile
DescendantInfo:
nat.UpnpPolicy
DescendantInfo:
pdnprofile.PacketDataNetworkProfilePolicy
DescendantInfo:
gtp.ApnPolicy
DescendantInfo:
rtr.AbstractSharedRiskLinkGroup
DescendantInfo:
aosqos.QoSCondition
DescendantInfo:
ltetwag.SwwRadiusProfile
DescendantInfo:
svt.PwTemplate
DescendantInfo:
filterprefixlist.ProtocolList
DescendantInfo:
rp.AdminGroupPolicy
DescendantInfo:
rtr.AdminTagPolicy
DescendantInfo:
ltehomeagent.FAHAPeerList
DescendantInfo:
mpls.SRLGStaticConfig
DescendantInfo:
accounting.Policy
DescendantInfo:
lte.PfcpTranslateProfile
DescendantInfo:
aapolicy.AaTcpValidation
DescendantInfo:
lte5g.CHFProfile
DescendantInfo:
opticalacl.AbstractIpFilter
DescendantInfo:
msappolicy.Policy
DescendantInfo:
wlangw.MgwProfile
DescendantInfo:
lte5g.AllowedNFDomainList
DescendantInfo:
mmepolicy.WMMPfmJobEntry
DescendantInfo:
aclfilterli.LiMacFilter
DescendantInfo:
securitypolicy.AppGroup
DescendantInfo:
aapolicy.AaCflowdGroupPolicy
DescendantInfo:
lte.PeerListPolicy
DescendantInfo:
fabricqos.FabricProfile
DescendantInfo:
firewall.FwPolicyDefinition
DescendantInfo:
multicast.McastCacPolicy
DescendantInfo:
rp.PolicyAccountingTemplate
DescendantInfo:
ipsec.AbstractTrustAnchorProfile
DescendantInfo:
aclfilter.GreTunnelTemplate
DescendantInfo:
lte.DiameterProfile
DescendantInfo:
lte.PgwChargingProfile
DescendantInfo:
sasqos.EgressRemarking
DescendantInfo:
aclfilterli.LiIpFilter
DescendantInfo:
ltepolicyoptions.UrrProfile
DescendantInfo:
service.Y1564PayloadProfile
DescendantInfo:
lte5g.UdmIdList
DescendantInfo:
sas.LinkMeasurementTemplate
DescendantInfo:
nat.NatPrefixList
DescendantInfo:
aaa.IsaRadiusPolicyBase
DescendantInfo:
lteradius.AbsRadiusProfile
DescendantInfo:
equipment.PortPolicy
DescendantInfo:
unpprofile.UNPProfile
DescendantInfo:
rtr.ReassemblyProfilePolicy
DescendantInfo:
lte.GtpPrimeServerGroupProfile
DescendantInfo:
lte.Profile
DescendantInfo:
layer2.L2Profile
DescendantInfo:
qosportlist.PortList
DescendantInfo:
lte.ClientProfile
DescendantInfo:
lte.OverloadControlProfile
DescendantInfo:
ressubscr.BrgProfile
DescendantInfo:
firewall.ServiceGroup
DescendantInfo:
vs.ServiceTypeDefinition
DescendantInfo:
qgroup.IngressQGroupPolicy
DescendantInfo:
lte.SubscriberMappingProfile
DescendantInfo:
lte5g.SMFAttributesProfile
DescendantInfo:
ltegw.UMTSQoSPolicy
DescendantInfo:
ltepolicyoptions.ActionRuleUnitProfile
DescendantInfo:
lte.S2bErrorMappingProfile
DescendantInfo:
dynsvc.DynSvcLocalAuthDb
DescendantInfo:
lte5g.EmerProfile
DescendantInfo:
aosqos.List
DescendantInfo:
shaperqos.ShaperPolicy
DescendantInfo:
sasqos.FcDot1pMap
DescendantInfo:
ltessg.SteeringProfile
DescendantInfo:
srpythonmgmt.PythonScript
DescendantInfo:
sasqos.MplsLspExpMap
DescendantInfo:
lte.CreditPoolProfile
DescendantInfo:
ltegw.UDPTunnelGroupProfile
DescendantInfo:
multicast.IngrPathMgmtBwPolicy
DescendantInfo:
aclfilter.Ipv6Filter
DescendantInfo:
aapolicy.AAPrefixListPolicy
DescendantInfo:
ipsec.IPSecTunnelTemplate
DescendantInfo:
nat.PcpPolicy
DescendantInfo:
mmepolicy.WMMPfmMeasGroupName
DescendantInfo:
aosqos.QoSAction
DescendantInfo:
lte5g.EventTriggerFBCProfile
DescendantInfo:
srpythonmgmt.PythonPolicy
DescendantInfo:
aclfilterli.LiFilter
DescendantInfo:
ixrqos.EgressRemarkPolicy
DescendantInfo:
diameter.DiameterPeerPolicy
DescendantInfo:
nat.AbstractNatPlcy
DescendantInfo:
aosqos.Policy
DescendantInfo:
aapolicy.AAPolicer
DescendantInfo:
aclfilter.IpFilter
DescendantInfo:
lte5g.SMFChargingProfile
DescendantInfo:
lte.TargetProfile
DescendantInfo:
lte.GroupLabel
DescendantInfo:
ixrqos.Dot1pFCMap
DescendantInfo:
lte5g.SMFServingAreaList
DescendantInfo:
squeue.Policy
DescendantInfo:
ltetwag.SlaacHostProfile
DescendantInfo:
aaa.RouteDownloadPolicy
DescendantInfo:
ltessg.AddressListProfile
DescendantInfo:
pppoe.PPPPolicyBase
DescendantInfo:
lte.AbsCallInsight
DescendantInfo:
nat.SvcChainEvpnPolicy
DescendantInfo:
aapolicy.AaStatTcaFilterCfg
DescendantInfo:
ltegw.QciListPolicyGroup
DescendantInfo:
aapolicy.AAUrlListPolicy
DescendantInfo:
aapolicy.HttpRedirect
DescendantInfo:
ixrqos.LspExpFCMap
DescendantInfo:
niegr.Policy
DescendantInfo:
securitypolicy.PolicerGroup
DescendantInfo:
aapolicy.AACertProfile
DescendantInfo:
securityqueue.SecurityQueuePolicy
DescendantInfo:
genericne.MvMultitermPolicy
DescendantInfo:
lte.TaiLaiListProfile
DescendantInfo:
nat.MapDomain
DescendantInfo:
nodelog.LogProfile
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_policy_PolicyDefinition_setConfigurationModeToReleased", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setConfigurationModeToReleasedResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/policy/PolicyDefinition/setDistributionModeToLocalEditOnly/{instanceFullName}": { "post": { "tags": [ "samo_policy" ], "summary": "rest_policy_PolicyDefinition_setDistributionModeToLocalEditOnly", "description": "Set distribution mode to local edit only for local policies on the sites specified by siteIds.
If it is called from the local policy, only that local policy is updated.

Intention : MODIFIER
setDistributionModeToLocalEditOnly:
instance-level modifier API setDistributionModeToLocalEditOnly
of class policy.PolicyDefinition
DescendantInfo:
rtr.SegmentRoutingMaintenancePolicy
DescendantInfo:
lte5g.PcfIdList
DescendantInfo:
mplstp.BFDTemplate
DescendantInfo:
ixrqos.VlanQosPolicy
DescendantInfo:
ressubscr.ShcvPolicy
DescendantInfo:
ltepolicyoptions.AssumePositiveActionProfile
DescendantInfo:
ixrqos.FcLspExpMap
DescendantInfo:
aclfilterli.LiIpv6Filter
DescendantInfo:
subscrexpmap.Policy
DescendantInfo:
sitesec.DCpuProtection
DescendantInfo:
rp.ASPathGroup
DescendantInfo:
diameter.DiameterAppPolicy
DescendantInfo:
aclfilter.AbstractFilterDefinition
DescendantInfo:
sasqos.Network
DescendantInfo:
lte.GtpProfile
DescendantInfo:
rp.PolicyStatement
DescendantInfo:
file.Policy
DescendantInfo:
lte.PfcpAPPeerList
DescendantInfo:
ethernetservice.UniProfile
DescendantInfo:
ltepolicyoptions.TrafficHashProfile
DescendantInfo:
sitesec.TlsCertificateProfile
DescendantInfo:
qosprofile.MlpppEgressQosProfile
DescendantInfo:
vs.AdvancedConfigPolicy
DescendantInfo:
sasqos.SchedulerPolicy
DescendantInfo:
aapolicy.AAUrlFilter
DescendantInfo:
genericne.MvQosPolicy
DescendantInfo:
sitesec.PkiCommonNameList
DescendantInfo:
ethernetservice.CustomL2Profile
DescendantInfo:
ltetwag.DiameterPeerGroupList
DescendantInfo:
postpolicermapping.PostPolicerMappingPolicy
DescendantInfo:
aengr.Policy
DescendantInfo:
sitesec.LocalUser
DescendantInfo:
rp.PrefixList
DescendantInfo:
lte5g.NfIdList
DescendantInfo:
rtr.RouteNextHopPolicyTemplate
DescendantInfo:
lte5g.QfiMappingProfile
DescendantInfo:
aapolicy.AbstractTransitPolicy
DescendantInfo:
aclfilter.AbstractExceptionFilter
DescendantInfo:
sasqos.DSCPClassification
DescendantInfo:
lte.WlanEmergencyProfile
DescendantInfo:
portscheduler.Policy
DescendantInfo:
vs.Policy
DescendantInfo:
lteggsn.GyAvpOptionProfile
DescendantInfo:
ixrqos.NetworkIngressPolicy
DescendantInfo:
ixrqos.FcDot1pMap
DescendantInfo:
sasqos.NQueue
DescendantInfo:
aapolicy.TetherDetection
DescendantInfo:
service.Y1564AcceptanceCriteriaProfile
DescendantInfo:
ltepolicyoptions.PolicyRule
DescendantInfo:
lte.Abspfcp
DescendantInfo:
mmepolicy.MMEEmergencyNumListPolicy
DescendantInfo:
sitesec.AOSSecurityPolicy
DescendantInfo:
lte.T6cProfile
DescendantInfo:
lte.EpdgGroupList
DescendantInfo:
slope.HsmdaSlopePolicy
DescendantInfo:
aapolicy.AaStatTcaFltrEntryCfg
DescendantInfo:
lte.SourceIpList
DescendantInfo:
sasqos.FcDscpMap
DescendantInfo:
lte.IPProfile
DescendantInfo:
ipsec.IPSecTransform
DescendantInfo:
subscrauth.Policy
DescendantInfo:
icmp.IcmpPingTemplate
DescendantInfo:
qosprefixlist.PrefixList
DescendantInfo:
sitesec.DoSProtection
DescendantInfo:
lte.DccaProfile
DescendantInfo:
filterprefixlist.PortList
DescendantInfo:
rtr.AdminTag
DescendantInfo:
aapolicy.AASessionFilter
DescendantInfo:
hsqos.HsSchedulerPolicy
DescendantInfo:
ltepolicyoptions.ServiceClassIndicator
DescendantInfo:
sitesec.UserProfile
DescendantInfo:
ltepolicyoptions.SruList
DescendantInfo:
lte.AllUesCallTrace
DescendantInfo:
sitesec.TlsServerCipherList
DescendantInfo:
ltegw.TariffChangeListProfilePolicyGroup
DescendantInfo:
aingr.Policy
DescendantInfo:
aapolicy.AbstractHttpRedirect
DescendantInfo:
ltetwag.StaProfile
DescendantInfo:
redirectfilter.RedirectPolicyBinding
DescendantInfo:
sasqos.FCMeterMap
DescendantInfo:
vrrp.Policy
DescendantInfo:
lte5g.SliceList
DescendantInfo:
sasqos.SlopePolicy
DescendantInfo:
todsuite.Policy
DescendantInfo:
diameter.DiameterPolicy
DescendantInfo:
sasqos.SystemResourceProfilePolicy
DescendantInfo:
genericne.MvAbstractPolicy
DescendantInfo:
aapolicy.TransitPrefixPolicy
DescendantInfo:
sitesec.EstAuthProfile
DescendantInfo:
hwaggshapersched.HwAggShaperSchedulerPolicy
DescendantInfo:
aossas.CPETestHeadGroupProfile
DescendantInfo:
lte5g.PrioAddrList
DescendantInfo:
rp.GlobalVariables
DescendantInfo:
lte5g.SliceInstanceList
DescendantInfo:
lte.DedicatedBearerIdleTimeOutProfile
DescendantInfo:
security.KeyChain
DescendantInfo:
lte.PcmdProfile
DescendantInfo:
lteepdg.SwmAvpOptionProfile
DescendantInfo:
mpls.SharedRiskLinkGroup
DescendantInfo:
sitesec.TlsClientCipherList
DescendantInfo:
lte.AmfIdList
DescendantInfo:
ltehomeagent.MobileIpv4Profile
DescendantInfo:
file.LogDefinition
DescendantInfo:
macsec.MacPolicy
DescendantInfo:
securitypolicy.Policy
DescendantInfo:
ltepolicyoptions.AbsPolicyOptionProfile
DescendantInfo:
aclfilter.IpExceptionFilter
DescendantInfo:
sasqos.Dot1pClassification
DescendantInfo:
ipsec.IkePolicy
DescendantInfo:
mpr.QueueMapPolicy
DescendantInfo:
aapolicy.ApplicationAssurancePolicyDefinition
DescendantInfo:
service.VplsSapTemplate
DescendantInfo:
ltegw.AbsListPolicyGroup
DescendantInfo:
lte.SDProfile
DescendantInfo:
aapolicy.SctpFilter
DescendantInfo:
lte.PlmnListPolicyGroup
DescendantInfo:
mpr.GneRadiusQosPolicy
DescendantInfo:
l2fwd.MrpPolicy
DescendantInfo:
sasqos.AccessIngress
DescendantInfo:
crdtctrl.CrdtCtrlPolicy
DescendantInfo:
lte.PortList
DescendantInfo:
lte5g.SbaNudmSdmProf
DescendantInfo:
rp.Damping
DescendantInfo:
aapolicy.TransitIpPolicy
DescendantInfo:
lte.SwmErrorMappingProfile
DescendantInfo:
firewall.Zone
DescendantInfo:
rp.ASPath
DescendantInfo:
ltepolicyoptions.UsgMonInfo
DescendantInfo:
sitesec.RadiusPolicy
DescendantInfo:
optical.AlarmProfile
DescendantInfo:
ipsec.CertProfile
DescendantInfo:
crdtctrl.CtgryMapPolicy
DescendantInfo:
lte.DiameterErrorMappingProfile
DescendantInfo:
ressubscr.HostTrackingPolicy
DescendantInfo:
sasqos.MplsLspExpClassification
DescendantInfo:
ressubscr.IgmpPolicy
DescendantInfo:
lte.AccountingPriorityProfile
DescendantInfo:
rp.RouteNextHopPolicyTemplate
DescendantInfo:
ressubscr.PimPolicy
DescendantInfo:
ltepolicyoptions.DynamicToInternalRuleMap
DescendantInfo:
netca.CardStatsTCAProfile
DescendantInfo:
subscrprofile.Policy
DescendantInfo:
aapolicy.HttpEnrich
DescendantInfo:
ltepolicyoptions.GxAvpOptionProfile
DescendantInfo:
sitesec.LdapPolicy
DescendantInfo:
aclfilter.FilterDefinition
DescendantInfo:
fpresource.FPResourcePolicy
DescendantInfo:
securitypolicy.Zone
DescendantInfo:
ltegw.SCTPProfile
DescendantInfo:
sasqos.QueueMgmtPolicy
DescendantInfo:
sasqos.FcLspExpMap
DescendantInfo:
ltepolicyoptions.TriggerRuleUnitProfile
DescendantInfo:
ressubscr.HttpRedirectPolicy
DescendantInfo:
service.Y1564FrameMixProfile
DescendantInfo:
ltepolicyoptions.PolicyRuleUnit
DescendantInfo:
firewall.MgmtAccessFirewall
DescendantInfo:
ltehomeagent.AbsHomeAgentProfile
DescendantInfo:
firewall.RuleSet
DescendantInfo:
netca.StatsTCAProfile
DescendantInfo:
genericne.MvPolicerPolicy
DescendantInfo:
rp.AbstractSrlgGroupPolicy
DescendantInfo:
lte5g.SbaNudmUecmProf
DescendantInfo:
sasqos.IngressCoSClassification
DescendantInfo:
rp.SrlgGroupPolicy
DescendantInfo:
aaa.RadiusScriptPolicy
DescendantInfo:
nat.SvcChainVasFilterPolicy
DescendantInfo:
aapolicy.DnsIpCache
DescendantInfo:
sasqos.NetworkIngress
DescendantInfo:
ltepolicyoptions.ChargingRuleUnit
DescendantInfo:
aapolicy.AAFlowCfgPolicy
DescendantInfo:
lte5g.HTTP2Profile
DescendantInfo:
sasqos.PortAccessIngress
DescendantInfo:
ltegw.PcscfGroupProfile
DescendantInfo:
multicast.IngrPathMgmtInfoPolicy
DescendantInfo:
sitesec.ManagementAccessFilter
DescendantInfo:
ltetwag.SwwTunnelProfile
DescendantInfo:
ethernetoam.MaintenanceDomain
DescendantInfo:
ipsec.RadiusAuthenticationPolicy
DescendantInfo:
aapolicy.AaStatTcaPolicerCfg
DescendantInfo:
ipsec.TrafficSelectorList
DescendantInfo:
atmpolicy.TrafficDescriptor
DescendantInfo:
sasqos.PortAccessEgress
DescendantInfo:
aapolicy.MpTcpProxy
DescendantInfo:
connprof.VlanConnProfPolicy
DescendantInfo:
opticalacl.IpPattern
DescendantInfo:
policing.PolicerControl
DescendantInfo:
sw.SoftwareRepositoryPolicy
DescendantInfo:
svt.TunnelAdminGroup
DescendantInfo:
optical.OcsAlarmProfile
DescendantInfo:
aclfilterli.BlockReservation
DescendantInfo:
genericne.MvMatchingRulePolicy
DescendantInfo:
mmepolicy.WMMInterfaceProfile
DescendantInfo:
calltrace.TraceProfile
DescendantInfo:
ltepolicyoptions.DhcpServerGroupProfile
DescendantInfo:
service.AbstractSapTemplate
DescendantInfo:
aapolicy.AaTcpValidationTca
DescendantInfo:
ltepmip.S6bAvpOptionProfile
DescendantInfo:
redirectfilter.RedirectPolicy
DescendantInfo:
service.EpipeSapTemplate
DescendantInfo:
lte.AbsGtpProfile
DescendantInfo:
ltegw.AvpOptionProfile
DescendantInfo:
nodelog.FirewallLog
DescendantInfo:
multicast.McastCacInterfacePolicy
DescendantInfo:
nodelog.FilterLog
DescendantInfo:
ixrqos.FcDSCPMap
DescendantInfo:
lte5g.NpcfProfile
DescendantInfo:
ltegw.AbsNodeSelPolicyGroup
DescendantInfo:
sitesec.PasswordPolicy
DescendantInfo:
nat.NatClassifier
DescendantInfo:
aaa.L2tpRadiusAccountingPolicy
DescendantInfo:
dynsvc.DynSvcPolicy
DescendantInfo:
ltepolicyoptions.UsgMonAction
DescendantInfo:
sitesec.TacacsPolicy
DescendantInfo:
ltepolicyoptions.StatsRuleUnit
DescendantInfo:
rp.Community
DescendantInfo:
securitypolicy.Bypass
DescendantInfo:
lte.DnsErrMapProfile
DescendantInfo:
nat.FirewallPolicy
DescendantInfo:
ipsec.IPSecClientDB
DescendantInfo:
lte.QciPolicy
DescendantInfo:
filterprefixlist.PrefixList
DescendantInfo:
netca.OCSStatsTCAProfile
DescendantInfo:
rmon.RemoteNetworkMonitoring
DescendantInfo:
aapolicy.AaFilterAbstract
DescendantInfo:
ltepmip.Pmipv6Profile
DescendantInfo:
lte5g.NrfProfile
DescendantInfo:
pppoe.PPPPolicy
DescendantInfo:
qgroup.EgressQGroupPolicy
DescendantInfo:
aaa.NatRadiusAccountingPolicy
DescendantInfo:
ressubscr.IpoePolicy
DescendantInfo:
securitypolicy.SecurityPolicyDefinition
DescendantInfo:
sitesec.RemoteAuthPolicy
DescendantInfo:
aosqos.QoSNetworkGroups
DescendantInfo:
aapolicy.GtpFilter
DescendantInfo:
lte.FqdnGroupProfile
DescendantInfo:
aclfilter.VlanFilter
DescendantInfo:
lte.DiameterPeerProfile
DescendantInfo:
mpr.RadioQOS
DescendantInfo:
portscheduler.HsmdaSchedulerPolicy
DescendantInfo:
lte5g.N1Profile
DescendantInfo:
lte.PfcpProfile
DescendantInfo:
securitypolicy.HostGroup
DescendantInfo:
ressubscr.RipPolicy
DescendantInfo:
aapolicy.AccessNetworkLocation
DescendantInfo:
lteepdg.IPSecProfile
DescendantInfo:
sitesec.TlsTrustAnchorProfile
DescendantInfo:
connprof.PssConnProfPolicy
DescendantInfo:
lte.DiameterRateLimProfile
DescendantInfo:
ltetwag.TwagChargingProfile
DescendantInfo:
ipsec.IPSecStaticSA
DescendantInfo:
ressubscr.MldPolicy
DescendantInfo:
nodelog.AbstractLog
DescendantInfo:
slaprofile.Policy
DescendantInfo:
wlangw.DsmIpFilterPolicy
DescendantInfo:
aapolicy.AaSubCongDetect
DescendantInfo:
opticalacl.OcsIpFilter
DescendantInfo:
lte.DnsProfile
DescendantInfo:
ipfix.IPFIXExportPolicy
DescendantInfo:
ixrqos.DSCPFCMap
DescendantInfo:
slope.Policy
DescendantInfo:
mpls.Policy
DescendantInfo:
rp.AbstractAdminGroupPolicy
DescendantInfo:
portscheduler.HsmdaWrrPolicy
DescendantInfo:
mmepolicy.MMEEmergencyNumListTblPolicy
DescendantInfo:
lteepdg.EpdgChargingProfile
DescendantInfo:
lte.ErrorMappingProfile
DescendantInfo:
lte.FqdnList
DescendantInfo:
lte.GxProfile
DescendantInfo:
lte.CloudDBProfile
DescendantInfo:
sasqos.Remark
DescendantInfo:
aclfilter.DhcpFilter
DescendantInfo:
slope.NamedPool
DescendantInfo:
qosprofile.McfrEgressQosProfile
DescendantInfo:
ipsec.IkeTransform
DescendantInfo:
lte5g.Oauth2Profile
DescendantInfo:
sitesec.TlsClientProfile
DescendantInfo:
aapolicy.AaStatTcaAbstract
DescendantInfo:
firewall.HostGroup
DescendantInfo:
ressubscr.BgpPeeringPolicy
DescendantInfo:
service.SvcActTestHeadAcceptanceCriteriaTemplate
DescendantInfo:
nodelog.SysLogTarget
DescendantInfo:
aaa.AcctOnOffGroup
DescendantInfo:
lte.UeCallTrace
DescendantInfo:
aclfilter.MacFilter
DescendantInfo:
sas.StreamingDelayTemplate
DescendantInfo:
lte.DefBearerQoSProfile
DescendantInfo:
rp.PolicyObjectBase
DescendantInfo:
service.Y1564TestHeadProfile
DescendantInfo:
igmp.SSMTranslatePolicy
DescendantInfo:
radiusaccounting.Policy
DescendantInfo:
aapolicy.AaTcpOpt
DescendantInfo:
service.SvcActTestHeadFrameSizeTemplate
DescendantInfo:
ipsec.TrustAnchorProfile
DescendantInfo:
ixrqos.PortQosPolicy
DescendantInfo:
nodelog.SecurityLog
DescendantInfo:
ixrqos.IngressClassification
DescendantInfo:
aapolicy.Policy
DescendantInfo:
ipsec.RadiusAccountingPolicy
DescendantInfo:
qosprofile.McfrIngressQosProfile
DescendantInfo:
ressubscr.HostLockoutPolicy
DescendantInfo:
ressubscr.SubMcastCacPolicy
DescendantInfo:
slope.HsmdaPoolPolicy
DescendantInfo:
opticalacl.IpFilter
DescendantInfo:
ixrqos.QueueMgmtPolicy
DescendantInfo:
policy.PSGGenericPolicy
DescendantInfo:
mmepolicy.MMESCTPProfile
DescendantInfo:
aapolicy.AARadiusAccountingPolicy
DescendantInfo:
lte.SgwChargingProfile
DescendantInfo:
multicast.EgressMcastGroup
DescendantInfo:
aapolicy.HttpErrorRedirect
DescendantInfo:
multicast.McastReportDestination
DescendantInfo:
firewall.CPMFirewall
DescendantInfo:
rtr.AbstractAdminGroupPolicy
DescendantInfo:
lte.TrustedPeerListPolicy
DescendantInfo:
lteli.DFPeer
DescendantInfo:
aosqos.QoSMacGroups
DescendantInfo:
ltepolicyoptions.ApnRateControl
DescendantInfo:
hsqos.HsAttachmentPolicy
DescendantInfo:
subscrident.Policy
DescendantInfo:
tod.Policy
DescendantInfo:
lteggsn.CdrAvpOptionProfile
DescendantInfo:
lte.OIOverList
DescendantInfo:
aapolicy.AAGroupPolicy
DescendantInfo:
lte.MMEGroupProfile
DescendantInfo:
lteradius.RadiusGroupProfile
DescendantInfo:
lteli.InterceptionTarget
DescendantInfo:
mmepolicy.MMEProfile
DescendantInfo:
lte.IkeRedList
DescendantInfo:
ltehomeagent.DNSRedirectServer
DescendantInfo:
qosprofile.MlpppIngressQosProfile
DescendantInfo:
dctr.PortProfile
DescendantInfo:
multicast.PackagePolicy
DescendantInfo:
lte.PgwSelectionCandidateList
DescendantInfo:
file.FileTransmissionProfile
DescendantInfo:
genericne.MvFilterPolicy
DescendantInfo:
mmepolicy.MMEGTPProfile
DescendantInfo:
genericne.MvForwardingClassPolicy
DescendantInfo:
ltetwag.DhcpServerProfile
DescendantInfo:
aclfilter.Ipv6ExceptionFilter
DescendantInfo:
aclfilter.DhcpV6Filter
DescendantInfo:
lteradius.RadiusProfile
DescendantInfo:
sitesec.TlsServerProfile
DescendantInfo:
nqueue.Policy
DescendantInfo:
sasqos.AccessEgress
DescendantInfo:
wlangw.DsmTrafficPolicer
DescendantInfo:
lte.UpPeerList
DescendantInfo:
netca.AbstractStatsTCAProfile
DescendantInfo:
sasqos.MpBwPolicy
DescendantInfo:
nat.NatPolicy
DescendantInfo:
ltepolicyoptions.QoSRuleUnit
DescendantInfo:
sas.BinGroup
DescendantInfo:
aapolicy.HttpNotif
DescendantInfo:
ethernetservice.SapProfile
DescendantInfo:
sitesec.CpmIpFilter
DescendantInfo:
mmepolicy.WMMSVCAgreementProfile
DescendantInfo:
connprof.ConnProfPolicy
DescendantInfo:
pae802_1x.RadiusServerPolicy
DescendantInfo:
aapolicy.AaStatTcaCfg
DescendantInfo:
sasqos.PortScheduler
DescendantInfo:
lte.IdiRealmList
DescendantInfo:
sitesec.CertificateAuthProfile
DescendantInfo:
qgroup.RedirectList
DescendantInfo:
ltepolicyoptions.PolicyRuleBase
DescendantInfo:
genericne.MVGenericPolicy
DescendantInfo:
rtr.AdminGroupPolicy
DescendantInfo:
aaa.RadiusServerPolicy
DescendantInfo:
securitypolicy.Profile
DescendantInfo:
lte.PpiMappingProfile
DescendantInfo:
rtr.SharedRiskLinkGroup
DescendantInfo:
aapolicy.AAPortList
DescendantInfo:
lte.AgwChargingProfile
DescendantInfo:
mpls.LspTemplateMvpn
DescendantInfo:
aossas.CPETestHeadProfile
DescendantInfo:
ltegw.ApnListPolicyGroup
DescendantInfo:
ancp.Policy
DescendantInfo:
lte.CCFHProfile
DescendantInfo:
aclfilter.AggregateFilter
DescendantInfo:
lte.IpAddressList
DescendantInfo:
dctr.Profile
DescendantInfo:
hsqos.HsPortPoolPolicy
DescendantInfo:
hsqos.HsPoolPolicy
DescendantInfo:
ltessg.TdfChargingProfile
DescendantInfo:
aaa.IsaRadiusPolicy
DescendantInfo:
ltepolicyoptions.TrafficRedirectProfile
DescendantInfo:
nat.UpnpPolicy
DescendantInfo:
pdnprofile.PacketDataNetworkProfilePolicy
DescendantInfo:
gtp.ApnPolicy
DescendantInfo:
rtr.AbstractSharedRiskLinkGroup
DescendantInfo:
aosqos.QoSCondition
DescendantInfo:
ltetwag.SwwRadiusProfile
DescendantInfo:
svt.PwTemplate
DescendantInfo:
filterprefixlist.ProtocolList
DescendantInfo:
rp.AdminGroupPolicy
DescendantInfo:
rtr.AdminTagPolicy
DescendantInfo:
ltehomeagent.FAHAPeerList
DescendantInfo:
mpls.SRLGStaticConfig
DescendantInfo:
accounting.Policy
DescendantInfo:
lte.PfcpTranslateProfile
DescendantInfo:
aapolicy.AaTcpValidation
DescendantInfo:
lte5g.CHFProfile
DescendantInfo:
opticalacl.AbstractIpFilter
DescendantInfo:
msappolicy.Policy
DescendantInfo:
wlangw.MgwProfile
DescendantInfo:
lte5g.AllowedNFDomainList
DescendantInfo:
mmepolicy.WMMPfmJobEntry
DescendantInfo:
aclfilterli.LiMacFilter
DescendantInfo:
securitypolicy.AppGroup
DescendantInfo:
aapolicy.AaCflowdGroupPolicy
DescendantInfo:
lte.PeerListPolicy
DescendantInfo:
fabricqos.FabricProfile
DescendantInfo:
firewall.FwPolicyDefinition
DescendantInfo:
multicast.McastCacPolicy
DescendantInfo:
rp.PolicyAccountingTemplate
DescendantInfo:
ipsec.AbstractTrustAnchorProfile
DescendantInfo:
aclfilter.GreTunnelTemplate
DescendantInfo:
lte.DiameterProfile
DescendantInfo:
lte.PgwChargingProfile
DescendantInfo:
sasqos.EgressRemarking
DescendantInfo:
aclfilterli.LiIpFilter
DescendantInfo:
ltepolicyoptions.UrrProfile
DescendantInfo:
service.Y1564PayloadProfile
DescendantInfo:
lte5g.UdmIdList
DescendantInfo:
sas.LinkMeasurementTemplate
DescendantInfo:
nat.NatPrefixList
DescendantInfo:
aaa.IsaRadiusPolicyBase
DescendantInfo:
lteradius.AbsRadiusProfile
DescendantInfo:
equipment.PortPolicy
DescendantInfo:
unpprofile.UNPProfile
DescendantInfo:
rtr.ReassemblyProfilePolicy
DescendantInfo:
lte.GtpPrimeServerGroupProfile
DescendantInfo:
lte.Profile
DescendantInfo:
layer2.L2Profile
DescendantInfo:
qosportlist.PortList
DescendantInfo:
lte.ClientProfile
DescendantInfo:
lte.OverloadControlProfile
DescendantInfo:
ressubscr.BrgProfile
DescendantInfo:
firewall.ServiceGroup
DescendantInfo:
vs.ServiceTypeDefinition
DescendantInfo:
qgroup.IngressQGroupPolicy
DescendantInfo:
lte.SubscriberMappingProfile
DescendantInfo:
lte5g.SMFAttributesProfile
DescendantInfo:
ltegw.UMTSQoSPolicy
DescendantInfo:
ltepolicyoptions.ActionRuleUnitProfile
DescendantInfo:
lte.S2bErrorMappingProfile
DescendantInfo:
dynsvc.DynSvcLocalAuthDb
DescendantInfo:
lte5g.EmerProfile
DescendantInfo:
aosqos.List
DescendantInfo:
shaperqos.ShaperPolicy
DescendantInfo:
sasqos.FcDot1pMap
DescendantInfo:
ltessg.SteeringProfile
DescendantInfo:
srpythonmgmt.PythonScript
DescendantInfo:
sasqos.MplsLspExpMap
DescendantInfo:
lte.CreditPoolProfile
DescendantInfo:
ltegw.UDPTunnelGroupProfile
DescendantInfo:
multicast.IngrPathMgmtBwPolicy
DescendantInfo:
aclfilter.Ipv6Filter
DescendantInfo:
aapolicy.AAPrefixListPolicy
DescendantInfo:
ipsec.IPSecTunnelTemplate
DescendantInfo:
nat.PcpPolicy
DescendantInfo:
mmepolicy.WMMPfmMeasGroupName
DescendantInfo:
aosqos.QoSAction
DescendantInfo:
lte5g.EventTriggerFBCProfile
DescendantInfo:
srpythonmgmt.PythonPolicy
DescendantInfo:
aclfilterli.LiFilter
DescendantInfo:
ixrqos.EgressRemarkPolicy
DescendantInfo:
diameter.DiameterPeerPolicy
DescendantInfo:
nat.AbstractNatPlcy
DescendantInfo:
aosqos.Policy
DescendantInfo:
aapolicy.AAPolicer
DescendantInfo:
aclfilter.IpFilter
DescendantInfo:
lte5g.SMFChargingProfile
DescendantInfo:
lte.TargetProfile
DescendantInfo:
lte.GroupLabel
DescendantInfo:
ixrqos.Dot1pFCMap
DescendantInfo:
lte5g.SMFServingAreaList
DescendantInfo:
squeue.Policy
DescendantInfo:
ltetwag.SlaacHostProfile
DescendantInfo:
aaa.RouteDownloadPolicy
DescendantInfo:
ltessg.AddressListProfile
DescendantInfo:
pppoe.PPPPolicyBase
DescendantInfo:
lte.AbsCallInsight
DescendantInfo:
nat.SvcChainEvpnPolicy
DescendantInfo:
aapolicy.AaStatTcaFilterCfg
DescendantInfo:
ltegw.QciListPolicyGroup
DescendantInfo:
aapolicy.AAUrlListPolicy
DescendantInfo:
aapolicy.HttpRedirect
DescendantInfo:
ixrqos.LspExpFCMap
DescendantInfo:
niegr.Policy
DescendantInfo:
securitypolicy.PolicerGroup
DescendantInfo:
aapolicy.AACertProfile
DescendantInfo:
securityqueue.SecurityQueuePolicy
DescendantInfo:
genericne.MvMultitermPolicy
DescendantInfo:
lte.TaiLaiListProfile
DescendantInfo:
nat.MapDomain
DescendantInfo:
nodelog.LogProfile
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_policy_PolicyDefinition_setDistributionModeToLocalEditOnly", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setDistributionModeToLocalEditOnlyResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/policy/PolicyDefinition/setDistributionModeToSyncWithGlobal/{instanceFullName}": { "post": { "tags": [ "samo_policy" ], "summary": "rest_policy_PolicyDefinition_setDistributionModeToSyncWithGlobal", "description": "Set distribution mode to Sync with Global for local policies on the sites specified by siteIds.
It automatically synchronize local policies with the most recent released global policy.
If it is called from the local policy, only that local policy is updated.

Intention : MODIFIER
setDistributionModeToSyncWithGlobal:
instance-level modifier API setDistributionModeToSyncWithGlobal
of class policy.PolicyDefinition
DescendantInfo:
rtr.SegmentRoutingMaintenancePolicy
DescendantInfo:
lte5g.PcfIdList
DescendantInfo:
mplstp.BFDTemplate
DescendantInfo:
ixrqos.VlanQosPolicy
DescendantInfo:
ressubscr.ShcvPolicy
DescendantInfo:
ltepolicyoptions.AssumePositiveActionProfile
DescendantInfo:
ixrqos.FcLspExpMap
DescendantInfo:
aclfilterli.LiIpv6Filter
DescendantInfo:
subscrexpmap.Policy
DescendantInfo:
sitesec.DCpuProtection
DescendantInfo:
rp.ASPathGroup
DescendantInfo:
diameter.DiameterAppPolicy
DescendantInfo:
aclfilter.AbstractFilterDefinition
DescendantInfo:
sasqos.Network
DescendantInfo:
lte.GtpProfile
DescendantInfo:
rp.PolicyStatement
DescendantInfo:
file.Policy
DescendantInfo:
lte.PfcpAPPeerList
DescendantInfo:
ethernetservice.UniProfile
DescendantInfo:
ltepolicyoptions.TrafficHashProfile
DescendantInfo:
sitesec.TlsCertificateProfile
DescendantInfo:
qosprofile.MlpppEgressQosProfile
DescendantInfo:
vs.AdvancedConfigPolicy
DescendantInfo:
sasqos.SchedulerPolicy
DescendantInfo:
aapolicy.AAUrlFilter
DescendantInfo:
genericne.MvQosPolicy
DescendantInfo:
sitesec.PkiCommonNameList
DescendantInfo:
ethernetservice.CustomL2Profile
DescendantInfo:
ltetwag.DiameterPeerGroupList
DescendantInfo:
postpolicermapping.PostPolicerMappingPolicy
DescendantInfo:
aengr.Policy
DescendantInfo:
sitesec.LocalUser
DescendantInfo:
rp.PrefixList
DescendantInfo:
lte5g.NfIdList
DescendantInfo:
rtr.RouteNextHopPolicyTemplate
DescendantInfo:
lte5g.QfiMappingProfile
DescendantInfo:
aapolicy.AbstractTransitPolicy
DescendantInfo:
aclfilter.AbstractExceptionFilter
DescendantInfo:
sasqos.DSCPClassification
DescendantInfo:
lte.WlanEmergencyProfile
DescendantInfo:
portscheduler.Policy
DescendantInfo:
vs.Policy
DescendantInfo:
lteggsn.GyAvpOptionProfile
DescendantInfo:
ixrqos.NetworkIngressPolicy
DescendantInfo:
ixrqos.FcDot1pMap
DescendantInfo:
sasqos.NQueue
DescendantInfo:
aapolicy.TetherDetection
DescendantInfo:
service.Y1564AcceptanceCriteriaProfile
DescendantInfo:
ltepolicyoptions.PolicyRule
DescendantInfo:
lte.Abspfcp
DescendantInfo:
mmepolicy.MMEEmergencyNumListPolicy
DescendantInfo:
sitesec.AOSSecurityPolicy
DescendantInfo:
lte.T6cProfile
DescendantInfo:
lte.EpdgGroupList
DescendantInfo:
slope.HsmdaSlopePolicy
DescendantInfo:
aapolicy.AaStatTcaFltrEntryCfg
DescendantInfo:
lte.SourceIpList
DescendantInfo:
sasqos.FcDscpMap
DescendantInfo:
lte.IPProfile
DescendantInfo:
ipsec.IPSecTransform
DescendantInfo:
subscrauth.Policy
DescendantInfo:
icmp.IcmpPingTemplate
DescendantInfo:
qosprefixlist.PrefixList
DescendantInfo:
sitesec.DoSProtection
DescendantInfo:
lte.DccaProfile
DescendantInfo:
filterprefixlist.PortList
DescendantInfo:
rtr.AdminTag
DescendantInfo:
aapolicy.AASessionFilter
DescendantInfo:
hsqos.HsSchedulerPolicy
DescendantInfo:
ltepolicyoptions.ServiceClassIndicator
DescendantInfo:
sitesec.UserProfile
DescendantInfo:
ltepolicyoptions.SruList
DescendantInfo:
lte.AllUesCallTrace
DescendantInfo:
sitesec.TlsServerCipherList
DescendantInfo:
ltegw.TariffChangeListProfilePolicyGroup
DescendantInfo:
aingr.Policy
DescendantInfo:
aapolicy.AbstractHttpRedirect
DescendantInfo:
ltetwag.StaProfile
DescendantInfo:
redirectfilter.RedirectPolicyBinding
DescendantInfo:
sasqos.FCMeterMap
DescendantInfo:
vrrp.Policy
DescendantInfo:
lte5g.SliceList
DescendantInfo:
sasqos.SlopePolicy
DescendantInfo:
todsuite.Policy
DescendantInfo:
diameter.DiameterPolicy
DescendantInfo:
sasqos.SystemResourceProfilePolicy
DescendantInfo:
genericne.MvAbstractPolicy
DescendantInfo:
aapolicy.TransitPrefixPolicy
DescendantInfo:
sitesec.EstAuthProfile
DescendantInfo:
hwaggshapersched.HwAggShaperSchedulerPolicy
DescendantInfo:
aossas.CPETestHeadGroupProfile
DescendantInfo:
lte5g.PrioAddrList
DescendantInfo:
rp.GlobalVariables
DescendantInfo:
lte5g.SliceInstanceList
DescendantInfo:
lte.DedicatedBearerIdleTimeOutProfile
DescendantInfo:
security.KeyChain
DescendantInfo:
lte.PcmdProfile
DescendantInfo:
lteepdg.SwmAvpOptionProfile
DescendantInfo:
mpls.SharedRiskLinkGroup
DescendantInfo:
sitesec.TlsClientCipherList
DescendantInfo:
lte.AmfIdList
DescendantInfo:
ltehomeagent.MobileIpv4Profile
DescendantInfo:
file.LogDefinition
DescendantInfo:
macsec.MacPolicy
DescendantInfo:
securitypolicy.Policy
DescendantInfo:
ltepolicyoptions.AbsPolicyOptionProfile
DescendantInfo:
aclfilter.IpExceptionFilter
DescendantInfo:
sasqos.Dot1pClassification
DescendantInfo:
ipsec.IkePolicy
DescendantInfo:
mpr.QueueMapPolicy
DescendantInfo:
aapolicy.ApplicationAssurancePolicyDefinition
DescendantInfo:
service.VplsSapTemplate
DescendantInfo:
ltegw.AbsListPolicyGroup
DescendantInfo:
lte.SDProfile
DescendantInfo:
aapolicy.SctpFilter
DescendantInfo:
lte.PlmnListPolicyGroup
DescendantInfo:
mpr.GneRadiusQosPolicy
DescendantInfo:
l2fwd.MrpPolicy
DescendantInfo:
sasqos.AccessIngress
DescendantInfo:
crdtctrl.CrdtCtrlPolicy
DescendantInfo:
lte.PortList
DescendantInfo:
lte5g.SbaNudmSdmProf
DescendantInfo:
rp.Damping
DescendantInfo:
aapolicy.TransitIpPolicy
DescendantInfo:
lte.SwmErrorMappingProfile
DescendantInfo:
firewall.Zone
DescendantInfo:
rp.ASPath
DescendantInfo:
ltepolicyoptions.UsgMonInfo
DescendantInfo:
sitesec.RadiusPolicy
DescendantInfo:
optical.AlarmProfile
DescendantInfo:
ipsec.CertProfile
DescendantInfo:
crdtctrl.CtgryMapPolicy
DescendantInfo:
lte.DiameterErrorMappingProfile
DescendantInfo:
ressubscr.HostTrackingPolicy
DescendantInfo:
sasqos.MplsLspExpClassification
DescendantInfo:
ressubscr.IgmpPolicy
DescendantInfo:
lte.AccountingPriorityProfile
DescendantInfo:
rp.RouteNextHopPolicyTemplate
DescendantInfo:
ressubscr.PimPolicy
DescendantInfo:
ltepolicyoptions.DynamicToInternalRuleMap
DescendantInfo:
netca.CardStatsTCAProfile
DescendantInfo:
subscrprofile.Policy
DescendantInfo:
aapolicy.HttpEnrich
DescendantInfo:
ltepolicyoptions.GxAvpOptionProfile
DescendantInfo:
sitesec.LdapPolicy
DescendantInfo:
aclfilter.FilterDefinition
DescendantInfo:
fpresource.FPResourcePolicy
DescendantInfo:
securitypolicy.Zone
DescendantInfo:
ltegw.SCTPProfile
DescendantInfo:
sasqos.QueueMgmtPolicy
DescendantInfo:
sasqos.FcLspExpMap
DescendantInfo:
ltepolicyoptions.TriggerRuleUnitProfile
DescendantInfo:
ressubscr.HttpRedirectPolicy
DescendantInfo:
service.Y1564FrameMixProfile
DescendantInfo:
ltepolicyoptions.PolicyRuleUnit
DescendantInfo:
firewall.MgmtAccessFirewall
DescendantInfo:
ltehomeagent.AbsHomeAgentProfile
DescendantInfo:
firewall.RuleSet
DescendantInfo:
netca.StatsTCAProfile
DescendantInfo:
genericne.MvPolicerPolicy
DescendantInfo:
rp.AbstractSrlgGroupPolicy
DescendantInfo:
lte5g.SbaNudmUecmProf
DescendantInfo:
sasqos.IngressCoSClassification
DescendantInfo:
rp.SrlgGroupPolicy
DescendantInfo:
aaa.RadiusScriptPolicy
DescendantInfo:
nat.SvcChainVasFilterPolicy
DescendantInfo:
aapolicy.DnsIpCache
DescendantInfo:
sasqos.NetworkIngress
DescendantInfo:
ltepolicyoptions.ChargingRuleUnit
DescendantInfo:
aapolicy.AAFlowCfgPolicy
DescendantInfo:
lte5g.HTTP2Profile
DescendantInfo:
sasqos.PortAccessIngress
DescendantInfo:
ltegw.PcscfGroupProfile
DescendantInfo:
multicast.IngrPathMgmtInfoPolicy
DescendantInfo:
sitesec.ManagementAccessFilter
DescendantInfo:
ltetwag.SwwTunnelProfile
DescendantInfo:
ethernetoam.MaintenanceDomain
DescendantInfo:
ipsec.RadiusAuthenticationPolicy
DescendantInfo:
aapolicy.AaStatTcaPolicerCfg
DescendantInfo:
ipsec.TrafficSelectorList
DescendantInfo:
atmpolicy.TrafficDescriptor
DescendantInfo:
sasqos.PortAccessEgress
DescendantInfo:
aapolicy.MpTcpProxy
DescendantInfo:
connprof.VlanConnProfPolicy
DescendantInfo:
opticalacl.IpPattern
DescendantInfo:
policing.PolicerControl
DescendantInfo:
sw.SoftwareRepositoryPolicy
DescendantInfo:
svt.TunnelAdminGroup
DescendantInfo:
optical.OcsAlarmProfile
DescendantInfo:
aclfilterli.BlockReservation
DescendantInfo:
genericne.MvMatchingRulePolicy
DescendantInfo:
mmepolicy.WMMInterfaceProfile
DescendantInfo:
calltrace.TraceProfile
DescendantInfo:
ltepolicyoptions.DhcpServerGroupProfile
DescendantInfo:
service.AbstractSapTemplate
DescendantInfo:
aapolicy.AaTcpValidationTca
DescendantInfo:
ltepmip.S6bAvpOptionProfile
DescendantInfo:
redirectfilter.RedirectPolicy
DescendantInfo:
service.EpipeSapTemplate
DescendantInfo:
lte.AbsGtpProfile
DescendantInfo:
ltegw.AvpOptionProfile
DescendantInfo:
nodelog.FirewallLog
DescendantInfo:
multicast.McastCacInterfacePolicy
DescendantInfo:
nodelog.FilterLog
DescendantInfo:
ixrqos.FcDSCPMap
DescendantInfo:
lte5g.NpcfProfile
DescendantInfo:
ltegw.AbsNodeSelPolicyGroup
DescendantInfo:
sitesec.PasswordPolicy
DescendantInfo:
nat.NatClassifier
DescendantInfo:
aaa.L2tpRadiusAccountingPolicy
DescendantInfo:
dynsvc.DynSvcPolicy
DescendantInfo:
ltepolicyoptions.UsgMonAction
DescendantInfo:
sitesec.TacacsPolicy
DescendantInfo:
ltepolicyoptions.StatsRuleUnit
DescendantInfo:
rp.Community
DescendantInfo:
securitypolicy.Bypass
DescendantInfo:
lte.DnsErrMapProfile
DescendantInfo:
nat.FirewallPolicy
DescendantInfo:
ipsec.IPSecClientDB
DescendantInfo:
lte.QciPolicy
DescendantInfo:
filterprefixlist.PrefixList
DescendantInfo:
netca.OCSStatsTCAProfile
DescendantInfo:
rmon.RemoteNetworkMonitoring
DescendantInfo:
aapolicy.AaFilterAbstract
DescendantInfo:
ltepmip.Pmipv6Profile
DescendantInfo:
lte5g.NrfProfile
DescendantInfo:
pppoe.PPPPolicy
DescendantInfo:
qgroup.EgressQGroupPolicy
DescendantInfo:
aaa.NatRadiusAccountingPolicy
DescendantInfo:
ressubscr.IpoePolicy
DescendantInfo:
securitypolicy.SecurityPolicyDefinition
DescendantInfo:
sitesec.RemoteAuthPolicy
DescendantInfo:
aosqos.QoSNetworkGroups
DescendantInfo:
aapolicy.GtpFilter
DescendantInfo:
lte.FqdnGroupProfile
DescendantInfo:
aclfilter.VlanFilter
DescendantInfo:
lte.DiameterPeerProfile
DescendantInfo:
mpr.RadioQOS
DescendantInfo:
portscheduler.HsmdaSchedulerPolicy
DescendantInfo:
lte5g.N1Profile
DescendantInfo:
lte.PfcpProfile
DescendantInfo:
securitypolicy.HostGroup
DescendantInfo:
ressubscr.RipPolicy
DescendantInfo:
aapolicy.AccessNetworkLocation
DescendantInfo:
lteepdg.IPSecProfile
DescendantInfo:
sitesec.TlsTrustAnchorProfile
DescendantInfo:
connprof.PssConnProfPolicy
DescendantInfo:
lte.DiameterRateLimProfile
DescendantInfo:
ltetwag.TwagChargingProfile
DescendantInfo:
ipsec.IPSecStaticSA
DescendantInfo:
ressubscr.MldPolicy
DescendantInfo:
nodelog.AbstractLog
DescendantInfo:
slaprofile.Policy
DescendantInfo:
wlangw.DsmIpFilterPolicy
DescendantInfo:
aapolicy.AaSubCongDetect
DescendantInfo:
opticalacl.OcsIpFilter
DescendantInfo:
lte.DnsProfile
DescendantInfo:
ipfix.IPFIXExportPolicy
DescendantInfo:
ixrqos.DSCPFCMap
DescendantInfo:
slope.Policy
DescendantInfo:
mpls.Policy
DescendantInfo:
rp.AbstractAdminGroupPolicy
DescendantInfo:
portscheduler.HsmdaWrrPolicy
DescendantInfo:
mmepolicy.MMEEmergencyNumListTblPolicy
DescendantInfo:
lteepdg.EpdgChargingProfile
DescendantInfo:
lte.ErrorMappingProfile
DescendantInfo:
lte.FqdnList
DescendantInfo:
lte.GxProfile
DescendantInfo:
lte.CloudDBProfile
DescendantInfo:
sasqos.Remark
DescendantInfo:
aclfilter.DhcpFilter
DescendantInfo:
slope.NamedPool
DescendantInfo:
qosprofile.McfrEgressQosProfile
DescendantInfo:
ipsec.IkeTransform
DescendantInfo:
lte5g.Oauth2Profile
DescendantInfo:
sitesec.TlsClientProfile
DescendantInfo:
aapolicy.AaStatTcaAbstract
DescendantInfo:
firewall.HostGroup
DescendantInfo:
ressubscr.BgpPeeringPolicy
DescendantInfo:
service.SvcActTestHeadAcceptanceCriteriaTemplate
DescendantInfo:
nodelog.SysLogTarget
DescendantInfo:
aaa.AcctOnOffGroup
DescendantInfo:
lte.UeCallTrace
DescendantInfo:
aclfilter.MacFilter
DescendantInfo:
sas.StreamingDelayTemplate
DescendantInfo:
lte.DefBearerQoSProfile
DescendantInfo:
rp.PolicyObjectBase
DescendantInfo:
service.Y1564TestHeadProfile
DescendantInfo:
igmp.SSMTranslatePolicy
DescendantInfo:
radiusaccounting.Policy
DescendantInfo:
aapolicy.AaTcpOpt
DescendantInfo:
service.SvcActTestHeadFrameSizeTemplate
DescendantInfo:
ipsec.TrustAnchorProfile
DescendantInfo:
ixrqos.PortQosPolicy
DescendantInfo:
nodelog.SecurityLog
DescendantInfo:
ixrqos.IngressClassification
DescendantInfo:
aapolicy.Policy
DescendantInfo:
ipsec.RadiusAccountingPolicy
DescendantInfo:
qosprofile.McfrIngressQosProfile
DescendantInfo:
ressubscr.HostLockoutPolicy
DescendantInfo:
ressubscr.SubMcastCacPolicy
DescendantInfo:
slope.HsmdaPoolPolicy
DescendantInfo:
opticalacl.IpFilter
DescendantInfo:
ixrqos.QueueMgmtPolicy
DescendantInfo:
policy.PSGGenericPolicy
DescendantInfo:
mmepolicy.MMESCTPProfile
DescendantInfo:
aapolicy.AARadiusAccountingPolicy
DescendantInfo:
lte.SgwChargingProfile
DescendantInfo:
multicast.EgressMcastGroup
DescendantInfo:
aapolicy.HttpErrorRedirect
DescendantInfo:
multicast.McastReportDestination
DescendantInfo:
firewall.CPMFirewall
DescendantInfo:
rtr.AbstractAdminGroupPolicy
DescendantInfo:
lte.TrustedPeerListPolicy
DescendantInfo:
lteli.DFPeer
DescendantInfo:
aosqos.QoSMacGroups
DescendantInfo:
ltepolicyoptions.ApnRateControl
DescendantInfo:
hsqos.HsAttachmentPolicy
DescendantInfo:
subscrident.Policy
DescendantInfo:
tod.Policy
DescendantInfo:
lteggsn.CdrAvpOptionProfile
DescendantInfo:
lte.OIOverList
DescendantInfo:
aapolicy.AAGroupPolicy
DescendantInfo:
lte.MMEGroupProfile
DescendantInfo:
lteradius.RadiusGroupProfile
DescendantInfo:
lteli.InterceptionTarget
DescendantInfo:
mmepolicy.MMEProfile
DescendantInfo:
lte.IkeRedList
DescendantInfo:
ltehomeagent.DNSRedirectServer
DescendantInfo:
qosprofile.MlpppIngressQosProfile
DescendantInfo:
dctr.PortProfile
DescendantInfo:
multicast.PackagePolicy
DescendantInfo:
lte.PgwSelectionCandidateList
DescendantInfo:
file.FileTransmissionProfile
DescendantInfo:
genericne.MvFilterPolicy
DescendantInfo:
mmepolicy.MMEGTPProfile
DescendantInfo:
genericne.MvForwardingClassPolicy
DescendantInfo:
ltetwag.DhcpServerProfile
DescendantInfo:
aclfilter.Ipv6ExceptionFilter
DescendantInfo:
aclfilter.DhcpV6Filter
DescendantInfo:
lteradius.RadiusProfile
DescendantInfo:
sitesec.TlsServerProfile
DescendantInfo:
nqueue.Policy
DescendantInfo:
sasqos.AccessEgress
DescendantInfo:
wlangw.DsmTrafficPolicer
DescendantInfo:
lte.UpPeerList
DescendantInfo:
netca.AbstractStatsTCAProfile
DescendantInfo:
sasqos.MpBwPolicy
DescendantInfo:
nat.NatPolicy
DescendantInfo:
ltepolicyoptions.QoSRuleUnit
DescendantInfo:
sas.BinGroup
DescendantInfo:
aapolicy.HttpNotif
DescendantInfo:
ethernetservice.SapProfile
DescendantInfo:
sitesec.CpmIpFilter
DescendantInfo:
mmepolicy.WMMSVCAgreementProfile
DescendantInfo:
connprof.ConnProfPolicy
DescendantInfo:
pae802_1x.RadiusServerPolicy
DescendantInfo:
aapolicy.AaStatTcaCfg
DescendantInfo:
sasqos.PortScheduler
DescendantInfo:
lte.IdiRealmList
DescendantInfo:
sitesec.CertificateAuthProfile
DescendantInfo:
qgroup.RedirectList
DescendantInfo:
ltepolicyoptions.PolicyRuleBase
DescendantInfo:
genericne.MVGenericPolicy
DescendantInfo:
rtr.AdminGroupPolicy
DescendantInfo:
aaa.RadiusServerPolicy
DescendantInfo:
securitypolicy.Profile
DescendantInfo:
lte.PpiMappingProfile
DescendantInfo:
rtr.SharedRiskLinkGroup
DescendantInfo:
aapolicy.AAPortList
DescendantInfo:
lte.AgwChargingProfile
DescendantInfo:
mpls.LspTemplateMvpn
DescendantInfo:
aossas.CPETestHeadProfile
DescendantInfo:
ltegw.ApnListPolicyGroup
DescendantInfo:
ancp.Policy
DescendantInfo:
lte.CCFHProfile
DescendantInfo:
aclfilter.AggregateFilter
DescendantInfo:
lte.IpAddressList
DescendantInfo:
dctr.Profile
DescendantInfo:
hsqos.HsPortPoolPolicy
DescendantInfo:
hsqos.HsPoolPolicy
DescendantInfo:
ltessg.TdfChargingProfile
DescendantInfo:
aaa.IsaRadiusPolicy
DescendantInfo:
ltepolicyoptions.TrafficRedirectProfile
DescendantInfo:
nat.UpnpPolicy
DescendantInfo:
pdnprofile.PacketDataNetworkProfilePolicy
DescendantInfo:
gtp.ApnPolicy
DescendantInfo:
rtr.AbstractSharedRiskLinkGroup
DescendantInfo:
aosqos.QoSCondition
DescendantInfo:
ltetwag.SwwRadiusProfile
DescendantInfo:
svt.PwTemplate
DescendantInfo:
filterprefixlist.ProtocolList
DescendantInfo:
rp.AdminGroupPolicy
DescendantInfo:
rtr.AdminTagPolicy
DescendantInfo:
ltehomeagent.FAHAPeerList
DescendantInfo:
mpls.SRLGStaticConfig
DescendantInfo:
accounting.Policy
DescendantInfo:
lte.PfcpTranslateProfile
DescendantInfo:
aapolicy.AaTcpValidation
DescendantInfo:
lte5g.CHFProfile
DescendantInfo:
opticalacl.AbstractIpFilter
DescendantInfo:
msappolicy.Policy
DescendantInfo:
wlangw.MgwProfile
DescendantInfo:
lte5g.AllowedNFDomainList
DescendantInfo:
mmepolicy.WMMPfmJobEntry
DescendantInfo:
aclfilterli.LiMacFilter
DescendantInfo:
securitypolicy.AppGroup
DescendantInfo:
aapolicy.AaCflowdGroupPolicy
DescendantInfo:
lte.PeerListPolicy
DescendantInfo:
fabricqos.FabricProfile
DescendantInfo:
firewall.FwPolicyDefinition
DescendantInfo:
multicast.McastCacPolicy
DescendantInfo:
rp.PolicyAccountingTemplate
DescendantInfo:
ipsec.AbstractTrustAnchorProfile
DescendantInfo:
aclfilter.GreTunnelTemplate
DescendantInfo:
lte.DiameterProfile
DescendantInfo:
lte.PgwChargingProfile
DescendantInfo:
sasqos.EgressRemarking
DescendantInfo:
aclfilterli.LiIpFilter
DescendantInfo:
ltepolicyoptions.UrrProfile
DescendantInfo:
service.Y1564PayloadProfile
DescendantInfo:
lte5g.UdmIdList
DescendantInfo:
sas.LinkMeasurementTemplate
DescendantInfo:
nat.NatPrefixList
DescendantInfo:
aaa.IsaRadiusPolicyBase
DescendantInfo:
lteradius.AbsRadiusProfile
DescendantInfo:
equipment.PortPolicy
DescendantInfo:
unpprofile.UNPProfile
DescendantInfo:
rtr.ReassemblyProfilePolicy
DescendantInfo:
lte.GtpPrimeServerGroupProfile
DescendantInfo:
lte.Profile
DescendantInfo:
layer2.L2Profile
DescendantInfo:
qosportlist.PortList
DescendantInfo:
lte.ClientProfile
DescendantInfo:
lte.OverloadControlProfile
DescendantInfo:
ressubscr.BrgProfile
DescendantInfo:
firewall.ServiceGroup
DescendantInfo:
vs.ServiceTypeDefinition
DescendantInfo:
qgroup.IngressQGroupPolicy
DescendantInfo:
lte.SubscriberMappingProfile
DescendantInfo:
lte5g.SMFAttributesProfile
DescendantInfo:
ltegw.UMTSQoSPolicy
DescendantInfo:
ltepolicyoptions.ActionRuleUnitProfile
DescendantInfo:
lte.S2bErrorMappingProfile
DescendantInfo:
dynsvc.DynSvcLocalAuthDb
DescendantInfo:
lte5g.EmerProfile
DescendantInfo:
aosqos.List
DescendantInfo:
shaperqos.ShaperPolicy
DescendantInfo:
sasqos.FcDot1pMap
DescendantInfo:
ltessg.SteeringProfile
DescendantInfo:
srpythonmgmt.PythonScript
DescendantInfo:
sasqos.MplsLspExpMap
DescendantInfo:
lte.CreditPoolProfile
DescendantInfo:
ltegw.UDPTunnelGroupProfile
DescendantInfo:
multicast.IngrPathMgmtBwPolicy
DescendantInfo:
aclfilter.Ipv6Filter
DescendantInfo:
aapolicy.AAPrefixListPolicy
DescendantInfo:
ipsec.IPSecTunnelTemplate
DescendantInfo:
nat.PcpPolicy
DescendantInfo:
mmepolicy.WMMPfmMeasGroupName
DescendantInfo:
aosqos.QoSAction
DescendantInfo:
lte5g.EventTriggerFBCProfile
DescendantInfo:
srpythonmgmt.PythonPolicy
DescendantInfo:
aclfilterli.LiFilter
DescendantInfo:
ixrqos.EgressRemarkPolicy
DescendantInfo:
diameter.DiameterPeerPolicy
DescendantInfo:
nat.AbstractNatPlcy
DescendantInfo:
aosqos.Policy
DescendantInfo:
aapolicy.AAPolicer
DescendantInfo:
aclfilter.IpFilter
DescendantInfo:
lte5g.SMFChargingProfile
DescendantInfo:
lte.TargetProfile
DescendantInfo:
lte.GroupLabel
DescendantInfo:
ixrqos.Dot1pFCMap
DescendantInfo:
lte5g.SMFServingAreaList
DescendantInfo:
squeue.Policy
DescendantInfo:
ltetwag.SlaacHostProfile
DescendantInfo:
aaa.RouteDownloadPolicy
DescendantInfo:
ltessg.AddressListProfile
DescendantInfo:
pppoe.PPPPolicyBase
DescendantInfo:
lte.AbsCallInsight
DescendantInfo:
nat.SvcChainEvpnPolicy
DescendantInfo:
aapolicy.AaStatTcaFilterCfg
DescendantInfo:
ltegw.QciListPolicyGroup
DescendantInfo:
aapolicy.AAUrlListPolicy
DescendantInfo:
aapolicy.HttpRedirect
DescendantInfo:
ixrqos.LspExpFCMap
DescendantInfo:
niegr.Policy
DescendantInfo:
securitypolicy.PolicerGroup
DescendantInfo:
aapolicy.AACertProfile
DescendantInfo:
securityqueue.SecurityQueuePolicy
DescendantInfo:
genericne.MvMultitermPolicy
DescendantInfo:
lte.TaiLaiListProfile
DescendantInfo:
nat.MapDomain
DescendantInfo:
nodelog.LogProfile
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_policy_PolicyDefinition_setDistributionModeToSyncWithGlobal", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setDistributionModeToSyncWithGlobalResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/policy/PolicyDefinition/syncTo/{instanceFullName}": { "post": { "tags": [ "samo_policy" ], "summary": "rest_policy_PolicyDefinition_syncTo", "description": "If it is called from global policy, the selected local policy is copied into this global policy.
If configuration mode is not used, the synchronized global policy is distributed to existing
local definitions network-wide.
If it is called from the local policy, the selected local policy is copied into this local policy
and applied to the network.

Intention : MODIFIER
syncTo:
instance-level modifier API syncTo
of class policy.PolicyDefinition
DescendantInfo:
rtr.SegmentRoutingMaintenancePolicy
DescendantInfo:
lte5g.PcfIdList
DescendantInfo:
mplstp.BFDTemplate
DescendantInfo:
ixrqos.VlanQosPolicy
DescendantInfo:
ressubscr.ShcvPolicy
DescendantInfo:
ltepolicyoptions.AssumePositiveActionProfile
DescendantInfo:
ixrqos.FcLspExpMap
DescendantInfo:
aclfilterli.LiIpv6Filter
DescendantInfo:
subscrexpmap.Policy
DescendantInfo:
sitesec.DCpuProtection
DescendantInfo:
rp.ASPathGroup
DescendantInfo:
diameter.DiameterAppPolicy
DescendantInfo:
aclfilter.AbstractFilterDefinition
DescendantInfo:
sasqos.Network
DescendantInfo:
lte.GtpProfile
DescendantInfo:
rp.PolicyStatement
DescendantInfo:
file.Policy
DescendantInfo:
lte.PfcpAPPeerList
DescendantInfo:
ethernetservice.UniProfile
DescendantInfo:
ltepolicyoptions.TrafficHashProfile
DescendantInfo:
sitesec.TlsCertificateProfile
DescendantInfo:
qosprofile.MlpppEgressQosProfile
DescendantInfo:
vs.AdvancedConfigPolicy
DescendantInfo:
sasqos.SchedulerPolicy
DescendantInfo:
aapolicy.AAUrlFilter
DescendantInfo:
genericne.MvQosPolicy
DescendantInfo:
sitesec.PkiCommonNameList
DescendantInfo:
ethernetservice.CustomL2Profile
DescendantInfo:
ltetwag.DiameterPeerGroupList
DescendantInfo:
postpolicermapping.PostPolicerMappingPolicy
DescendantInfo:
aengr.Policy
DescendantInfo:
sitesec.LocalUser
DescendantInfo:
rp.PrefixList
DescendantInfo:
lte5g.NfIdList
DescendantInfo:
rtr.RouteNextHopPolicyTemplate
DescendantInfo:
lte5g.QfiMappingProfile
DescendantInfo:
aapolicy.AbstractTransitPolicy
DescendantInfo:
aclfilter.AbstractExceptionFilter
DescendantInfo:
sasqos.DSCPClassification
DescendantInfo:
lte.WlanEmergencyProfile
DescendantInfo:
portscheduler.Policy
DescendantInfo:
vs.Policy
DescendantInfo:
lteggsn.GyAvpOptionProfile
DescendantInfo:
ixrqos.NetworkIngressPolicy
DescendantInfo:
ixrqos.FcDot1pMap
DescendantInfo:
sasqos.NQueue
DescendantInfo:
aapolicy.TetherDetection
DescendantInfo:
service.Y1564AcceptanceCriteriaProfile
DescendantInfo:
ltepolicyoptions.PolicyRule
DescendantInfo:
lte.Abspfcp
DescendantInfo:
mmepolicy.MMEEmergencyNumListPolicy
DescendantInfo:
sitesec.AOSSecurityPolicy
DescendantInfo:
lte.T6cProfile
DescendantInfo:
lte.EpdgGroupList
DescendantInfo:
slope.HsmdaSlopePolicy
DescendantInfo:
aapolicy.AaStatTcaFltrEntryCfg
DescendantInfo:
lte.SourceIpList
DescendantInfo:
sasqos.FcDscpMap
DescendantInfo:
lte.IPProfile
DescendantInfo:
ipsec.IPSecTransform
DescendantInfo:
subscrauth.Policy
DescendantInfo:
icmp.IcmpPingTemplate
DescendantInfo:
qosprefixlist.PrefixList
DescendantInfo:
sitesec.DoSProtection
DescendantInfo:
lte.DccaProfile
DescendantInfo:
filterprefixlist.PortList
DescendantInfo:
rtr.AdminTag
DescendantInfo:
aapolicy.AASessionFilter
DescendantInfo:
hsqos.HsSchedulerPolicy
DescendantInfo:
ltepolicyoptions.ServiceClassIndicator
DescendantInfo:
sitesec.UserProfile
DescendantInfo:
ltepolicyoptions.SruList
DescendantInfo:
lte.AllUesCallTrace
DescendantInfo:
sitesec.TlsServerCipherList
DescendantInfo:
ltegw.TariffChangeListProfilePolicyGroup
DescendantInfo:
aingr.Policy
DescendantInfo:
aapolicy.AbstractHttpRedirect
DescendantInfo:
ltetwag.StaProfile
DescendantInfo:
redirectfilter.RedirectPolicyBinding
DescendantInfo:
sasqos.FCMeterMap
DescendantInfo:
vrrp.Policy
DescendantInfo:
lte5g.SliceList
DescendantInfo:
sasqos.SlopePolicy
DescendantInfo:
todsuite.Policy
DescendantInfo:
diameter.DiameterPolicy
DescendantInfo:
sasqos.SystemResourceProfilePolicy
DescendantInfo:
genericne.MvAbstractPolicy
DescendantInfo:
aapolicy.TransitPrefixPolicy
DescendantInfo:
sitesec.EstAuthProfile
DescendantInfo:
hwaggshapersched.HwAggShaperSchedulerPolicy
DescendantInfo:
aossas.CPETestHeadGroupProfile
DescendantInfo:
lte5g.PrioAddrList
DescendantInfo:
rp.GlobalVariables
DescendantInfo:
lte5g.SliceInstanceList
DescendantInfo:
lte.DedicatedBearerIdleTimeOutProfile
DescendantInfo:
security.KeyChain
DescendantInfo:
lte.PcmdProfile
DescendantInfo:
lteepdg.SwmAvpOptionProfile
DescendantInfo:
mpls.SharedRiskLinkGroup
DescendantInfo:
sitesec.TlsClientCipherList
DescendantInfo:
lte.AmfIdList
DescendantInfo:
ltehomeagent.MobileIpv4Profile
DescendantInfo:
file.LogDefinition
DescendantInfo:
macsec.MacPolicy
DescendantInfo:
securitypolicy.Policy
DescendantInfo:
ltepolicyoptions.AbsPolicyOptionProfile
DescendantInfo:
aclfilter.IpExceptionFilter
DescendantInfo:
sasqos.Dot1pClassification
DescendantInfo:
ipsec.IkePolicy
DescendantInfo:
mpr.QueueMapPolicy
DescendantInfo:
aapolicy.ApplicationAssurancePolicyDefinition
DescendantInfo:
service.VplsSapTemplate
DescendantInfo:
ltegw.AbsListPolicyGroup
DescendantInfo:
lte.SDProfile
DescendantInfo:
aapolicy.SctpFilter
DescendantInfo:
lte.PlmnListPolicyGroup
DescendantInfo:
mpr.GneRadiusQosPolicy
DescendantInfo:
l2fwd.MrpPolicy
DescendantInfo:
sasqos.AccessIngress
DescendantInfo:
crdtctrl.CrdtCtrlPolicy
DescendantInfo:
lte.PortList
DescendantInfo:
lte5g.SbaNudmSdmProf
DescendantInfo:
rp.Damping
DescendantInfo:
aapolicy.TransitIpPolicy
DescendantInfo:
lte.SwmErrorMappingProfile
DescendantInfo:
firewall.Zone
DescendantInfo:
rp.ASPath
DescendantInfo:
ltepolicyoptions.UsgMonInfo
DescendantInfo:
sitesec.RadiusPolicy
DescendantInfo:
optical.AlarmProfile
DescendantInfo:
ipsec.CertProfile
DescendantInfo:
crdtctrl.CtgryMapPolicy
DescendantInfo:
lte.DiameterErrorMappingProfile
DescendantInfo:
ressubscr.HostTrackingPolicy
DescendantInfo:
sasqos.MplsLspExpClassification
DescendantInfo:
ressubscr.IgmpPolicy
DescendantInfo:
lte.AccountingPriorityProfile
DescendantInfo:
rp.RouteNextHopPolicyTemplate
DescendantInfo:
ressubscr.PimPolicy
DescendantInfo:
ltepolicyoptions.DynamicToInternalRuleMap
DescendantInfo:
netca.CardStatsTCAProfile
DescendantInfo:
subscrprofile.Policy
DescendantInfo:
aapolicy.HttpEnrich
DescendantInfo:
ltepolicyoptions.GxAvpOptionProfile
DescendantInfo:
sitesec.LdapPolicy
DescendantInfo:
aclfilter.FilterDefinition
DescendantInfo:
fpresource.FPResourcePolicy
DescendantInfo:
securitypolicy.Zone
DescendantInfo:
ltegw.SCTPProfile
DescendantInfo:
sasqos.QueueMgmtPolicy
DescendantInfo:
sasqos.FcLspExpMap
DescendantInfo:
ltepolicyoptions.TriggerRuleUnitProfile
DescendantInfo:
ressubscr.HttpRedirectPolicy
DescendantInfo:
service.Y1564FrameMixProfile
DescendantInfo:
ltepolicyoptions.PolicyRuleUnit
DescendantInfo:
firewall.MgmtAccessFirewall
DescendantInfo:
ltehomeagent.AbsHomeAgentProfile
DescendantInfo:
firewall.RuleSet
DescendantInfo:
netca.StatsTCAProfile
DescendantInfo:
genericne.MvPolicerPolicy
DescendantInfo:
rp.AbstractSrlgGroupPolicy
DescendantInfo:
lte5g.SbaNudmUecmProf
DescendantInfo:
sasqos.IngressCoSClassification
DescendantInfo:
rp.SrlgGroupPolicy
DescendantInfo:
aaa.RadiusScriptPolicy
DescendantInfo:
nat.SvcChainVasFilterPolicy
DescendantInfo:
aapolicy.DnsIpCache
DescendantInfo:
sasqos.NetworkIngress
DescendantInfo:
ltepolicyoptions.ChargingRuleUnit
DescendantInfo:
aapolicy.AAFlowCfgPolicy
DescendantInfo:
lte5g.HTTP2Profile
DescendantInfo:
sasqos.PortAccessIngress
DescendantInfo:
ltegw.PcscfGroupProfile
DescendantInfo:
multicast.IngrPathMgmtInfoPolicy
DescendantInfo:
sitesec.ManagementAccessFilter
DescendantInfo:
ltetwag.SwwTunnelProfile
DescendantInfo:
ethernetoam.MaintenanceDomain
DescendantInfo:
ipsec.RadiusAuthenticationPolicy
DescendantInfo:
aapolicy.AaStatTcaPolicerCfg
DescendantInfo:
ipsec.TrafficSelectorList
DescendantInfo:
atmpolicy.TrafficDescriptor
DescendantInfo:
sasqos.PortAccessEgress
DescendantInfo:
aapolicy.MpTcpProxy
DescendantInfo:
connprof.VlanConnProfPolicy
DescendantInfo:
opticalacl.IpPattern
DescendantInfo:
policing.PolicerControl
DescendantInfo:
sw.SoftwareRepositoryPolicy
DescendantInfo:
svt.TunnelAdminGroup
DescendantInfo:
optical.OcsAlarmProfile
DescendantInfo:
aclfilterli.BlockReservation
DescendantInfo:
genericne.MvMatchingRulePolicy
DescendantInfo:
mmepolicy.WMMInterfaceProfile
DescendantInfo:
calltrace.TraceProfile
DescendantInfo:
ltepolicyoptions.DhcpServerGroupProfile
DescendantInfo:
service.AbstractSapTemplate
DescendantInfo:
aapolicy.AaTcpValidationTca
DescendantInfo:
ltepmip.S6bAvpOptionProfile
DescendantInfo:
redirectfilter.RedirectPolicy
DescendantInfo:
service.EpipeSapTemplate
DescendantInfo:
lte.AbsGtpProfile
DescendantInfo:
ltegw.AvpOptionProfile
DescendantInfo:
nodelog.FirewallLog
DescendantInfo:
multicast.McastCacInterfacePolicy
DescendantInfo:
nodelog.FilterLog
DescendantInfo:
ixrqos.FcDSCPMap
DescendantInfo:
lte5g.NpcfProfile
DescendantInfo:
ltegw.AbsNodeSelPolicyGroup
DescendantInfo:
sitesec.PasswordPolicy
DescendantInfo:
nat.NatClassifier
DescendantInfo:
aaa.L2tpRadiusAccountingPolicy
DescendantInfo:
dynsvc.DynSvcPolicy
DescendantInfo:
ltepolicyoptions.UsgMonAction
DescendantInfo:
sitesec.TacacsPolicy
DescendantInfo:
ltepolicyoptions.StatsRuleUnit
DescendantInfo:
rp.Community
DescendantInfo:
securitypolicy.Bypass
DescendantInfo:
lte.DnsErrMapProfile
DescendantInfo:
nat.FirewallPolicy
DescendantInfo:
ipsec.IPSecClientDB
DescendantInfo:
lte.QciPolicy
DescendantInfo:
filterprefixlist.PrefixList
DescendantInfo:
netca.OCSStatsTCAProfile
DescendantInfo:
rmon.RemoteNetworkMonitoring
DescendantInfo:
aapolicy.AaFilterAbstract
DescendantInfo:
ltepmip.Pmipv6Profile
DescendantInfo:
lte5g.NrfProfile
DescendantInfo:
pppoe.PPPPolicy
DescendantInfo:
qgroup.EgressQGroupPolicy
DescendantInfo:
aaa.NatRadiusAccountingPolicy
DescendantInfo:
ressubscr.IpoePolicy
DescendantInfo:
securitypolicy.SecurityPolicyDefinition
DescendantInfo:
sitesec.RemoteAuthPolicy
DescendantInfo:
aosqos.QoSNetworkGroups
DescendantInfo:
aapolicy.GtpFilter
DescendantInfo:
lte.FqdnGroupProfile
DescendantInfo:
aclfilter.VlanFilter
DescendantInfo:
lte.DiameterPeerProfile
DescendantInfo:
mpr.RadioQOS
DescendantInfo:
portscheduler.HsmdaSchedulerPolicy
DescendantInfo:
lte5g.N1Profile
DescendantInfo:
lte.PfcpProfile
DescendantInfo:
securitypolicy.HostGroup
DescendantInfo:
ressubscr.RipPolicy
DescendantInfo:
aapolicy.AccessNetworkLocation
DescendantInfo:
lteepdg.IPSecProfile
DescendantInfo:
sitesec.TlsTrustAnchorProfile
DescendantInfo:
connprof.PssConnProfPolicy
DescendantInfo:
lte.DiameterRateLimProfile
DescendantInfo:
ltetwag.TwagChargingProfile
DescendantInfo:
ipsec.IPSecStaticSA
DescendantInfo:
ressubscr.MldPolicy
DescendantInfo:
nodelog.AbstractLog
DescendantInfo:
slaprofile.Policy
DescendantInfo:
wlangw.DsmIpFilterPolicy
DescendantInfo:
aapolicy.AaSubCongDetect
DescendantInfo:
opticalacl.OcsIpFilter
DescendantInfo:
lte.DnsProfile
DescendantInfo:
ipfix.IPFIXExportPolicy
DescendantInfo:
ixrqos.DSCPFCMap
DescendantInfo:
slope.Policy
DescendantInfo:
mpls.Policy
DescendantInfo:
rp.AbstractAdminGroupPolicy
DescendantInfo:
portscheduler.HsmdaWrrPolicy
DescendantInfo:
mmepolicy.MMEEmergencyNumListTblPolicy
DescendantInfo:
lteepdg.EpdgChargingProfile
DescendantInfo:
lte.ErrorMappingProfile
DescendantInfo:
lte.FqdnList
DescendantInfo:
lte.GxProfile
DescendantInfo:
lte.CloudDBProfile
DescendantInfo:
sasqos.Remark
DescendantInfo:
aclfilter.DhcpFilter
DescendantInfo:
slope.NamedPool
DescendantInfo:
qosprofile.McfrEgressQosProfile
DescendantInfo:
ipsec.IkeTransform
DescendantInfo:
lte5g.Oauth2Profile
DescendantInfo:
sitesec.TlsClientProfile
DescendantInfo:
aapolicy.AaStatTcaAbstract
DescendantInfo:
firewall.HostGroup
DescendantInfo:
ressubscr.BgpPeeringPolicy
DescendantInfo:
service.SvcActTestHeadAcceptanceCriteriaTemplate
DescendantInfo:
nodelog.SysLogTarget
DescendantInfo:
aaa.AcctOnOffGroup
DescendantInfo:
lte.UeCallTrace
DescendantInfo:
aclfilter.MacFilter
DescendantInfo:
sas.StreamingDelayTemplate
DescendantInfo:
lte.DefBearerQoSProfile
DescendantInfo:
rp.PolicyObjectBase
DescendantInfo:
service.Y1564TestHeadProfile
DescendantInfo:
igmp.SSMTranslatePolicy
DescendantInfo:
radiusaccounting.Policy
DescendantInfo:
aapolicy.AaTcpOpt
DescendantInfo:
service.SvcActTestHeadFrameSizeTemplate
DescendantInfo:
ipsec.TrustAnchorProfile
DescendantInfo:
ixrqos.PortQosPolicy
DescendantInfo:
nodelog.SecurityLog
DescendantInfo:
ixrqos.IngressClassification
DescendantInfo:
aapolicy.Policy
DescendantInfo:
ipsec.RadiusAccountingPolicy
DescendantInfo:
qosprofile.McfrIngressQosProfile
DescendantInfo:
ressubscr.HostLockoutPolicy
DescendantInfo:
ressubscr.SubMcastCacPolicy
DescendantInfo:
slope.HsmdaPoolPolicy
DescendantInfo:
opticalacl.IpFilter
DescendantInfo:
ixrqos.QueueMgmtPolicy
DescendantInfo:
policy.PSGGenericPolicy
DescendantInfo:
mmepolicy.MMESCTPProfile
DescendantInfo:
aapolicy.AARadiusAccountingPolicy
DescendantInfo:
lte.SgwChargingProfile
DescendantInfo:
multicast.EgressMcastGroup
DescendantInfo:
aapolicy.HttpErrorRedirect
DescendantInfo:
multicast.McastReportDestination
DescendantInfo:
firewall.CPMFirewall
DescendantInfo:
rtr.AbstractAdminGroupPolicy
DescendantInfo:
lte.TrustedPeerListPolicy
DescendantInfo:
lteli.DFPeer
DescendantInfo:
aosqos.QoSMacGroups
DescendantInfo:
ltepolicyoptions.ApnRateControl
DescendantInfo:
hsqos.HsAttachmentPolicy
DescendantInfo:
subscrident.Policy
DescendantInfo:
tod.Policy
DescendantInfo:
lteggsn.CdrAvpOptionProfile
DescendantInfo:
lte.OIOverList
DescendantInfo:
aapolicy.AAGroupPolicy
DescendantInfo:
lte.MMEGroupProfile
DescendantInfo:
lteradius.RadiusGroupProfile
DescendantInfo:
lteli.InterceptionTarget
DescendantInfo:
mmepolicy.MMEProfile
DescendantInfo:
lte.IkeRedList
DescendantInfo:
ltehomeagent.DNSRedirectServer
DescendantInfo:
qosprofile.MlpppIngressQosProfile
DescendantInfo:
dctr.PortProfile
DescendantInfo:
multicast.PackagePolicy
DescendantInfo:
lte.PgwSelectionCandidateList
DescendantInfo:
file.FileTransmissionProfile
DescendantInfo:
genericne.MvFilterPolicy
DescendantInfo:
mmepolicy.MMEGTPProfile
DescendantInfo:
genericne.MvForwardingClassPolicy
DescendantInfo:
ltetwag.DhcpServerProfile
DescendantInfo:
aclfilter.Ipv6ExceptionFilter
DescendantInfo:
aclfilter.DhcpV6Filter
DescendantInfo:
lteradius.RadiusProfile
DescendantInfo:
sitesec.TlsServerProfile
DescendantInfo:
nqueue.Policy
DescendantInfo:
sasqos.AccessEgress
DescendantInfo:
wlangw.DsmTrafficPolicer
DescendantInfo:
lte.UpPeerList
DescendantInfo:
netca.AbstractStatsTCAProfile
DescendantInfo:
sasqos.MpBwPolicy
DescendantInfo:
nat.NatPolicy
DescendantInfo:
ltepolicyoptions.QoSRuleUnit
DescendantInfo:
sas.BinGroup
DescendantInfo:
aapolicy.HttpNotif
DescendantInfo:
ethernetservice.SapProfile
DescendantInfo:
sitesec.CpmIpFilter
DescendantInfo:
mmepolicy.WMMSVCAgreementProfile
DescendantInfo:
connprof.ConnProfPolicy
DescendantInfo:
pae802_1x.RadiusServerPolicy
DescendantInfo:
aapolicy.AaStatTcaCfg
DescendantInfo:
sasqos.PortScheduler
DescendantInfo:
lte.IdiRealmList
DescendantInfo:
sitesec.CertificateAuthProfile
DescendantInfo:
qgroup.RedirectList
DescendantInfo:
ltepolicyoptions.PolicyRuleBase
DescendantInfo:
genericne.MVGenericPolicy
DescendantInfo:
rtr.AdminGroupPolicy
DescendantInfo:
aaa.RadiusServerPolicy
DescendantInfo:
securitypolicy.Profile
DescendantInfo:
lte.PpiMappingProfile
DescendantInfo:
rtr.SharedRiskLinkGroup
DescendantInfo:
aapolicy.AAPortList
DescendantInfo:
lte.AgwChargingProfile
DescendantInfo:
mpls.LspTemplateMvpn
DescendantInfo:
aossas.CPETestHeadProfile
DescendantInfo:
ltegw.ApnListPolicyGroup
DescendantInfo:
ancp.Policy
DescendantInfo:
lte.CCFHProfile
DescendantInfo:
aclfilter.AggregateFilter
DescendantInfo:
lte.IpAddressList
DescendantInfo:
dctr.Profile
DescendantInfo:
hsqos.HsPortPoolPolicy
DescendantInfo:
hsqos.HsPoolPolicy
DescendantInfo:
ltessg.TdfChargingProfile
DescendantInfo:
aaa.IsaRadiusPolicy
DescendantInfo:
ltepolicyoptions.TrafficRedirectProfile
DescendantInfo:
nat.UpnpPolicy
DescendantInfo:
pdnprofile.PacketDataNetworkProfilePolicy
DescendantInfo:
gtp.ApnPolicy
DescendantInfo:
rtr.AbstractSharedRiskLinkGroup
DescendantInfo:
aosqos.QoSCondition
DescendantInfo:
ltetwag.SwwRadiusProfile
DescendantInfo:
svt.PwTemplate
DescendantInfo:
filterprefixlist.ProtocolList
DescendantInfo:
rp.AdminGroupPolicy
DescendantInfo:
rtr.AdminTagPolicy
DescendantInfo:
ltehomeagent.FAHAPeerList
DescendantInfo:
mpls.SRLGStaticConfig
DescendantInfo:
accounting.Policy
DescendantInfo:
lte.PfcpTranslateProfile
DescendantInfo:
aapolicy.AaTcpValidation
DescendantInfo:
lte5g.CHFProfile
DescendantInfo:
opticalacl.AbstractIpFilter
DescendantInfo:
msappolicy.Policy
DescendantInfo:
wlangw.MgwProfile
DescendantInfo:
lte5g.AllowedNFDomainList
DescendantInfo:
mmepolicy.WMMPfmJobEntry
DescendantInfo:
aclfilterli.LiMacFilter
DescendantInfo:
securitypolicy.AppGroup
DescendantInfo:
aapolicy.AaCflowdGroupPolicy
DescendantInfo:
lte.PeerListPolicy
DescendantInfo:
fabricqos.FabricProfile
DescendantInfo:
firewall.FwPolicyDefinition
DescendantInfo:
multicast.McastCacPolicy
DescendantInfo:
rp.PolicyAccountingTemplate
DescendantInfo:
ipsec.AbstractTrustAnchorProfile
DescendantInfo:
aclfilter.GreTunnelTemplate
DescendantInfo:
lte.DiameterProfile
DescendantInfo:
lte.PgwChargingProfile
DescendantInfo:
sasqos.EgressRemarking
DescendantInfo:
aclfilterli.LiIpFilter
DescendantInfo:
ltepolicyoptions.UrrProfile
DescendantInfo:
service.Y1564PayloadProfile
DescendantInfo:
lte5g.UdmIdList
DescendantInfo:
sas.LinkMeasurementTemplate
DescendantInfo:
nat.NatPrefixList
DescendantInfo:
aaa.IsaRadiusPolicyBase
DescendantInfo:
lteradius.AbsRadiusProfile
DescendantInfo:
equipment.PortPolicy
DescendantInfo:
unpprofile.UNPProfile
DescendantInfo:
rtr.ReassemblyProfilePolicy
DescendantInfo:
lte.GtpPrimeServerGroupProfile
DescendantInfo:
lte.Profile
DescendantInfo:
layer2.L2Profile
DescendantInfo:
qosportlist.PortList
DescendantInfo:
lte.ClientProfile
DescendantInfo:
lte.OverloadControlProfile
DescendantInfo:
ressubscr.BrgProfile
DescendantInfo:
firewall.ServiceGroup
DescendantInfo:
vs.ServiceTypeDefinition
DescendantInfo:
qgroup.IngressQGroupPolicy
DescendantInfo:
lte.SubscriberMappingProfile
DescendantInfo:
lte5g.SMFAttributesProfile
DescendantInfo:
ltegw.UMTSQoSPolicy
DescendantInfo:
ltepolicyoptions.ActionRuleUnitProfile
DescendantInfo:
lte.S2bErrorMappingProfile
DescendantInfo:
dynsvc.DynSvcLocalAuthDb
DescendantInfo:
lte5g.EmerProfile
DescendantInfo:
aosqos.List
DescendantInfo:
shaperqos.ShaperPolicy
DescendantInfo:
sasqos.FcDot1pMap
DescendantInfo:
ltessg.SteeringProfile
DescendantInfo:
srpythonmgmt.PythonScript
DescendantInfo:
sasqos.MplsLspExpMap
DescendantInfo:
lte.CreditPoolProfile
DescendantInfo:
ltegw.UDPTunnelGroupProfile
DescendantInfo:
multicast.IngrPathMgmtBwPolicy
DescendantInfo:
aclfilter.Ipv6Filter
DescendantInfo:
aapolicy.AAPrefixListPolicy
DescendantInfo:
ipsec.IPSecTunnelTemplate
DescendantInfo:
nat.PcpPolicy
DescendantInfo:
mmepolicy.WMMPfmMeasGroupName
DescendantInfo:
aosqos.QoSAction
DescendantInfo:
lte5g.EventTriggerFBCProfile
DescendantInfo:
srpythonmgmt.PythonPolicy
DescendantInfo:
aclfilterli.LiFilter
DescendantInfo:
ixrqos.EgressRemarkPolicy
DescendantInfo:
diameter.DiameterPeerPolicy
DescendantInfo:
nat.AbstractNatPlcy
DescendantInfo:
aosqos.Policy
DescendantInfo:
aapolicy.AAPolicer
DescendantInfo:
aclfilter.IpFilter
DescendantInfo:
lte5g.SMFChargingProfile
DescendantInfo:
lte.TargetProfile
DescendantInfo:
lte.GroupLabel
DescendantInfo:
ixrqos.Dot1pFCMap
DescendantInfo:
lte5g.SMFServingAreaList
DescendantInfo:
squeue.Policy
DescendantInfo:
ltetwag.SlaacHostProfile
DescendantInfo:
aaa.RouteDownloadPolicy
DescendantInfo:
ltessg.AddressListProfile
DescendantInfo:
pppoe.PPPPolicyBase
DescendantInfo:
lte.AbsCallInsight
DescendantInfo:
nat.SvcChainEvpnPolicy
DescendantInfo:
aapolicy.AaStatTcaFilterCfg
DescendantInfo:
ltegw.QciListPolicyGroup
DescendantInfo:
aapolicy.AAUrlListPolicy
DescendantInfo:
aapolicy.HttpRedirect
DescendantInfo:
ixrqos.LspExpFCMap
DescendantInfo:
niegr.Policy
DescendantInfo:
securitypolicy.PolicerGroup
DescendantInfo:
aapolicy.AACertProfile
DescendantInfo:
securityqueue.SecurityQueuePolicy
DescendantInfo:
genericne.MvMultitermPolicy
DescendantInfo:
lte.TaiLaiListProfile
DescendantInfo:
nat.MapDomain
DescendantInfo:
nodelog.LogProfile
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_policy_PolicyDefinition_syncTo", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/syncToResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/policy/PolicyDefinition/syncToLocalWithResync/{instanceFullName}": { "post": { "tags": [ "samo_policy" ], "summary": "rest_policy_PolicyDefinition_syncToLocalWithResync", "description": "Is called from the local policy,resync of the local policy is done before the selected local policy is copied into this local policy
and applied to the network.

Intention : MODIFIER
syncToLocalWithResync:
instance-level modifier API syncToLocalWithResync
of class policy.PolicyDefinition
DescendantInfo:
rtr.SegmentRoutingMaintenancePolicy
DescendantInfo:
lte5g.PcfIdList
DescendantInfo:
mplstp.BFDTemplate
DescendantInfo:
ixrqos.VlanQosPolicy
DescendantInfo:
ressubscr.ShcvPolicy
DescendantInfo:
ltepolicyoptions.AssumePositiveActionProfile
DescendantInfo:
ixrqos.FcLspExpMap
DescendantInfo:
aclfilterli.LiIpv6Filter
DescendantInfo:
subscrexpmap.Policy
DescendantInfo:
sitesec.DCpuProtection
DescendantInfo:
rp.ASPathGroup
DescendantInfo:
diameter.DiameterAppPolicy
DescendantInfo:
aclfilter.AbstractFilterDefinition
DescendantInfo:
sasqos.Network
DescendantInfo:
lte.GtpProfile
DescendantInfo:
rp.PolicyStatement
DescendantInfo:
file.Policy
DescendantInfo:
lte.PfcpAPPeerList
DescendantInfo:
ethernetservice.UniProfile
DescendantInfo:
ltepolicyoptions.TrafficHashProfile
DescendantInfo:
sitesec.TlsCertificateProfile
DescendantInfo:
qosprofile.MlpppEgressQosProfile
DescendantInfo:
vs.AdvancedConfigPolicy
DescendantInfo:
sasqos.SchedulerPolicy
DescendantInfo:
aapolicy.AAUrlFilter
DescendantInfo:
genericne.MvQosPolicy
DescendantInfo:
sitesec.PkiCommonNameList
DescendantInfo:
ethernetservice.CustomL2Profile
DescendantInfo:
ltetwag.DiameterPeerGroupList
DescendantInfo:
postpolicermapping.PostPolicerMappingPolicy
DescendantInfo:
aengr.Policy
DescendantInfo:
sitesec.LocalUser
DescendantInfo:
rp.PrefixList
DescendantInfo:
lte5g.NfIdList
DescendantInfo:
rtr.RouteNextHopPolicyTemplate
DescendantInfo:
lte5g.QfiMappingProfile
DescendantInfo:
aapolicy.AbstractTransitPolicy
DescendantInfo:
aclfilter.AbstractExceptionFilter
DescendantInfo:
sasqos.DSCPClassification
DescendantInfo:
lte.WlanEmergencyProfile
DescendantInfo:
portscheduler.Policy
DescendantInfo:
vs.Policy
DescendantInfo:
lteggsn.GyAvpOptionProfile
DescendantInfo:
ixrqos.NetworkIngressPolicy
DescendantInfo:
ixrqos.FcDot1pMap
DescendantInfo:
sasqos.NQueue
DescendantInfo:
aapolicy.TetherDetection
DescendantInfo:
service.Y1564AcceptanceCriteriaProfile
DescendantInfo:
ltepolicyoptions.PolicyRule
DescendantInfo:
lte.Abspfcp
DescendantInfo:
mmepolicy.MMEEmergencyNumListPolicy
DescendantInfo:
sitesec.AOSSecurityPolicy
DescendantInfo:
lte.T6cProfile
DescendantInfo:
lte.EpdgGroupList
DescendantInfo:
slope.HsmdaSlopePolicy
DescendantInfo:
aapolicy.AaStatTcaFltrEntryCfg
DescendantInfo:
lte.SourceIpList
DescendantInfo:
sasqos.FcDscpMap
DescendantInfo:
lte.IPProfile
DescendantInfo:
ipsec.IPSecTransform
DescendantInfo:
subscrauth.Policy
DescendantInfo:
icmp.IcmpPingTemplate
DescendantInfo:
qosprefixlist.PrefixList
DescendantInfo:
sitesec.DoSProtection
DescendantInfo:
lte.DccaProfile
DescendantInfo:
filterprefixlist.PortList
DescendantInfo:
rtr.AdminTag
DescendantInfo:
aapolicy.AASessionFilter
DescendantInfo:
hsqos.HsSchedulerPolicy
DescendantInfo:
ltepolicyoptions.ServiceClassIndicator
DescendantInfo:
sitesec.UserProfile
DescendantInfo:
ltepolicyoptions.SruList
DescendantInfo:
lte.AllUesCallTrace
DescendantInfo:
sitesec.TlsServerCipherList
DescendantInfo:
ltegw.TariffChangeListProfilePolicyGroup
DescendantInfo:
aingr.Policy
DescendantInfo:
aapolicy.AbstractHttpRedirect
DescendantInfo:
ltetwag.StaProfile
DescendantInfo:
redirectfilter.RedirectPolicyBinding
DescendantInfo:
sasqos.FCMeterMap
DescendantInfo:
vrrp.Policy
DescendantInfo:
lte5g.SliceList
DescendantInfo:
sasqos.SlopePolicy
DescendantInfo:
todsuite.Policy
DescendantInfo:
diameter.DiameterPolicy
DescendantInfo:
sasqos.SystemResourceProfilePolicy
DescendantInfo:
genericne.MvAbstractPolicy
DescendantInfo:
aapolicy.TransitPrefixPolicy
DescendantInfo:
sitesec.EstAuthProfile
DescendantInfo:
hwaggshapersched.HwAggShaperSchedulerPolicy
DescendantInfo:
aossas.CPETestHeadGroupProfile
DescendantInfo:
lte5g.PrioAddrList
DescendantInfo:
rp.GlobalVariables
DescendantInfo:
lte5g.SliceInstanceList
DescendantInfo:
lte.DedicatedBearerIdleTimeOutProfile
DescendantInfo:
security.KeyChain
DescendantInfo:
lte.PcmdProfile
DescendantInfo:
lteepdg.SwmAvpOptionProfile
DescendantInfo:
mpls.SharedRiskLinkGroup
DescendantInfo:
sitesec.TlsClientCipherList
DescendantInfo:
lte.AmfIdList
DescendantInfo:
ltehomeagent.MobileIpv4Profile
DescendantInfo:
file.LogDefinition
DescendantInfo:
macsec.MacPolicy
DescendantInfo:
securitypolicy.Policy
DescendantInfo:
ltepolicyoptions.AbsPolicyOptionProfile
DescendantInfo:
aclfilter.IpExceptionFilter
DescendantInfo:
sasqos.Dot1pClassification
DescendantInfo:
ipsec.IkePolicy
DescendantInfo:
mpr.QueueMapPolicy
DescendantInfo:
aapolicy.ApplicationAssurancePolicyDefinition
DescendantInfo:
service.VplsSapTemplate
DescendantInfo:
ltegw.AbsListPolicyGroup
DescendantInfo:
lte.SDProfile
DescendantInfo:
aapolicy.SctpFilter
DescendantInfo:
lte.PlmnListPolicyGroup
DescendantInfo:
mpr.GneRadiusQosPolicy
DescendantInfo:
l2fwd.MrpPolicy
DescendantInfo:
sasqos.AccessIngress
DescendantInfo:
crdtctrl.CrdtCtrlPolicy
DescendantInfo:
lte.PortList
DescendantInfo:
lte5g.SbaNudmSdmProf
DescendantInfo:
rp.Damping
DescendantInfo:
aapolicy.TransitIpPolicy
DescendantInfo:
lte.SwmErrorMappingProfile
DescendantInfo:
firewall.Zone
DescendantInfo:
rp.ASPath
DescendantInfo:
ltepolicyoptions.UsgMonInfo
DescendantInfo:
sitesec.RadiusPolicy
DescendantInfo:
optical.AlarmProfile
DescendantInfo:
ipsec.CertProfile
DescendantInfo:
crdtctrl.CtgryMapPolicy
DescendantInfo:
lte.DiameterErrorMappingProfile
DescendantInfo:
ressubscr.HostTrackingPolicy
DescendantInfo:
sasqos.MplsLspExpClassification
DescendantInfo:
ressubscr.IgmpPolicy
DescendantInfo:
lte.AccountingPriorityProfile
DescendantInfo:
rp.RouteNextHopPolicyTemplate
DescendantInfo:
ressubscr.PimPolicy
DescendantInfo:
ltepolicyoptions.DynamicToInternalRuleMap
DescendantInfo:
netca.CardStatsTCAProfile
DescendantInfo:
subscrprofile.Policy
DescendantInfo:
aapolicy.HttpEnrich
DescendantInfo:
ltepolicyoptions.GxAvpOptionProfile
DescendantInfo:
sitesec.LdapPolicy
DescendantInfo:
aclfilter.FilterDefinition
DescendantInfo:
fpresource.FPResourcePolicy
DescendantInfo:
securitypolicy.Zone
DescendantInfo:
ltegw.SCTPProfile
DescendantInfo:
sasqos.QueueMgmtPolicy
DescendantInfo:
sasqos.FcLspExpMap
DescendantInfo:
ltepolicyoptions.TriggerRuleUnitProfile
DescendantInfo:
ressubscr.HttpRedirectPolicy
DescendantInfo:
service.Y1564FrameMixProfile
DescendantInfo:
ltepolicyoptions.PolicyRuleUnit
DescendantInfo:
firewall.MgmtAccessFirewall
DescendantInfo:
ltehomeagent.AbsHomeAgentProfile
DescendantInfo:
firewall.RuleSet
DescendantInfo:
netca.StatsTCAProfile
DescendantInfo:
genericne.MvPolicerPolicy
DescendantInfo:
rp.AbstractSrlgGroupPolicy
DescendantInfo:
lte5g.SbaNudmUecmProf
DescendantInfo:
sasqos.IngressCoSClassification
DescendantInfo:
rp.SrlgGroupPolicy
DescendantInfo:
aaa.RadiusScriptPolicy
DescendantInfo:
nat.SvcChainVasFilterPolicy
DescendantInfo:
aapolicy.DnsIpCache
DescendantInfo:
sasqos.NetworkIngress
DescendantInfo:
ltepolicyoptions.ChargingRuleUnit
DescendantInfo:
aapolicy.AAFlowCfgPolicy
DescendantInfo:
lte5g.HTTP2Profile
DescendantInfo:
sasqos.PortAccessIngress
DescendantInfo:
ltegw.PcscfGroupProfile
DescendantInfo:
multicast.IngrPathMgmtInfoPolicy
DescendantInfo:
sitesec.ManagementAccessFilter
DescendantInfo:
ltetwag.SwwTunnelProfile
DescendantInfo:
ethernetoam.MaintenanceDomain
DescendantInfo:
ipsec.RadiusAuthenticationPolicy
DescendantInfo:
aapolicy.AaStatTcaPolicerCfg
DescendantInfo:
ipsec.TrafficSelectorList
DescendantInfo:
atmpolicy.TrafficDescriptor
DescendantInfo:
sasqos.PortAccessEgress
DescendantInfo:
aapolicy.MpTcpProxy
DescendantInfo:
connprof.VlanConnProfPolicy
DescendantInfo:
opticalacl.IpPattern
DescendantInfo:
policing.PolicerControl
DescendantInfo:
sw.SoftwareRepositoryPolicy
DescendantInfo:
svt.TunnelAdminGroup
DescendantInfo:
optical.OcsAlarmProfile
DescendantInfo:
aclfilterli.BlockReservation
DescendantInfo:
genericne.MvMatchingRulePolicy
DescendantInfo:
mmepolicy.WMMInterfaceProfile
DescendantInfo:
calltrace.TraceProfile
DescendantInfo:
ltepolicyoptions.DhcpServerGroupProfile
DescendantInfo:
service.AbstractSapTemplate
DescendantInfo:
aapolicy.AaTcpValidationTca
DescendantInfo:
ltepmip.S6bAvpOptionProfile
DescendantInfo:
redirectfilter.RedirectPolicy
DescendantInfo:
service.EpipeSapTemplate
DescendantInfo:
lte.AbsGtpProfile
DescendantInfo:
ltegw.AvpOptionProfile
DescendantInfo:
nodelog.FirewallLog
DescendantInfo:
multicast.McastCacInterfacePolicy
DescendantInfo:
nodelog.FilterLog
DescendantInfo:
ixrqos.FcDSCPMap
DescendantInfo:
lte5g.NpcfProfile
DescendantInfo:
ltegw.AbsNodeSelPolicyGroup
DescendantInfo:
sitesec.PasswordPolicy
DescendantInfo:
nat.NatClassifier
DescendantInfo:
aaa.L2tpRadiusAccountingPolicy
DescendantInfo:
dynsvc.DynSvcPolicy
DescendantInfo:
ltepolicyoptions.UsgMonAction
DescendantInfo:
sitesec.TacacsPolicy
DescendantInfo:
ltepolicyoptions.StatsRuleUnit
DescendantInfo:
rp.Community
DescendantInfo:
securitypolicy.Bypass
DescendantInfo:
lte.DnsErrMapProfile
DescendantInfo:
nat.FirewallPolicy
DescendantInfo:
ipsec.IPSecClientDB
DescendantInfo:
lte.QciPolicy
DescendantInfo:
filterprefixlist.PrefixList
DescendantInfo:
netca.OCSStatsTCAProfile
DescendantInfo:
rmon.RemoteNetworkMonitoring
DescendantInfo:
aapolicy.AaFilterAbstract
DescendantInfo:
ltepmip.Pmipv6Profile
DescendantInfo:
lte5g.NrfProfile
DescendantInfo:
pppoe.PPPPolicy
DescendantInfo:
qgroup.EgressQGroupPolicy
DescendantInfo:
aaa.NatRadiusAccountingPolicy
DescendantInfo:
ressubscr.IpoePolicy
DescendantInfo:
securitypolicy.SecurityPolicyDefinition
DescendantInfo:
sitesec.RemoteAuthPolicy
DescendantInfo:
aosqos.QoSNetworkGroups
DescendantInfo:
aapolicy.GtpFilter
DescendantInfo:
lte.FqdnGroupProfile
DescendantInfo:
aclfilter.VlanFilter
DescendantInfo:
lte.DiameterPeerProfile
DescendantInfo:
mpr.RadioQOS
DescendantInfo:
portscheduler.HsmdaSchedulerPolicy
DescendantInfo:
lte5g.N1Profile
DescendantInfo:
lte.PfcpProfile
DescendantInfo:
securitypolicy.HostGroup
DescendantInfo:
ressubscr.RipPolicy
DescendantInfo:
aapolicy.AccessNetworkLocation
DescendantInfo:
lteepdg.IPSecProfile
DescendantInfo:
sitesec.TlsTrustAnchorProfile
DescendantInfo:
connprof.PssConnProfPolicy
DescendantInfo:
lte.DiameterRateLimProfile
DescendantInfo:
ltetwag.TwagChargingProfile
DescendantInfo:
ipsec.IPSecStaticSA
DescendantInfo:
ressubscr.MldPolicy
DescendantInfo:
nodelog.AbstractLog
DescendantInfo:
slaprofile.Policy
DescendantInfo:
wlangw.DsmIpFilterPolicy
DescendantInfo:
aapolicy.AaSubCongDetect
DescendantInfo:
opticalacl.OcsIpFilter
DescendantInfo:
lte.DnsProfile
DescendantInfo:
ipfix.IPFIXExportPolicy
DescendantInfo:
ixrqos.DSCPFCMap
DescendantInfo:
slope.Policy
DescendantInfo:
mpls.Policy
DescendantInfo:
rp.AbstractAdminGroupPolicy
DescendantInfo:
portscheduler.HsmdaWrrPolicy
DescendantInfo:
mmepolicy.MMEEmergencyNumListTblPolicy
DescendantInfo:
lteepdg.EpdgChargingProfile
DescendantInfo:
lte.ErrorMappingProfile
DescendantInfo:
lte.FqdnList
DescendantInfo:
lte.GxProfile
DescendantInfo:
lte.CloudDBProfile
DescendantInfo:
sasqos.Remark
DescendantInfo:
aclfilter.DhcpFilter
DescendantInfo:
slope.NamedPool
DescendantInfo:
qosprofile.McfrEgressQosProfile
DescendantInfo:
ipsec.IkeTransform
DescendantInfo:
lte5g.Oauth2Profile
DescendantInfo:
sitesec.TlsClientProfile
DescendantInfo:
aapolicy.AaStatTcaAbstract
DescendantInfo:
firewall.HostGroup
DescendantInfo:
ressubscr.BgpPeeringPolicy
DescendantInfo:
service.SvcActTestHeadAcceptanceCriteriaTemplate
DescendantInfo:
nodelog.SysLogTarget
DescendantInfo:
aaa.AcctOnOffGroup
DescendantInfo:
lte.UeCallTrace
DescendantInfo:
aclfilter.MacFilter
DescendantInfo:
sas.StreamingDelayTemplate
DescendantInfo:
lte.DefBearerQoSProfile
DescendantInfo:
rp.PolicyObjectBase
DescendantInfo:
service.Y1564TestHeadProfile
DescendantInfo:
igmp.SSMTranslatePolicy
DescendantInfo:
radiusaccounting.Policy
DescendantInfo:
aapolicy.AaTcpOpt
DescendantInfo:
service.SvcActTestHeadFrameSizeTemplate
DescendantInfo:
ipsec.TrustAnchorProfile
DescendantInfo:
ixrqos.PortQosPolicy
DescendantInfo:
nodelog.SecurityLog
DescendantInfo:
ixrqos.IngressClassification
DescendantInfo:
aapolicy.Policy
DescendantInfo:
ipsec.RadiusAccountingPolicy
DescendantInfo:
qosprofile.McfrIngressQosProfile
DescendantInfo:
ressubscr.HostLockoutPolicy
DescendantInfo:
ressubscr.SubMcastCacPolicy
DescendantInfo:
slope.HsmdaPoolPolicy
DescendantInfo:
opticalacl.IpFilter
DescendantInfo:
ixrqos.QueueMgmtPolicy
DescendantInfo:
policy.PSGGenericPolicy
DescendantInfo:
mmepolicy.MMESCTPProfile
DescendantInfo:
aapolicy.AARadiusAccountingPolicy
DescendantInfo:
lte.SgwChargingProfile
DescendantInfo:
multicast.EgressMcastGroup
DescendantInfo:
aapolicy.HttpErrorRedirect
DescendantInfo:
multicast.McastReportDestination
DescendantInfo:
firewall.CPMFirewall
DescendantInfo:
rtr.AbstractAdminGroupPolicy
DescendantInfo:
lte.TrustedPeerListPolicy
DescendantInfo:
lteli.DFPeer
DescendantInfo:
aosqos.QoSMacGroups
DescendantInfo:
ltepolicyoptions.ApnRateControl
DescendantInfo:
hsqos.HsAttachmentPolicy
DescendantInfo:
subscrident.Policy
DescendantInfo:
tod.Policy
DescendantInfo:
lteggsn.CdrAvpOptionProfile
DescendantInfo:
lte.OIOverList
DescendantInfo:
aapolicy.AAGroupPolicy
DescendantInfo:
lte.MMEGroupProfile
DescendantInfo:
lteradius.RadiusGroupProfile
DescendantInfo:
lteli.InterceptionTarget
DescendantInfo:
mmepolicy.MMEProfile
DescendantInfo:
lte.IkeRedList
DescendantInfo:
ltehomeagent.DNSRedirectServer
DescendantInfo:
qosprofile.MlpppIngressQosProfile
DescendantInfo:
dctr.PortProfile
DescendantInfo:
multicast.PackagePolicy
DescendantInfo:
lte.PgwSelectionCandidateList
DescendantInfo:
file.FileTransmissionProfile
DescendantInfo:
genericne.MvFilterPolicy
DescendantInfo:
mmepolicy.MMEGTPProfile
DescendantInfo:
genericne.MvForwardingClassPolicy
DescendantInfo:
ltetwag.DhcpServerProfile
DescendantInfo:
aclfilter.Ipv6ExceptionFilter
DescendantInfo:
aclfilter.DhcpV6Filter
DescendantInfo:
lteradius.RadiusProfile
DescendantInfo:
sitesec.TlsServerProfile
DescendantInfo:
nqueue.Policy
DescendantInfo:
sasqos.AccessEgress
DescendantInfo:
wlangw.DsmTrafficPolicer
DescendantInfo:
lte.UpPeerList
DescendantInfo:
netca.AbstractStatsTCAProfile
DescendantInfo:
sasqos.MpBwPolicy
DescendantInfo:
nat.NatPolicy
DescendantInfo:
ltepolicyoptions.QoSRuleUnit
DescendantInfo:
sas.BinGroup
DescendantInfo:
aapolicy.HttpNotif
DescendantInfo:
ethernetservice.SapProfile
DescendantInfo:
sitesec.CpmIpFilter
DescendantInfo:
mmepolicy.WMMSVCAgreementProfile
DescendantInfo:
connprof.ConnProfPolicy
DescendantInfo:
pae802_1x.RadiusServerPolicy
DescendantInfo:
aapolicy.AaStatTcaCfg
DescendantInfo:
sasqos.PortScheduler
DescendantInfo:
lte.IdiRealmList
DescendantInfo:
sitesec.CertificateAuthProfile
DescendantInfo:
qgroup.RedirectList
DescendantInfo:
ltepolicyoptions.PolicyRuleBase
DescendantInfo:
genericne.MVGenericPolicy
DescendantInfo:
rtr.AdminGroupPolicy
DescendantInfo:
aaa.RadiusServerPolicy
DescendantInfo:
securitypolicy.Profile
DescendantInfo:
lte.PpiMappingProfile
DescendantInfo:
rtr.SharedRiskLinkGroup
DescendantInfo:
aapolicy.AAPortList
DescendantInfo:
lte.AgwChargingProfile
DescendantInfo:
mpls.LspTemplateMvpn
DescendantInfo:
aossas.CPETestHeadProfile
DescendantInfo:
ltegw.ApnListPolicyGroup
DescendantInfo:
ancp.Policy
DescendantInfo:
lte.CCFHProfile
DescendantInfo:
aclfilter.AggregateFilter
DescendantInfo:
lte.IpAddressList
DescendantInfo:
dctr.Profile
DescendantInfo:
hsqos.HsPortPoolPolicy
DescendantInfo:
hsqos.HsPoolPolicy
DescendantInfo:
ltessg.TdfChargingProfile
DescendantInfo:
aaa.IsaRadiusPolicy
DescendantInfo:
ltepolicyoptions.TrafficRedirectProfile
DescendantInfo:
nat.UpnpPolicy
DescendantInfo:
pdnprofile.PacketDataNetworkProfilePolicy
DescendantInfo:
gtp.ApnPolicy
DescendantInfo:
rtr.AbstractSharedRiskLinkGroup
DescendantInfo:
aosqos.QoSCondition
DescendantInfo:
ltetwag.SwwRadiusProfile
DescendantInfo:
svt.PwTemplate
DescendantInfo:
filterprefixlist.ProtocolList
DescendantInfo:
rp.AdminGroupPolicy
DescendantInfo:
rtr.AdminTagPolicy
DescendantInfo:
ltehomeagent.FAHAPeerList
DescendantInfo:
mpls.SRLGStaticConfig
DescendantInfo:
accounting.Policy
DescendantInfo:
lte.PfcpTranslateProfile
DescendantInfo:
aapolicy.AaTcpValidation
DescendantInfo:
lte5g.CHFProfile
DescendantInfo:
opticalacl.AbstractIpFilter
DescendantInfo:
msappolicy.Policy
DescendantInfo:
wlangw.MgwProfile
DescendantInfo:
lte5g.AllowedNFDomainList
DescendantInfo:
mmepolicy.WMMPfmJobEntry
DescendantInfo:
aclfilterli.LiMacFilter
DescendantInfo:
securitypolicy.AppGroup
DescendantInfo:
aapolicy.AaCflowdGroupPolicy
DescendantInfo:
lte.PeerListPolicy
DescendantInfo:
fabricqos.FabricProfile
DescendantInfo:
firewall.FwPolicyDefinition
DescendantInfo:
multicast.McastCacPolicy
DescendantInfo:
rp.PolicyAccountingTemplate
DescendantInfo:
ipsec.AbstractTrustAnchorProfile
DescendantInfo:
aclfilter.GreTunnelTemplate
DescendantInfo:
lte.DiameterProfile
DescendantInfo:
lte.PgwChargingProfile
DescendantInfo:
sasqos.EgressRemarking
DescendantInfo:
aclfilterli.LiIpFilter
DescendantInfo:
ltepolicyoptions.UrrProfile
DescendantInfo:
service.Y1564PayloadProfile
DescendantInfo:
lte5g.UdmIdList
DescendantInfo:
sas.LinkMeasurementTemplate
DescendantInfo:
nat.NatPrefixList
DescendantInfo:
aaa.IsaRadiusPolicyBase
DescendantInfo:
lteradius.AbsRadiusProfile
DescendantInfo:
equipment.PortPolicy
DescendantInfo:
unpprofile.UNPProfile
DescendantInfo:
rtr.ReassemblyProfilePolicy
DescendantInfo:
lte.GtpPrimeServerGroupProfile
DescendantInfo:
lte.Profile
DescendantInfo:
layer2.L2Profile
DescendantInfo:
qosportlist.PortList
DescendantInfo:
lte.ClientProfile
DescendantInfo:
lte.OverloadControlProfile
DescendantInfo:
ressubscr.BrgProfile
DescendantInfo:
firewall.ServiceGroup
DescendantInfo:
vs.ServiceTypeDefinition
DescendantInfo:
qgroup.IngressQGroupPolicy
DescendantInfo:
lte.SubscriberMappingProfile
DescendantInfo:
lte5g.SMFAttributesProfile
DescendantInfo:
ltegw.UMTSQoSPolicy
DescendantInfo:
ltepolicyoptions.ActionRuleUnitProfile
DescendantInfo:
lte.S2bErrorMappingProfile
DescendantInfo:
dynsvc.DynSvcLocalAuthDb
DescendantInfo:
lte5g.EmerProfile
DescendantInfo:
aosqos.List
DescendantInfo:
shaperqos.ShaperPolicy
DescendantInfo:
sasqos.FcDot1pMap
DescendantInfo:
ltessg.SteeringProfile
DescendantInfo:
srpythonmgmt.PythonScript
DescendantInfo:
sasqos.MplsLspExpMap
DescendantInfo:
lte.CreditPoolProfile
DescendantInfo:
ltegw.UDPTunnelGroupProfile
DescendantInfo:
multicast.IngrPathMgmtBwPolicy
DescendantInfo:
aclfilter.Ipv6Filter
DescendantInfo:
aapolicy.AAPrefixListPolicy
DescendantInfo:
ipsec.IPSecTunnelTemplate
DescendantInfo:
nat.PcpPolicy
DescendantInfo:
mmepolicy.WMMPfmMeasGroupName
DescendantInfo:
aosqos.QoSAction
DescendantInfo:
lte5g.EventTriggerFBCProfile
DescendantInfo:
srpythonmgmt.PythonPolicy
DescendantInfo:
aclfilterli.LiFilter
DescendantInfo:
ixrqos.EgressRemarkPolicy
DescendantInfo:
diameter.DiameterPeerPolicy
DescendantInfo:
nat.AbstractNatPlcy
DescendantInfo:
aosqos.Policy
DescendantInfo:
aapolicy.AAPolicer
DescendantInfo:
aclfilter.IpFilter
DescendantInfo:
lte5g.SMFChargingProfile
DescendantInfo:
lte.TargetProfile
DescendantInfo:
lte.GroupLabel
DescendantInfo:
ixrqos.Dot1pFCMap
DescendantInfo:
lte5g.SMFServingAreaList
DescendantInfo:
squeue.Policy
DescendantInfo:
ltetwag.SlaacHostProfile
DescendantInfo:
aaa.RouteDownloadPolicy
DescendantInfo:
ltessg.AddressListProfile
DescendantInfo:
pppoe.PPPPolicyBase
DescendantInfo:
lte.AbsCallInsight
DescendantInfo:
nat.SvcChainEvpnPolicy
DescendantInfo:
aapolicy.AaStatTcaFilterCfg
DescendantInfo:
ltegw.QciListPolicyGroup
DescendantInfo:
aapolicy.AAUrlListPolicy
DescendantInfo:
aapolicy.HttpRedirect
DescendantInfo:
ixrqos.LspExpFCMap
DescendantInfo:
niegr.Policy
DescendantInfo:
securitypolicy.PolicerGroup
DescendantInfo:
aapolicy.AACertProfile
DescendantInfo:
securityqueue.SecurityQueuePolicy
DescendantInfo:
genericne.MvMultitermPolicy
DescendantInfo:
lte.TaiLaiListProfile
DescendantInfo:
nat.MapDomain
DescendantInfo:
nodelog.LogProfile
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_policy_PolicyDefinition_syncToLocalWithResync", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/syncToLocalWithResyncResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/policy/PolicyDistributeGroup/addNetworkElementsToGroup/{instanceFullName}": { "post": { "tags": [ "samo_policy" ], "summary": "rest_policy_PolicyDistributeGroup_addNetworkElementsToGroup", "operationId": "rest_policy_PolicyDistributeGroup_addNetworkElementsToGroup", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/policy/PolicyDistributeGroup/removeNetworkElementsFromGroup/{instanceFullName}": { "post": { "tags": [ "samo_policy" ], "summary": "rest_policy_PolicyDistributeGroup_removeNetworkElementsFromGroup", "operationId": "rest_policy_PolicyDistributeGroup_removeNetworkElementsFromGroup", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/policy/PolicyDistributeGroupManager/findPolicyDistributeGroups": { "get": { "tags": [ "samo_policy" ], "summary": "rest_policy_PolicyDistributeGroupManager_findPolicyDistributeGroups", "description": "
Intention : RETRIEVER
findPolicyDistributeGroups:
class-level [object finder] (retriever) API findPolicyDistributeGroups on default instance pdg-mgr of class policy.PolicyDistributeGroupManager


", "operationId": "rest_policy_PolicyDistributeGroupManager_findPolicyDistributeGroups", "parameters": [ { "name": "aInNetworkElementOrSiteId", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findPolicyDistributeGroupsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/policy/PolicySyncGroup/addClasses/{instanceFullName}": { "post": { "tags": [ "samo_policy" ], "summary": "rest_policy_PolicySyncGroup_addClasses", "operationId": "rest_policy_PolicySyncGroup_addClasses", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/policy/PolicySyncGroup/addMembers/{instanceFullName}": { "post": { "tags": [ "samo_policy" ], "summary": "rest_policy_PolicySyncGroup_addMembers", "operationId": "rest_policy_PolicySyncGroup_addMembers", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/addMembers" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/policy/PolicySyncGroup/addToMembers/{instanceFullName}": { "post": { "tags": [ "samo_policy" ], "summary": "rest_policy_PolicySyncGroup_addToMembers", "description": "Add the master policy contents to members.

Intention : MODIFIER
addToMembers:
instance-level modifier API addToMembers
of class policy.PolicySyncGroup
instanceFullName : distinguished/instance name of called object
The updated member list.

", "operationId": "rest_policy_PolicySyncGroup_addToMembers", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/addToMembersResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/policy/PolicySyncGroup/audit/{instanceFullName}": { "post": { "tags": [ "samo_policy" ], "summary": "rest_policy_PolicySyncGroup_audit", "operationId": "rest_policy_PolicySyncGroup_audit", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/policy/PolicySyncGroup/deleteClasses/{instanceFullName}": { "delete": { "tags": [ "samo_policy" ], "summary": "rest_policy_PolicySyncGroup_deleteClasses", "operationId": "rest_policy_PolicySyncGroup_deleteClasses", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/policy/PolicySyncGroup/deleteMembers/{instanceFullName}": { "delete": { "tags": [ "samo_policy" ], "summary": "rest_policy_PolicySyncGroup_deleteMembers", "operationId": "rest_policy_PolicySyncGroup_deleteMembers", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/policy/PolicySyncGroup/syncMembers/{instanceFullName}": { "post": { "tags": [ "samo_policy" ], "summary": "rest_policy_PolicySyncGroup_syncMembers", "description": "Sync the master policy contents to members.

Intention : MODIFIER
syncMembers:
instance-level modifier API syncMembers
of class policy.PolicySyncGroup
instanceFullName : distinguished/instance name of called object
The updated member list.

", "operationId": "rest_policy_PolicySyncGroup_syncMembers", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/syncMembersResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/policy/PolicySyncGroup/updateMaster/{instanceFullName}": { "put": { "tags": [ "samo_policy" ], "summary": "rest_policy_PolicySyncGroup_updateMaster", "description": "Add and update the selected global AAGroupPolicy contents to master policy.

Intention : MODIFIER
updateMaster:
instance-level modifier API updateMaster
of class policy.PolicySyncGroup
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_policy_PolicySyncGroup_updateMaster", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateMasterResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/event/EventPolicy/purge": { "post": { "tags": [ "samo_event" ], "summary": "rest_event_EventPolicy_purge", "operationId": "rest_event_EventPolicy_purge", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/purge" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/rsvp/ForwardingClassMap/configure/{instanceFullName}": { "post": { "tags": [ "samo_rsvp" ], "summary": "rest_rsvp_ForwardingClassMap_configure", "operationId": "rest_rsvp_ForwardingClassMap_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/rsvp/Session/findProtectedLsps/{instanceFullName}": { "post": { "tags": [ "samo_rsvp" ], "summary": "rest_rsvp_Session_findProtectedLsps", "description": "
Intention : RETRIEVER
findProtectedLsps:
instance-level [object finder] (retriever) API findProtectedLsps
of class rsvp.Session
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_rsvp_Session_findProtectedLsps", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findProtectedLspsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rsvp/Session/findReroutePath/{instanceFullName}": { "post": { "tags": [ "samo_rsvp" ], "summary": "rest_rsvp_Session_findReroutePath", "description": "
Intention : RETRIEVER
findReroutePath:
instance-level [object finder] (retriever) API findReroutePath
of class rsvp.Session
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_rsvp_Session_findReroutePath", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findReroutePathResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rsvp/TeClass/configure/{instanceFullName}": { "post": { "tags": [ "samo_rsvp" ], "summary": "rest_rsvp_TeClass_configure", "operationId": "rest_rsvp_TeClass_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/snmp/PollerManager/findPolicy": { "get": { "tags": [ "samo_snmp" ], "summary": "rest_snmp_PollerManager_findPolicy", "description": "finds the list of poller policies for a particular product and version

Intention : RETRIEVER
findPolicy:
instance-level [object finder] (retriever) API findPolicy on default instance pollerManager of class snmp.PollerManager

list of policies

", "operationId": "rest_snmp_PollerManager_findPolicy", "parameters": [ { "name": "productId", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "versionId", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findPolicyResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/snmp/PollerManager/getPollerManager": { "get": { "tags": [ "samo_snmp" ], "summary": "rest_snmp_PollerManager_getPollerManager", "description": "retrieves the default instance of the poller manager

Intention : RETRIEVER
getPollerManager:
instance-level retriever API getPollerManager on default instance pollerManager of class snmp.PollerManager

returns the poller manager instance

", "operationId": "rest_snmp_PollerManager_getPollerManager", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getPollerManagerResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/snmp/PollerManager/getStatsMibEntryPolicy": { "get": { "tags": [ "samo_snmp" ], "summary": "rest_snmp_PollerManager_getStatsMibEntryPolicy", "description": "retrieves stats mib entry policy associated to the object

Intention : RETRIEVER
getStatsMibEntryPolicy:
instance-level retriever API getStatsMibEntryPolicy on default instance pollerManager of class snmp.PollerManager

returns the stats mib entry policy

", "operationId": "rest_snmp_PollerManager_getStatsMibEntryPolicy", "parameters": [ { "name": "aInFullName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "aInStatsClassName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getStatsMibEntryPolicyResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/snmp/PollerManager/getStatsMibPolicy": { "get": { "tags": [ "samo_snmp" ], "summary": "rest_snmp_PollerManager_getStatsMibPolicy", "description": "retrieves stats entry policy associated to the object

Intention : RETRIEVER
getStatsMibPolicy:
instance-level retriever API getStatsMibPolicy on default instance pollerManager of class snmp.PollerManager

list of the policies

", "operationId": "rest_snmp_PollerManager_getStatsMibPolicy", "parameters": [ { "name": "aInFullName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "aInStatsClassName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getStatsMibPolicyResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/snmp/PollerManager/resync": { "post": { "tags": [ "samo_snmp" ], "summary": "rest_snmp_PollerManager_resync", "operationId": "rest_snmp_PollerManager_resync", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resync" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/snmp/PollerPolicy/configure/{instanceFullName}": { "post": { "tags": [ "samo_snmp" ], "summary": "rest_snmp_PollerPolicy_configure", "description": "
Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure
of class snmp.PollerPolicy
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_snmp_PollerPolicy_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PollerPolicyConfigInfo" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/snmp/SpecificStatsPollerPolicy/addMonitoredObjects/{instanceFullName}": { "post": { "tags": [ "samo_snmp" ], "summary": "rest_snmp_SpecificStatsPollerPolicy_addMonitoredObjects", "operationId": "rest_snmp_SpecificStatsPollerPolicy_addMonitoredObjects", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/snmp/SpecificStatsPollerPolicy/removeMonitoredObjects/{instanceFullName}": { "post": { "tags": [ "samo_snmp" ], "summary": "rest_snmp_SpecificStatsPollerPolicy_removeMonitoredObjects", "operationId": "rest_snmp_SpecificStatsPollerPolicy_removeMonitoredObjects", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/snmp/StatsPollerPolicy/findNEs": { "get": { "tags": [ "samo_snmp" ], "summary": "rest_snmp_StatsPollerPolicy_findNEs", "description": "Find all the NEs with the specified MIB statistics polling policy assigned.

Intention : RETRIEVER
findNEs:
class-level [object finder] (retriever) API findNEs
of class snmp.StatsPollerPolicy


", "operationId": "rest_snmp_StatsPollerPolicy_findNEs", "parameters": [ { "name": "policyId", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findNEsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ancp/AncpDslLineInfo/retrieveDslLineInfo": { "post": { "tags": [ "samo_ancp" ], "summary": "rest_ancp_AncpDslLineInfo_retrieveDslLineInfo", "description": "Method used to retrieve ANCP DSL Line Information from NE.

Intention : RETRIEVER
retrieveDslLineInfo:
class-level retriever API retrieveDslLineInfo
of class ancp.AncpDslLineInfo


", "operationId": "rest_ancp_AncpDslLineInfo_retrieveDslLineInfo", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DslLineInfoRetrievalStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveDslLineInfoResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/shg/Port/configure/{instanceFullName}": { "post": { "tags": [ "samo_shg" ], "summary": "rest_shg_Port_configure", "description": "
Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure
of class shg.Port
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_shg_Port_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/shg/Port/find/{instanceFullName}": { "post": { "tags": [ "samo_shg" ], "summary": "rest_shg_Port_find", "description": "
Intention : RETRIEVER
find:
instance-level [object finder] (retriever) API find
of class shg.Port
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_shg_Port_find", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/shg/Site/configure/{instanceFullName}": { "post": { "tags": [ "samo_shg" ], "summary": "rest_shg_Site_configure", "description": "
Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure
of class shg.Site
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_shg_Site_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ltecmm/CMMInstance/amfDirectedUELoadBalance/{instanceFullName}": { "post": { "tags": [ "samo_ltecmm" ], "summary": "rest_ltecmm_CMMInstance_amfDirectedUELoadBalance", "operationId": "rest_ltecmm_CMMInstance_amfDirectedUELoadBalance", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/amfDirectedUELoadBalance" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ltecmm/CMMInstance/retrieveAllPM/{instanceFullName}": { "post": { "tags": [ "samo_ltecmm" ], "summary": "rest_ltecmm_CMMInstance_retrieveAllPM", "operationId": "rest_ltecmm_CMMInstance_retrieveAllPM", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ltecmm/CMMInstance/retrieveSigNodeAdmin": { "post": { "tags": [ "samo_ltecmm" ], "summary": "rest_ltecmm_CMMInstance_retrieveSigNodeAdmin", "description": "
Intention : RETRIEVER
retrieveSigNodeAdmin:
class-level retriever API retrieveSigNodeAdmin
of class ltecmm.CMMInstance


", "operationId": "rest_ltecmm_CMMInstance_retrieveSigNodeAdmin", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveSigNodeAdmin" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveSigNodeAdminResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ltecmm/CMMInstance/setAggregateAdminState": { "post": { "tags": [ "samo_ltecmm" ], "summary": "rest_ltecmm_CMMInstance_setAggregateAdminState", "operationId": "rest_ltecmm_CMMInstance_setAggregateAdminState", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setAggregateAdminState" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ltecmm/CMMInstance/setGwAdminState": { "post": { "tags": [ "samo_ltecmm" ], "summary": "rest_ltecmm_CMMInstance_setGwAdminState", "operationId": "rest_ltecmm_CMMInstance_setGwAdminState", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setGwAdminState" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ltecmm/CMMInstance/setGwtsAdminState": { "post": { "tags": [ "samo_ltecmm" ], "summary": "rest_ltecmm_CMMInstance_setGwtsAdminState", "operationId": "rest_ltecmm_CMMInstance_setGwtsAdminState", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setGwtsAdminState" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/flexigrp/FlexiTopologyGroupManager/createTopologyGroup": { "post": { "tags": [ "samo_flexigrp" ], "summary": "rest_flexigrp_FlexiTopologyGroupManager_createTopologyGroup", "operationId": "rest_flexigrp_FlexiTopologyGroupManager_createTopologyGroup", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/flexigrp/FlexiTopologyGroupManager/regroupNEsInTopologyGroup": { "post": { "tags": [ "samo_flexigrp" ], "summary": "rest_flexigrp_FlexiTopologyGroupManager_regroupNEsInTopologyGroup", "operationId": "rest_flexigrp_FlexiTopologyGroupManager_regroupNEsInTopologyGroup", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/aclfilter/AbstractFilterDefinition/findAccessInterfaces/{instanceFullName}": { "post": { "tags": [ "samo_aclfilter" ], "summary": "rest_aclfilter_AbstractFilterDefinition_findAccessInterfaces", "description": "
Intention : RETRIEVER
findAccessInterfaces:
instance-level [object finder] (retriever) API findAccessInterfaces
of class aclfilter.AbstractFilterDefinition
DescendantInfo:
aclfilter.FilterDefinition
DescendantInfo:
aclfilter.MacFilter
DescendantInfo:
aclfilter.VlanFilter
DescendantInfo:
aclfilter.IpFilter
DescendantInfo:
aclfilter.AggregateFilter
DescendantInfo:
aclfilter.Ipv6Filter
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_aclfilter_AbstractFilterDefinition_findAccessInterfaces", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAccessInterfacesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/aclfilter/AbstractFilterDefinition/findCircuits/{instanceFullName}": { "post": { "tags": [ "samo_aclfilter" ], "summary": "rest_aclfilter_AbstractFilterDefinition_findCircuits", "description": "
Intention : RETRIEVER
findCircuits:
instance-level [object finder] (retriever) API findCircuits
of class aclfilter.AbstractFilterDefinition
DescendantInfo:
aclfilter.FilterDefinition
DescendantInfo:
aclfilter.MacFilter
DescendantInfo:
aclfilter.VlanFilter
DescendantInfo:
aclfilter.IpFilter
DescendantInfo:
aclfilter.AggregateFilter
DescendantInfo:
aclfilter.Ipv6Filter
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_aclfilter_AbstractFilterDefinition_findCircuits", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findCircuitsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/aclfilter/AbstractFilterDefinition/findNetworkIpInterfaces/{instanceFullName}": { "post": { "tags": [ "samo_aclfilter" ], "summary": "rest_aclfilter_AbstractFilterDefinition_findNetworkIpInterfaces", "description": "
Intention : RETRIEVER
findNetworkIpInterfaces:
instance-level [object finder] (retriever) API findNetworkIpInterfaces
of class aclfilter.AbstractFilterDefinition
DescendantInfo:
aclfilter.FilterDefinition
DescendantInfo:
aclfilter.MacFilter
DescendantInfo:
aclfilter.VlanFilter
DescendantInfo:
aclfilter.IpFilter
DescendantInfo:
aclfilter.AggregateFilter
DescendantInfo:
aclfilter.Ipv6Filter
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_aclfilter_AbstractFilterDefinition_findNetworkIpInterfaces", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findNetworkIpInterfacesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/aclfilter/DhcpFilter/getAllGroupInterfaces/{instanceFullName}": { "post": { "tags": [ "samo_aclfilter" ], "summary": "rest_aclfilter_DhcpFilter_getAllGroupInterfaces", "description": "
Intention : RETRIEVER
getAllGroupInterfaces:
instance-level retriever API getAllGroupInterfaces
of class aclfilter.DhcpFilter
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_aclfilter_DhcpFilter_getAllGroupInterfaces", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getAllGroupInterfacesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/aclfilter/EntryDefinition/find": { "post": { "tags": [ "samo_aclfilter" ], "summary": "rest_aclfilter_EntryDefinition_find", "description": "
Intention : RETRIEVER
find:
class-level [object finder] (retriever) API find
of class aclfilter.EntryDefinition
DescendantInfo:
aclfilter.VlanFilterEntry
DescendantInfo:
aclfilter.AppEntryDefinition
DescendantInfo:
aclfilter.Ipv6FilterEntry
DescendantInfo:
aclfilter.MacFilterEntry
DescendantInfo:
aclfilter.ApplicationIPFilterEntry
DescendantInfo:
aclfilter.CommonEntryDefinition
DescendantInfo:
aclfilter.ApplicationIPv6FilterEntry
DescendantInfo:
aclfilter.IpFilterEntry


", "operationId": "rest_aclfilter_EntryDefinition_find", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/aclfilter/EntryDefinition/renum": { "post": { "tags": [ "samo_aclfilter" ], "summary": "rest_aclfilter_EntryDefinition_renum", "operationId": "rest_aclfilter_EntryDefinition_renum", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/renum" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/aclfilter/FilterDefinition/findEgressMcastGroups/{instanceFullName}": { "post": { "tags": [ "samo_aclfilter" ], "summary": "rest_aclfilter_FilterDefinition_findEgressMcastGroups", "description": "
Intention : RETRIEVER
findEgressMcastGroups:
instance-level [object finder] (retriever) API findEgressMcastGroups
of class aclfilter.FilterDefinition
DescendantInfo:
aclfilter.MacFilter
DescendantInfo:
aclfilter.VlanFilter
DescendantInfo:
aclfilter.IpFilter
DescendantInfo:
aclfilter.Ipv6Filter
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_aclfilter_FilterDefinition_findEgressMcastGroups", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findEgressMcastGroupsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/aclfilter/FilterDefinition/findServiceIpInterfaces/{instanceFullName}": { "post": { "tags": [ "samo_aclfilter" ], "summary": "rest_aclfilter_FilterDefinition_findServiceIpInterfaces", "description": "
Intention : RETRIEVER
findServiceIpInterfaces:
instance-level [object finder] (retriever) API findServiceIpInterfaces
of class aclfilter.FilterDefinition
DescendantInfo:
aclfilter.MacFilter
DescendantInfo:
aclfilter.VlanFilter
DescendantInfo:
aclfilter.IpFilter
DescendantInfo:
aclfilter.Ipv6Filter
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_aclfilter_FilterDefinition_findServiceIpInterfaces", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findServiceIpInterfacesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/aclfilter/FilterDefinition/initiateGroupInserts": { "post": { "tags": [ "samo_aclfilter" ], "summary": "rest_aclfilter_FilterDefinition_initiateGroupInserts", "description": "Method used by IPFilter and IPv6Filter for group insertion sorting.
Method invocation will be ignored for any other filter types.

Intention : MODIFIER
initiateGroupInserts:
class-level modifier API initiateGroupInserts
of class aclfilter.FilterDefinition
DescendantInfo:
aclfilter.MacFilter
DescendantInfo:
aclfilter.VlanFilter
DescendantInfo:
aclfilter.IpFilter
DescendantInfo:
aclfilter.Ipv6Filter


", "operationId": "rest_aclfilter_FilterDefinition_initiateGroupInserts", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupEntriesStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/initiateGroupInsertsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/aclfilter/FilterDefinition/retrieveHostSharedFilter": { "post": { "tags": [ "samo_aclfilter" ], "summary": "rest_aclfilter_FilterDefinition_retrieveHostSharedFilter", "description": "Method retrieves IP Filter and IPv6 Filter from the network element. This method
has option to specify either retrieving its entries or not.

Intention : RETRIEVER
retrieveHostSharedFilter:
class-level retriever API retrieveHostSharedFilter
of class aclfilter.FilterDefinition
DescendantInfo:
aclfilter.MacFilter
DescendantInfo:
aclfilter.VlanFilter
DescendantInfo:
aclfilter.IpFilter
DescendantInfo:
aclfilter.Ipv6Filter


", "operationId": "rest_aclfilter_FilterDefinition_retrieveHostSharedFilter", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RtrvHostSharedFilterStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveHostSharedFilterResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/aclfilter/IpFilterEntry/findSampleProfile": { "post": { "tags": [ "samo_aclfilter" ], "summary": "rest_aclfilter_IpFilterEntry_findSampleProfile", "description": "
Intention : RETRIEVER
findSampleProfile:
class-level [object finder] (retriever) API findSampleProfile
of class aclfilter.IpFilterEntry


", "operationId": "rest_aclfilter_IpFilterEntry_findSampleProfile", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findSampleProfileResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/aclfilter/Ipv6FilterEntry/findSampleProfile": { "post": { "tags": [ "samo_aclfilter" ], "summary": "rest_aclfilter_Ipv6FilterEntry_findSampleProfile", "description": "
Intention : RETRIEVER
findSampleProfile:
class-level [object finder] (retriever) API findSampleProfile
of class aclfilter.Ipv6FilterEntry


", "operationId": "rest_aclfilter_Ipv6FilterEntry_findSampleProfile", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findSampleProfileResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/wlangw/GTPSession/retrieveGtpSessions": { "post": { "tags": [ "samo_wlangw" ], "summary": "rest_wlangw_GTPSession_retrieveGtpSessions", "description": "Method used to retrieve GTP sessions from NE.

Intention : RETRIEVER
retrieveGtpSessions:
class-level retriever API retrieveGtpSessions
of class wlangw.GTPSession


", "operationId": "rest_wlangw_GTPSession_retrieveGtpSessions", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrGtpSessionStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveGtpSessionsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/wlangw/IsaPoolSubnet/requestClearIsaSubnets": { "post": { "tags": [ "samo_wlangw" ], "summary": "rest_wlangw_IsaPoolSubnet_requestClearIsaSubnets", "description": "Request clearing the ISA Subnets with the specified parameters.
The siteId is required. If svcId is not given, the method will use the base routing instance.
If using any other optional parameters, either subscriberInterfaceName or ipAddress and prefix must be set.
When this method returns resources for the clear have been allocated but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearIsaSubnets:
class-level modifier API requestClearIsaSubnets
of class wlangw.IsaPoolSubnet

A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_wlangw_IsaPoolSubnet_requestClearIsaSubnets", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClearIsaSubnetStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearIsaSubnetsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/wlangw/IsaPoolSubnet/retrieveIsaPoolSubnets": { "post": { "tags": [ "samo_wlangw" ], "summary": "rest_wlangw_IsaPoolSubnet_retrieveIsaPoolSubnets", "description": "
Intention : RETRIEVER
retrieveIsaPoolSubnets:
class-level retriever API retrieveIsaPoolSubnets
of class wlangw.IsaPoolSubnet


", "operationId": "rest_wlangw_IsaPoolSubnet_retrieveIsaPoolSubnets", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveIsaPoolSubnets" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveIsaPoolSubnetsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/wlangw/MgwAddrMap/removeMgwAddrMaps": { "post": { "tags": [ "samo_wlangw" ], "summary": "rest_wlangw_MgwAddrMap_removeMgwAddrMaps", "operationId": "rest_wlangw_MgwAddrMap_removeMgwAddrMaps", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/wlangw/WlanGwBdUe/retrieveWlanGwBdUesPerTunnel": { "post": { "tags": [ "samo_wlangw" ], "summary": "rest_wlangw_WlanGwBdUe_retrieveWlanGwBdUesPerTunnel", "description": "Method retrieve all User Equipments resides on the specified tunnel (Base or VPRN).

Intention : RETRIEVER
retrieveWlanGwBdUesPerTunnel:
class-level retriever API retrieveWlanGwBdUesPerTunnel
of class wlangw.WlanGwBdUe


", "operationId": "rest_wlangw_WlanGwBdUe_retrieveWlanGwBdUesPerTunnel", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveWlanGwBdUesPerTunnel" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveWlanGwBdUesPerTunnelResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/wlangw/WlanGwBdUe/retrieveWlanGwUesPerBd": { "post": { "tags": [ "samo_wlangw" ], "summary": "rest_wlangw_WlanGwBdUe_retrieveWlanGwUesPerBd", "description": "Method retrieves all User Equipments of a given Bridge Identified on the specific Network Element.

Intention : RETRIEVER
retrieveWlanGwUesPerBd:
class-level retriever API retrieveWlanGwUesPerBd
of class wlangw.WlanGwBdUe


", "operationId": "rest_wlangw_WlanGwBdUe_retrieveWlanGwUesPerBd", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveWlanGwUesPerBd" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveWlanGwUesPerBdResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/wlangw/WlanGwBridgeDomain/retrieveWlanGwBd": { "post": { "tags": [ "samo_wlangw" ], "summary": "rest_wlangw_WlanGwBridgeDomain_retrieveWlanGwBd", "description": "Method retrieves WLAN Gateway Bridge Domain.

Intention : RETRIEVER
retrieveWlanGwBd:
class-level retriever API retrieveWlanGwBd
of class wlangw.WlanGwBridgeDomain


", "operationId": "rest_wlangw_WlanGwBridgeDomain_retrieveWlanGwBd", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveWlanGwBd" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveWlanGwBdResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/wlangw/WlanGwIsaGroup/findBaseCardsWithIsabb/{instanceFullName}": { "get": { "tags": [ "samo_wlangw" ], "summary": "rest_wlangw_WlanGwIsaGroup_findBaseCardsWithIsabb", "description": "
Intention : RETRIEVER
findBaseCardsWithIsabb:
instance-level [object finder] (retriever) API findBaseCardsWithIsabb
of class wlangw.WlanGwIsaGroup
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_wlangw_WlanGwIsaGroup_findBaseCardsWithIsabb", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findBaseCardsWithIsabbResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/wlangw/WlanGwIsaGroup/getDependencyCount/{instanceFullName}": { "get": { "tags": [ "samo_wlangw" ], "summary": "rest_wlangw_WlanGwIsaGroup_getDependencyCount", "description": "
Intention : RETRIEVER
getDependencyCount:
instance-level retriever API getDependencyCount
of class wlangw.WlanGwIsaGroup
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_wlangw_WlanGwIsaGroup_getDependencyCount", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getDependencyCountResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/wlangw/WlanGwQbtTunnel/retrieveWlanGwTunnelCount": { "post": { "tags": [ "samo_wlangw" ], "summary": "rest_wlangw_WlanGwQbtTunnel_retrieveWlanGwTunnelCount", "description": "Method to retrieve WLAN GW Tunnels count with specified parameters

Intention : RETRIEVER
retrieveWlanGwTunnelCount:
class-level retriever API retrieveWlanGwTunnelCount
of class wlangw.WlanGwQbtTunnel


", "operationId": "rest_wlangw_WlanGwQbtTunnel_retrieveWlanGwTunnelCount", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveWlanGwTunnelCount" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveWlanGwTunnelCountResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/wlangw/WlanGwQbtTunnel/retrieveWlanGwTunnels": { "post": { "tags": [ "samo_wlangw" ], "summary": "rest_wlangw_WlanGwQbtTunnel_retrieveWlanGwTunnels", "description": "Method to retrieve WLAN GW Tunnels with specified parameters

Intention : RETRIEVER
retrieveWlanGwTunnels:
class-level retriever API retrieveWlanGwTunnels
of class wlangw.WlanGwQbtTunnel


", "operationId": "rest_wlangw_WlanGwQbtTunnel_retrieveWlanGwTunnels", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveWlanGwTunnels" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveWlanGwTunnelsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/wlangw/WlanGwQbtTunnel/validateQuery": { "post": { "tags": [ "samo_wlangw" ], "summary": "rest_wlangw_WlanGwQbtTunnel_validateQuery", "description": "
Intention : RETRIEVER
validateQuery:
class-level retriever API validateQuery
of class wlangw.WlanGwQbtTunnel


", "operationId": "rest_wlangw_WlanGwQbtTunnel_validateQuery", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validateQuery" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validateQueryResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/wlangw/WlanGwQbtUe/retrieveWlanGwUeCount": { "post": { "tags": [ "samo_wlangw" ], "summary": "rest_wlangw_WlanGwQbtUe_retrieveWlanGwUeCount", "description": "Method to retrieve WLAN GW User Equipment count with specified parameters

Intention : RETRIEVER
retrieveWlanGwUeCount:
class-level retriever API retrieveWlanGwUeCount
of class wlangw.WlanGwQbtUe


", "operationId": "rest_wlangw_WlanGwQbtUe_retrieveWlanGwUeCount", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveWlanGwUeCount" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveWlanGwUeCountResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/wlangw/WlanGwQbtUe/retrieveWlanGwUes": { "post": { "tags": [ "samo_wlangw" ], "summary": "rest_wlangw_WlanGwQbtUe_retrieveWlanGwUes", "description": "Method to retrieve WLAN GW User Equipments with specified parameters

Intention : RETRIEVER
retrieveWlanGwUes:
class-level retriever API retrieveWlanGwUes
of class wlangw.WlanGwQbtUe


", "operationId": "rest_wlangw_WlanGwQbtUe_retrieveWlanGwUes", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveWlanGwUes" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveWlanGwUesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/wlangw/WlanGwQbtUe/validateQuery": { "post": { "tags": [ "samo_wlangw" ], "summary": "rest_wlangw_WlanGwQbtUe_validateQuery", "description": "
Intention : RETRIEVER
validateQuery:
class-level retriever API validateQuery
of class wlangw.WlanGwQbtUe


", "operationId": "rest_wlangw_WlanGwQbtUe_validateQuery", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validateQuery" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validateQueryResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/wlangw/WlanGwRedundancyConfig/forceSwitchover": { "post": { "tags": [ "samo_wlangw" ], "summary": "rest_wlangw_WlanGwRedundancyConfig_forceSwitchover", "operationId": "rest_wlangw_WlanGwRedundancyConfig_forceSwitchover", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forceSwitchover" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/wlangw/WlanGwTuQos/retrieveQos": { "post": { "tags": [ "samo_wlangw" ], "summary": "rest_wlangw_WlanGwTuQos_retrieveQos", "description": "Method used to retrieve WLAN GW Tunnel QoS from NE.

Intention : RETRIEVER
retrieveQos:
class-level retriever API retrieveQos
of class wlangw.WlanGwTuQos


", "operationId": "rest_wlangw_WlanGwTuQos_retrieveQos", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QoSRetrievalStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveQosResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/wlangw/WlanGwUe/retrieveWlanGwUes": { "post": { "tags": [ "samo_wlangw" ], "summary": "rest_wlangw_WlanGwUe_retrieveWlanGwUes", "description": "Method queries the NE for the User Equipments resides on the specified tunnel (Base or VPRN).

Intention : RETRIEVER
retrieveWlanGwUes:
class-level retriever API retrieveWlanGwUes
of class wlangw.WlanGwUe


", "operationId": "rest_wlangw_WlanGwUe_retrieveWlanGwUes", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveWlanGwUes" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveWlanGwUesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/wlangw/WlanGwUe/retrieveWlanGwUesByMacAddr": { "post": { "tags": [ "samo_wlangw" ], "summary": "rest_wlangw_WlanGwUe_retrieveWlanGwUesByMacAddr", "description": "Method queries the specific NE for the User Equipments by given MAC Address.

Intention : RETRIEVER
retrieveWlanGwUesByMacAddr:
class-level retriever API retrieveWlanGwUesByMacAddr
of class wlangw.WlanGwUe


", "operationId": "rest_wlangw_WlanGwUe_retrieveWlanGwUesByMacAddr", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveWlanGwUesByMacAddr" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveWlanGwUesByMacAddrResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/server/AuxServerPair/assignedObjects/{instanceFullName}": { "post": { "tags": [ "samo_server" ], "summary": "rest_server_AuxServerPair_assignedObjects", "operationId": "rest_server_AuxServerPair_assignedObjects", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/server/AuxServerPair/unAssignedObjects/{instanceFullName}": { "post": { "tags": [ "samo_server" ], "summary": "rest_server_AuxServerPair_unAssignedObjects", "operationId": "rest_server_AuxServerPair_unAssignedObjects", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/server/TCE/deleteAllENBs/{instanceFullName}": { "delete": { "tags": [ "samo_server" ], "summary": "rest_server_TCE_deleteAllENBs", "description": "Unassign to TCE all eNBs which are in a suitable state and have not an active trace.
If forceDelete is true, unassign all eNBs unconditionally.

Intention : MODIFIER
deleteAllENBs:
instance-level [administrative deletion] (modifier) API deleteAllENBs
of class server.TCE
instanceFullName : distinguished/instance name of called object
The number of un-deleted eNBs because of active traces or unsuitable state.

", "operationId": "rest_server_TCE_deleteAllENBs", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleteAllENBsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/server/TCE/preDeleteENBs/{instanceFullName}": { "post": { "tags": [ "samo_server" ], "summary": "rest_server_TCE_preDeleteENBs", "description": "Identify which eNBs will be - and will not be - removed from a TCE

Intention : MODIFIER
preDeleteENBs:
instance-level modifier API preDeleteENBs
of class server.TCE
instanceFullName : distinguished/instance name of called object
The number of un-deleted eNBs because of active traces or unsuitable state.

", "operationId": "rest_server_TCE_preDeleteENBs", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preDeleteENBs" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preDeleteENBsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/tod/Policy/getTimeZone": { "get": { "tags": [ "samo_tod" ], "summary": "rest_tod_Policy_getTimeZone", "description": "
Intention : RETRIEVER
getTimeZone:
class-level retriever API getTimeZone
of class tod.Policy


", "operationId": "rest_tod_Policy_getTimeZone", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getTimeZoneResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/tod/TimeRangeEntryAssignment/getTimeRangeEntryAssignments": { "post": { "tags": [ "samo_tod" ], "summary": "rest_tod_TimeRangeEntryAssignment_getTimeRangeEntryAssignments", "description": "
Intention : RETRIEVER
getTimeRangeEntryAssignments:
class-level retriever API getTimeRangeEntryAssignments
of class tod.TimeRangeEntryAssignment

List of TimeRangeEntryAssignment info objects that yielded from the provided parameters.

", "operationId": "rest_tod_TimeRangeEntryAssignment_getTimeRangeEntryAssignments", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeRangeEntryAssignmentSearchConfig" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getTimeRangeEntryAssignmentsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/fm/AdditionalTextPolicy/configureAdditionalTextPolicy": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_AdditionalTextPolicy_configureAdditionalTextPolicy", "description": "Configure additional text policy

Intention : MODIFIER
configureAdditionalTextPolicy:
class-level [hierarchical administrative configuration/modification] (modifier) API configureAdditionalTextPolicy
of class fm.AdditionalTextPolicy
This API follows hierarchical config model rules.

Returns the full name of the additional text attribute instance

", "operationId": "rest_fm_AdditionalTextPolicy_configureAdditionalTextPolicy", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureAdditionalTextPolicy" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureAdditionalTextPolicyResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/fm/AlarmHistoryDatabase/configure": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_AlarmHistoryDatabase_configure", "operationId": "rest_fm_AlarmHistoryDatabase_configure", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlarmHistoryDatabaseConfigInfo" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/fm/AlarmHistoryDatabase/getLog": { "get": { "tags": [ "samo_fm" ], "summary": "rest_fm_AlarmHistoryDatabase_getLog", "description": "
Intention : RETRIEVER
getLog:
instance-level retriever API getLog on default instance AlarmHistoryDatabase of class fm.AlarmHistoryDatabase


", "operationId": "rest_fm_AlarmHistoryDatabase_getLog", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getLogResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/fm/AlarmHistoryDatabase/getLogRecords": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_AlarmHistoryDatabase_getLogRecords", "description": "
Intention : RETRIEVER
getLogRecords:
class-level retriever API getLogRecords on default instance AlarmHistoryDatabase of class fm.AlarmHistoryDatabase


", "operationId": "rest_fm_AlarmHistoryDatabase_getLogRecords", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getLogRecordsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/fm/AlarmHistoryDatabase/purge": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_AlarmHistoryDatabase_purge", "operationId": "rest_fm_AlarmHistoryDatabase_purge", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/purge" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/fm/FaultManager/acknowledgeFault": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_acknowledgeFault", "operationId": "rest_fm_FaultManager_acknowledgeFault", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/acknowledgeFault" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/fm/FaultManager/acknowledgeFaultList": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_acknowledgeFaultList", "operationId": "rest_fm_FaultManager_acknowledgeFaultList", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/acknowledgeFaultList" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/fm/FaultManager/acknowledgeFaultUsingDefaults": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_acknowledgeFaultUsingDefaults", "operationId": "rest_fm_FaultManager_acknowledgeFaultUsingDefaults", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/fm/FaultManager/acknowledgeFaults": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_acknowledgeFaults", "operationId": "rest_fm_FaultManager_acknowledgeFaults", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/acknowledgeFaults" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/fm/FaultManager/alterOLCStateOfFaultList": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_alterOLCStateOfFaultList", "operationId": "rest_fm_FaultManager_alterOLCStateOfFaultList", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alterOLCStateOfFaultList" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/fm/FaultManager/alterSeverityOfFault": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_alterSeverityOfFault", "operationId": "rest_fm_FaultManager_alterSeverityOfFault", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alterSeverityOfFault" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/fm/FaultManager/alterSeverityOfFaultList": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_alterSeverityOfFaultList", "operationId": "rest_fm_FaultManager_alterSeverityOfFaultList", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alterSeverityOfFaultList" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/fm/FaultManager/alterSeverityOfFaultsOnObject": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_alterSeverityOfFaultsOnObject", "operationId": "rest_fm_FaultManager_alterSeverityOfFaultsOnObject", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alterSeverityOfFaultsOnObject" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/fm/FaultManager/alterUrgencyOfFault": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_alterUrgencyOfFault", "operationId": "rest_fm_FaultManager_alterUrgencyOfFault", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alterUrgencyOfFault" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/fm/FaultManager/alterUrgencyOfFaultList": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_alterUrgencyOfFaultList", "operationId": "rest_fm_FaultManager_alterUrgencyOfFaultList", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alterUrgencyOfFaultList" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/fm/FaultManager/alterUrgencyOfFaultsOnObject": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_alterUrgencyOfFaultsOnObject", "operationId": "rest_fm_FaultManager_alterUrgencyOfFaultsOnObject", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/alterUrgencyOfFaultsOnObject" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/fm/FaultManager/clearFault": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_clearFault", "operationId": "rest_fm_FaultManager_clearFault", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/fm/FaultManager/clearFaultList": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_clearFaultList", "operationId": "rest_fm_FaultManager_clearFaultList", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/fm/FaultManager/clearFaultsOnObject": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_clearFaultsOnObject", "operationId": "rest_fm_FaultManager_clearFaultsOnObject", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clearFaultsOnObject" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/fm/FaultManager/editNote": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_editNote", "operationId": "rest_fm_FaultManager_editNote", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/editNote" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/fm/FaultManager/findAlarmsForOfn": { "get": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_findAlarmsForOfn", "description": "This method returns a structure that contains every alarm in the self, affecting, aggregated and related categories for the specified object.

Intention : RETRIEVER
findAlarmsForOfn:
class-level [object finder] (retriever) API findAlarmsForOfn on default instance faultManager of class fm.FaultManager

Alarm list structure.

", "operationId": "rest_fm_FaultManager_findAlarmsForOfn", "parameters": [ { "name": "alarmedObjectOfn", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAlarmsForOfnResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/fm/FaultManager/findAlarmsForOfns": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_findAlarmsForOfns", "description": "This method returns a map of the structures that contain every alarm self, affecting, aggregated and related categories for the specified object.

Intention : RETRIEVER
findAlarmsForOfns:
class-level [object finder] (retriever) API findAlarmsForOfns on default instance faultManager of class fm.FaultManager

Map of alarm structures. The map key is the affected object full name.

", "operationId": "rest_fm_FaultManager_findAlarmsForOfns", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAlarmsForOfnsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/fm/FaultManager/findAlarmsStatusesForOfn": { "get": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_findAlarmsStatusesForOfn", "description": "This method returns a structure that contains the alarm status and aggregated alarm status for the specified object.

Intention : RETRIEVER
findAlarmsStatusesForOfn:
class-level [object finder] (retriever) API findAlarmsStatusesForOfn on default instance faultManager of class fm.FaultManager

Alarm statuses for the specified object.

", "operationId": "rest_fm_FaultManager_findAlarmsStatusesForOfn", "parameters": [ { "name": "alarmedObjectOfn", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAlarmsStatusesForOfnResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/fm/FaultManager/findAlarmsStatusesForOfns": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_findAlarmsStatusesForOfns", "description": "This method returns a list of structures that contains the alarm status and aggregated alarm status for the specified objects.

Intention : RETRIEVER
findAlarmsStatusesForOfns:
class-level [object finder] (retriever) API findAlarmsStatusesForOfns on default instance faultManager of class fm.FaultManager

Map of the alarm statuses. The map key is the affected object full name.

", "operationId": "rest_fm_FaultManager_findAlarmsStatusesForOfns", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAlarmsStatusesForOfnsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/fm/FaultManager/findFault": { "get": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_findFault", "description": "This method returns the specified alarm.

Intention : RETRIEVER
findFault:
class-level [object finder] (retriever) API findFault on default instance faultManager of class fm.FaultManager

Alarm for the specified full name.

", "operationId": "rest_fm_FaultManager_findFault", "parameters": [ { "name": "alarmInstanceFullName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findFaultResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/fm/FaultManager/findFaultList": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_findFaultList", "description": "This method returns the specified alarms.

Intention : RETRIEVER
findFaultList:
class-level [object finder] (retriever) API findFaultList on default instance faultManager of class fm.FaultManager

Map of alarms. The alarm full name is the map key.

", "operationId": "rest_fm_FaultManager_findFaultList", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findFaultListResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/fm/FaultManager/findFaults": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_findFaults", "description": "This method retrieves all alarms in the network matching the faultFilter criteria and returns a map.

Intention : RETRIEVER
findFaults:
class-level [object finder] (retriever) API findFaults on default instance faultManager of class fm.FaultManager

Map of alarms. The alarm full name is the map key.

", "operationId": "rest_fm_FaultManager_findFaults", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findFaultsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/fm/FaultManager/findFaultsOnObject": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_findFaultsOnObject", "description": "This method retrieves alarms on the specified affected object.

Intention : RETRIEVER
findFaultsOnObject:
class-level [object finder] (retriever) API findFaultsOnObject on default instance faultManager of class fm.FaultManager

Map of alarms on the specified affected object. The alarm full name is the map key.

", "operationId": "rest_fm_FaultManager_findFaultsOnObject", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findFaultsOnObject" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findFaultsOnObjectResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/fm/FaultManager/findNoteForAlarmInstance": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_findNoteForAlarmInstance", "description": "This method retrieves alarm notes for the specified alarm.

Intention : RETRIEVER
findNoteForAlarmInstance:
class-level [object finder] (retriever) API findNoteForAlarmInstance on default instance faultManager of class fm.FaultManager

List of alarm notes.

", "operationId": "rest_fm_FaultManager_findNoteForAlarmInstance", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findNoteForAlarmInstance" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findNoteForAlarmInstanceResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/fm/FaultManager/findObjectsAffectingOfn": { "get": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_findObjectsAffectingOfn", "description": "This method returns a list of the affecting objects full names for the specified object.

Intention : RETRIEVER
findObjectsAffectingOfn:
class-level [object finder] (retriever) API findObjectsAffectingOfn on default instance faultManager of class fm.FaultManager

List of full names of the affecting objects.

", "operationId": "rest_fm_FaultManager_findObjectsAffectingOfn", "parameters": [ { "name": "alarmedObjectOfn", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findObjectsAffectingOfnResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/fm/FaultManager/findObjectsRelatedToOfn": { "get": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_findObjectsRelatedToOfn", "description": "This method returns a list of the related objects full names for the specified object.

Intention : RETRIEVER
findObjectsRelatedToOfn:
class-level [object finder] (retriever) API findObjectsRelatedToOfn on default instance faultManager of class fm.FaultManager

List of full names of the related objects.

", "operationId": "rest_fm_FaultManager_findObjectsRelatedToOfn", "parameters": [ { "name": "alarmedObjectOfn", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findObjectsRelatedToOfnResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/fm/FaultManager/getAlarms": { "get": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_getAlarms", "description": "This method returns all the alarms in the system without relationships (affecting related objects).

Intention : RETRIEVER
getAlarms:
class-level retriever API getAlarms on default instance faultManager of class fm.FaultManager

Map of alarms. The alarm full name is the map key.

", "operationId": "rest_fm_FaultManager_getAlarms", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getAlarmsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/fm/FaultManager/getCorrelatedAlarmsForOfn": { "get": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_getCorrelatedAlarmsForOfn", "description": "This method returns the correlated alarms for the specified alarm name.

Intention : RETRIEVER
getCorrelatedAlarmsForOfn:
class-level retriever API getCorrelatedAlarmsForOfn on default instance faultManager of class fm.FaultManager

Map of correlated alarms. The correlated alarm full name is the map key.

", "operationId": "rest_fm_FaultManager_getCorrelatedAlarmsForOfn", "parameters": [ { "name": "alarmInstancePointer", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getCorrelatedAlarmsForOfnResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/fm/FaultManager/reload": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_reload", "operationId": "rest_fm_FaultManager_reload", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/fm/FaultManager/removeFault": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_removeFault", "operationId": "rest_fm_FaultManager_removeFault", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/fm/FaultManager/removeFaultList": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_removeFaultList", "operationId": "rest_fm_FaultManager_removeFaultList", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/fm/FaultManager/removeFaultsOnObject": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_removeFaultsOnObject", "operationId": "rest_fm_FaultManager_removeFaultsOnObject", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/removeFaultsOnObject" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/fm/FaultManager/testAlarm": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_testAlarm", "operationId": "rest_fm_FaultManager_testAlarm", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/testAlarm" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/fm/FaultManager/verifyAlarmStatus": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_FaultManager_verifyAlarmStatus", "operationId": "rest_fm_FaultManager_verifyAlarmStatus", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/fm/GlobalPolicy/configure": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_GlobalPolicy_configure", "operationId": "rest_fm_GlobalPolicy_configure", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalPolicyConfigInfo" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/fm/SeverityChangeThreshold/configure/{instanceFullName}": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_SeverityChangeThreshold_configure", "operationId": "rest_fm_SeverityChangeThreshold_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeverityChangeThresholdConfigInfo" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/fm/SpecificPolicy/configure/{instanceFullName}": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_SpecificPolicy_configure", "operationId": "rest_fm_SpecificPolicy_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpecificPolicyConfigInfo" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/fm/SpecificPolicy/findSpecificPolicies": { "post": { "tags": [ "samo_fm" ], "summary": "rest_fm_SpecificPolicy_findSpecificPolicies", "description": "
Intention : RETRIEVER
findSpecificPolicies:
class-level [object finder] (retriever) API findSpecificPolicies
of class fm.SpecificPolicy


", "operationId": "rest_fm_SpecificPolicy_findSpecificPolicies", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findSpecificPoliciesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vpls/AbstractVpls/distributeServiceMacProtectionList/{instanceFullName}": { "post": { "tags": [ "samo_vpls" ], "summary": "rest_vpls_AbstractVpls_distributeServiceMacProtectionList", "operationId": "rest_vpls_AbstractVpls_distributeServiceMacProtectionList", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/vpls/AbstractVpls/findAssociatedEpipeSites/{instanceFullName}": { "post": { "tags": [ "samo_vpls" ], "summary": "rest_vpls_AbstractVpls_findAssociatedEpipeSites", "description": "Return the list of the EPIPE sites which are associated
with the backbone sites in this VPLS service.

Intention : RETRIEVER
findAssociatedEpipeSites:
instance-level [object finder] (retriever) API findAssociatedEpipeSites
of class vpls.AbstractVpls
DescendantInfo:
vpls.Vpls
DescendantInfo:
mvpls.Mvpls
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_vpls_AbstractVpls_findAssociatedEpipeSites", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAssociatedEpipeSitesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vpls/AbstractVpls/findAssociatedISites/{instanceFullName}": { "post": { "tags": [ "samo_vpls" ], "summary": "rest_vpls_AbstractVpls_findAssociatedISites", "description": "Return the list of the I-VPLS sites which are associated
with the backbone sites in this VPLS service.

Intention : RETRIEVER
findAssociatedISites:
instance-level [object finder] (retriever) API findAssociatedISites
of class vpls.AbstractVpls
DescendantInfo:
vpls.Vpls
DescendantInfo:
mvpls.Mvpls
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_vpls_AbstractVpls_findAssociatedISites", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAssociatedISitesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vpls/BgpCfg/evalPwTemplateAction/{instanceFullName}": { "post": { "tags": [ "samo_vpls" ], "summary": "rest_vpls_BgpCfg_evalPwTemplateAction", "operationId": "rest_vpls_BgpCfg_evalPwTemplateAction", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/vpls/EvpnSite/getEVPNSites": { "get": { "tags": [ "samo_vpls" ], "summary": "rest_vpls_EvpnSite_getEVPNSites", "description": "Gets the eVPN Service Sites for the DVRS Site

Intention : RETRIEVER
getEVPNSites:
class-level retriever API getEVPNSites
of class vpls.EvpnSite


", "operationId": "rest_vpls_EvpnSite_getEVPNSites", "parameters": [ { "name": "aInDVRSSiteName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getEVPNSitesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vpls/L2AccessInterface/requestClearIgmpHostTracking/{instanceFullName}": { "post": { "tags": [ "samo_vpls" ], "summary": "rest_vpls_L2AccessInterface_requestClearIgmpHostTracking", "description": "Request clearing of all IGMP Host Tracking information for this L2 AccessInterface.
When this method returns resources for the clear have been allocated
but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearIgmpHostTracking:
instance-level modifier API requestClearIgmpHostTracking
of class vpls.L2AccessInterface
DescendantInfo:
vpls.MSap
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_vpls_L2AccessInterface_requestClearIgmpHostTracking", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "boolean" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearIgmpHostTrackingResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vpls/MSap/requestClearMsap/{instanceFullName}": { "post": { "tags": [ "samo_vpls" ], "summary": "rest_vpls_MSap_requestClearMsap", "description": "Request clearing of this MSAP.
When this method returns resources for the clear have been allocated
but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearMsap:
instance-level modifier API requestClearMsap
of class vpls.MSap
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_vpls_MSap_requestClearMsap", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearMsapResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vpls/ProxyArpNdMacList/findNumberOfAssociation": { "get": { "tags": [ "samo_vpls" ], "summary": "rest_vpls_ProxyArpNdMacList_findNumberOfAssociation", "description": "Return the number of MACs associated to this MAC list.

Intention : RETRIEVER
findNumberOfAssociation:
class-level [object finder] (retriever) API findNumberOfAssociation
of class vpls.ProxyArpNdMacList


", "operationId": "rest_vpls_ProxyArpNdMacList_findNumberOfAssociation", "parameters": [ { "name": "siteId", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "macListName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findNumberOfAssociationResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vpls/ProxyArpNdMacList/findNumberOfMacs": { "get": { "tags": [ "samo_vpls" ], "summary": "rest_vpls_ProxyArpNdMacList_findNumberOfMacs", "description": "Return the number of MACs associated to this MAC list.

Intention : RETRIEVER
findNumberOfMacs:
class-level [object finder] (retriever) API findNumberOfMacs
of class vpls.ProxyArpNdMacList


", "operationId": "rest_vpls_ProxyArpNdMacList_findNumberOfMacs", "parameters": [ { "name": "siteId", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "macListName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findNumberOfMacsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vpls/Site/requestClearIgmpHostTracking/{instanceFullName}": { "post": { "tags": [ "samo_vpls" ], "summary": "rest_vpls_Site_requestClearIgmpHostTracking", "description": "Request clearing of all IGMP Host Tracking information for this site.
When this method returns resources for the clear have been allocated
but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearIgmpHostTracking:
instance-level modifier API requestClearIgmpHostTracking
of class vpls.Site
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_vpls_Site_requestClearIgmpHostTracking", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "boolean" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearIgmpHostTrackingResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vpls/Site/requestClearProxyArpDups/{instanceFullName}": { "post": { "tags": [ "samo_vpls" ], "summary": "rest_vpls_Site_requestClearProxyArpDups", "description": "Request to clear the duplicate Proxy-ARP entrie(s)

Intention : MODIFIER
requestClearProxyArpDups:
instance-level modifier API requestClearProxyArpDups
of class vpls.Site
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_vpls_Site_requestClearProxyArpDups", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearProxyArpDupsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vpls/Site/requestClearProxyArpDyn/{instanceFullName}": { "post": { "tags": [ "samo_vpls" ], "summary": "rest_vpls_Site_requestClearProxyArpDyn", "description": "Request to clear the dynamic Proxy-ARP entrie(s)

Intention : MODIFIER
requestClearProxyArpDyn:
instance-level modifier API requestClearProxyArpDyn
of class vpls.Site
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_vpls_Site_requestClearProxyArpDyn", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearProxyArpDynResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vpls/Site/requestClearProxyNdDups/{instanceFullName}": { "post": { "tags": [ "samo_vpls" ], "summary": "rest_vpls_Site_requestClearProxyNdDups", "description": "Request to clear the duplicate Proxy-ND entrie(s)

Intention : MODIFIER
requestClearProxyNdDups:
instance-level modifier API requestClearProxyNdDups
of class vpls.Site
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_vpls_Site_requestClearProxyNdDups", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearProxyNdDupsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vpls/Site/requestClearProxyNdDyn/{instanceFullName}": { "post": { "tags": [ "samo_vpls" ], "summary": "rest_vpls_Site_requestClearProxyNdDyn", "description": "Request to clear the dynamic Proxy-ND entrie(s)

Intention : MODIFIER
requestClearProxyNdDyn:
instance-level modifier API requestClearProxyNdDyn
of class vpls.Site
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_vpls_Site_requestClearProxyNdDyn", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearProxyNdDynResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vpls/Vpls/restoreServiceForThroughputTest": { "post": { "tags": [ "samo_vpls" ], "summary": "rest_vpls_Vpls_restoreServiceForThroughputTest", "description": "Restore the service from the throughput test.

Intention : MODIFIER
restoreServiceForThroughputTest:
class-level modifier API restoreServiceForThroughputTest
of class vpls.Vpls

A list of error messages.

", "operationId": "rest_vpls_Vpls_restoreServiceForThroughputTest", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/restoreServiceForThroughputTestResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/isa/AaEsmHostInfo/retrieveAaEsmHosts": { "post": { "tags": [ "samo_isa" ], "summary": "rest_isa_AaEsmHostInfo_retrieveAaEsmHosts", "description": "Method to query the NE for AaEsmHost.

Intention : RETRIEVER
retrieveAaEsmHosts:
class-level retriever API retrieveAaEsmHosts
of class isa.AaEsmHostInfo


", "operationId": "rest_isa_AaEsmHostInfo_retrieveAaEsmHosts", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveAaEsmHosts" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveAaEsmHostsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/isa/AaGroup/getDependencyCount/{instanceFullName}": { "get": { "tags": [ "samo_isa" ], "summary": "rest_isa_AaGroup_getDependencyCount", "description": "Count the total number of AA subscriber, SAPs, and
spoke SDP binding summary information objects on the group.

Intention : RETRIEVER
getDependencyCount:
instance-level retriever API getDependencyCount
of class isa.AaGroup
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_isa_AaGroup_getDependencyCount", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getDependencyCountResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/isa/AaSapInfo/invokeResyncAaSapInfo": { "post": { "tags": [ "samo_isa" ], "summary": "rest_isa_AaSapInfo_invokeResyncAaSapInfo", "operationId": "rest_isa_AaSapInfo_invokeResyncAaSapInfo", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invokeResyncAaSapInfo" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/isa/AaSpokeSdpBindingInfo/invokeResyncAaSpokeSdpBindingInfo": { "post": { "tags": [ "samo_isa" ], "summary": "rest_isa_AaSpokeSdpBindingInfo_invokeResyncAaSpokeSdpBindingInfo", "operationId": "rest_isa_AaSpokeSdpBindingInfo_invokeResyncAaSpokeSdpBindingInfo", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invokeResyncAaSpokeSdpBindingInfo" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/isa/AaSubInfo/invokeResyncAaSubInfo": { "post": { "tags": [ "samo_isa" ], "summary": "rest_isa_AaSubInfo_invokeResyncAaSubInfo", "operationId": "rest_isa_AaSubInfo_invokeResyncAaSubInfo", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invokeResyncAaSubInfo" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/isa/IPSecIsaGroup/getDependencyCount/{instanceFullName}": { "get": { "tags": [ "samo_isa" ], "summary": "rest_isa_IPSecIsaGroup_getDependencyCount", "description": "
Intention : RETRIEVER
getDependencyCount:
instance-level retriever API getDependencyCount
of class isa.IPSecIsaGroup
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_isa_IPSecIsaGroup_getDependencyCount", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getDependencyCountResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/isa/LnsGroup/getDependencyCount/{instanceFullName}": { "get": { "tags": [ "samo_isa" ], "summary": "rest_isa_LnsGroup_getDependencyCount", "description": "
Intention : RETRIEVER
getDependencyCount:
instance-level retriever API getDependencyCount
of class isa.LnsGroup
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_isa_LnsGroup_getDependencyCount", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getDependencyCountResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/isa/VideoGroup/getDependencyCount/{instanceFullName}": { "get": { "tags": [ "samo_isa" ], "summary": "rest_isa_VideoGroup_getDependencyCount", "description": "
Intention : RETRIEVER
getDependencyCount:
instance-level retriever API getDependencyCount
of class isa.VideoGroup
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_isa_VideoGroup_getDependencyCount", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getDependencyCountResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/analytics/AnalyticsManager/isAnalyticalBaseEnabled": { "post": { "tags": [ "samo_analytics" ], "summary": "rest_analytics_AnalyticsManager_isAnalyticalBaseEnabled", "description": "
Intention : RETRIEVER
isAnalyticalBaseEnabled:
class-level retriever API isAnalyticalBaseEnabled on default instance AnltMgr of class analytics.AnalyticsManager


", "operationId": "rest_analytics_AnalyticsManager_isAnalyticalBaseEnabled", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/isAnalyticalBaseEnabledResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/analytics/AnalyticsManager/isPremiumPkgEnabled": { "post": { "tags": [ "samo_analytics" ], "summary": "rest_analytics_AnalyticsManager_isPremiumPkgEnabled", "description": "
Intention : RETRIEVER
isPremiumPkgEnabled:
class-level retriever API isPremiumPkgEnabled on default instance AnltMgr of class analytics.AnalyticsManager


", "operationId": "rest_analytics_AnalyticsManager_isPremiumPkgEnabled", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/isPremiumPkgEnabledResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/analytics/AnalyticsManager/purgeAnalyticReports": { "post": { "tags": [ "samo_analytics" ], "summary": "rest_analytics_AnalyticsManager_purgeAnalyticReports", "operationId": "rest_analytics_AnalyticsManager_purgeAnalyticReports", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/oth/OdukPtf/buildHigherRateOdu/{instanceFullName}": { "post": { "tags": [ "samo_oth" ], "summary": "rest_oth_OdukPtf_buildHigherRateOdu", "operationId": "rest_oth_OdukPtf_buildHigherRateOdu", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/buildHigherRateOdu" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/oth/OdukPtf/collapseHigherRateOdu/{instanceFullName}": { "post": { "tags": [ "samo_oth" ], "summary": "rest_oth_OdukPtf_collapseHigherRateOdu", "operationId": "rest_oth_OdukPtf_collapseHigherRateOdu", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/oth/OdukPtf/getOdu1PtfObject": { "get": { "tags": [ "samo_oth" ], "summary": "rest_oth_OdukPtf_getOdu1PtfObject", "description": "Retrieve the Odu1PtfChannel objects.

Intention : RETRIEVER
getOdu1PtfObject:
class-level retriever API getOdu1PtfObject
of class oth.OdukPtf


", "operationId": "rest_oth_OdukPtf_getOdu1PtfObject", "parameters": [ { "name": "aInOdukPtfDn", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getOdu1PtfObjectResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/oth/OdukPtf/getOptsgObjects": { "get": { "tags": [ "samo_oth" ], "summary": "rest_oth_OdukPtf_getOptsgObjects", "description": "Retrieve the OPTSG objects.

Intention : RETRIEVER
getOptsgObjects:
class-level retriever API getOptsgObjects
of class oth.OdukPtf


", "operationId": "rest_oth_OdukPtf_getOptsgObjects", "parameters": [ { "name": "aInOdukPtfDn", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getOptsgObjectsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/oth/OdukPtf/updateTimeSlots": { "put": { "tags": [ "samo_oth" ], "summary": "rest_oth_OdukPtf_updateTimeSlots", "operationId": "rest_oth_OdukPtf_updateTimeSlots", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateTimeSlots" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/gtp/S11Session/retrieveGtpS11Sessions": { "post": { "tags": [ "samo_gtp" ], "summary": "rest_gtp_S11Session_retrieveGtpS11Sessions", "description": "Method used to retrieve GTP S11 sessions from NE.

Intention : RETRIEVER
retrieveGtpS11Sessions:
class-level retriever API retrieveGtpS11Sessions
of class gtp.S11Session


", "operationId": "rest_gtp_S11Session_retrieveGtpS11Sessions", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveGtpS11Sessions" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveGtpS11SessionsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vs/Policy/findAccessInterfaces/{instanceFullName}": { "post": { "tags": [ "samo_vs" ], "summary": "rest_vs_Policy_findAccessInterfaces", "description": "
Intention : RETRIEVER
findAccessInterfaces:
instance-level [object finder] (retriever) API findAccessInterfaces
of class vs.Policy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_vs_Policy_findAccessInterfaces", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAccessInterfacesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vs/Policy/findAggregationSchedulers/{instanceFullName}": { "post": { "tags": [ "samo_vs" ], "summary": "rest_vs_Policy_findAggregationSchedulers", "description": "
Intention : RETRIEVER
findAggregationSchedulers:
instance-level [object finder] (retriever) API findAggregationSchedulers
of class vs.Policy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_vs_Policy_findAggregationSchedulers", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAggregationSchedulersResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vs/Policy/findServiceIpInterfaces/{instanceFullName}": { "post": { "tags": [ "samo_vs" ], "summary": "rest_vs_Policy_findServiceIpInterfaces", "description": "
Intention : RETRIEVER
findServiceIpInterfaces:
instance-level [object finder] (retriever) API findServiceIpInterfaces
of class vs.Policy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_vs_Policy_findServiceIpInterfaces", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findServiceIpInterfacesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vs/Policy/getDependency": { "get": { "tags": [ "samo_vs" ], "summary": "rest_vs_Policy_getDependency", "description": "
Intention : RETRIEVER
getDependency:
class-level retriever API getDependency
of class vs.Policy


", "operationId": "rest_vs_Policy_getDependency", "parameters": [ { "name": "objectName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getDependencyResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vs/Policy/getDependencyCount": { "get": { "tags": [ "samo_vs" ], "summary": "rest_vs_Policy_getDependencyCount", "description": "
Intention : RETRIEVER
getDependencyCount:
class-level retriever API getDependencyCount
of class vs.Policy


", "operationId": "rest_vs_Policy_getDependencyCount", "parameters": [ { "name": "objectName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getDependencyCountResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ethernettunnel/EthPathComponent/renum": { "post": { "tags": [ "samo_ethernettunnel" ], "summary": "rest_ethernettunnel_EthPathComponent_renum", "operationId": "rest_ethernettunnel_EthPathComponent_renum", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/renum" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ethernettunnel/EthernetPath/createMEPs/{instanceFullName}": { "post": { "tags": [ "samo_ethernettunnel" ], "summary": "rest_ethernettunnel_EthernetPath_createMEPs", "operationId": "rest_ethernettunnel_EthernetPath_createMEPs", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ethernettunnel/EthernetPath/deleteEthernetPath/{instanceFullName}": { "delete": { "tags": [ "samo_ethernettunnel" ], "summary": "rest_ethernettunnel_EthernetPath_deleteEthernetPath", "operationId": "rest_ethernettunnel_EthernetPath_deleteEthernetPath", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ethernettunnel/EthernetPath/executeCCProtocol/{instanceFullName}": { "put": { "tags": [ "samo_ethernettunnel" ], "summary": "rest_ethernettunnel_EthernetPath_executeCCProtocol", "operationId": "rest_ethernettunnel_EthernetPath_executeCCProtocol", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ethernettunnel/EthernetTunnel/addEthernetTunnelEndpoint/{instanceFullName}": { "post": { "tags": [ "samo_ethernettunnel" ], "summary": "rest_ethernettunnel_EthernetTunnel_addEthernetTunnelEndpoint", "operationId": "rest_ethernettunnel_EthernetTunnel_addEthernetTunnelEndpoint", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ethernettunnel/EthernetTunnel/createEthernetTunnelEndpoint/{instanceFullName}": { "post": { "tags": [ "samo_ethernettunnel" ], "summary": "rest_ethernettunnel_EthernetTunnel_createEthernetTunnelEndpoint", "description": "creates a EthernetTunnelEndpoint and it add the endpoint to this Ethernet Tunnel

Intention : MODIFIER
createEthernetTunnelEndpoint:
instance-level [administrative creation] (modifier) API createEthernetTunnelEndpoint
of class ethernettunnel.EthernetTunnel
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_ethernettunnel_EthernetTunnel_createEthernetTunnelEndpoint", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EthernetTunnelEndpointConfigInfo" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createEthernetTunnelEndpointResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ethernettunnel/EthernetTunnel/removeEthernetTunnelEndpoint/{instanceFullName}": { "post": { "tags": [ "samo_ethernettunnel" ], "summary": "rest_ethernettunnel_EthernetTunnel_removeEthernetTunnelEndpoint", "operationId": "rest_ethernettunnel_EthernetTunnel_removeEthernetTunnelEndpoint", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ethernettunnel/EthernetTunnelPathEndpoint/findCtpsForTunnelPathEndpoint": { "post": { "tags": [ "samo_ethernettunnel" ], "summary": "rest_ethernettunnel_EthernetTunnelPathEndpoint_findCtpsForTunnelPathEndpoint", "description": "
Intention : RETRIEVER
findCtpsForTunnelPathEndpoint:
class-level [object finder] (retriever) API findCtpsForTunnelPathEndpoint
of class ethernettunnel.EthernetTunnelPathEndpoint


", "operationId": "rest_ethernettunnel_EthernetTunnelPathEndpoint_findCtpsForTunnelPathEndpoint", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findCtpsForTunnelPathEndpoint" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findCtpsForTunnelPathEndpointResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ipipe/Site/requestClearArpCache/{instanceFullName}": { "post": { "tags": [ "samo_ipipe" ], "summary": "rest_ipipe_Site_requestClearArpCache", "description": "Request clearing the ARP cache for this site. When this method
returns resources for the clear have been allocated but the
clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearArpCache:
instance-level modifier API requestClearArpCache
of class ipipe.Site
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_ipipe_Site_requestClearArpCache", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearArpCacheResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ipipe/Site/requestClearNeighborCache/{instanceFullName}": { "post": { "tags": [ "samo_ipipe" ], "summary": "rest_ipipe_Site_requestClearNeighborCache", "description": "Request clearing the discovered IPv6 neighbor cache for this site. When this method
returns resources for the clear have been allocated but the
clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearNeighborCache:
instance-level modifier API requestClearNeighborCache
of class ipipe.Site
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_ipipe_Site_requestClearNeighborCache", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearNeighborCacheResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ipsec/IPSecGateway/shutDown/{instanceFullName}": { "post": { "tags": [ "samo_ipsec" ], "summary": "rest_ipsec_IPSecGateway_shutDown", "operationId": "rest_ipsec_IPSecGateway_shutDown", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ipsec/IPSecGateway/turnUp/{instanceFullName}": { "post": { "tags": [ "samo_ipsec" ], "summary": "rest_ipsec_IPSecGateway_turnUp", "operationId": "rest_ipsec_IPSecGateway_turnUp", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ipsec/IPSecSecuredVpnManager/configureIPSecSecuredVPN": { "post": { "tags": [ "samo_ipsec" ], "summary": "rest_ipsec_IPSecSecuredVpnManager_configureIPSecSecuredVPN", "description": "
Intention : MODIFIER
configureIPSecSecuredVPN:
instance-level [hierarchical administrative configuration/modification] (modifier) API configureIPSecSecuredVPN on default instance isv-mgr of class ipsec.IPSecSecuredVpnManager
This API follows hierarchical config model rules.


", "operationId": "rest_ipsec_IPSecSecuredVpnManager_configureIPSecSecuredVPN", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureIPSecSecuredVPN" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureIPSecSecuredVPNResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ipsec/InternalDHCPv4AddressAssignment/shutDown/{instanceFullName}": { "post": { "tags": [ "samo_ipsec" ], "summary": "rest_ipsec_InternalDHCPv4AddressAssignment_shutDown", "operationId": "rest_ipsec_InternalDHCPv4AddressAssignment_shutDown", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ipsec/InternalDHCPv4AddressAssignment/turnUp/{instanceFullName}": { "post": { "tags": [ "samo_ipsec" ], "summary": "rest_ipsec_InternalDHCPv4AddressAssignment_turnUp", "operationId": "rest_ipsec_InternalDHCPv4AddressAssignment_turnUp", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ipsec/InternalDHCPv6AddressAssignment/shutDown/{instanceFullName}": { "post": { "tags": [ "samo_ipsec" ], "summary": "rest_ipsec_InternalDHCPv6AddressAssignment_shutDown", "operationId": "rest_ipsec_InternalDHCPv6AddressAssignment_shutDown", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ipsec/InternalDHCPv6AddressAssignment/turnUp/{instanceFullName}": { "post": { "tags": [ "samo_ipsec" ], "summary": "rest_ipsec_InternalDHCPv6AddressAssignment_turnUp", "operationId": "rest_ipsec_InternalDHCPv6AddressAssignment_turnUp", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ipsec/LocalAddressAssignment/shutDown/{instanceFullName}": { "post": { "tags": [ "samo_ipsec" ], "summary": "rest_ipsec_LocalAddressAssignment_shutDown", "operationId": "rest_ipsec_LocalAddressAssignment_shutDown", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ipsec/LocalAddressAssignment/turnUp/{instanceFullName}": { "post": { "tags": [ "samo_ipsec" ], "summary": "rest_ipsec_LocalAddressAssignment_turnUp", "operationId": "rest_ipsec_LocalAddressAssignment_turnUp", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/esa/EsaVirtualMachine/getDependencyCount/{instanceFullName}": { "get": { "tags": [ "samo_esa" ], "summary": "rest_esa_EsaVirtualMachine_getDependencyCount", "description": "
Intention : RETRIEVER
getDependencyCount:
instance-level retriever API getDependencyCount
of class esa.EsaVirtualMachine
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_esa_EsaVirtualMachine_getDependencyCount", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getDependencyCountResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/esa/ExtendedServicesAppliance/getDependencyCount/{instanceFullName}": { "get": { "tags": [ "samo_esa" ], "summary": "rest_esa_ExtendedServicesAppliance_getDependencyCount", "description": "
Intention : RETRIEVER
getDependencyCount:
instance-level retriever API getDependencyCount
of class esa.ExtendedServicesAppliance
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_esa_ExtendedServicesAppliance_getDependencyCount", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getDependencyCountResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sonetequipment/SonetPortSpecifics/findChannels/{instanceFullName}": { "post": { "tags": [ "samo_sonetequipment" ], "summary": "rest_sonetequipment_SonetPortSpecifics_findChannels", "description": "
Intention : RETRIEVER
findChannels:
instance-level [object finder] (retriever) API findChannels
of class sonetequipment.SonetPortSpecifics
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_sonetequipment_SonetPortSpecifics_findChannels", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findChannelsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ies/GroupInterface/requestPolicyAccountStatsClear/{instanceFullName}": { "post": { "tags": [ "samo_ies" ], "summary": "rest_ies_GroupInterface_requestPolicyAccountStatsClear", "description": "Request clearing of Policy Accounting Statistics on this interface.
When this method returns resources for the clear have been allocated
but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestPolicyAccountStatsClear:
instance-level modifier API requestPolicyAccountStatsClear
of class ies.GroupInterface
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_ies_GroupInterface_requestPolicyAccountStatsClear", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestPolicyAccountStatsClear" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestPolicyAccountStatsClearResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ies/L3AccessInterface/requestPolicyAccountStatsClear/{instanceFullName}": { "post": { "tags": [ "samo_ies" ], "summary": "rest_ies_L3AccessInterface_requestPolicyAccountStatsClear", "description": "Request clearing of Policy Accounting Statistics on this interface.
When this method returns resources for the clear have been allocated
but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestPolicyAccountStatsClear:
instance-level modifier API requestPolicyAccountStatsClear
of class ies.L3AccessInterface
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_ies_L3AccessInterface_requestPolicyAccountStatsClear", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestPolicyAccountStatsClear" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestPolicyAccountStatsClearResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ies/MSap/requestClearMsap/{instanceFullName}": { "post": { "tags": [ "samo_ies" ], "summary": "rest_ies_MSap_requestClearMsap", "description": "Request clearing of this MSAP.
When this method returns resources for the clear have been allocated
but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearMsap:
instance-level modifier API requestClearMsap
of class ies.MSap
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_ies_MSap_requestClearMsap", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearMsapResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ies/ServiceAccessPoint/requestClearIgmpHostTracking/{instanceFullName}": { "post": { "tags": [ "samo_ies" ], "summary": "rest_ies_ServiceAccessPoint_requestClearIgmpHostTracking", "description": "Request clearing of all IGMP Host Tracking information for this ServiceAccessPoint.
When this method returns resources for the clear have been allocated
but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearIgmpHostTracking:
instance-level modifier API requestClearIgmpHostTracking
of class ies.ServiceAccessPoint
DescendantInfo:
ies.MSap
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_ies_ServiceAccessPoint_requestClearIgmpHostTracking", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "boolean" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearIgmpHostTrackingResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ies/Site/requestClearIgmpHostTracking/{instanceFullName}": { "post": { "tags": [ "samo_ies" ], "summary": "rest_ies_Site_requestClearIgmpHostTracking", "description": "Request clearing of all IGMP Host Tracking information for this site.
When this method returns resources for the clear have been allocated
but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearIgmpHostTracking:
instance-level modifier API requestClearIgmpHostTracking
of class ies.Site
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_ies_Site_requestClearIgmpHostTracking", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "boolean" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearIgmpHostTrackingResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ospf/Interface/removePassword/{instanceFullName}": { "post": { "tags": [ "samo_ospf" ], "summary": "rest_ospf_Interface_removePassword", "operationId": "rest_ospf_Interface_removePassword", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ospf/ShamLink/removePassword/{instanceFullName}": { "post": { "tags": [ "samo_ospf" ], "summary": "rest_ospf_ShamLink_removePassword", "operationId": "rest_ospf_ShamLink_removePassword", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ospf/SiteExtension/initiatePlannedRestart": { "post": { "tags": [ "samo_ospf" ], "summary": "rest_ospf_SiteExtension_initiatePlannedRestart", "operationId": "rest_ospf_SiteExtension_initiatePlannedRestart", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/initiatePlannedRestart" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ospf/VirtualLink/removePassword/{instanceFullName}": { "post": { "tags": [ "samo_ospf" ], "summary": "rest_ospf_VirtualLink_removePassword", "operationId": "rest_ospf_VirtualLink_removePassword", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/svt/AbstractTunnel/findCircuits/{instanceFullName}": { "post": { "tags": [ "samo_svt" ], "summary": "rest_svt_AbstractTunnel_findCircuits", "description": "
Intention : RETRIEVER
findCircuits:
instance-level [object finder] (retriever) API findCircuits
of class svt.AbstractTunnel
DescendantInfo:
svt.BvlanTunnel
DescendantInfo:
svt.Tunnel
DescendantInfo:
svt.L2TPv3Tunnel
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_svt_AbstractTunnel_findCircuits", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findCircuitsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/svt/AbstractTunnel/findServices/{instanceFullName}": { "post": { "tags": [ "samo_svt" ], "summary": "rest_svt_AbstractTunnel_findServices", "description": "
Intention : RETRIEVER
findServices:
instance-level [object finder] (retriever) API findServices
of class svt.AbstractTunnel
DescendantInfo:
svt.BvlanTunnel
DescendantInfo:
svt.Tunnel
DescendantInfo:
svt.L2TPv3Tunnel
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_svt_AbstractTunnel_findServices", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findServicesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/svt/AbstractTunnel/findSubscribers/{instanceFullName}": { "post": { "tags": [ "samo_svt" ], "summary": "rest_svt_AbstractTunnel_findSubscribers", "description": "
Intention : RETRIEVER
findSubscribers:
instance-level [object finder] (retriever) API findSubscribers
of class svt.AbstractTunnel
DescendantInfo:
svt.BvlanTunnel
DescendantInfo:
svt.Tunnel
DescendantInfo:
svt.L2TPv3Tunnel
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_svt_AbstractTunnel_findSubscribers", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findSubscribersResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/svt/AbstractTunnel/rediscoverTunnelDestination": { "post": { "tags": [ "samo_svt" ], "summary": "rest_svt_AbstractTunnel_rediscoverTunnelDestination", "description": "Rediscover the destinations for the tunnels in the specified list, where the tunnels
destination node ID is not set.

Intention : MODIFIER
rediscoverTunnelDestination:
class-level modifier API rediscoverTunnelDestination
of class svt.AbstractTunnel
DescendantInfo:
svt.BvlanTunnel
DescendantInfo:
svt.Tunnel
DescendantInfo:
svt.L2TPv3Tunnel

A list of error messages.

", "operationId": "rest_svt_AbstractTunnel_rediscoverTunnelDestination", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rediscoverTunnelDestinationResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/svt/AbstractTunnel/shutDown/{instanceFullName}": { "post": { "tags": [ "samo_svt" ], "summary": "rest_svt_AbstractTunnel_shutDown", "operationId": "rest_svt_AbstractTunnel_shutDown", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/svt/AbstractTunnel/turnUp/{instanceFullName}": { "post": { "tags": [ "samo_svt" ], "summary": "rest_svt_AbstractTunnel_turnUp", "operationId": "rest_svt_AbstractTunnel_turnUp", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/svt/L2TPv3Tunnel/rediscoverDestinationSite": { "post": { "tags": [ "samo_svt" ], "summary": "rest_svt_L2TPv3Tunnel_rediscoverDestinationSite", "description": "Re-discover the destination site for L2TPv3 tunnel if the destination node ID is not set
but far-end IP address is set.

Intention : MODIFIER
rediscoverDestinationSite:
class-level modifier API rediscoverDestinationSite
of class svt.L2TPv3Tunnel

A list of error messages.

", "operationId": "rest_svt_L2TPv3Tunnel_rediscoverDestinationSite", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rediscoverDestinationSiteResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/svt/Manager/discoverFlowThruServices": { "post": { "tags": [ "samo_svt" ], "summary": "rest_svt_Manager_discoverFlowThruServices", "operationId": "rest_svt_Manager_discoverFlowThruServices", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/svt/MeshSdpBinding/requestClearMeshSdpBfdSession/{instanceFullName}": { "post": { "tags": [ "samo_svt" ], "summary": "rest_svt_MeshSdpBinding_requestClearMeshSdpBfdSession", "description": "Request to clear the VCCV BFD session on this mesh SDP binding.

Intention : MODIFIER
requestClearMeshSdpBfdSession:
instance-level modifier API requestClearMeshSdpBfdSession
of class svt.MeshSdpBinding
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_svt_MeshSdpBinding_requestClearMeshSdpBfdSession", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearMeshSdpBfdSessionResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/svt/MeshSdpBinding/requestClearMeshSdpBfdStats/{instanceFullName}": { "post": { "tags": [ "samo_svt" ], "summary": "rest_svt_MeshSdpBinding_requestClearMeshSdpBfdStats", "description": "Request to clear the VCCV BFD session stats on this mesh SDP binding.

Intention : MODIFIER
requestClearMeshSdpBfdStats:
instance-level modifier API requestClearMeshSdpBfdStats
of class svt.MeshSdpBinding
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_svt_MeshSdpBinding_requestClearMeshSdpBfdStats", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearMeshSdpBfdStatsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/svt/SpokeSdpBinding/requestClearSpokeSdpBfdSession/{instanceFullName}": { "post": { "tags": [ "samo_svt" ], "summary": "rest_svt_SpokeSdpBinding_requestClearSpokeSdpBfdSession", "description": "Request to clear the VCCV BFD session on this spoke SDP binding.

Intention : MODIFIER
requestClearSpokeSdpBfdSession:
instance-level modifier API requestClearSpokeSdpBfdSession
of class svt.SpokeSdpBinding
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_svt_SpokeSdpBinding_requestClearSpokeSdpBfdSession", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearSpokeSdpBfdSessionResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/svt/SpokeSdpBinding/requestClearSpokeSdpBfdStats/{instanceFullName}": { "post": { "tags": [ "samo_svt" ], "summary": "rest_svt_SpokeSdpBinding_requestClearSpokeSdpBfdStats", "description": "Request to clear the VCCV BFD session stats on this spoke SDP binding.

Intention : MODIFIER
requestClearSpokeSdpBfdStats:
instance-level modifier API requestClearSpokeSdpBfdStats
of class svt.SpokeSdpBinding
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_svt_SpokeSdpBinding_requestClearSpokeSdpBfdStats", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearSpokeSdpBfdStatsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/svt/Tunnel/configure": { "post": { "tags": [ "samo_svt" ], "summary": "rest_svt_Tunnel_configure", "description": "
Intention : MODIFIER
configure:
class-level [hierarchical administrative configuration/modification] (modifier) API configure
of class svt.Tunnel
This API follows hierarchical config model rules.


", "operationId": "rest_svt_Tunnel_configure", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/svt/Tunnel/findServiceSites/{instanceFullName}": { "post": { "tags": [ "samo_svt" ], "summary": "rest_svt_Tunnel_findServiceSites", "description": "
Intention : RETRIEVER
findServiceSites:
instance-level [object finder] (retriever) API findServiceSites
of class svt.Tunnel
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_svt_Tunnel_findServiceSites", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findServiceSitesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/general/find": { "post": { "tags": [ "samo_general" ], "summary": "rest_coregeristry_application_register_find", "description": "The find method returns a set of objects of the type specified in the fullClassName element that match the filter criteria. The method response is a XML result.For example, the client makes the following HTTP request:\n \n\n POST /v2/general/find HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n Content-Type: application/json\n\n {\"fullClassName\":\"netw.NetworkElement\", \"resultFilter\": { \"attributes\": [\"objectFullName\",\"siteId\"] } }\n\n", "operationId": "rest_coregeristry_application_register_find", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterFindDto" } } }, "required": false }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/xml": { "schema": { "type": "object", "additionalProperties": { "type": "object" }, "xml": { "name": "response", "attribute": false, "wrapped": false } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" } } } } }, "204": { "description": "Result will return synchronously", "headers": {}, "content": {} }, "400": { "description": "Not found", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/general/findToFile": { "post": { "tags": [ "samo_general" ], "summary": "rest_coregeristry_application_register_findToFile", "description": "The findToFile method returns a set of objects of the type specified in the fullClassName element that match the filter criteria. You can specify the following result file storage options:\n - save the file locally on the NFM-P server\n - use FTP to transfer the results to a remote host\n\nFile content will be in XML format.\n\nBy default, the findToFile method runs synchronously, which means that one request has to complete and return before the processing of the next request begins.\n The NFM-P returns the following when a findToFile request cannot be processed:\n - synchronous request:\n - HTTP error message, if a request timeout occurs\n - Event notification, for an error during the query execution or file creation\n - synchronous request:\n - HTTP error message, if the number of requests exceeds the maximum allowed or a request timeout occurs\n\nFor example, the client makes the following HTTP request:\n\n POST /v2/general/findToFile HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n Content-Type: application/json\n\n {\"fullClassName\":[\"netw.NetworkElement\"], \"fileName\": \"myFile.xml\", \"resultFilter\": { \"attributes\": [\"objectFullName\",\"siteId\"] } }\n\n", "operationId": "rest_coregeristry_application_register_findToFile", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterFindToFileDto" } } }, "required": false }, "responses": { "204": { "description": "Result will return asynchronously", "headers": {}, "content": {} }, "400": { "description": "Not found", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/general/ping": { "post": { "tags": [ "samo_general" ], "summary": "rest_coregeristry_application_register_ping", "description": "The ping method can be used to test whether the OSS application can access the NFM-P server. A successful ping returns an empty response. A failed ping may result in many types of return messages, for example:\n - socket timeouts\n - HTTP 404 errors\n - connection exceptions", "operationId": "rest_coregeristry_application_register_ping", "parameters": [], "responses": { "204": { "description": "Result will return synchronously", "headers": {}, "content": {} }, "400": { "description": "Not found", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/general/registerLogToFile/{clientId}": { "post": { "tags": [ "samo_general" ], "summary": "rest_coregeristry_application_register", "description": "Create accounting or performance statistics data files for specific classes. When the registerLogToFile method is used, the specific statistics files are generated on an NFM-P server with the requested data for each registered client. Content is generated to file independent of database storage. \n\nA LogFileAvailableEvent is sent each time a file is ready for retrieval, if the client subscribes to specific Kafka Categories. See Kafka Notification Service Tutorial on the NSP Developer Portal at network.developer.nokia.com for information about JMS events.\n\nBy default, the NFM-P performs a regular client inactivity check and deregisters any client that does not subscribe to an event stream within a specified time. For registerLogToFile, a Kafka subscription is optional; to avoid client deregistration after inactivity, you can disable the client inactivity check. See \"To configure the registerLogToFile or registerSasLogToFile client inactivity check\" in the XML API Developer Guide for information.\n\nTo reduce the volume of exported statistics data, you can apply a filter during registration. The optional filter input parameter allows filtering on the monitoredObjectSiteName attribute of the log record that is written to the statistics file.\n\nFor example, the client makes the following HTTP request:\n\n POST /v2/general/registerLogToFile/ac8adb38-3d41-422b-99f3-deb17c34b63a HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n Content-Type: application/json\n\n {\"fullClassName\":[\"equipment.InterfaceStats\"], \"dirName\": \"myDir\", \"compress\": true, \"filter\": { \"fullClassName\": \"equipment.InterfaceStats\", \"filterExpression\": \"monitoredObjectSiteName='s121_147_227_both'\" },\"resultFilter\": { \"attributes\": [\"monitoredObjectPointer\",\"receivedOctets\"] } }\n\n", "operationId": "rest_coregeristry_application_register", "parameters": [ { "name": "clientId", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestRegisterLogToFileDto" } } }, "required": false }, "responses": { "204": { "description": "Result will return asynchronously", "headers": {}, "content": {} }, "400": { "description": "Not found", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] }, "delete": { "tags": [ "samo_general" ], "summary": "rest_coregeristry_application_deregister", "description": "Deregister from receiving notifications for accounting and performance statistics and stop the export file creation. Deregistration also occurs when the client Kafka subscription expires. The NFM-P checks client connectivity every 5 minutes; you can use a GUI client to configure the maximum number of intervals before a disconnected client is deregistered. See \"System preferences configuration procedures\" in the NSP NFM-P System Administrator Guide. A deregistered client must re-register to receive notifications.\n\nThe optional fullClassName parameter takes a list of package qualified class names in dot-separated format to deregister. If this parameter is not specified, the method deregisters all accounting statistics registrations.\n\nFor example, the client makes the following HTTP request:\n\n DELETE /v2/general/registerLogToFile/ac8adb38-3d41-422b-99f3-deb17c34b63a HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n Content-Type: application/json\n\n [ \"equipment.InterfaceStats\" ]\n\n", "operationId": "rest_coregeristry_application_deregister", "parameters": [ { "name": "clientId", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "204": { "description": "Successfully deregister log to file", "headers": {}, "content": {} }, "400": { "description": "Not found", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/general/registerSasLogToFile/{clientId}": { "post": { "tags": [ "samo_general" ], "summary": "rest_coregeristry_application_register_sas_logToFile", "description": "Retrieve OAM test result export files for specific test class results. A LogFileAvailableEvent is sent each time a file is available for retrieval; a client must subscribe to Kafka to receive the events. By default, if the client is not subscribed, no result files are created, and the NFM-P deregisters the client after a period of client inactivity. A Kafka subscription for registerSasLogToFile is optional, however; you can disable the client inactivity check to ensure that no deregistration occurs. See \"To configure the registerLogToFile or registerSasLogToFile client inactivity check\" in the XML API Developer Guide for information.\n\nOAM data is exported to a result file after the data is read from the NE. The file is saved to a specified directory on the NFM-P server.\n\nNote: Not all OAM tests provide OAM data when the registerSasLogToFile method is used. The following conditions are required for OAM data to be generated for registerSasLogToFile:\n - OAM test sas.Test.neSchedulable attribute is true\n - OAM test sas.Test.accountingPolicyObjectPointer attribute is not empty\n - OAM test sas.Test.accountingFiles attribute is true\n - OAM test sas.Test.testResultStorage attribute value is logToFile or logToDBAndFile\n\nSee \"OAM diagnostic tests\" in the NSP NFM-P User Guide for configuration information.\n\nThe NFM-P server verifies the presence of the Kafka client subscription that is specified in the registerSasLogtoFile method using the Kafka subscription Id input parameter. If the client is not subscribed, the server deregisters the registerSasLogToFile request. This means that OAM result export files are not generated after the Log Retention Time expires. It is recommended that you run the registerSasLogToFile method every time the client obtains Kafka subscripotion Id.\n\nFor example, the client makes the following HTTP request:\n\n POST /v2/general/registerSasLogToFile/ac8adb38-3d41-422b-99f3-deb17c34b63a HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n Content-Type: application/json\n\n {\"fullClassName\":[\"sas.TestResult\", \"sas.TraceHop\"], \"dirName\": \"myDir\", \"compress\": \"true\", \"resultFilter\": { \"attributes\": [\"testSuiteId\",\"testId\"] } }\n\n", "operationId": "rest_coregeristry_application_register_sas_logToFile", "parameters": [ { "name": "clientId", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterSasLogToFileDto" } } }, "required": false }, "responses": { "204": { "description": "Result will return asynchronously", "headers": {}, "content": {} }, "400": { "description": "Not found", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] }, "delete": { "tags": [ "samo_general" ], "summary": "rest_coregeristry_application_deregister_sas_logToFile", "description": "Deregister from receiving notifications for OAM test results and stop the export file creation.\n\nThe optional fullClassName parameter takes a list of package qualified class names in dot-separated format to deregister. If this parameter is not specified, the method deregisters all test results registrations. If a class is not an instance of sas.TestResult or sas.TraceHop, an exception occurs and no classes are deregistered.\n\nFor example, the client makes the following HTTP request:\n\n DELETE /v2/general/registerSasLogToFile/ac8adb38-3d41-422b-99f3-deb17c34b63a HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n Content-Type: application/json\n\n [ \"sas.TestResult\" ]\n\n", "operationId": "rest_coregeristry_application_deregister_sas_logToFile", "parameters": [ { "name": "clientId", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "default": { "description": "successful operation", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/general/timestamp": { "post": { "tags": [ "samo_general" ], "summary": "rest_coregeristry_application_register_timestamp", "description": "Returns the current Java time on the NFM-P server.", "operationId": "rest_coregeristry_application_register_timestamp", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeStampDto" } } }, "required": false }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "type": "string" } } } }, "204": { "description": "Result will return synchronously", "headers": {}, "content": {} }, "400": { "description": "Not found", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/general/version": { "get": { "tags": [ "samo_general" ], "summary": "rest_coregeristry_application_register_version", "description": "Returns NFM-P software release information.", "operationId": "rest_coregeristry_application_register_version", "parameters": [], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" } } } } }, "204": { "description": "Result will return synchronously", "headers": {}, "content": {} }, "400": { "description": "Not found", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/lmgperf/LMGPMPolicy/findLmgNodes": { "get": { "tags": [ "samo_lmgperf" ], "summary": "rest_lmgperf_LMGPMPolicy_findLmgNodes", "description": "Find all managed eNodeBs for the specified Performance Management polling policy assigned.

Intention : RETRIEVER
findLmgNodes:
class-level [object finder] (retriever) API findLmgNodes
of class lmgperf.LMGPMPolicy
DescendantInfo:
lmgperf.LMGNodePMPolicy


", "operationId": "rest_lmgperf_LMGPMPolicy_findLmgNodes", "parameters": [ { "name": "policyId", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findLmgNodesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/lmgperf/LMGPMPolicy/invokeCatchup": { "post": { "tags": [ "samo_lmgperf" ], "summary": "rest_lmgperf_LMGPMPolicy_invokeCatchup", "operationId": "rest_lmgperf_LMGPMPolicy_invokeCatchup", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "integer", "format": "int32" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/lmgperf/LMGPMPolicy/invokeLMGsCatchup": { "post": { "tags": [ "samo_lmgperf" ], "summary": "rest_lmgperf_LMGPMPolicy_invokeLMGsCatchup", "operationId": "rest_lmgperf_LMGPMPolicy_invokeLMGsCatchup", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invokeLMGsCatchup" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/propertyrules/PropertyValuePolicy/assignGroups/{instanceFullName}": { "post": { "tags": [ "samo_propertyrules" ], "summary": "rest_propertyrules_PropertyValuePolicy_assignGroups", "operationId": "rest_propertyrules_PropertyValuePolicy_assignGroups", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/propertyrules/PropertyValuePolicy/assignUsers/{instanceFullName}": { "post": { "tags": [ "samo_propertyrules" ], "summary": "rest_propertyrules_PropertyValuePolicy_assignUsers", "operationId": "rest_propertyrules_PropertyValuePolicy_assignUsers", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/propertyrules/PropertyValuePolicy/unassignGroups/{instanceFullName}": { "post": { "tags": [ "samo_propertyrules" ], "summary": "rest_propertyrules_PropertyValuePolicy_unassignGroups", "operationId": "rest_propertyrules_PropertyValuePolicy_unassignGroups", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/propertyrules/PropertyValuePolicy/unassignUsers/{instanceFullName}": { "post": { "tags": [ "samo_propertyrules" ], "summary": "rest_propertyrules_PropertyValuePolicy_unassignUsers", "operationId": "rest_propertyrules_PropertyValuePolicy_unassignUsers", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/opticsperf/OpticsPMPolicy/findPSSs": { "get": { "tags": [ "samo_opticsperf" ], "summary": "rest_opticsperf_OpticsPMPolicy_findPSSs", "description": "Find all managed PSSs for the specified Performance Management polling policy assigned.

Intention : RETRIEVER
findPSSs:
class-level [object finder] (retriever) API findPSSs
of class opticsperf.OpticsPMPolicy
DescendantInfo:
opticsperf.PSSPMPolicy


", "operationId": "rest_opticsperf_OpticsPMPolicy_findPSSs", "parameters": [ { "name": "policyId", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findPSSsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/opticsperf/PMConfig/clearPMCounters/{instanceFullName}": { "post": { "tags": [ "samo_opticsperf" ], "summary": "rest_opticsperf_PMConfig_clearPMCounters", "operationId": "rest_opticsperf_PMConfig_clearPMCounters", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "boolean" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/calltrace/CallTraceConfig/addIPoECallTraceJob": { "post": { "tags": [ "samo_calltrace" ], "summary": "rest_calltrace_CallTraceConfig_addIPoECallTraceJob", "description": "Add selective call trace job based on ipoe session.

Intention : RETRIEVER
addIPoECallTraceJob:
class-level retriever API addIPoECallTraceJob
of class calltrace.CallTraceConfig


", "operationId": "rest_calltrace_CallTraceConfig_addIPoECallTraceJob", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TraceInfoStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/addIPoECallTraceJobResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/calltrace/CallTraceConfig/addWlanGwUeCallTraceJob": { "post": { "tags": [ "samo_calltrace" ], "summary": "rest_calltrace_CallTraceConfig_addWlanGwUeCallTraceJob", "description": "Add selective call trace job based on WLAN GW UE.

Intention : RETRIEVER
addWlanGwUeCallTraceJob:
class-level retriever API addWlanGwUeCallTraceJob
of class calltrace.CallTraceConfig


", "operationId": "rest_calltrace_CallTraceConfig_addWlanGwUeCallTraceJob", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WlanGwUeTraceInfoStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/addWlanGwUeCallTraceJobResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/calltrace/CallTraceConfig/removeIPoECallTraceJob": { "post": { "tags": [ "samo_calltrace" ], "summary": "rest_calltrace_CallTraceConfig_removeIPoECallTraceJob", "description": "Remove selective call trace job based on ipoe session.

Intention : RETRIEVER
removeIPoECallTraceJob:
class-level [administrative deletion] (retriever) API removeIPoECallTraceJob
of class calltrace.CallTraceConfig


", "operationId": "rest_calltrace_CallTraceConfig_removeIPoECallTraceJob", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveTraceInfoStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/removeIPoECallTraceJobResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/calltrace/CallTraceConfig/removeWlanGwUeCallTraceJob": { "post": { "tags": [ "samo_calltrace" ], "summary": "rest_calltrace_CallTraceConfig_removeWlanGwUeCallTraceJob", "description": "Remove selective call trace job based on WLAN GW UE.

Intention : RETRIEVER
removeWlanGwUeCallTraceJob:
class-level [administrative deletion] (retriever) API removeWlanGwUeCallTraceJob
of class calltrace.CallTraceConfig


", "operationId": "rest_calltrace_CallTraceConfig_removeWlanGwUeCallTraceJob", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveWlanGwUeTraceInfoStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/removeWlanGwUeCallTraceJobResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/calltrace/CallTraceConfig/requestClearCallTraceIpoeSession": { "post": { "tags": [ "samo_calltrace" ], "summary": "rest_calltrace_CallTraceConfig_requestClearCallTraceIpoeSession", "description": "Request clearing of IPoE job with specific session key with the specified parameters.
The siteId, sapFdn and macAddress are required. circuitId and remoteId are optional and are mutually exclusive.
When this method returns, resources for the clear have been allocated but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle as input param of the
retrieveClearRequest method of the clear.ClearCommandManager.

Intention : MODIFIER
requestClearCallTraceIpoeSession:
class-level modifier API requestClearCallTraceIpoeSession
of class calltrace.CallTraceConfig

A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_calltrace_CallTraceConfig_requestClearCallTraceIpoeSession", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClearCallTraceIpoeSessionStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearCallTraceIpoeSessionResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/calltrace/CallTraceConfig/requestClearCallTraceIpoeTrace": { "post": { "tags": [ "samo_calltrace" ], "summary": "rest_calltrace_CallTraceConfig_requestClearCallTraceIpoeTrace", "description": "Request clearing of IPoE Jobs Started By Specific Trace with the specified parameters.
The siteId and traceName are required.
When this method returns, resources for the clear have been allocated but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearCallTraceIpoeTrace:
class-level modifier API requestClearCallTraceIpoeTrace
of class calltrace.CallTraceConfig

A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_calltrace_CallTraceConfig_requestClearCallTraceIpoeTrace", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClearCallTraceIpoeTraceStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearCallTraceIpoeTraceResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/calltrace/CallTraceFile/retrieveCallTraceFile": { "post": { "tags": [ "samo_calltrace" ], "summary": "rest_calltrace_CallTraceFile_retrieveCallTraceFile", "description": "
Intention : RETRIEVER
retrieveCallTraceFile:
class-level retriever API retrieveCallTraceFile
of class calltrace.CallTraceFile


", "operationId": "rest_calltrace_CallTraceFile_retrieveCallTraceFile", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveCallTraceFile" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveCallTraceFileResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/calltrace/CallTraceJob/retrieveCallTraceJobs": { "post": { "tags": [ "samo_calltrace" ], "summary": "rest_calltrace_CallTraceJob_retrieveCallTraceJobs", "description": "Retrieve call-trace jobs request with desired siteId, and (optional) ID,
traceName, sapFdn, macAddress, circuitId, remoteId
whose values are used to retrieve the call-trace jobs.

Intention : RETRIEVER
retrieveCallTraceJobs:
class-level retriever API retrieveCallTraceJobs
of class calltrace.CallTraceJob


", "operationId": "rest_calltrace_CallTraceJob_retrieveCallTraceJobs", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveCallTraceJobs" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveCallTraceJobsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/calltrace/CallTraceJob/retrieveWlanGwUeCallTraceJobs": { "post": { "tags": [ "samo_calltrace" ], "summary": "rest_calltrace_CallTraceJob_retrieveWlanGwUeCallTraceJobs", "description": "Retrieve call-trace jobs request with desired siteId, and optional IEEE address,
whose values are used to retrieve the call-trace jobs.

Intention : RETRIEVER
retrieveWlanGwUeCallTraceJobs:
class-level retriever API retrieveWlanGwUeCallTraceJobs
of class calltrace.CallTraceJob


", "operationId": "rest_calltrace_CallTraceJob_retrieveWlanGwUeCallTraceJobs", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveWlanGwUeCallTraceJobs" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveWlanGwUeCallTraceJobsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/calltrace/CallTraceTrace/retrieveCallTraceTraces": { "post": { "tags": [ "samo_calltrace" ], "summary": "rest_calltrace_CallTraceTrace_retrieveCallTraceTraces", "description": "Retrieve call-trace trace object with desired siteId, and optional ID or traceName
whose values are used to retrieve the call-trace traces.

Intention : RETRIEVER
retrieveCallTraceTraces:
class-level retriever API retrieveCallTraceTraces
of class calltrace.CallTraceTrace


", "operationId": "rest_calltrace_CallTraceTrace_retrieveCallTraceTraces", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveCallTraceTraces" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveCallTraceTracesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/l3fwd/ServiceSite/generateNewRouteDistinguisher": { "post": { "tags": [ "samo_l3fwd" ], "summary": "rest_l3fwd_ServiceSite_generateNewRouteDistinguisher", "description": "Generates a new globally unique Route Distinguisher.

Intention : MODIFIER
generateNewRouteDistinguisher:
class-level modifier API generateNewRouteDistinguisher
of class l3fwd.ServiceSite

Returns the generated Route Distinguisher.
The format of Route Distinguisher is: \"value1:value2\".

", "operationId": "rest_l3fwd_ServiceSite_generateNewRouteDistinguisher", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generateNewRouteDistinguisher" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generateNewRouteDistinguisherResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/l3fwd/ServiceSite/generateNewVrfTarget": { "post": { "tags": [ "samo_l3fwd" ], "summary": "rest_l3fwd_ServiceSite_generateNewVrfTarget", "description": "Generates a new globally unique VRF target.

Intention : MODIFIER
generateNewVrfTarget:
class-level modifier API generateNewVrfTarget
of class l3fwd.ServiceSite

Returns the generated VRF Target.
The format of VRF Target is: \"value1:value2\".

", "operationId": "rest_l3fwd_ServiceSite_generateNewVrfTarget", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generateNewVrfTarget" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generateNewVrfTargetResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/l3fwd/ServiceSite/getRouteDistinguisherValues": { "get": { "tags": [ "samo_l3fwd" ], "summary": "rest_l3fwd_ServiceSite_getRouteDistinguisherValues", "description": "Retrieves the set of Route Distinguisher used by a specific VPRN service.

Intention : RETRIEVER
getRouteDistinguisherValues:
class-level retriever API getRouteDistinguisherValues
of class l3fwd.ServiceSite

Returns the set of Route Distinguishers used by this VPRN service.
The format of each Route Distinguisher entry is: \"value1:value2\".

", "operationId": "rest_l3fwd_ServiceSite_getRouteDistinguisherValues", "parameters": [ { "name": "servicePointer", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "routeDistinguisherType", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getRouteDistinguisherValuesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/l3fwd/ServiceSite/getVrfTargets": { "get": { "tags": [ "samo_l3fwd" ], "summary": "rest_l3fwd_ServiceSite_getVrfTargets", "description": "Retrieves the set of VRF targets used by a specific VPRN service.

Intention : RETRIEVER
getVrfTargets:
class-level retriever API getVrfTargets
of class l3fwd.ServiceSite

Returns the set of VRF Targets used by this VPRN service.
The format of each VRF Target entry is: \"value1:value2\".

", "operationId": "rest_l3fwd_ServiceSite_getVrfTargets", "parameters": [ { "name": "servicePointer", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "vrfTargetFormat", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getVrfTargetsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/bgp/Md5Key/removeAuthentication/{instanceFullName}": { "post": { "tags": [ "samo_bgp" ], "summary": "rest_bgp_Md5Key_removeAuthentication", "operationId": "rest_bgp_Md5Key_removeAuthentication", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/crdtctrl/CcEntryDefinition/find": { "post": { "tags": [ "samo_crdtctrl" ], "summary": "rest_crdtctrl_CcEntryDefinition_find", "description": "
Intention : RETRIEVER
find:
class-level [object finder] (retriever) API find
of class crdtctrl.CcEntryDefinition
DescendantInfo:
crdtctrl.CcIpv6FilterEntry
DescendantInfo:
crdtctrl.CcIpFilterEntry


", "operationId": "rest_crdtctrl_CcEntryDefinition_find", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ethring/Interconnect/deleteInterconnect/{instanceFullName}": { "delete": { "tags": [ "samo_ethring" ], "summary": "rest_ethring_Interconnect_deleteInterconnect", "operationId": "rest_ethring_Interconnect_deleteInterconnect", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ethring/Path/createMEPs/{instanceFullName}": { "post": { "tags": [ "samo_ethring" ], "summary": "rest_ethring_Path_createMEPs", "operationId": "rest_ethring_Path_createMEPs", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ethring/Path/deleteEthernetPath/{instanceFullName}": { "delete": { "tags": [ "samo_ethring" ], "summary": "rest_ethring_Path_deleteEthernetPath", "operationId": "rest_ethring_Path_deleteEthernetPath", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ethring/Path/executeCCProtocol/{instanceFullName}": { "put": { "tags": [ "samo_ethring" ], "summary": "rest_ethring_Path_executeCCProtocol", "operationId": "rest_ethring_Path_executeCCProtocol", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ethring/PathEndpoint/findCtpsForPathEndpoint": { "post": { "tags": [ "samo_ethring" ], "summary": "rest_ethring_PathEndpoint_findCtpsForPathEndpoint", "description": "
Intention : RETRIEVER
findCtpsForPathEndpoint:
class-level [object finder] (retriever) API findCtpsForPathEndpoint
of class ethring.PathEndpoint


", "operationId": "rest_ethring_PathEndpoint_findCtpsForPathEndpoint", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findCtpsForPathEndpoint" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findCtpsForPathEndpointResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ethring/RadioRing/addElement/{instanceFullName}": { "post": { "tags": [ "samo_ethring" ], "summary": "rest_ethring_RadioRing_addElement", "operationId": "rest_ethring_RadioRing_addElement", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ethring/RadioRing/createElement/{instanceFullName}": { "post": { "tags": [ "samo_ethring" ], "summary": "rest_ethring_RadioRing_createElement", "description": "Creates an Ethernet Ring Element and adds it to this Ethernet Ring.

Intention : MODIFIER
createElement:
instance-level [administrative creation] (modifier) API createElement
of class ethring.RadioRing
instanceFullName : distinguished/instance name of called object
Resulting objects list.

", "operationId": "rest_ethring_RadioRing_createElement", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createElementResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ethring/RadioRing/removeElement/{instanceFullName}": { "post": { "tags": [ "samo_ethring" ], "summary": "rest_ethring_RadioRing_removeElement", "operationId": "rest_ethring_RadioRing_removeElement", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ethring/Ring/addElement/{instanceFullName}": { "post": { "tags": [ "samo_ethring" ], "summary": "rest_ethring_Ring_addElement", "operationId": "rest_ethring_Ring_addElement", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ethring/Ring/ccmStartAll/{instanceFullName}": { "post": { "tags": [ "samo_ethring" ], "summary": "rest_ethring_Ring_ccmStartAll", "operationId": "rest_ethring_Ring_ccmStartAll", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ethring/Ring/ccmStopAll/{instanceFullName}": { "post": { "tags": [ "samo_ethring" ], "summary": "rest_ethring_Ring_ccmStopAll", "operationId": "rest_ethring_Ring_ccmStopAll", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ethring/Ring/createControlService/{instanceFullName}": { "post": { "tags": [ "samo_ethring" ], "summary": "rest_ethring_Ring_createControlService", "description": "Creates the Control Service for this Ethernet Ring using the parameters specified.

Intention : MODIFIER
createControlService:
instance-level [administrative creation] (modifier) API createControlService
of class ethring.Ring
instanceFullName : distinguished/instance name of called object
The FDN of the resulting Control Service.

", "operationId": "rest_ethring_Ring_createControlService", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createControlService" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createControlServiceResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ethring/Ring/createDataService/{instanceFullName}": { "post": { "tags": [ "samo_ethring" ], "summary": "rest_ethring_Ring_createDataService", "description": "Creates the Data Service for this Ethernet Ring using the parameters specified.

Intention : MODIFIER
createDataService:
instance-level [administrative creation] (modifier) API createDataService
of class ethring.Ring
instanceFullName : distinguished/instance name of called object
The FDN of the resulting Data Service.

", "operationId": "rest_ethring_Ring_createDataService", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createDataService" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createDataServiceResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ethring/Ring/createDataServicePathSearch": { "post": { "tags": [ "samo_ethring" ], "summary": "rest_ethring_Ring_createDataServicePathSearch", "description": "Creates the Data Service for this Ethernet Ring using the parameters specified.

Intention : MODIFIER
createDataServicePathSearch:
class-level [administrative creation] (modifier) API createDataServicePathSearch
of class ethring.Ring

The FDN of the resulting Data Service.

", "operationId": "rest_ethring_Ring_createDataServicePathSearch", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createDataServicePathSearch" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createDataServicePathSearchResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ethring/Ring/createElement/{instanceFullName}": { "post": { "tags": [ "samo_ethring" ], "summary": "rest_ethring_Ring_createElement", "description": "Creates an Ethernet Ring Element and adds it to this Ethernet Ring.

Intention : MODIFIER
createElement:
instance-level [administrative creation] (modifier) API createElement
of class ethring.Ring
instanceFullName : distinguished/instance name of called object
Resulting objects list.

", "operationId": "rest_ethring_Ring_createElement", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createElement" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createElementResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ethring/Ring/createTransitService/{instanceFullName}": { "post": { "tags": [ "samo_ethring" ], "summary": "rest_ethring_Ring_createTransitService", "description": "Creates the Transit Service for this Ethernet Ring using the parameters specified.

Intention : MODIFIER
createTransitService:
instance-level [administrative creation] (modifier) API createTransitService
of class ethring.Ring
instanceFullName : distinguished/instance name of called object
The FDN of the resulting Transit Service.

", "operationId": "rest_ethring_Ring_createTransitService", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createTransitService" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createTransitServiceResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ethring/Ring/globalRingAuditCheck": { "post": { "tags": [ "samo_ethring" ], "summary": "rest_ethring_Ring_globalRingAuditCheck", "description": "Checks to see if all ethernet rings appear to be fully configured (based on number of
elements, paths, interconnects, path endpoints, and operational flags of the ring).

Intention : RETRIEVER
globalRingAuditCheck:
class-level retriever API globalRingAuditCheck
of class ethring.Ring

The result of the global ring audit.

", "operationId": "rest_ethring_Ring_globalRingAuditCheck", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/globalRingAuditCheckResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ethring/Ring/removeElement/{instanceFullName}": { "post": { "tags": [ "samo_ethring" ], "summary": "rest_ethring_Ring_removeElement", "operationId": "rest_ethring_Ring_removeElement", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ethring/Ring/ringAuditCheck/{instanceFullName}": { "post": { "tags": [ "samo_ethring" ], "summary": "rest_ethring_Ring_ringAuditCheck", "description": "Checks to see if the ethernet ring appears to be fully configured (based on number of
elements, paths, interconnects, path endpoints, and operational flags of the ring).

Intention : RETRIEVER
ringAuditCheck:
instance-level retriever API ringAuditCheck
of class ethring.Ring
instanceFullName : distinguished/instance name of called object
The result of the ring audit.

", "operationId": "rest_ethring_Ring_ringAuditCheck", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ringAuditCheckResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ethring/Ring/updateDataServices/{instanceFullName}": { "put": { "tags": [ "samo_ethring" ], "summary": "rest_ethring_Ring_updateDataServices", "description": "Update all data services associated with this ring, allowing for cut-in cut-out

Intention : MODIFIER
updateDataServices:
instance-level modifier API updateDataServices
of class ethring.Ring
instanceFullName : distinguished/instance name of called object
Returns number of data services updated.

", "operationId": "rest_ethring_Ring_updateDataServices", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateDataServicesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/srmrmtauth/RemoteAuthServer/configure/{instanceFullName}": { "post": { "tags": [ "samo_srmrmtauth" ], "summary": "rest_srmrmtauth_RemoteAuthServer_configure", "description": "
Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure
of class srmrmtauth.RemoteAuthServer
This API follows hierarchical config model rules.
DescendantInfo:
srmrmtauth.TacacsPlusAuthServer
DescendantInfo:
srmrmtauth.RadiusAuthServer
DescendantInfo:
srmrmtauth.LdapAuthServer
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_srmrmtauth_RemoteAuthServer_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/srmrmtauth/RemoteAuthenticationManager/configure": { "post": { "tags": [ "samo_srmrmtauth" ], "summary": "rest_srmrmtauth_RemoteAuthenticationManager_configure", "description": "
Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure on default instance remote-authentication-manager of class srmrmtauth.RemoteAuthenticationManager
This API follows hierarchical config model rules.


", "operationId": "rest_srmrmtauth_RemoteAuthenticationManager_configure", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/tunnelmgmt/RuleBasedGroup/addMember/{instanceFullName}": { "post": { "tags": [ "samo_tunnelmgmt" ], "summary": "rest_tunnelmgmt_RuleBasedGroup_addMember", "operationId": "rest_tunnelmgmt_RuleBasedGroup_addMember", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/addMember" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/tunnelmgmt/RuleBasedGroup/findPotentialMembersIfg/{instanceFullName}": { "get": { "tags": [ "samo_tunnelmgmt" ], "summary": "rest_tunnelmgmt_RuleBasedGroup_findPotentialMembersIfg", "description": "Find members that potentially can be added to this group.

Intention : RETRIEVER
findPotentialMembersIfg:
instance-level [object finder] (retriever) API findPotentialMembersIfg
of class tunnelmgmt.RuleBasedGroup
DescendantInfo:
tunnelmgmt.RuleBasedNeGroup
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_tunnelmgmt_RuleBasedGroup_findPotentialMembersIfg", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findPotentialMembersIfgResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/tunnelmgmt/RuleBasedGroup/removeMember/{instanceFullName}": { "post": { "tags": [ "samo_tunnelmgmt" ], "summary": "rest_tunnelmgmt_RuleBasedGroup_removeMember", "operationId": "rest_tunnelmgmt_RuleBasedGroup_removeMember", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/tunnelmgmt/TopologyRule/applyRule/{instanceFullName}": { "post": { "tags": [ "samo_tunnelmgmt" ], "summary": "rest_tunnelmgmt_TopologyRule_applyRule", "operationId": "rest_tunnelmgmt_TopologyRule_applyRule", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/tunnelmgmt/TopologyRule/convertOldDefinitions/{instanceFullName}": { "post": { "tags": [ "samo_tunnelmgmt" ], "summary": "rest_tunnelmgmt_TopologyRule_convertOldDefinitions", "operationId": "rest_tunnelmgmt_TopologyRule_convertOldDefinitions", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConvertOldDefinitionStruct" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/tunnelmgmt/TopologyRule/deleteCreatedTunnels/{instanceFullName}": { "delete": { "tags": [ "samo_tunnelmgmt" ], "summary": "rest_tunnelmgmt_TopologyRule_deleteCreatedTunnels", "operationId": "rest_tunnelmgmt_TopologyRule_deleteCreatedTunnels", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/tunnelmgmt/TopologyRule/deleteUnusedTunnels/{instanceFullName}": { "delete": { "tags": [ "samo_tunnelmgmt" ], "summary": "rest_tunnelmgmt_TopologyRule_deleteUnusedTunnels", "operationId": "rest_tunnelmgmt_TopologyRule_deleteUnusedTunnels", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/tunnelmgmt/TopologyRule/findCreatedTunnels/{instanceFullName}": { "get": { "tags": [ "samo_tunnelmgmt" ], "summary": "rest_tunnelmgmt_TopologyRule_findCreatedTunnels", "description": "Retrieves a list of tunnel elements created by the topologyrule.


Should only be called on a main topology rule and not on one of
the sub-topology rules.

Intention : RETRIEVER
findCreatedTunnels:
instance-level [object finder] (retriever) API findCreatedTunnels
of class tunnelmgmt.TopologyRule
DescendantInfo:
tunnelmgmt.HubAndSpokeTopologyRule
DescendantInfo:
tunnelmgmt.SpokeTopologyRule
DescendantInfo:
tunnelmgmt.ChainTopologyRule
DescendantInfo:
tunnelmgmt.SubTopologyRule
DescendantInfo:
tunnelmgmt.RingTopologyRule
DescendantInfo:
tunnelmgmt.CompositeTopologyRule
DescendantInfo:
tunnelmgmt.MeshTopologyRule
DescendantInfo:
tunnelmgmt.SingleGroupTopologyRule
DescendantInfo:
tunnelmgmt.ConfigurableTopologyRule
DescendantInfo:
tunnelmgmt.TwoNeighborTopologyRule
DescendantInfo:
tunnelmgmt.HubTopologyRule
instanceFullName : distinguished/instance name of called object
A list of CreatedTunnelElements

", "operationId": "rest_tunnelmgmt_TopologyRule_findCreatedTunnels", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findCreatedTunnelsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/tunnelmgmt/TopologyRule/findMissingTunnels/{instanceFullName}": { "get": { "tags": [ "samo_tunnelmgmt" ], "summary": "rest_tunnelmgmt_TopologyRule_findMissingTunnels", "description": "Retrieves a list of tunnel elements that are missing
in the topology maintained by the topologyrule.


Should only be called on a main topology rule and not on one of
the sub-topology rules.

Intention : MODIFIER
findMissingTunnels:
instance-level [object finder] (modifier) API findMissingTunnels
of class tunnelmgmt.TopologyRule
DescendantInfo:
tunnelmgmt.HubAndSpokeTopologyRule
DescendantInfo:
tunnelmgmt.SpokeTopologyRule
DescendantInfo:
tunnelmgmt.ChainTopologyRule
DescendantInfo:
tunnelmgmt.SubTopologyRule
DescendantInfo:
tunnelmgmt.RingTopologyRule
DescendantInfo:
tunnelmgmt.CompositeTopologyRule
DescendantInfo:
tunnelmgmt.MeshTopologyRule
DescendantInfo:
tunnelmgmt.SingleGroupTopologyRule
DescendantInfo:
tunnelmgmt.ConfigurableTopologyRule
DescendantInfo:
tunnelmgmt.TwoNeighborTopologyRule
DescendantInfo:
tunnelmgmt.HubTopologyRule
instanceFullName : distinguished/instance name of called object
A list of MissingTunnelElements.

", "operationId": "rest_tunnelmgmt_TopologyRule_findMissingTunnels", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findMissingTunnelsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/tunnelmgmt/TopologyRule/importNetwork/{instanceFullName}": { "post": { "tags": [ "samo_tunnelmgmt" ], "summary": "rest_tunnelmgmt_TopologyRule_importNetwork", "operationId": "rest_tunnelmgmt_TopologyRule_importNetwork", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/igh/InterfaceGroupHandler/configureIghMember/{instanceFullName}": { "post": { "tags": [ "samo_igh" ], "summary": "rest_igh_InterfaceGroupHandler_configureIghMember", "description": "This API can be used to create IghMembers .

Intention : MODIFIER
configureIghMember:
instance-level [hierarchical administrative configuration/modification] (modifier) API configureIghMember
of class igh.InterfaceGroupHandler
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object
DN of successfully created IghMember

", "operationId": "rest_igh_InterfaceGroupHandler_configureIghMember", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IGHMemCreateInfo" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureIghMemberResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sw/BackupRestoreManager/backup/{instanceFullName}": { "post": { "tags": [ "samo_sw" ], "summary": "rest_sw_BackupRestoreManager_backup", "operationId": "rest_sw_BackupRestoreManager_backup", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sw/BackupRestoreManager/backupStatusRefresh/{instanceFullName}": { "post": { "tags": [ "samo_sw" ], "summary": "rest_sw_BackupRestoreManager_backupStatusRefresh", "operationId": "rest_sw_BackupRestoreManager_backupStatusRefresh", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sw/BackupRestoreManager/restore/{instanceFullName}": { "post": { "tags": [ "samo_sw" ], "summary": "rest_sw_BackupRestoreManager_restore", "operationId": "rest_sw_BackupRestoreManager_restore", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/restore" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sw/BackupRestoreManager/saveConfig/{instanceFullName}": { "post": { "tags": [ "samo_sw" ], "summary": "rest_sw_BackupRestoreManager_saveConfig", "operationId": "rest_sw_BackupRestoreManager_saveConfig", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sw/LogRetrievalManager/retrieveLogs/{instanceFullName}": { "post": { "tags": [ "samo_sw" ], "summary": "rest_sw_LogRetrievalManager_retrieveLogs", "operationId": "rest_sw_LogRetrievalManager_retrieveLogs", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sw/RadioRSLRetrievalManager/retrieveRadioRSL/{instanceFullName}": { "post": { "tags": [ "samo_sw" ], "summary": "rest_sw_RadioRSLRetrievalManager_retrieveRadioRSL", "operationId": "rest_sw_RadioRSLRetrievalManager_retrieveRadioRSL", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sw/RanBackupFolderDescriptor/restoreRefresh/{instanceFullName}": { "post": { "tags": [ "samo_sw" ], "summary": "rest_sw_RanBackupFolderDescriptor_restoreRefresh", "operationId": "rest_sw_RanBackupFolderDescriptor_restoreRefresh", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/multicast/EgressMcastGroup/findAccessInterfaces/{instanceFullName}": { "post": { "tags": [ "samo_multicast" ], "summary": "rest_multicast_EgressMcastGroup_findAccessInterfaces", "description": "
Intention : RETRIEVER
findAccessInterfaces:
instance-level [object finder] (retriever) API findAccessInterfaces
of class multicast.EgressMcastGroup
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_multicast_EgressMcastGroup_findAccessInterfaces", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAccessInterfacesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/multicast/IngrPathMgmtOperationalChannelMda/retrieveChannels": { "post": { "tags": [ "samo_multicast" ], "summary": "rest_multicast_IngrPathMgmtOperationalChannelMda_retrieveChannels", "description": "Retrieve the operational Ingress Multicast Path Management
channels on a specific MDA.

Intention : RETRIEVER
retrieveChannels:
class-level retriever API retrieveChannels
of class multicast.IngrPathMgmtOperationalChannelMda

List of IngrPathMgmtOperationalChannelMdaInfo.

", "operationId": "rest_multicast_IngrPathMgmtOperationalChannelMda_retrieveChannels", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveChannels" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveChannelsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/multicast/IngrPathMgmtOperationalChannelSvc/retrieveVRtrChannels": { "post": { "tags": [ "samo_multicast" ], "summary": "rest_multicast_IngrPathMgmtOperationalChannelSvc_retrieveVRtrChannels", "description": "Retrieve the operational Ingress Multicast Path Management
channels used by a specific VPRN service or Default routing
instance.

Intention : RETRIEVER
retrieveVRtrChannels:
class-level retriever API retrieveVRtrChannels
of class multicast.IngrPathMgmtOperationalChannelSvc

List of IngrPathMgmtOperationalChannelSvcInfo.

", "operationId": "rest_multicast_IngrPathMgmtOperationalChannelSvc_retrieveVRtrChannels", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveVRtrChannels" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveVRtrChannelsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/multicast/IngrPathMgmtOperationalChannelSvc/retrieveVplsChannels": { "post": { "tags": [ "samo_multicast" ], "summary": "rest_multicast_IngrPathMgmtOperationalChannelSvc_retrieveVplsChannels", "description": "Retrieve the operational Ingress Multicast Path Management
channels used by a specific VPLS service.

Intention : RETRIEVER
retrieveVplsChannels:
class-level retriever API retrieveVplsChannels
of class multicast.IngrPathMgmtOperationalChannelSvc

List of IngrPathMgmtOperationalChannelSvcInfo.

", "operationId": "rest_multicast_IngrPathMgmtOperationalChannelSvc_retrieveVplsChannels", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveVplsChannels" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveVplsChannelsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/multicast/PolicyGroupEntry/find": { "post": { "tags": [ "samo_multicast" ], "summary": "rest_multicast_PolicyGroupEntry_find", "description": "
Intention : RETRIEVER
find:
class-level [object finder] (retriever) API find
of class multicast.PolicyGroupEntry

List of multicast.PolicyGroupEntry items.

", "operationId": "rest_multicast_PolicyGroupEntry_find", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/isis/Area/configure/{instanceFullName}": { "post": { "tags": [ "samo_isis" ], "summary": "rest_isis_Area_configure", "description": "
Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure
of class isis.Area
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_isis_Area_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaConfigInfo" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/isis/AuthenticationKey/removeAuthenticationKey/{instanceFullName}": { "post": { "tags": [ "samo_isis" ], "summary": "rest_isis_AuthenticationKey_removeAuthenticationKey", "operationId": "rest_isis_AuthenticationKey_removeAuthenticationKey", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/isis/Interface/configure/{instanceFullName}": { "post": { "tags": [ "samo_isis" ], "summary": "rest_isis_Interface_configure", "description": "
Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure
of class isis.Interface
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_isis_Interface_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/isis/Isis/configure": { "post": { "tags": [ "samo_isis" ], "summary": "rest_isis_Isis_configure", "description": "
Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure on default instance isis of class isis.Isis
This API follows hierarchical config model rules.


", "operationId": "rest_isis_Isis_configure", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/isis/SiteExportPolicy/configure/{instanceFullName}": { "post": { "tags": [ "samo_isis" ], "summary": "rest_isis_SiteExportPolicy_configure", "description": "
Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure
of class isis.SiteExportPolicy
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_isis_SiteExportPolicy_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mwa/PortTermination/getDependencyCount/{instanceFullName}": { "get": { "tags": [ "samo_mwa" ], "summary": "rest_mwa_PortTermination_getDependencyCount", "description": "
Intention : RETRIEVER
getDependencyCount:
instance-level retriever API getDependencyCount
of class mwa.PortTermination
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mwa_PortTermination_getDependencyCount", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getDependencyCountResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mwa/PortTermination/rebootRadio/{instanceFullName}": { "post": { "tags": [ "samo_mwa" ], "summary": "rest_mwa_PortTermination_rebootRadio", "operationId": "rest_mwa_PortTermination_rebootRadio", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mirror/PcapSession/shutDown/{instanceFullName}": { "post": { "tags": [ "samo_mirror" ], "summary": "rest_mirror_PcapSession_shutDown", "operationId": "rest_mirror_PcapSession_shutDown", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mirror/PcapSession/turnUp/{instanceFullName}": { "post": { "tags": [ "samo_mirror" ], "summary": "rest_mirror_PcapSession_turnUp", "operationId": "rest_mirror_PcapSession_turnUp", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/lps/LPSConfiguration/restartLearningWindowTimer": { "post": { "tags": [ "samo_lps" ], "summary": "rest_lps_LPSConfiguration_restartLearningWindowTimer", "operationId": "rest_lps_LPSConfiguration_restartLearningWindowTimer", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/lps/LearnedPortSecurity/convertToStatic": { "post": { "tags": [ "samo_lps" ], "summary": "rest_lps_LearnedPortSecurity_convertToStatic", "operationId": "rest_lps_LearnedPortSecurity_convertToStatic", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/lps/LearnedPortSecurity/releaseViolatedPort": { "post": { "tags": [ "samo_lps" ], "summary": "rest_lps_LearnedPortSecurity_releaseViolatedPort", "operationId": "rest_lps_LearnedPortSecurity_releaseViolatedPort", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/diameter/DiameterAppPolicy/clearCcrtReplaySession": { "post": { "tags": [ "samo_diameter" ], "summary": "rest_diameter_DiameterAppPolicy_clearCcrtReplaySession", "description": "Request clearing of CCR Terminate replay session with the specified parameters.
The siteId and diameterAppPolicy are required.
When this method returns, resources for the clear have been allocated but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
clearCcrtReplaySession:
class-level [functionality clearing] (modifier) API clearCcrtReplaySession
of class diameter.DiameterAppPolicy

A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_diameter_DiameterAppPolicy_clearCcrtReplaySession", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clearCcrtReplaySession" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clearCcrtReplaySessionResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/diameter/DiameterAppPolicy/clearCcrtReplayStatistics": { "post": { "tags": [ "samo_diameter" ], "summary": "rest_diameter_DiameterAppPolicy_clearCcrtReplayStatistics", "description": "Request clearing of CCR Terminate replay statistics with the specified parameters.
The siteId and diameterAppPolicy are required.
When this method returns, resources for the clear have been allocated but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
clearCcrtReplayStatistics:
class-level [functionality clearing] (modifier) API clearCcrtReplayStatistics
of class diameter.DiameterAppPolicy

A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_diameter_DiameterAppPolicy_clearCcrtReplayStatistics", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clearCcrtReplayStatistics" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clearCcrtReplayStatisticsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/diameter/DiameterSeCcrtReplay/retrieveCcrtReplay": { "post": { "tags": [ "samo_diameter" ], "summary": "rest_diameter_DiameterSeCcrtReplay_retrieveCcrtReplay", "description": "Method used to retrieve information about a Diameter Session that is in CCR-T replay mode from NE.

Intention : RETRIEVER
retrieveCcrtReplay:
class-level retriever API retrieveCcrtReplay
of class diameter.DiameterSeCcrtReplay


", "operationId": "rest_diameter_DiameterSeCcrtReplay_retrieveCcrtReplay", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveCcrtReplay" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveCcrtReplayResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/AaInterface/shutDown/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_AaInterface_shutDown", "operationId": "rest_service_AaInterface_shutDown", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/service/AaInterface/turnUp/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_AaInterface_turnUp", "operationId": "rest_service_AaInterface_turnUp", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/service/AccessInterface/findSitesFor": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_AccessInterface_findSitesFor", "description": "Find the sites used by the access interfaces identified
by the filter.

Intention : RETRIEVER
findSitesFor:
class-level [object finder] (retriever) API findSitesFor
of class service.AccessInterface
DescendantInfo:
vpls.AbstractPbbSap
DescendantInfo:
ipipe.L2AccessInterface
DescendantInfo:
ies.L3AccessInterface
DescendantInfo:
mvpls.IL2AccessInterface
DescendantInfo:
service.AaInterface
DescendantInfo:
vpls.IL2AccessInterface
DescendantInfo:
vlan.L2AccessInterface
DescendantInfo:
ies.AaInterface
DescendantInfo:
mvpls.L2AccessInterface
DescendantInfo:
ies.IPsecInterface
DescendantInfo:
ies.MSap
DescendantInfo:
ies.ServiceAccessPoint
DescendantInfo:
vll.L2AccessInterface
DescendantInfo:
service.GneAccessInterface
DescendantInfo:
vpls.L2AccessInterface
DescendantInfo:
vprn.AaInterface
DescendantInfo:
service.L2AccessInterface
DescendantInfo:
service.IPsecInterface
DescendantInfo:
vpls.AbstractL2AccessInterface
DescendantInfo:
vpls.BL2AccessInterface
DescendantInfo:
vprn.IPsecInterface
DescendantInfo:
mvpls.BL2AccessInterface
DescendantInfo:
service.ServiceAccessPoint
DescendantInfo:
service.L3AccessInterface
DescendantInfo:
vlan.ServiceAccessPoint
DescendantInfo:
mirror.L2AccessInterface
DescendantInfo:
vpls.MSap
DescendantInfo:
vprn.MSap
DescendantInfo:
vpls.AbstractTlsSap
DescendantInfo:
pbbvlan.L2AccessInterface
DescendantInfo:
vprn.L3AccessInterface
DescendantInfo:
vprn.ServiceAccessPoint


", "operationId": "rest_service_AccessInterface_findSitesFor", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findSitesFor" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findSitesForResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/AccessInterface/moveSapToAnotherService": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_AccessInterface_moveSapToAnotherService", "description": "Move the sap from this service to another service.
Only L2 AccessInterfaces are supported for now.
Input the SAP FDN and the destination site FDN

Intention : MODIFIER
moveSapToAnotherService:
class-level modifier API moveSapToAnotherService
of class service.AccessInterface
DescendantInfo:
vpls.AbstractPbbSap
DescendantInfo:
ipipe.L2AccessInterface
DescendantInfo:
ies.L3AccessInterface
DescendantInfo:
mvpls.IL2AccessInterface
DescendantInfo:
service.AaInterface
DescendantInfo:
vpls.IL2AccessInterface
DescendantInfo:
vlan.L2AccessInterface
DescendantInfo:
ies.AaInterface
DescendantInfo:
mvpls.L2AccessInterface
DescendantInfo:
ies.IPsecInterface
DescendantInfo:
ies.MSap
DescendantInfo:
ies.ServiceAccessPoint
DescendantInfo:
vll.L2AccessInterface
DescendantInfo:
service.GneAccessInterface
DescendantInfo:
vpls.L2AccessInterface
DescendantInfo:
vprn.AaInterface
DescendantInfo:
service.L2AccessInterface
DescendantInfo:
service.IPsecInterface
DescendantInfo:
vpls.AbstractL2AccessInterface
DescendantInfo:
vpls.BL2AccessInterface
DescendantInfo:
vprn.IPsecInterface
DescendantInfo:
mvpls.BL2AccessInterface
DescendantInfo:
service.ServiceAccessPoint
DescendantInfo:
service.L3AccessInterface
DescendantInfo:
vlan.ServiceAccessPoint
DescendantInfo:
mirror.L2AccessInterface
DescendantInfo:
vpls.MSap
DescendantInfo:
vprn.MSap
DescendantInfo:
vpls.AbstractTlsSap
DescendantInfo:
pbbvlan.L2AccessInterface
DescendantInfo:
vprn.L3AccessInterface
DescendantInfo:
vprn.ServiceAccessPoint


", "operationId": "rest_service_AccessInterface_moveSapToAnotherService", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/moveSapToAnotherService" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/moveSapToAnotherServiceResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/CompositeService/addServices/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_CompositeService_addServices", "operationId": "rest_service_CompositeService_addServices", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/service/CompositeService/createCrossConnect/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_CompositeService_createCrossConnect", "description": "
Intention : MODIFIER
createCrossConnect:
instance-level [administrative creation] (modifier) API createCrossConnect
of class service.CompositeService
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_service_CompositeService_createCrossConnect", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrossConnectConfigInfo" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createCrossConnectResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/CompositeService/createRoutedVplsConnector/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_CompositeService_createRoutedVplsConnector", "description": "
Intention : MODIFIER
createRoutedVplsConnector:
instance-level [administrative creation] (modifier) API createRoutedVplsConnector
of class service.CompositeService
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_service_CompositeService_createRoutedVplsConnector", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutedVplsConnectorConfigInfo" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createRoutedVplsConnectorResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/CompositeService/createScpConnector/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_CompositeService_createScpConnector", "description": "
Intention : MODIFIER
createScpConnector:
instance-level [administrative creation] (modifier) API createScpConnector
of class service.CompositeService
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_service_CompositeService_createScpConnector", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScpConnectorConfigInfo" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createScpConnectorResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/CompositeService/createService/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_CompositeService_createService", "description": "creates a service and it add the service to this CompositeService

Intention : MODIFIER
createService:
instance-level [administrative creation] (modifier) API createService
of class service.CompositeService
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_service_CompositeService_createService", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceConfigInfo" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createServiceResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/CompositeService/createSpokeConnector/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_CompositeService_createSpokeConnector", "description": "
Intention : MODIFIER
createSpokeConnector:
instance-level [administrative creation] (modifier) API createSpokeConnector
of class service.CompositeService
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_service_CompositeService_createSpokeConnector", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpokeConnectorConfigInfo" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createSpokeConnectorResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/CompositeService/getConnectors/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_CompositeService_getConnectors", "description": "Returns all connectors of this composite service.

Intention : RETRIEVER
getConnectors:
instance-level retriever API getConnectors
of class service.CompositeService
instanceFullName : distinguished/instance name of called object
Connectors of this composite service.
The returned connector objects are shallow (they do not contain any child objects).

", "operationId": "rest_service_CompositeService_getConnectors", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getConnectorsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/CompositeService/getServiceSites/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_CompositeService_getServiceSites", "description": "Returns all service sites of this composite service.

Intention : RETRIEVER
getServiceSites:
instance-level retriever API getServiceSites
of class service.CompositeService
instanceFullName : distinguished/instance name of called object
Service sites of this composite service.
The returned site objects are shallow (they do not contain any child objects).

", "operationId": "rest_service_CompositeService_getServiceSites", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getServiceSitesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/CompositeService/getServices/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_CompositeService_getServices", "description": "Returns all services of this composite service.

Intention : RETRIEVER
getServices:
instance-level retriever API getServices
of class service.CompositeService
instanceFullName : distinguished/instance name of called object
Services of this composite service.
The returned service objects are shallow (they do not contain any child objects).

", "operationId": "rest_service_CompositeService_getServices", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getServicesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/CompositeService/moveServices/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_CompositeService_moveServices", "operationId": "rest_service_CompositeService_moveServices", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/moveServices" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/service/CompositeService/prepareThroughputTest": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_CompositeService_prepareThroughputTest", "description": "Prepare the throughput test with the test info passed in.

Intention : MODIFIER
prepareThroughputTest:
class-level modifier API prepareThroughputTest
of class service.CompositeService

A list of error messages.

", "operationId": "rest_service_CompositeService_prepareThroughputTest", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThroughputTestStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/prepareThroughputTestResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/CompositeService/removeServices/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_CompositeService_removeServices", "operationId": "rest_service_CompositeService_removeServices", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/service/CompositeService/restoreCompSvcForThroughputTest": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_CompositeService_restoreCompSvcForThroughputTest", "description": "Restore the composite service from the throughput test.

Intention : MODIFIER
restoreCompSvcForThroughputTest:
class-level modifier API restoreCompSvcForThroughputTest
of class service.CompositeService

A list of error messages.

", "operationId": "rest_service_CompositeService_restoreCompSvcForThroughputTest", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/restoreCompSvcForThroughputTestResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/GroupInterface/cleanUpBondingGroupInterface": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_GroupInterface_cleanUpBondingGroupInterface", "operationId": "rest_service_GroupInterface_cleanUpBondingGroupInterface", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/service/GroupInterface/cleanUpGtpGroupInterface": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_GroupInterface_cleanUpGtpGroupInterface", "operationId": "rest_service_GroupInterface_cleanUpGtpGroupInterface", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/service/IPsecInterface/requestPolicyAccountStatsClear/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_IPsecInterface_requestPolicyAccountStatsClear", "description": "Request clearing of Policy Accounting Statistics on this interface.
When this method returns resources for the clear have been allocated
but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestPolicyAccountStatsClear:
instance-level modifier API requestPolicyAccountStatsClear
of class service.IPsecInterface
DescendantInfo:
ies.IPsecInterface
DescendantInfo:
vprn.IPsecInterface
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_service_IPsecInterface_requestPolicyAccountStatsClear", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestPolicyAccountStatsClear" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestPolicyAccountStatsClearResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/IPsecInterface/shutDown/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_IPsecInterface_shutDown", "operationId": "rest_service_IPsecInterface_shutDown", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/service/IPsecInterface/turnUp/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_IPsecInterface_turnUp", "operationId": "rest_service_IPsecInterface_turnUp", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/service/L2AccessInterface/cleanupSAPsWithBadFdns": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_L2AccessInterface_cleanupSAPsWithBadFdns", "operationId": "rest_service_L2AccessInterface_cleanupSAPsWithBadFdns", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/service/L2AccessInterface/copyMoveSaps": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_L2AccessInterface_copyMoveSaps", "description": "Copy or move the SAPs from the source port to destination
port with a source SAP filter. Only Epipe, Ipipe, (B,I)VPLS
and (B,I)MVPLS type of L2 SAPs, and IES, VPRN type of L3
SAPs(L3 Access Interface, L3 Service Access Point) on source
port will be copied or moved.

Intention : MODIFIER
copyMoveSaps:
class-level modifier API copyMoveSaps
of class service.L2AccessInterface
DescendantInfo:
vpls.AbstractPbbSap
DescendantInfo:
vpls.L2AccessInterface
DescendantInfo:
ipipe.L2AccessInterface
DescendantInfo:
mvpls.IL2AccessInterface
DescendantInfo:
vpls.AbstractL2AccessInterface
DescendantInfo:
vpls.BL2AccessInterface
DescendantInfo:
vpls.IL2AccessInterface
DescendantInfo:
mvpls.BL2AccessInterface
DescendantInfo:
vlan.L2AccessInterface
DescendantInfo:
mvpls.L2AccessInterface
DescendantInfo:
mirror.L2AccessInterface
DescendantInfo:
vpls.MSap
DescendantInfo:
vll.L2AccessInterface
DescendantInfo:
vpls.AbstractTlsSap
DescendantInfo:
pbbvlan.L2AccessInterface


", "operationId": "rest_service_L2AccessInterface_copyMoveSaps", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/copyMoveSaps" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/copyMoveSapsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/L2AccessInterface/copyMoveSapsWithSapList": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_L2AccessInterface_copyMoveSapsWithSapList", "description": "Copy or move the SAPs with passed in source SAP fullName list.
Executing this method on the destination port instance.
Only Epipe, Ipipe, (B,I)VPLS and (B,I)MVPLS type of L2 SAPs, and IES,
VPRN type of L3 SAPs(L3 Access Interface, L3 Service Access Point) can be
copied or moved.

Intention : MODIFIER
copyMoveSapsWithSapList:
class-level modifier API copyMoveSapsWithSapList
of class service.L2AccessInterface
DescendantInfo:
vpls.AbstractPbbSap
DescendantInfo:
vpls.L2AccessInterface
DescendantInfo:
ipipe.L2AccessInterface
DescendantInfo:
mvpls.IL2AccessInterface
DescendantInfo:
vpls.AbstractL2AccessInterface
DescendantInfo:
vpls.BL2AccessInterface
DescendantInfo:
vpls.IL2AccessInterface
DescendantInfo:
mvpls.BL2AccessInterface
DescendantInfo:
vlan.L2AccessInterface
DescendantInfo:
mvpls.L2AccessInterface
DescendantInfo:
mirror.L2AccessInterface
DescendantInfo:
vpls.MSap
DescendantInfo:
vll.L2AccessInterface
DescendantInfo:
vpls.AbstractTlsSap
DescendantInfo:
pbbvlan.L2AccessInterface


", "operationId": "rest_service_L2AccessInterface_copyMoveSapsWithSapList", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/copyMoveSapsWithSapList" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/copyMoveSapsWithSapListResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/L2AccessInterface/findMcRingProtectedSaps": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_L2AccessInterface_findMcRingProtectedSaps", "description": "Return the list of the Multi Chassis Ring protected
L2 Access Interface on the ethernet port or LAG.
This method will return all the SAPs managed by MC
ring(s) if there are multiples rings on this port.
The ring should be in administrative up state.

Intention : RETRIEVER
findMcRingProtectedSaps:
class-level [object finder] (retriever) API findMcRingProtectedSaps
of class service.L2AccessInterface
DescendantInfo:
vpls.AbstractPbbSap
DescendantInfo:
vpls.L2AccessInterface
DescendantInfo:
ipipe.L2AccessInterface
DescendantInfo:
mvpls.IL2AccessInterface
DescendantInfo:
vpls.AbstractL2AccessInterface
DescendantInfo:
vpls.BL2AccessInterface
DescendantInfo:
vpls.IL2AccessInterface
DescendantInfo:
mvpls.BL2AccessInterface
DescendantInfo:
vlan.L2AccessInterface
DescendantInfo:
mvpls.L2AccessInterface
DescendantInfo:
mirror.L2AccessInterface
DescendantInfo:
vpls.MSap
DescendantInfo:
vll.L2AccessInterface
DescendantInfo:
vpls.AbstractTlsSap
DescendantInfo:
pbbvlan.L2AccessInterface


", "operationId": "rest_service_L2AccessInterface_findMcRingProtectedSaps", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findMcRingProtectedSaps" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findMcRingProtectedSapsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/L2AccessInterface/findMcRingProtectedSapsOnRing": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_L2AccessInterface_findMcRingProtectedSapsOnRing", "description": "Return the list of the Multi Chassis Ring protected
L2 Access Interface on the ring. The ring should be
in administrative up state.

Intention : RETRIEVER
findMcRingProtectedSapsOnRing:
class-level [object finder] (retriever) API findMcRingProtectedSapsOnRing
of class service.L2AccessInterface
DescendantInfo:
vpls.AbstractPbbSap
DescendantInfo:
vpls.L2AccessInterface
DescendantInfo:
ipipe.L2AccessInterface
DescendantInfo:
mvpls.IL2AccessInterface
DescendantInfo:
vpls.AbstractL2AccessInterface
DescendantInfo:
vpls.BL2AccessInterface
DescendantInfo:
vpls.IL2AccessInterface
DescendantInfo:
mvpls.BL2AccessInterface
DescendantInfo:
vlan.L2AccessInterface
DescendantInfo:
mvpls.L2AccessInterface
DescendantInfo:
mirror.L2AccessInterface
DescendantInfo:
vpls.MSap
DescendantInfo:
vll.L2AccessInterface
DescendantInfo:
vpls.AbstractTlsSap
DescendantInfo:
pbbvlan.L2AccessInterface


", "operationId": "rest_service_L2AccessInterface_findMcRingProtectedSapsOnRing", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findMcRingProtectedSapsOnRing" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findMcRingProtectedSapsOnRingResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/L3AccessInterface/removeIpAddress/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_L3AccessInterface_removeIpAddress", "description": "
Intention : MODIFIER
removeIpAddress:
instance-level [administrative deletion] (modifier) API removeIpAddress
of class service.L3AccessInterface
DescendantInfo:
ies.L3AccessInterface
DescendantInfo:
vprn.L3AccessInterface
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_service_L3AccessInterface_removeIpAddress", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/removeIpAddressResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/L3AccessInterface/shutDown/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_L3AccessInterface_shutDown", "operationId": "rest_service_L3AccessInterface_shutDown", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/service/L3AccessInterface/turnUp/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_L3AccessInterface_turnUp", "operationId": "rest_service_L3AccessInterface_turnUp", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/service/MacPing/cancelMacPingTest/{instanceFullName}": { "delete": { "tags": [ "samo_service" ], "summary": "rest_service_MacPing_cancelMacPingTest", "operationId": "rest_service_MacPing_cancelMacPingTest", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/service/SapLagPerLinkHash/cleanupOrphanedInstance": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_SapLagPerLinkHash_cleanupOrphanedInstance", "operationId": "rest_service_SapLagPerLinkHash_cleanupOrphanedInstance", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/service/ScpConnector/getTransitService/{instanceFullName}": { "get": { "tags": [ "samo_service" ], "summary": "rest_service_ScpConnector_getTransitService", "description": "Return the Transit Service which is associated with this Scp Connector.

Intention : RETRIEVER
getTransitService:
instance-level retriever API getTransitService
of class service.ScpConnector
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_service_ScpConnector_getTransitService", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getTransitServiceResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/Service/DeleteAllSystemDCPGroups/{instanceFullName}": { "delete": { "tags": [ "samo_service" ], "summary": "rest_service_Service_DeleteAllSystemDCPGroups", "operationId": "rest_service_Service_DeleteAllSystemDCPGroups", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/service/Service/auditServiceState": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_Service_auditServiceState", "operationId": "rest_service_Service_auditServiceState", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/service/Service/getServiceSegments/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_Service_getServiceSegments", "description": "Returns all service segments of this service.

Intention : RETRIEVER
getServiceSegments:
instance-level retriever API getServiceSegments
of class service.Service
DescendantInfo:
hpipe.Hpipe
DescendantInfo:
mpr.BackhaulService
DescendantInfo:
pbbvlan.VlanPBBEdge
DescendantInfo:
vlan.Vlan
DescendantInfo:
fpipe.Fpipe
DescendantInfo:
mvpls.Mvpls
DescendantInfo:
optical.TransportService
DescendantInfo:
optical.MultipointTransportService
DescendantInfo:
apipe.Apipe
DescendantInfo:
mirror.Mirror
DescendantInfo:
vll.Vll
DescendantInfo:
vpls.AbstractVpls
DescendantInfo:
vpls.Vpls
DescendantInfo:
ipipe.Ipipe
DescendantInfo:
ies.Ies
DescendantInfo:
cpipe.Cpipe
DescendantInfo:
vprn.Vprn
DescendantInfo:
mpr.PathSearchService
DescendantInfo:
epipe.Epipe
instanceFullName : distinguished/instance name of called object
Segments of this service.
The returned segment objects are shallow (they do not contain any child objects).

", "operationId": "rest_service_Service_getServiceSegments", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getServiceSegmentsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/Service/rediscoverReturnSpokeSdpBinding": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_Service_rediscoverReturnSpokeSdpBinding", "operationId": "rest_service_Service_rediscoverReturnSpokeSdpBinding", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "integer", "format": "int64" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/service/Service/shutDown/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_Service_shutDown", "operationId": "rest_service_Service_shutDown", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/service/Service/turnUp/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_Service_turnUp", "operationId": "rest_service_Service_turnUp", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/service/ServiceManager/IgnoreSAPPortState": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_ServiceManager_IgnoreSAPPortState", "operationId": "rest_service_ServiceManager_IgnoreSAPPortState", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IgnoreSAPPortState" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/service/ServiceManager/NavigateToOppositeObj": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_ServiceManager_NavigateToOppositeObj", "description": "The other SAP for the VLAN Up-Link.

Intention : RETRIEVER
NavigateToOppositeObj:
instance-level retriever API NavigateToOppositeObj on default instance svc-mgr of class service.ServiceManager


", "operationId": "rest_service_ServiceManager_NavigateToOppositeObj", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NavigateToOppositeObj" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NavigateToOppositeObjResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/Site/findSitesFor": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_Site_findSitesFor", "description": "Find the sites identified by the filter.

Intention : RETRIEVER
findSitesFor:
class-level [object finder] (retriever) API findSitesFor
of class service.Site
DescendantInfo:
dctr.VprnVirtualSite
DescendantInfo:
vpls.BSite
DescendantInfo:
ies.Site
DescendantInfo:
mvpls.EvpnSite
DescendantInfo:
apipe.Site
DescendantInfo:
vpls.EvpnSite
DescendantInfo:
epipe.AbstractSite
DescendantInfo:
mvpls.Site
DescendantInfo:
mpr.BackhaulSite
DescendantInfo:
vpls.AbstractSite
DescendantInfo:
optical.ServiceSite
DescendantInfo:
dctr.VplsVirtualSite
DescendantInfo:
fpipe.Site
DescendantInfo:
service.GneSite
DescendantInfo:
cpipe.Site
DescendantInfo:
dctr.AbstractVirtualSite
DescendantInfo:
optical.TrailSite
DescendantInfo:
hpipe.Site
DescendantInfo:
vpls.AbstractEvpnSite
DescendantInfo:
vpls.ISite
DescendantInfo:
vprn.Site
DescendantInfo:
vpls.AbstractBSite
DescendantInfo:
vpls.Site
DescendantInfo:
epipe.Site
DescendantInfo:
pbbvlan.Site
DescendantInfo:
vprn.AbstractSite
DescendantInfo:
vprn.DVRSSite
DescendantInfo:
ipipe.Site
DescendantInfo:
mvpls.ISite
DescendantInfo:
epipe.VpwsSite
DescendantInfo:
mvpls.BSite
DescendantInfo:
vll.Site
DescendantInfo:
vlan.Site
DescendantInfo:
vpls.AbstractTlsSite
DescendantInfo:
mirror.Site
DescendantInfo:
vpls.AbstractISite


", "operationId": "rest_service_Site_findSitesFor", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findSitesFor" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findSitesForResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/Site/shutDown/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_Site_shutDown", "operationId": "rest_service_Site_shutDown", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/service/Site/turnUp/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_Site_turnUp", "operationId": "rest_service_Site_turnUp", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/service/SvcActTestHeadAcceptanceCriteriaTemplate/findTests/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_SvcActTestHeadAcceptanceCriteriaTemplate_findTests", "description": "
Intention : RETRIEVER
findTests:
instance-level [object finder] (retriever) API findTests
of class service.SvcActTestHeadAcceptanceCriteriaTemplate
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_service_SvcActTestHeadAcceptanceCriteriaTemplate_findTests", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findTestsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/SvcActTestHeadFrameSizeTemplate/findTests/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_SvcActTestHeadFrameSizeTemplate_findTests", "description": "
Intention : RETRIEVER
findTests:
instance-level [object finder] (retriever) API findTests
of class service.SvcActTestHeadFrameSizeTemplate
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_service_SvcActTestHeadFrameSizeTemplate_findTests", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findTestsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/SvcResourceReservation/retrieveReservedResources": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_SvcResourceReservation_retrieveReservedResources", "description": "Performs the retrieval of reserved resources such as route targets for specific service.

Intention : RETRIEVER
retrieveReservedResources:
class-level retriever API retrieveReservedResources
of class service.SvcResourceReservation


", "operationId": "rest_service_SvcResourceReservation_retrieveReservedResources", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveReservedResources" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveReservedResourcesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/SvcTopology/completeSvcTopology": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_SvcTopology_completeSvcTopology", "operationId": "rest_service_SvcTopology_completeSvcTopology", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/service/TemplateService/constructServiceTemplate": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_TemplateService_constructServiceTemplate", "description": "Given a service, this method constructs the corresponding service template

Intention : MODIFIER
constructServiceTemplate:
class-level modifier API constructServiceTemplate
of class service.TemplateService
DescendantInfo:
fpipe.TemplateFpipe
DescendantInfo:
vprn.TemplateVprn
DescendantInfo:
mvpls.TemplateMvpls
DescendantInfo:
cpipe.TemplateCpipe
DescendantInfo:
ies.TemplateIes
DescendantInfo:
vll.TemplateVll
DescendantInfo:
ipipe.TemplateIpipe
DescendantInfo:
apipe.TemplateApipe
DescendantInfo:
vpls.TemplateVpls
DescendantInfo:
epipe.TemplateEpipe
DescendantInfo:
vlan.TemplateVlan
DescendantInfo:
vpls.TemplateAbstractVpls
DescendantInfo:
mirror.TemplateMirror


", "operationId": "rest_service_TemplateService_constructServiceTemplate", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/constructServiceTemplate" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/constructServiceTemplateResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/TemplateService/constructTemplatedService/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_TemplateService_constructTemplatedService", "description": "This method is a specialized form of constructing a templated object from a template,
applicable to templated service creation only. It returns a list containing the service subscriber
being created, as well as the template driving the creation and any associated templates that
were used for creation (eg. service template has template bindings that refer to real templates
that are used for templated service creation).

Intention : MODIFIER
constructTemplatedService:
instance-level modifier API constructTemplatedService
of class service.TemplateService
DescendantInfo:
fpipe.TemplateFpipe
DescendantInfo:
vprn.TemplateVprn
DescendantInfo:
mvpls.TemplateMvpls
DescendantInfo:
cpipe.TemplateCpipe
DescendantInfo:
ies.TemplateIes
DescendantInfo:
vll.TemplateVll
DescendantInfo:
ipipe.TemplateIpipe
DescendantInfo:
apipe.TemplateApipe
DescendantInfo:
vpls.TemplateVpls
DescendantInfo:
epipe.TemplateEpipe
DescendantInfo:
vlan.TemplateVlan
DescendantInfo:
vpls.TemplateAbstractVpls
DescendantInfo:
mirror.TemplateMirror
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_service_TemplateService_constructTemplatedService", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/constructTemplatedServiceResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/VlanUplink/getTransitService/{instanceFullName}": { "get": { "tags": [ "samo_service" ], "summary": "rest_service_VlanUplink_getTransitService", "description": "Return the Transit Service which is associated with this VLAN Uplink.

Intention : RETRIEVER
getTransitService:
instance-level retriever API getTransitService
of class service.VlanUplink
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_service_VlanUplink_getTransitService", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getTransitServiceResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/Y1564AcceptanceCriteriaProfile/findTests/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_Y1564AcceptanceCriteriaProfile_findTests", "description": "
Intention : RETRIEVER
findTests:
instance-level [object finder] (retriever) API findTests
of class service.Y1564AcceptanceCriteriaProfile
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_service_Y1564AcceptanceCriteriaProfile_findTests", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findTestsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/Y1564FrameMixProfile/findTests/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_Y1564FrameMixProfile_findTests", "description": "
Intention : RETRIEVER
findTests:
instance-level [object finder] (retriever) API findTests
of class service.Y1564FrameMixProfile
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_service_Y1564FrameMixProfile_findTests", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findTestsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/Y1564PayloadProfile/findTests/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_Y1564PayloadProfile_findTests", "description": "
Intention : RETRIEVER
findTests:
instance-level [object finder] (retriever) API findTests
of class service.Y1564PayloadProfile
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_service_Y1564PayloadProfile_findTests", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findTestsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/Y1564Test/stopTest/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_Y1564Test_stopTest", "operationId": "rest_service_Y1564Test_stopTest", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/service/Y1564TestHeadProfile/clearTestResults/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_Y1564TestHeadProfile_clearTestResults", "description": "
Intention : MODIFIER
clearTestResults:
instance-level [functionality clearing] (modifier) API clearTestResults
of class service.Y1564TestHeadProfile
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_service_Y1564TestHeadProfile_clearTestResults", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clearTestResultsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/service/Y1564TestHeadProfile/findTests/{instanceFullName}": { "post": { "tags": [ "samo_service" ], "summary": "rest_service_Y1564TestHeadProfile_findTests", "description": "
Intention : RETRIEVER
findTests:
instance-level [object finder] (retriever) API findTests
of class service.Y1564TestHeadProfile
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_service_Y1564TestHeadProfile_findTests", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findTestsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/bundle/Interface/findMembers/{instanceFullName}": { "post": { "tags": [ "samo_bundle" ], "summary": "rest_bundle_Interface_findMembers", "description": "
Intention : RETRIEVER
findMembers:
instance-level [object finder] (retriever) API findMembers
of class bundle.Interface
DescendantInfo:
bundle.ApsInterface
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_bundle_Interface_findMembers", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findMembersResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/bundle/Interface/testSetPattern/{instanceFullName}": { "post": { "tags": [ "samo_bundle" ], "summary": "rest_bundle_Interface_testSetPattern", "operationId": "rest_bundle_Interface_testSetPattern", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "integer", "format": "int32" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/bundle/MultiChassisApsInterface/findInstanceApsBundles/{instanceFullName}": { "post": { "tags": [ "samo_bundle" ], "summary": "rest_bundle_MultiChassisApsInterface_findInstanceApsBundles", "description": "
Intention : RETRIEVER
findInstanceApsBundles:
instance-level [object finder] (retriever) API findInstanceApsBundles
of class bundle.MultiChassisApsInterface
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_bundle_MultiChassisApsInterface_findInstanceApsBundles", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findInstanceApsBundlesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/bundle/MultiChassisApsInterface/getDependencyCount/{instanceFullName}": { "get": { "tags": [ "samo_bundle" ], "summary": "rest_bundle_MultiChassisApsInterface_getDependencyCount", "description": "
Intention : RETRIEVER
getDependencyCount:
instance-level retriever API getDependencyCount
of class bundle.MultiChassisApsInterface
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_bundle_MultiChassisApsInterface_getDependencyCount", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getDependencyCountResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/localuserdb/LocalUserDb/retrieveLocalUserDatabases": { "post": { "tags": [ "samo_localuserdb" ], "summary": "rest_localuserdb_LocalUserDb_retrieveLocalUserDatabases", "description": "This method gets the local user database entries from the database.

Intention : RETRIEVER
retrieveLocalUserDatabases:
class-level retriever API retrieveLocalUserDatabases
of class localuserdb.LocalUserDb

The number of local user databases.

", "operationId": "rest_localuserdb_LocalUserDb_retrieveLocalUserDatabases", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveLocalUserDatabasesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mld/GroupInterfaceSapGroup/retrieveMldGroupIfSapGrp": { "post": { "tags": [ "samo_mld" ], "summary": "rest_mld_GroupInterfaceSapGroup_retrieveMldGroupIfSapGrp", "description": "Method used to query the NE for group address entries under a GroupInterfaceSap.

Intention : RETRIEVER
retrieveMldGroupIfSapGrp:
class-level retriever API retrieveMldGroupIfSapGrp
of class mld.GroupInterfaceSapGroup


", "operationId": "rest_mld_GroupInterfaceSapGroup_retrieveMldGroupIfSapGrp", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveMldGroupIfSapGrp" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveMldGroupIfSapGrpResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mld/MldHost/retrieveMldHostPerSubscrHost": { "post": { "tags": [ "samo_mld" ], "summary": "rest_mld_MldHost_retrieveMldHostPerSubscrHost", "description": "Method used to retrieve MLD Host which is mapped to Subscriber Host from Residential Subscriber Host window.

Intention : RETRIEVER
retrieveMldHostPerSubscrHost:
class-level retriever API retrieveMldHostPerSubscrHost
of class mld.MldHost


", "operationId": "rest_mld_MldHost_retrieveMldHostPerSubscrHost", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MldHostBaseInfoStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveMldHostPerSubscrHostResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mld/MldHost/retrieveMldHosts": { "post": { "tags": [ "samo_mld" ], "summary": "rest_mld_MldHost_retrieveMldHosts", "description": "Method used to query the NE for MLD host and child objects (MLD Groups) associated with a subscriber.

Intention : RETRIEVER
retrieveMldHosts:
class-level retriever API retrieveMldHosts
of class mld.MldHost


", "operationId": "rest_mld_MldHost_retrieveMldHosts", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveMldHosts" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveMldHostsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mld/MldHost/retrieveResSubscrMldHosts": { "post": { "tags": [ "samo_mld" ], "summary": "rest_mld_MldHost_retrieveResSubscrMldHosts", "description": "Method used to query the NE for MLD hosts and child objects (MLD Groups and Sources) from Residential Subscriber Manager window

Intention : RETRIEVER
retrieveResSubscrMldHosts:
class-level retriever API retrieveResSubscrMldHosts
of class mld.MldHost


", "operationId": "rest_mld_MldHost_retrieveResSubscrMldHosts", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MldHostRetrievalStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveResSubscrMldHostsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mediation/BackupPolicy/configure/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_BackupPolicy_configure", "operationId": "rest_mediation_BackupPolicy_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupPolicyConfigInfo" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/DeploymentPolicy/configure": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_DeploymentPolicy_configure", "operationId": "rest_mediation_DeploymentPolicy_configure", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeploymentPolicyConfigInfo" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/DeploymentPolicy/getInfo": { "get": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_DeploymentPolicy_getInfo", "description": "
Intention : ACCESSOR
getInfo:
instance-level accessor API getInfo on default instance Default.DeployerBank:policy of class mediation.DeploymentPolicy


", "operationId": "rest_mediation_DeploymentPolicy_getInfo", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getInfoResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mediation/FirmwareFolderDescriptor/activateFirmwareImage/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_FirmwareFolderDescriptor_activateFirmwareImage", "operationId": "rest_mediation_FirmwareFolderDescriptor_activateFirmwareImage", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/activateFirmwareImage" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/FirmwareFolderDescriptor/findFirmwareApplicableNes/{instanceFullName}": { "get": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_FirmwareFolderDescriptor_findFirmwareApplicableNes", "description": "Used to find list network elements that could be upgraded using this image.

Intention : RETRIEVER
findFirmwareApplicableNes:
instance-level [object finder] (retriever) API findFirmwareApplicableNes
of class mediation.FirmwareFolderDescriptor
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mediation_FirmwareFolderDescriptor_findFirmwareApplicableNes", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "isScheduled", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findFirmwareApplicableNesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mediation/FirmwareFolderDescriptor/scheduleFirmwareUpgrade/{instanceFullName}": { "put": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_FirmwareFolderDescriptor_scheduleFirmwareUpgrade", "operationId": "rest_mediation_FirmwareFolderDescriptor_scheduleFirmwareUpgrade", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scheduleFirmwareUpgrade" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/FirmwareFolderDescriptor/upgradeFirmware/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_FirmwareFolderDescriptor_upgradeFirmware", "operationId": "rest_mediation_FirmwareFolderDescriptor_upgradeFirmware", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/upgradeFirmware" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/FirmwareFolderDescriptor/validateFirmwareDiskSpace/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_FirmwareFolderDescriptor_validateFirmwareDiskSpace", "operationId": "rest_mediation_FirmwareFolderDescriptor_validateFirmwareDiskSpace", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/GNESoftwareFolderDescriptor/findApplicableNes/{instanceFullName}": { "get": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_GNESoftwareFolderDescriptor_findApplicableNes", "description": "Used to find list network elements that could be upgraded using this image.

Intention : RETRIEVER
findApplicableNes:
instance-level [object finder] (retriever) API findApplicableNes
of class mediation.GNESoftwareFolderDescriptor
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mediation_GNESoftwareFolderDescriptor_findApplicableNes", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "isScheduled", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findApplicableNesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mediation/GNESoftwareFolderDescriptor/findApplicableOperations/{instanceFullName}": { "get": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_GNESoftwareFolderDescriptor_findApplicableOperations", "description": "Used to find list upgrade operations that could be performed using this image.

Intention : RETRIEVER
findApplicableOperations:
instance-level [object finder] (retriever) API findApplicableOperations
of class mediation.GNESoftwareFolderDescriptor
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mediation_GNESoftwareFolderDescriptor_findApplicableOperations", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "isScheduled", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findApplicableOperationsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mediation/GNESoftwareFolderDescriptor/scheduleUpgrade/{instanceFullName}": { "put": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_GNESoftwareFolderDescriptor_scheduleUpgrade", "operationId": "rest_mediation_GNESoftwareFolderDescriptor_scheduleUpgrade", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scheduleUpgrade" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/GNESoftwareFolderDescriptor/upgrade/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_GNESoftwareFolderDescriptor_upgrade", "operationId": "rest_mediation_GNESoftwareFolderDescriptor_upgrade", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/upgrade" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/MMESoftwareFolderDescriptor/backout/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_MMESoftwareFolderDescriptor_backout", "operationId": "rest_mediation_MMESoftwareFolderDescriptor_backout", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/backout" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/MMESoftwareFolderDescriptor/commit/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_MMESoftwareFolderDescriptor_commit", "operationId": "rest_mediation_MMESoftwareFolderDescriptor_commit", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/commit" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/MMESoftwareFolderDescriptor/continueExecutingSU/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_MMESoftwareFolderDescriptor_continueExecutingSU", "operationId": "rest_mediation_MMESoftwareFolderDescriptor_continueExecutingSU", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/continueExecutingSU" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/MMESoftwareFolderDescriptor/scheduleUpgrade/{instanceFullName}": { "put": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_MMESoftwareFolderDescriptor_scheduleUpgrade", "operationId": "rest_mediation_MMESoftwareFolderDescriptor_scheduleUpgrade", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scheduleUpgrade" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/MMESoftwareFolderDescriptor/upgrade/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_MMESoftwareFolderDescriptor_upgrade", "operationId": "rest_mediation_MMESoftwareFolderDescriptor_upgrade", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/upgrade" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/MPRSoftwareFolderDescriptor/abortUpgrade/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_MPRSoftwareFolderDescriptor_abortUpgrade", "operationId": "rest_mediation_MPRSoftwareFolderDescriptor_abortUpgrade", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/MPRSoftwareFolderDescriptor/scheduleUpgrade/{instanceFullName}": { "put": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_MPRSoftwareFolderDescriptor_scheduleUpgrade", "operationId": "rest_mediation_MPRSoftwareFolderDescriptor_scheduleUpgrade", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scheduleUpgrade" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/MPRSoftwareFolderDescriptor/upgrade/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_MPRSoftwareFolderDescriptor_upgrade", "operationId": "rest_mediation_MPRSoftwareFolderDescriptor_upgrade", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/ManagementPingDestination/ping/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_ManagementPingDestination_ping", "operationId": "rest_mediation_ManagementPingDestination_ping", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/ManagementPingDestination/pingAndGetResult/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_ManagementPingDestination_pingAndGetResult", "description": "Execute network element reachability test and return the ping status enum {{mediation.PingStatus}}.
It waits for the result and then returns so there may be delay due to network or timeout.

Intention : RETRIEVER
pingAndGetResult:
instance-level retriever API pingAndGetResult
of class mediation.ManagementPingDestination
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mediation_ManagementPingDestination_pingAndGetResult", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pingAndGetResultResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mediation/OCSSoftwareFolderDescriptor/abort/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_OCSSoftwareFolderDescriptor_abort", "operationId": "rest_mediation_OCSSoftwareFolderDescriptor_abort", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/OCSSoftwareFolderDescriptor/activate/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_OCSSoftwareFolderDescriptor_activate", "operationId": "rest_mediation_OCSSoftwareFolderDescriptor_activate", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/activate" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/OCSSoftwareFolderDescriptor/activateGmre": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_OCSSoftwareFolderDescriptor_activateGmre", "operationId": "rest_mediation_OCSSoftwareFolderDescriptor_activateGmre", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/OCSSoftwareFolderDescriptor/audit/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_OCSSoftwareFolderDescriptor_audit", "operationId": "rest_mediation_OCSSoftwareFolderDescriptor_audit", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/audit" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/OCSSoftwareFolderDescriptor/autoUpgrade/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_OCSSoftwareFolderDescriptor_autoUpgrade", "operationId": "rest_mediation_OCSSoftwareFolderDescriptor_autoUpgrade", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/autoUpgrade" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/OCSSoftwareFolderDescriptor/commit/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_OCSSoftwareFolderDescriptor_commit", "operationId": "rest_mediation_OCSSoftwareFolderDescriptor_commit", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/OCSSoftwareFolderDescriptor/download/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_OCSSoftwareFolderDescriptor_download", "operationId": "rest_mediation_OCSSoftwareFolderDescriptor_download", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/OCSSoftwareFolderDescriptor/revert/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_OCSSoftwareFolderDescriptor_revert", "operationId": "rest_mediation_OCSSoftwareFolderDescriptor_revert", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/OCSSoftwareFolderDescriptor/scheduleUpgrade/{instanceFullName}": { "put": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_OCSSoftwareFolderDescriptor_scheduleUpgrade", "operationId": "rest_mediation_OCSSoftwareFolderDescriptor_scheduleUpgrade", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scheduleUpgrade" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/OmniSoftwareFolderDescriptor/certifyImage/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_OmniSoftwareFolderDescriptor_certifyImage", "operationId": "rest_mediation_OmniSoftwareFolderDescriptor_certifyImage", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/OmniSoftwareFolderDescriptor/deleteUbootMiniBoot/{instanceFullName}": { "delete": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_OmniSoftwareFolderDescriptor_deleteUbootMiniBoot", "operationId": "rest_mediation_OmniSoftwareFolderDescriptor_deleteUbootMiniBoot", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/OmniSoftwareFolderDescriptor/installImage/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_OmniSoftwareFolderDescriptor_installImage", "operationId": "rest_mediation_OmniSoftwareFolderDescriptor_installImage", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/OmniSoftwareFolderDescriptor/reload/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_OmniSoftwareFolderDescriptor_reload", "operationId": "rest_mediation_OmniSoftwareFolderDescriptor_reload", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reload" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/OmniSoftwareFolderDescriptor/upgrade/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_OmniSoftwareFolderDescriptor_upgrade", "operationId": "rest_mediation_OmniSoftwareFolderDescriptor_upgrade", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/upgrade" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/OmniSoftwareFolderDescriptor/upgradeFPGA/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_OmniSoftwareFolderDescriptor_upgradeFPGA", "operationId": "rest_mediation_OmniSoftwareFolderDescriptor_upgradeFPGA", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/OmniSoftwareFolderDescriptor/upgradeUbootMiniBoot/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_OmniSoftwareFolderDescriptor_upgradeUbootMiniBoot", "operationId": "rest_mediation_OmniSoftwareFolderDescriptor_upgradeUbootMiniBoot", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/PSSSoftwareFolderDescriptor/abort/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_PSSSoftwareFolderDescriptor_abort", "operationId": "rest_mediation_PSSSoftwareFolderDescriptor_abort", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/PSSSoftwareFolderDescriptor/activate/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_PSSSoftwareFolderDescriptor_activate", "operationId": "rest_mediation_PSSSoftwareFolderDescriptor_activate", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/PSSSoftwareFolderDescriptor/audit/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_PSSSoftwareFolderDescriptor_audit", "operationId": "rest_mediation_PSSSoftwareFolderDescriptor_audit", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/audit" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/PSSSoftwareFolderDescriptor/autoUpgrade/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_PSSSoftwareFolderDescriptor_autoUpgrade", "operationId": "rest_mediation_PSSSoftwareFolderDescriptor_autoUpgrade", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/autoUpgrade" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/PSSSoftwareFolderDescriptor/commit/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_PSSSoftwareFolderDescriptor_commit", "operationId": "rest_mediation_PSSSoftwareFolderDescriptor_commit", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/PSSSoftwareFolderDescriptor/download/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_PSSSoftwareFolderDescriptor_download", "operationId": "rest_mediation_PSSSoftwareFolderDescriptor_download", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/PSSSoftwareFolderDescriptor/revert/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_PSSSoftwareFolderDescriptor_revert", "operationId": "rest_mediation_PSSSoftwareFolderDescriptor_revert", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/PSSSoftwareFolderDescriptor/scheduleUpgrade/{instanceFullName}": { "put": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_PSSSoftwareFolderDescriptor_scheduleUpgrade", "operationId": "rest_mediation_PSSSoftwareFolderDescriptor_scheduleUpgrade", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scheduleUpgrade" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/RANAldSoftwareFolderDescriptor/aldUpgrade/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_RANAldSoftwareFolderDescriptor_aldUpgrade", "description": "This operation results in transfer of the image set to the selected elements.

Intention : MODIFIER
aldUpgrade:
instance-level modifier API aldUpgrade
of class mediation.RANAldSoftwareFolderDescriptor
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mediation_RANAldSoftwareFolderDescriptor_aldUpgrade", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aldUpgrade" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/aldUpgradeResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mediation/RANSoftwareFolderDescriptor/abort/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_RANSoftwareFolderDescriptor_abort", "operationId": "rest_mediation_RANSoftwareFolderDescriptor_abort", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/RANSoftwareFolderDescriptor/accept/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_RANSoftwareFolderDescriptor_accept", "operationId": "rest_mediation_RANSoftwareFolderDescriptor_accept", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/RANSoftwareFolderDescriptor/activate/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_RANSoftwareFolderDescriptor_activate", "operationId": "rest_mediation_RANSoftwareFolderDescriptor_activate", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/RANSoftwareFolderDescriptor/download/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_RANSoftwareFolderDescriptor_download", "operationId": "rest_mediation_RANSoftwareFolderDescriptor_download", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/download" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/RANSoftwareFolderDescriptor/reject/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_RANSoftwareFolderDescriptor_reject", "operationId": "rest_mediation_RANSoftwareFolderDescriptor_reject", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/RANSoftwareFolderDescriptor/scheduleActivate/{instanceFullName}": { "put": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_RANSoftwareFolderDescriptor_scheduleActivate", "operationId": "rest_mediation_RANSoftwareFolderDescriptor_scheduleActivate", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scheduleActivate" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/RANSoftwareFolderDescriptor/scheduleUpgrade/{instanceFullName}": { "put": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_RANSoftwareFolderDescriptor_scheduleUpgrade", "operationId": "rest_mediation_RANSoftwareFolderDescriptor_scheduleUpgrade", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scheduleUpgrade" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/RANSoftwareFolderDescriptor/stopMonitoring/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_RANSoftwareFolderDescriptor_stopMonitoring", "operationId": "rest_mediation_RANSoftwareFolderDescriptor_stopMonitoring", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/SoftwareFolderDescriptor/activateImage/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_SoftwareFolderDescriptor_activateImage", "operationId": "rest_mediation_SoftwareFolderDescriptor_activateImage", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/SoftwareFolderDescriptor/extShelfScheduleUpgrade/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_SoftwareFolderDescriptor_extShelfScheduleUpgrade", "operationId": "rest_mediation_SoftwareFolderDescriptor_extShelfScheduleUpgrade", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/extShelfScheduleUpgrade" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/SoftwareFolderDescriptor/findApplicableNes/{instanceFullName}": { "get": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_SoftwareFolderDescriptor_findApplicableNes", "description": "Used to find list network elements that could be upgraded using this image.

Intention : RETRIEVER
findApplicableNes:
instance-level [object finder] (retriever) API findApplicableNes
of class mediation.SoftwareFolderDescriptor
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mediation_SoftwareFolderDescriptor_findApplicableNes", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "isScheduled", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findApplicableNesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mediation/SoftwareFolderDescriptor/scheduleUpgrade/{instanceFullName}": { "put": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_SoftwareFolderDescriptor_scheduleUpgrade", "operationId": "rest_mediation_SoftwareFolderDescriptor_scheduleUpgrade", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scheduleUpgrade" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/SoftwareFolderDescriptor/upgrade/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_SoftwareFolderDescriptor_upgrade", "operationId": "rest_mediation_SoftwareFolderDescriptor_upgrade", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/SoftwareFolderDescriptor/upgradeExtShelves/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_SoftwareFolderDescriptor_upgradeExtShelves", "description": "This operation results in transfer of the image set, to the selected Extended Shelves on SR Chassis, as per assigned, \nsoftware upgrade policy, followed by activation of the image (reboot or reboot with firmware upgrade). \n \ninstance-level modifier API upgradeExtShelves of class mediation.SoftwareFolderDescriptor \n\n \n\nFor example, the client makes the following HTTP request:\n\n POST: v2/mediation/SoftwareFolderDescriptor/upgradeExtShelves/TiMOS-B-20.9.R1\n Host: server.example.com\n Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n X-Deployer-ID: -1\n Content-Type: application/json\n\n [{\"objectClassName\":\"sw.ExtensionShelfUpgradeManager\", \"siteId\": \"35.250.64.165\", \"shelfId\": 1, \"oesShelfId\": 5, \"phyShelfClass\": 1, \"policyType\": 1, \"softwareUpgradePolicyId\": 9, \"softwareImage\": \"\", \"softwareRepository\": \"softwareRepository:swrep-eSat_TiMOS-B-20.9.R1\", \"description\": \"Software Upgrade\", \"objectFullName\": \"network:35.250.64.165:softwareUpgradeManager:srextsm-1-5-5\"]\n\n", "operationId": "rest_mediation_SoftwareFolderDescriptor_upgradeExtShelves", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionShelfUpgradeManagerInfo" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findApplicableNesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mediation/SoftwareFolderDescriptor/validateDiskSpace/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_SoftwareFolderDescriptor_validateDiskSpace", "operationId": "rest_mediation_SoftwareFolderDescriptor_validateDiskSpace", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/SoftwareFolderManager/getInfo": { "get": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_SoftwareFolderManager_getInfo", "description": "
Intention : ACCESSOR
getInfo:
instance-level accessor API getInfo on default instance network:SoftwareFolderManager of class mediation.SoftwareFolderManager


", "operationId": "rest_mediation_SoftwareFolderManager_getInfo", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getInfoResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mediation/SoftwareFolderManager/importFwImage": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_SoftwareFolderManager_importFwImage", "description": "This operation reads the firmware image files, from a selected location, relative to the local directory server_install_dir nms nodeSoftware
and saves them in the NFM-P database. The local directory server_install_dir nms nodeSoftware shall be cleaned up periodically,
based on config parameter - \"nodeSoftware timeToKeepFile\" (default = 1440 minutes), specified in nms-server.xml config file.


Intention : MODIFIER
importFwImage:
instance-level modifier API importFwImage on default instance network:SoftwareFolderManager of class mediation.SoftwareFolderManager


", "operationId": "rest_mediation_SoftwareFolderManager_importFwImage", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/importFwImage" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/importFwImageResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mediation/SoftwareFolderManager/importImage": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_SoftwareFolderManager_importImage", "description": "This operation reads the software image files, from a selected location, relative to the local directory server_install_dir nms nodeSoftware
and saves them in the NFM-P database. The local directory server_install_dir nms nodeSoftware shall be cleaned up periodically,
based on config parameter - \"nodeSoftware timeToKeepFile\" (default = 1440 minutes), specified in nms-server.xml config file.



Example (eNodeB):

<mediation.SoftwareFolderManager.importImage xmlns=\"xmlapi_1.0\">
     <deployer>immediate< deployer>
     <synchronousDeploy >true< synchronousDeploy >
     <imageFileNames>
          <string>#BI_0622#FT_OMsw#FI_RH2XANB07#FV_0000002A< string>
          <string>#BI_0623#FT_OMsw#FI_RH2XANB13#FV_0000006A< string>
          <string>#BI_0626#FT_OMsw#FI_RH1XANB64#FV_00000014< string>
          <string>#BI_0627#FT_OMsw#FI_SA2XCOB02#FV_00000018< string>
          <string>#BI_0630#FT_OMsw#FI_TR2XANB13#FV_0000006E< string>
          <string>#BI_0690#FT_OMsw#FI_eccm#FV_00000806< string>
          <string>#BI_06D0#FT_OMsw#FI_MT2XALB03#FV_0000002D< string>
          <string>#BI_06E2#FT_OMsw#FI_TR2XALB07#FV_00000067< string>
          <string>#BI_0702#FT_OMsw#FI_RH2XASB05#FV_0000002F< string>
          <string>#BI_0703#FT_OMsw#FI_RH2XALB01#FV_00000003< string>
          <string>#BI_0704#FT_OMsw#FI_MR2XASB03#FV_00000056< string>
          <string>#BI_0705#FT_OMsw#FI_RH2XASB02#FV_0000002A< string>
          <string>#BI_0708#FT_OMsw#FI_AR2XALB17#FV_00000043< string>
          <string>#BI_070B#FT_OMsw#FI_RH2XALA01#FV_00000011< string>
          <string>#BI_070D#FT_OMsw#FI_AR2XASB07#FV_00000005< string>
          <string>#BI_070F#FT_OMsw#FI_AR2XASB02#FV_00000018< string>
          <string>#BI_0721#FT_OMsw#FI_MX1XASB03#FV_00000003< string>
          <string>#BI_0730#FT_OMsw#FI_RH2XALB04#FV_000000A8< string>
          <string>#BI_0731#FT_OMsw#FI_RH2XALB12#FV_000000A8< string>
          <string>#BI_0734#FT_OMsw#FI_RH2XALL20#FV_000000A0< string>
          <string>#BI_0735#FT_OMsw#FI_RH2XALU20#FV_000000A0< string>
          <string>#BI_0737#FT_OMsw#FI_RH2XALB07#FV_00000099< string>
          <string>#BI_0739#FT_OMsw#FI_RH4XALB02#FV_0000006A< string>
          <string>#BI_073B#FT_OMsw#FI_RH2XALB03#FV_000000A5< string>
          <string>#BI_073C#FT_OMsw#FI_RH2XALB28#FV_00000003< string>
          <string>#BI_07B4#FT_OMsw#FI_bcem#FV_000006C9< string>
          <string>#BI_07D0#FT_OMsw#FI_TR2XPAL20#FV_0000003C< string>
          <string>#BI_07D1#FT_OMsw#FI_TR2XPAU20#FV_00000041< string>
          <string>#BI_07D2#FT_OMsw#FI_TR2XPAB04#FV_0000002A< string>
          <string>#BI_07E0#FT_OMsw#FI_TR2XGPB13#FV_00000074< string>
          <string>#BI_07E1#FT_OMsw#FI_TR2XGPB14#FV_0000003C< string>
          <string>#BI_07E2#FT_OMsw#FI_TR2XGPB12#FV_00000020< string>
          <string>#BI_0820#FT_OMsw#FI_RH4XPAB02#FV_0000003E< string>
          <string>#BI_08C0#FT_OMsw#FI_RM2XALB13#FV_0000001E< string>
          <string>#BI_08D0#FT_OMsw#FI_eccm2#FV_00000287< string>
          <string>#BI_08F0#FT_OMsw#FI_RH2XKMB26#FV_0000002A< string>
          <string>#BI_08F1#FT_OMsw#FI_RH2XKMB04#FV_00000003< string>
          <string>#BI_0920#FT_OMsw#FI_RH2XASB04#FV_00000006< string>
          <string>#BI_cb#FT_OMcpf#FI_cbCpf#FV_00000235< string>
          <string>#BI_enb#FT_OMsdf#FI_sdf#FV_ENB_LR1401_D1000_E00026< string>
          <string>ENODEB-ENB_LR1401_D1000_E00026.xml< string>
     < imageFileNames>
     <imageLocation>ENB_LR1401_D1000_E00026< imageLocation>
     <imageType>lt; imageType>
     <md5Map>< md5Map>
     <versionString>LR1401_D1000_E00026< versionString>
< mediation.SoftwareFolderManager.importImage>


Intention : MODIFIER
importImage:
instance-level modifier API importImage on default instance network:SoftwareFolderManager of class mediation.SoftwareFolderManager


", "operationId": "rest_mediation_SoftwareFolderManager_importImage", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/importImage" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/importImageResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mediation/VwmOsuSoftwareFolderDescriptor/abort/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_VwmOsuSoftwareFolderDescriptor_abort", "operationId": "rest_mediation_VwmOsuSoftwareFolderDescriptor_abort", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/VwmOsuSoftwareFolderDescriptor/activate/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_VwmOsuSoftwareFolderDescriptor_activate", "operationId": "rest_mediation_VwmOsuSoftwareFolderDescriptor_activate", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/VwmOsuSoftwareFolderDescriptor/audit/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_VwmOsuSoftwareFolderDescriptor_audit", "operationId": "rest_mediation_VwmOsuSoftwareFolderDescriptor_audit", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/audit" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/VwmOsuSoftwareFolderDescriptor/autoUpgrade/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_VwmOsuSoftwareFolderDescriptor_autoUpgrade", "operationId": "rest_mediation_VwmOsuSoftwareFolderDescriptor_autoUpgrade", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/autoUpgrade" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/VwmOsuSoftwareFolderDescriptor/commit/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_VwmOsuSoftwareFolderDescriptor_commit", "operationId": "rest_mediation_VwmOsuSoftwareFolderDescriptor_commit", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/VwmOsuSoftwareFolderDescriptor/download/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_VwmOsuSoftwareFolderDescriptor_download", "operationId": "rest_mediation_VwmOsuSoftwareFolderDescriptor_download", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/VwmOsuSoftwareFolderDescriptor/revert/{instanceFullName}": { "post": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_VwmOsuSoftwareFolderDescriptor_revert", "operationId": "rest_mediation_VwmOsuSoftwareFolderDescriptor_revert", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mediation/VwmOsuSoftwareFolderDescriptor/scheduleUpgrade/{instanceFullName}": { "put": { "tags": [ "samo_mediation" ], "summary": "rest_mediation_VwmOsuSoftwareFolderDescriptor_scheduleUpgrade", "operationId": "rest_mediation_VwmOsuSoftwareFolderDescriptor_scheduleUpgrade", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scheduleUpgrade" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/layer2/Bridge/configure/{instanceFullName}": { "post": { "tags": [ "samo_layer2" ], "summary": "rest_layer2_Bridge_configure", "description": "
Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure
of class layer2.Bridge
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_layer2_Bridge_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/layer2/MvrInterfaceConfigure/configure/{instanceFullName}": { "post": { "tags": [ "samo_layer2" ], "summary": "rest_layer2_MvrInterfaceConfigure_configure", "description": "
Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure
of class layer2.MvrInterfaceConfigure
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_layer2_MvrInterfaceConfigure_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/layer2/MvrSite/configure/{instanceFullName}": { "post": { "tags": [ "samo_layer2" ], "summary": "rest_layer2_MvrSite_configure", "description": "
Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure
of class layer2.MvrSite
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_layer2_MvrSite_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/layer2/NetworkInterface/configure/{instanceFullName}": { "post": { "tags": [ "samo_layer2" ], "summary": "rest_layer2_NetworkInterface_configure", "description": "
Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure
of class layer2.NetworkInterface
This API follows hierarchical config model rules.
DescendantInfo:
vlan.NetworkInterface
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_layer2_NetworkInterface_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/layer2/SuperVlanInterfaceConfigure/configure/{instanceFullName}": { "post": { "tags": [ "samo_layer2" ], "summary": "rest_layer2_SuperVlanInterfaceConfigure_configure", "description": "
Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure
of class layer2.SuperVlanInterfaceConfigure
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_layer2_SuperVlanInterfaceConfigure_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/layer2/TlsInterfaceConfigure/configure/{instanceFullName}": { "post": { "tags": [ "samo_layer2" ], "summary": "rest_layer2_TlsInterfaceConfigure_configure", "description": "
Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure
of class layer2.TlsInterfaceConfigure
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_layer2_TlsInterfaceConfigure_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/layer2/TlsSite/configure/{instanceFullName}": { "post": { "tags": [ "samo_layer2" ], "summary": "rest_layer2_TlsSite_configure", "description": "
Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure
of class layer2.TlsSite
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_layer2_TlsSite_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topologysim/IgpTopologyModel/importAllPathMonitors/{instanceFullName}": { "post": { "tags": [ "samo_topologysim" ], "summary": "rest_topologysim_IgpTopologyModel_importAllPathMonitors", "operationId": "rest_topologysim_IgpTopologyModel_importAllPathMonitors", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topologysim/IgpTopologyModel/importCheckpoint/{instanceFullName}": { "post": { "tags": [ "samo_topologysim" ], "summary": "rest_topologysim_IgpTopologyModel_importCheckpoint", "operationId": "rest_topologysim_IgpTopologyModel_importCheckpoint", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topologysim/IgpTopologyModel/importFromIgpAdminDomain/{instanceFullName}": { "post": { "tags": [ "samo_topologysim" ], "summary": "rest_topologysim_IgpTopologyModel_importFromIgpAdminDomain", "operationId": "rest_topologysim_IgpTopologyModel_importFromIgpAdminDomain", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/importFromIgpAdminDomain" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topologysim/IgpTopologyModel/importFromScenario/{instanceFullName}": { "post": { "tags": [ "samo_topologysim" ], "summary": "rest_topologysim_IgpTopologyModel_importFromScenario", "operationId": "rest_topologysim_IgpTopologyModel_importFromScenario", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topologysim/IgpTopologyModel/importIsisRoutingDomain/{instanceFullName}": { "post": { "tags": [ "samo_topologysim" ], "summary": "rest_topologysim_IgpTopologyModel_importIsisRoutingDomain", "operationId": "rest_topologysim_IgpTopologyModel_importIsisRoutingDomain", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/importIsisRoutingDomain" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topologysim/IgpTopologyModel/importOspfArea/{instanceFullName}": { "post": { "tags": [ "samo_topologysim" ], "summary": "rest_topologysim_IgpTopologyModel_importOspfArea", "operationId": "rest_topologysim_IgpTopologyModel_importOspfArea", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topologysim/IgpTopologyModel/importPathMonitors/{instanceFullName}": { "post": { "tags": [ "samo_topologysim" ], "summary": "rest_topologysim_IgpTopologyModel_importPathMonitors", "operationId": "rest_topologysim_IgpTopologyModel_importPathMonitors", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topologysim/IpPathRecord/findServices/{instanceFullName}": { "post": { "tags": [ "samo_topologysim" ], "summary": "rest_topologysim_IpPathRecord_findServices", "description": "Find all the associated Services with an IP path record.

Intention : RETRIEVER
findServices:
instance-level [object finder] (retriever) API findServices
of class topologysim.IpPathRecord
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_topologysim_IpPathRecord_findServices", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findServices" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findServicesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topologysim/LspPathRecord/findServices/{instanceFullName}": { "post": { "tags": [ "samo_topologysim" ], "summary": "rest_topologysim_LspPathRecord_findServices", "description": "Find all the associated Services with a path monitor.

Intention : RETRIEVER
findServices:
instance-level [object finder] (retriever) API findServices
of class topologysim.LspPathRecord
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_topologysim_LspPathRecord_findServices", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findServices" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findServicesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topologysim/MplsModel/importAllLsps/{instanceFullName}": { "post": { "tags": [ "samo_topologysim" ], "summary": "rest_topologysim_MplsModel_importAllLsps", "operationId": "rest_topologysim_MplsModel_importAllLsps", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topologysim/MplsModel/importAllRealLsps/{instanceFullName}": { "post": { "tags": [ "samo_topologysim" ], "summary": "rest_topologysim_MplsModel_importAllRealLsps", "operationId": "rest_topologysim_MplsModel_importAllRealLsps", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topologysim/MplsModel/importRealLsps/{instanceFullName}": { "post": { "tags": [ "samo_topologysim" ], "summary": "rest_topologysim_MplsModel_importRealLsps", "operationId": "rest_topologysim_MplsModel_importRealLsps", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topologysim/MplsModel/importSimulatedLsps/{instanceFullName}": { "post": { "tags": [ "samo_topologysim" ], "summary": "rest_topologysim_MplsModel_importSimulatedLsps", "operationId": "rest_topologysim_MplsModel_importSimulatedLsps", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/rmd/AccessInterface/initiateDiscovery/{instanceFullName}": { "post": { "tags": [ "samo_rmd" ], "summary": "rest_rmd_AccessInterface_initiateDiscovery", "operationId": "rest_rmd_AccessInterface_initiateDiscovery", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/rmd/Device/reset/{instanceFullName}": { "post": { "tags": [ "samo_rmd" ], "summary": "rest_rmd_Device_reset", "operationId": "rest_rmd_Device_reset", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/rmd/DiscoveredDevice/createDevice": { "post": { "tags": [ "samo_rmd" ], "summary": "rest_rmd_DiscoveredDevice_createDevice", "description": "This method will create remote managed devices.

Intention : MODIFIER
createDevice:
class-level [administrative creation] (modifier) API createDevice
of class rmd.DiscoveredDevice


", "operationId": "rest_rmd_DiscoveredDevice_createDevice", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createDeviceResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rmd/DiscoveredDevice/resync": { "post": { "tags": [ "samo_rmd" ], "summary": "rest_rmd_DiscoveredDevice_resync", "operationId": "rest_rmd_DiscoveredDevice_resync", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/rmd/RmdConfig/discoverDevices": { "post": { "tags": [ "samo_rmd" ], "summary": "rest_rmd_RmdConfig_discoverDevices", "description": "This method will discover remote managed devices.

Intention : MODIFIER
discoverDevices:
class-level modifier API discoverDevices
of class rmd.RmdConfig


", "operationId": "rest_rmd_RmdConfig_discoverDevices", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/discoverDevicesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rmd/RmdConfig/startDiscovery/{instanceFullName}": { "post": { "tags": [ "samo_rmd" ], "summary": "rest_rmd_RmdConfig_startDiscovery", "operationId": "rest_rmd_RmdConfig_startDiscovery", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/aingr/Match/renum": { "post": { "tags": [ "samo_aingr" ], "summary": "rest_aingr_Match_renum", "operationId": "rest_aingr_Match_renum", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/renum" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/aingr/Policy/retrieveHostSharedPccRuleIngressPolicy": { "post": { "tags": [ "samo_aingr" ], "summary": "rest_aingr_Policy_retrieveHostSharedPccRuleIngressPolicy", "description": "Method retrieves QoS SAP Access Ingress Policy from the network element. This method
has option to specify either retrieving its entries or not.

Intention : RETRIEVER
retrieveHostSharedPccRuleIngressPolicy:
class-level retriever API retrieveHostSharedPccRuleIngressPolicy
of class aingr.Policy


", "operationId": "rest_aingr_Policy_retrieveHostSharedPccRuleIngressPolicy", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RtrvHostSharedPccRuleIngPolicyStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveHostSharedPccRuleIngressPolicyResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mirrorli/LICfg/saveLIConfig/{instanceFullName}": { "post": { "tags": [ "samo_mirrorli" ], "summary": "rest_mirrorli_LICfg_saveLIConfig", "operationId": "rest_mirrorli_LICfg_saveLIConfig", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/nat/AbstractLsnSubscriber/queryLsnSubscribers": { "post": { "tags": [ "samo_nat" ], "summary": "rest_nat_AbstractLsnSubscriber_queryLsnSubscribers", "description": "This method is used to query the NE for LSN Subscriber(s) exists on a specified routing instance (Base or VPRN) and
the subscriber inside IP Address. This method is only applicable to the node with version 12.0 and above.

Intention : RETRIEVER
queryLsnSubscribers:
class-level retriever API queryLsnSubscribers
of class nat.AbstractLsnSubscriber
DescendantInfo:
nat.ClassicLsnHost
DescendantInfo:
nat.Nat64Subscriber
DescendantInfo:
nat.DsLiteSubscriber


", "operationId": "rest_nat_AbstractLsnSubscriber_queryLsnSubscribers", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LsnSubRetrievalStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/queryLsnSubscribersResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/nat/ClassicLsnHost/retrieveSubIdStrTimestamp": { "post": { "tags": [ "samo_nat" ], "summary": "rest_nat_ClassicLsnHost_retrieveSubIdStrTimestamp", "description": "Retrieves subscriber string association time with classic LSN host.
Method used to query the NE for to update the subscriber ID String Timestamp.

Intention : RETRIEVER
retrieveSubIdStrTimestamp:
class-level retriever API retrieveSubIdStrTimestamp
of class nat.ClassicLsnHost


", "operationId": "rest_nat_ClassicLsnHost_retrieveSubIdStrTimestamp", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveSubIdStrTimestamp" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveSubIdStrTimestampResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/nat/FirewallHost/retrieveFirewallHosts": { "post": { "tags": [ "samo_nat" ], "summary": "rest_nat_FirewallHost_retrieveFirewallHosts", "description": "Method used to query the NE for the Firewall Hosts related to the specified NAT L2 Aware Subscriber.

Intention : RETRIEVER
retrieveFirewallHosts:
class-level retriever API retrieveFirewallHosts
of class nat.FirewallHost


", "operationId": "rest_nat_FirewallHost_retrieveFirewallHosts", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveFirewallHosts" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveFirewallHostsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/nat/IsaMda/requestRecoverL2AwBypass": { "post": { "tags": [ "samo_nat" ], "summary": "rest_nat_IsaMda_requestRecoverL2AwBypass", "description": "This method restores NAT resources to the recovered MS-ISA and resume forwarding
subscriber traffic through it (tool performs nat recover-l2aw-bypass slot mda).

Intention : RETRIEVER
requestRecoverL2AwBypass:
class-level retriever API requestRecoverL2AwBypass
of class nat.IsaMda


", "operationId": "rest_nat_IsaMda_requestRecoverL2AwBypass", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestRecoverL2AwBypass" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestRecoverL2AwBypassResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/nat/L2AwHosts/retrieveL2AwHosts": { "post": { "tags": [ "samo_nat" ], "summary": "rest_nat_L2AwHosts_retrieveL2AwHosts", "description": "Method used to query the NE for the NAT L2 Aware Hosts related to the specified NAT L2 Aware Subscriber.

Intention : RETRIEVER
retrieveL2AwHosts:
class-level retriever API retrieveL2AwHosts
of class nat.L2AwHosts


", "operationId": "rest_nat_L2AwHosts_retrieveL2AwHosts", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveL2AwHosts" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveL2AwHostsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/nat/L2AwSubscriber/retrieveL2AwareSubscribers": { "post": { "tags": [ "samo_nat" ], "summary": "rest_nat_L2AwSubscriber_retrieveL2AwareSubscribers", "operationId": "rest_nat_L2AwSubscriber_retrieveL2AwareSubscribers", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveL2AwareSubscribers" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/nat/L2AwareBlockAllocation/retrieveL2AwareBlockAllocations": { "post": { "tags": [ "samo_nat" ], "summary": "rest_nat_L2AwareBlockAllocation_retrieveL2AwareBlockAllocations", "description": "Method used to query the NE for the L2 Aware Block Allocations related to the specified NAT L2 Aware Subscriber.

Intention : RETRIEVER
retrieveL2AwareBlockAllocations:
class-level retriever API retrieveL2AwareBlockAllocations
of class nat.L2AwareBlockAllocation


", "operationId": "rest_nat_L2AwareBlockAllocation_retrieveL2AwareBlockAllocations", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveL2AwareBlockAllocations" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveL2AwareBlockAllocationsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/nat/L2AwareNatSubscriberPolicies/retrieveL2AwareNatSubscriberPolicies": { "post": { "tags": [ "samo_nat" ], "summary": "rest_nat_L2AwareNatSubscriberPolicies_retrieveL2AwareNatSubscriberPolicies", "description": "Method used to query the NE for the L2 Aware NAT Subscriber Policies related to the specified NAT L2 Aware Subscriber.

Intention : RETRIEVER
retrieveL2AwareNatSubscriberPolicies:
class-level retriever API retrieveL2AwareNatSubscriberPolicies
of class nat.L2AwareNatSubscriberPolicies


", "operationId": "rest_nat_L2AwareNatSubscriberPolicies_retrieveL2AwareNatSubscriberPolicies", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveL2AwareNatSubscriberPolicies" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveL2AwareNatSubscriberPoliciesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/nat/LsnBlockAllocation/retrieveLsnBlockAllocations": { "post": { "tags": [ "samo_nat" ], "summary": "rest_nat_LsnBlockAllocation_retrieveLsnBlockAllocations", "description": "Method used to query the NE for the Block Allocations that on a specified routing instance (Base or VPRN) and
the Block Allocation outside IP Address.

Intention : RETRIEVER
retrieveLsnBlockAllocations:
class-level retriever API retrieveLsnBlockAllocations
of class nat.LsnBlockAllocation


", "operationId": "rest_nat_LsnBlockAllocation_retrieveLsnBlockAllocations", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveLsnBlockAllocations" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveLsnBlockAllocationsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/nat/NatIsaGroup/findDaughterCards/{instanceFullName}": { "get": { "tags": [ "samo_nat" ], "summary": "rest_nat_NatIsaGroup_findDaughterCards", "description": "
Intention : RETRIEVER
findDaughterCards:
instance-level [object finder] (retriever) API findDaughterCards
of class nat.NatIsaGroup
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_nat_NatIsaGroup_findDaughterCards", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "siteId", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "isaGroup", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findDaughterCardsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/nat/NatIsaGroup/getDependencyCount/{instanceFullName}": { "get": { "tags": [ "samo_nat" ], "summary": "rest_nat_NatIsaGroup_getDependencyCount", "description": "
Intention : RETRIEVER
getDependencyCount:
instance-level retriever API getDependencyCount
of class nat.NatIsaGroup
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_nat_NatIsaGroup_getDependencyCount", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getDependencyCountResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/nat/NatIsaGroupConf/getReassemblyGroups": { "get": { "tags": [ "samo_nat" ], "summary": "rest_nat_NatIsaGroupConf_getReassemblyGroups", "description": "
Intention : RETRIEVER
getReassemblyGroups:
class-level retriever API getReassemblyGroups
of class nat.NatIsaGroupConf
DescendantInfo:
wlangw.WlanGwIsaGroup
DescendantInfo:
nat.NatIsaGroup


", "operationId": "rest_nat_NatIsaGroupConf_getReassemblyGroups", "parameters": [ { "name": "siteId", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "isaGroup", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getReassemblyGroupsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/nat/NatPool/requestNatPoolHistogram": { "post": { "tags": [ "samo_nat" ], "summary": "rest_nat_NatPool_requestNatPoolHistogram", "description": "This method allows to request the creation of a port usage histogram for a given NAT pool.

Intention : RETRIEVER
requestNatPoolHistogram:
class-level retriever API requestNatPoolHistogram
of class nat.NatPool


", "operationId": "rest_nat_NatPool_requestNatPoolHistogram", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestNatPoolHistogram" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestNatPoolHistogramResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/nat/NatVapp/requestRecoverEsaVm": { "post": { "tags": [ "samo_nat" ], "summary": "rest_nat_NatVapp_requestRecoverEsaVm", "description": "This method restores NAT resources to the recovered ESA VM and resume forwarding
subscriber traffic through it.

Intention : RETRIEVER
requestRecoverEsaVm:
class-level retriever API requestRecoverEsaVm
of class nat.NatVapp


", "operationId": "rest_nat_NatVapp_requestRecoverEsaVm", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestRecoverEsaVm" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestRecoverEsaVmResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/nat/StaticPortMapRequest/applyStaticPortMapRequest": { "post": { "tags": [ "samo_nat" ], "summary": "rest_nat_StaticPortMapRequest_applyStaticPortMapRequest", "description": "Method will not return errors through exceptions, but will use JMS instead. If the caller is not able to listen to JMS events but
is interested in error conditions, 'applyStaticPortMapRequestWithResult' method should be used.
For Classic LSN, DS lite LSN and NAT64 LSN successful execution of the function requires that user must provide these parameters,
\"actionType\", \"ipAddress\", \"routerId\" and \"nodeId\" for creation. Although, for delete modify \"port\"(inside) value is required along
with above mandatory parameters. However for the parameters \"ipAddresstype\", \"subType\" and \"protocol\" if a value is not defined the default
value will be provided before deployment.
For L2-Aware type everything remains the same except in SPF request user has to specify \"subIdent\" parameter to create, modify or delete.

Intention : MODIFIER
applyStaticPortMapRequest:
class-level modifier API applyStaticPortMapRequest
of class nat.StaticPortMapRequest


", "operationId": "rest_nat_StaticPortMapRequest_applyStaticPortMapRequest", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StaticPortMapRequestConfigInfo" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/applyStaticPortMapRequestResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/nat/StaticPortMapRequest/applyStaticPortMapRequestWithResult": { "post": { "tags": [ "samo_nat" ], "summary": "rest_nat_StaticPortMapRequest_applyStaticPortMapRequestWithResult", "description": "For Classic LSN, DS lite LSN and NAT64 LSN successful execution of the function requires that user must provide these parameters,
\"actionType\", \"ipAddress\", \"routerId\" and \"nodeId\" for creation. Although, for delete modify \"port\"(inside) value is required along
with above mandatory parameters. However for the parameters \"ipAddresstype\", \"subType\" and \"protocol\" if a value is not defined the default
value will be provided before deployment.
For L2-Aware type everything remains the same except in SPF request user has to specify \"subIdent\" parameter to create, modify or delete.

Intention : RETRIEVER
applyStaticPortMapRequestWithResult:
class-level retriever API applyStaticPortMapRequestWithResult
of class nat.StaticPortMapRequest


", "operationId": "rest_nat_StaticPortMapRequest_applyStaticPortMapRequestWithResult", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/applyStaticPortMapRequestWithResult" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/applyStaticPortMapRequestWithResultResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/nat/StaticPortMapRequest/applyStaticPortMapRequests": { "post": { "tags": [ "samo_nat" ], "summary": "rest_nat_StaticPortMapRequest_applyStaticPortMapRequests", "description": "Method will not return errors through exceptions, but will use JMS instead. If the caller is not able to listen to JMS events but
is interested in error conditions, 'applyStaticPortMapRequestWithResult' method should be used.
For Classic LSN, DS lite LSN and NAT64 LSN successful execution of the function requires that user must provide these parameters,
\"actionType\", \"ipAddress\", \"routerId\" and \"nodeId\" for creation. Although, for delete modify \"port\"(inside) value is required along
with above mandatory parameters. However for the parameters \"ipAddresstype\", \"subType\" and \"protocol\" if a value is not defined the default
value will be provided before deployment.
For L2-Aware type everything remains the same except in SPF request user has to specify \"subIdent\" parameter to create, modify or delete.

Intention : MODIFIER
applyStaticPortMapRequests:
class-level modifier API applyStaticPortMapRequests
of class nat.StaticPortMapRequest


", "operationId": "rest_nat_StaticPortMapRequest_applyStaticPortMapRequests", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StaticPortMapRequestConfigInfo" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/applyStaticPortMapRequestsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/nat/StaticPortMapping/retrieveNatPortForwarding": { "post": { "tags": [ "samo_nat" ], "summary": "rest_nat_StaticPortMapping_retrieveNatPortForwarding", "description": "Method used to query the NE for the NAT Port Forwarding that on a specified .

Intention : RETRIEVER
retrieveNatPortForwarding:
class-level retriever API retrieveNatPortForwarding
of class nat.StaticPortMapping
DescendantInfo:
nat.StaticPortMappingL2Aware
DescendantInfo:
nat.StaticPortMappingLsn


", "operationId": "rest_nat_StaticPortMapping_retrieveNatPortForwarding", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveNatPortForwarding" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveNatPortForwardingResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/nat/SvcChainEsiMapping/retrieveEsiMappings": { "post": { "tags": [ "samo_nat" ], "summary": "rest_nat_SvcChainEsiMapping_retrieveEsiMappings", "description": "Method to retrieve ESI mapping(s) for the specified EVPN (Ethernet VPN).

Intention : RETRIEVER
retrieveEsiMappings:
class-level retriever API retrieveEsiMappings
of class nat.SvcChainEsiMapping


", "operationId": "rest_nat_SvcChainEsiMapping_retrieveEsiMappings", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveEsiMappings" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveEsiMappingsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/nat/SvcChainIpMapping/retrieveIpMappings": { "post": { "tags": [ "samo_nat" ], "summary": "rest_nat_SvcChainIpMapping_retrieveIpMappings", "description": "Method to retrieve IP mapping(s) for the specified EVPN (Ethernet VPN).

Intention : RETRIEVER
retrieveIpMappings:
class-level retriever API retrieveIpMappings
of class nat.SvcChainIpMapping


", "operationId": "rest_nat_SvcChainIpMapping_retrieveIpMappings", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveIpMappings" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveIpMappingsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/nat/SvcChainVasFilterPolicy/requestClearIsaSvcChainVasFilter": { "post": { "tags": [ "samo_nat" ], "summary": "rest_nat_SvcChainVasFilterPolicy_requestClearIsaSvcChainVasFilter", "description": "Request clearing of all NAT Sessions associated with this ISA Service Chaining VAS Filter.
When this method returns resources for the clear have been allocated but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearIsaSvcChainVasFilter:
class-level modifier API requestClearIsaSvcChainVasFilter
of class nat.SvcChainVasFilterPolicy

A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_nat_SvcChainVasFilterPolicy_requestClearIsaSvcChainVasFilter", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearIsaSvcChainVasFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearIsaSvcChainVasFilterResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ranlicense/RANLicenseManager/getLicenseUsage": { "get": { "tags": [ "samo_ranlicense" ], "summary": "rest_ranlicense_RANLicenseManager_getLicenseUsage", "description": "Synchronize NeLicense Service from Config Objects

Intention : MODIFIER
getLicenseUsage:
instance-level modifier API getLicenseUsage on default instance rlm-mgr of class ranlicense.RANLicenseManager


", "operationId": "rest_ranlicense_RANLicenseManager_getLicenseUsage", "parameters": [ { "name": "licenseFileName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getLicenseUsageResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ranlicense/RANLicenseManager/importRANLicenses": { "post": { "tags": [ "samo_ranlicense" ], "summary": "rest_ranlicense_RANLicenseManager_importRANLicenses", "operationId": "rest_ranlicense_RANLicenseManager_importRANLicenses", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/importRANLicenses" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ranlicense/RANLicenseManager/reloadRANLicenses": { "post": { "tags": [ "samo_ranlicense" ], "summary": "rest_ranlicense_RANLicenseManager_reloadRANLicenses", "operationId": "rest_ranlicense_RANLicenseManager_reloadRANLicenses", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ranlicense/RANLicenseManager/synchronizeNeLicenseServiceFromConfigObjects": { "post": { "tags": [ "samo_ranlicense" ], "summary": "rest_ranlicense_RANLicenseManager_synchronizeNeLicenseServiceFromConfigObjects", "operationId": "rest_ranlicense_RANLicenseManager_synchronizeNeLicenseServiceFromConfigObjects", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/AbstractPhysicalLink/findBwUsage/{instanceFullName}": { "get": { "tags": [ "samo_netw" ], "summary": "rest_netw_AbstractPhysicalLink_findBwUsage", "description": "This is return a list of cac.TunnelServiceMap type objects that are currently using this Physical Link

Intention : RETRIEVER
findBwUsage:
instance-level [object finder] (retriever) API findBwUsage
of class netw.AbstractPhysicalLink
DescendantInfo:
vwm.VwmPhysicalLink
DescendantInfo:
optical.OpticalLink
DescendantInfo:
netw.RadioPhysicalLink
DescendantInfo:
netw.PortTopology
DescendantInfo:
lteservice.CupsLink
DescendantInfo:
netw.LagMemberCapableLink
DescendantInfo:
netw.DiscoveredPhysicalLink
DescendantInfo:
netw.PhysicalLink
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_netw_AbstractPhysicalLink_findBwUsage", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findBwUsageResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/AdvertisedNode/purge": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_AdvertisedNode_purge", "operationId": "rest_netw_AdvertisedNode_purge", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/ConnectionTerminationPoint/findAvailableAccessCtpsPerNode": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_ConnectionTerminationPoint_findAvailableAccessCtpsPerNode", "description": "
Intention : RETRIEVER
findAvailableAccessCtpsPerNode:
class-level [object finder] (retriever) API findAvailableAccessCtpsPerNode
of class netw.ConnectionTerminationPoint
DescendantInfo:
opticalequipment.EthernetCtp
DescendantInfo:
tdm.AUn
DescendantInfo:
oth.OdukPtf
DescendantInfo:
optical.Odu1PtfChannel
DescendantInfo:
oth.OdukNimSubStructure
DescendantInfo:
netw.LogicalQosConstrainedInterfaceCtp
DescendantInfo:
rtr.IpAddressLikeCtp
DescendantInfo:
rtr.VirtualInterfaceCtp
DescendantInfo:
netw.PhysicalInterfaceCtp
DescendantInfo:
opticalequipment.OtuCtp
DescendantInfo:
opticalequipment.OduCtp
DescendantInfo:
opticalequipment.Ots
DescendantInfo:
opticalequipment.OmsOch
DescendantInfo:
optical.LoOdukChannel
DescendantInfo:
oth.Otuk
DescendantInfo:
oth.OduPoolOdukPtf
DescendantInfo:
rtr.UnnumberedInterfaceCtp
DescendantInfo:
opticalequipment.GmreOduCtpSubStructure
DescendantInfo:
oth.Oduk
DescendantInfo:
opticalequipment.OduCtpSubStructure
DescendantInfo:
opticalequipment.Oms
DescendantInfo:
rtr.DirectInterfaceCtp
DescendantInfo:
netw.QosConstrainedCtp
DescendantInfo:
tdm.TdmFacility
DescendantInfo:
netw.LogicalInterfaceCtp
DescendantInfo:
rtr.VirtualRouterIpAddress
DescendantInfo:
opticalequipment.OchCtp
DescendantInfo:
opticalequipment.OpticalInterfaceCtp
DescendantInfo:
optical.OptsgChannel
DescendantInfo:
rtr.VirtualRouterSubscriberPrefix
DescendantInfo:
oth.OdukNim
DescendantInfo:
opticalequipment.OmsOchIf
DescendantInfo:
opticalequipment.OduTermination
DescendantInfo:
opticalequipment.OpticalPortCtp
DescendantInfo:
opticalequipment.OtuTermination


", "operationId": "rest_netw_ConnectionTerminationPoint_findAvailableAccessCtpsPerNode", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAvailableAccessCtpsPerNode" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAvailableAccessCtpsPerNodeResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/ConnectionTerminationPoint/findAvailableCtpsPerNode": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_ConnectionTerminationPoint_findAvailableCtpsPerNode", "description": "
Intention : RETRIEVER
findAvailableCtpsPerNode:
class-level [object finder] (retriever) API findAvailableCtpsPerNode
of class netw.ConnectionTerminationPoint
DescendantInfo:
opticalequipment.EthernetCtp
DescendantInfo:
tdm.AUn
DescendantInfo:
oth.OdukPtf
DescendantInfo:
optical.Odu1PtfChannel
DescendantInfo:
oth.OdukNimSubStructure
DescendantInfo:
netw.LogicalQosConstrainedInterfaceCtp
DescendantInfo:
rtr.IpAddressLikeCtp
DescendantInfo:
rtr.VirtualInterfaceCtp
DescendantInfo:
netw.PhysicalInterfaceCtp
DescendantInfo:
opticalequipment.OtuCtp
DescendantInfo:
opticalequipment.OduCtp
DescendantInfo:
opticalequipment.Ots
DescendantInfo:
opticalequipment.OmsOch
DescendantInfo:
optical.LoOdukChannel
DescendantInfo:
oth.Otuk
DescendantInfo:
oth.OduPoolOdukPtf
DescendantInfo:
rtr.UnnumberedInterfaceCtp
DescendantInfo:
opticalequipment.GmreOduCtpSubStructure
DescendantInfo:
oth.Oduk
DescendantInfo:
opticalequipment.OduCtpSubStructure
DescendantInfo:
opticalequipment.Oms
DescendantInfo:
rtr.DirectInterfaceCtp
DescendantInfo:
netw.QosConstrainedCtp
DescendantInfo:
tdm.TdmFacility
DescendantInfo:
netw.LogicalInterfaceCtp
DescendantInfo:
rtr.VirtualRouterIpAddress
DescendantInfo:
opticalequipment.OchCtp
DescendantInfo:
opticalequipment.OpticalInterfaceCtp
DescendantInfo:
optical.OptsgChannel
DescendantInfo:
rtr.VirtualRouterSubscriberPrefix
DescendantInfo:
oth.OdukNim
DescendantInfo:
opticalequipment.OmsOchIf
DescendantInfo:
opticalequipment.OduTermination
DescendantInfo:
opticalequipment.OpticalPortCtp
DescendantInfo:
opticalequipment.OtuTermination


", "operationId": "rest_netw_ConnectionTerminationPoint_findAvailableCtpsPerNode", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAvailableCtpsPerNode" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAvailableCtpsPerNodeResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/ConnectionTerminationPoint/findAvailableNetworkCtpsPerNode": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_ConnectionTerminationPoint_findAvailableNetworkCtpsPerNode", "description": "
Intention : RETRIEVER
findAvailableNetworkCtpsPerNode:
class-level [object finder] (retriever) API findAvailableNetworkCtpsPerNode
of class netw.ConnectionTerminationPoint
DescendantInfo:
opticalequipment.EthernetCtp
DescendantInfo:
tdm.AUn
DescendantInfo:
oth.OdukPtf
DescendantInfo:
optical.Odu1PtfChannel
DescendantInfo:
oth.OdukNimSubStructure
DescendantInfo:
netw.LogicalQosConstrainedInterfaceCtp
DescendantInfo:
rtr.IpAddressLikeCtp
DescendantInfo:
rtr.VirtualInterfaceCtp
DescendantInfo:
netw.PhysicalInterfaceCtp
DescendantInfo:
opticalequipment.OtuCtp
DescendantInfo:
opticalequipment.OduCtp
DescendantInfo:
opticalequipment.Ots
DescendantInfo:
opticalequipment.OmsOch
DescendantInfo:
optical.LoOdukChannel
DescendantInfo:
oth.Otuk
DescendantInfo:
oth.OduPoolOdukPtf
DescendantInfo:
rtr.UnnumberedInterfaceCtp
DescendantInfo:
opticalequipment.GmreOduCtpSubStructure
DescendantInfo:
oth.Oduk
DescendantInfo:
opticalequipment.OduCtpSubStructure
DescendantInfo:
opticalequipment.Oms
DescendantInfo:
rtr.DirectInterfaceCtp
DescendantInfo:
netw.QosConstrainedCtp
DescendantInfo:
tdm.TdmFacility
DescendantInfo:
netw.LogicalInterfaceCtp
DescendantInfo:
rtr.VirtualRouterIpAddress
DescendantInfo:
opticalequipment.OchCtp
DescendantInfo:
opticalequipment.OpticalInterfaceCtp
DescendantInfo:
optical.OptsgChannel
DescendantInfo:
rtr.VirtualRouterSubscriberPrefix
DescendantInfo:
oth.OdukNim
DescendantInfo:
opticalequipment.OmsOchIf
DescendantInfo:
opticalequipment.OduTermination
DescendantInfo:
opticalequipment.OpticalPortCtp
DescendantInfo:
opticalequipment.OtuTermination


", "operationId": "rest_netw_ConnectionTerminationPoint_findAvailableNetworkCtpsPerNode", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAvailableNetworkCtpsPerNode" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAvailableNetworkCtpsPerNodeResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/ConnectionTerminationPoint/findCtp": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_ConnectionTerminationPoint_findCtp", "description": "
Intention : RETRIEVER
findCtp:
class-level [object finder] (retriever) API findCtp
of class netw.ConnectionTerminationPoint
DescendantInfo:
opticalequipment.EthernetCtp
DescendantInfo:
tdm.AUn
DescendantInfo:
oth.OdukPtf
DescendantInfo:
optical.Odu1PtfChannel
DescendantInfo:
oth.OdukNimSubStructure
DescendantInfo:
netw.LogicalQosConstrainedInterfaceCtp
DescendantInfo:
rtr.IpAddressLikeCtp
DescendantInfo:
rtr.VirtualInterfaceCtp
DescendantInfo:
netw.PhysicalInterfaceCtp
DescendantInfo:
opticalequipment.OtuCtp
DescendantInfo:
opticalequipment.OduCtp
DescendantInfo:
opticalequipment.Ots
DescendantInfo:
opticalequipment.OmsOch
DescendantInfo:
optical.LoOdukChannel
DescendantInfo:
oth.Otuk
DescendantInfo:
oth.OduPoolOdukPtf
DescendantInfo:
rtr.UnnumberedInterfaceCtp
DescendantInfo:
opticalequipment.GmreOduCtpSubStructure
DescendantInfo:
oth.Oduk
DescendantInfo:
opticalequipment.OduCtpSubStructure
DescendantInfo:
opticalequipment.Oms
DescendantInfo:
rtr.DirectInterfaceCtp
DescendantInfo:
netw.QosConstrainedCtp
DescendantInfo:
tdm.TdmFacility
DescendantInfo:
netw.LogicalInterfaceCtp
DescendantInfo:
rtr.VirtualRouterIpAddress
DescendantInfo:
opticalequipment.OchCtp
DescendantInfo:
opticalequipment.OpticalInterfaceCtp
DescendantInfo:
optical.OptsgChannel
DescendantInfo:
rtr.VirtualRouterSubscriberPrefix
DescendantInfo:
oth.OdukNim
DescendantInfo:
opticalequipment.OmsOchIf
DescendantInfo:
opticalequipment.OduTermination
DescendantInfo:
opticalequipment.OpticalPortCtp
DescendantInfo:
opticalequipment.OtuTermination


", "operationId": "rest_netw_ConnectionTerminationPoint_findCtp", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findCtp" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findCtpResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/ConnectionTerminationPoint/findCtpFiltered": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_ConnectionTerminationPoint_findCtpFiltered", "description": "
Intention : RETRIEVER
findCtpFiltered:
class-level [object finder] (retriever) API findCtpFiltered
of class netw.ConnectionTerminationPoint
DescendantInfo:
opticalequipment.EthernetCtp
DescendantInfo:
tdm.AUn
DescendantInfo:
oth.OdukPtf
DescendantInfo:
optical.Odu1PtfChannel
DescendantInfo:
oth.OdukNimSubStructure
DescendantInfo:
netw.LogicalQosConstrainedInterfaceCtp
DescendantInfo:
rtr.IpAddressLikeCtp
DescendantInfo:
rtr.VirtualInterfaceCtp
DescendantInfo:
netw.PhysicalInterfaceCtp
DescendantInfo:
opticalequipment.OtuCtp
DescendantInfo:
opticalequipment.OduCtp
DescendantInfo:
opticalequipment.Ots
DescendantInfo:
opticalequipment.OmsOch
DescendantInfo:
optical.LoOdukChannel
DescendantInfo:
oth.Otuk
DescendantInfo:
oth.OduPoolOdukPtf
DescendantInfo:
rtr.UnnumberedInterfaceCtp
DescendantInfo:
opticalequipment.GmreOduCtpSubStructure
DescendantInfo:
oth.Oduk
DescendantInfo:
opticalequipment.OduCtpSubStructure
DescendantInfo:
opticalequipment.Oms
DescendantInfo:
rtr.DirectInterfaceCtp
DescendantInfo:
netw.QosConstrainedCtp
DescendantInfo:
tdm.TdmFacility
DescendantInfo:
netw.LogicalInterfaceCtp
DescendantInfo:
rtr.VirtualRouterIpAddress
DescendantInfo:
opticalequipment.OchCtp
DescendantInfo:
opticalequipment.OpticalInterfaceCtp
DescendantInfo:
optical.OptsgChannel
DescendantInfo:
rtr.VirtualRouterSubscriberPrefix
DescendantInfo:
oth.OdukNim
DescendantInfo:
opticalequipment.OmsOchIf
DescendantInfo:
opticalequipment.OduTermination
DescendantInfo:
opticalequipment.OpticalPortCtp
DescendantInfo:
opticalequipment.OtuTermination


", "operationId": "rest_netw_ConnectionTerminationPoint_findCtpFiltered", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findCtpFilteredResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/ConnectionTerminationPoint/findCtpsOnDirectlyTerminatablePort": { "get": { "tags": [ "samo_netw" ], "summary": "rest_netw_ConnectionTerminationPoint_findCtpsOnDirectlyTerminatablePort", "description": "
Intention : RETRIEVER
findCtpsOnDirectlyTerminatablePort:
class-level [object finder] (retriever) API findCtpsOnDirectlyTerminatablePort
of class netw.ConnectionTerminationPoint
DescendantInfo:
opticalequipment.EthernetCtp
DescendantInfo:
tdm.AUn
DescendantInfo:
oth.OdukPtf
DescendantInfo:
optical.Odu1PtfChannel
DescendantInfo:
oth.OdukNimSubStructure
DescendantInfo:
netw.LogicalQosConstrainedInterfaceCtp
DescendantInfo:
rtr.IpAddressLikeCtp
DescendantInfo:
rtr.VirtualInterfaceCtp
DescendantInfo:
netw.PhysicalInterfaceCtp
DescendantInfo:
opticalequipment.OtuCtp
DescendantInfo:
opticalequipment.OduCtp
DescendantInfo:
opticalequipment.Ots
DescendantInfo:
opticalequipment.OmsOch
DescendantInfo:
optical.LoOdukChannel
DescendantInfo:
oth.Otuk
DescendantInfo:
oth.OduPoolOdukPtf
DescendantInfo:
rtr.UnnumberedInterfaceCtp
DescendantInfo:
opticalequipment.GmreOduCtpSubStructure
DescendantInfo:
oth.Oduk
DescendantInfo:
opticalequipment.OduCtpSubStructure
DescendantInfo:
opticalequipment.Oms
DescendantInfo:
rtr.DirectInterfaceCtp
DescendantInfo:
netw.QosConstrainedCtp
DescendantInfo:
tdm.TdmFacility
DescendantInfo:
netw.LogicalInterfaceCtp
DescendantInfo:
rtr.VirtualRouterIpAddress
DescendantInfo:
opticalequipment.OchCtp
DescendantInfo:
opticalequipment.OpticalInterfaceCtp
DescendantInfo:
optical.OptsgChannel
DescendantInfo:
rtr.VirtualRouterSubscriberPrefix
DescendantInfo:
oth.OdukNim
DescendantInfo:
opticalequipment.OmsOchIf
DescendantInfo:
opticalequipment.OduTermination
DescendantInfo:
opticalequipment.OpticalPortCtp
DescendantInfo:
opticalequipment.OtuTermination


", "operationId": "rest_netw_ConnectionTerminationPoint_findCtpsOnDirectlyTerminatablePort", "parameters": [ { "name": "portObjectPointer", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findCtpsOnDirectlyTerminatablePortResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/ConnectionTerminationPoint/findCtpsOnMultiplePorts": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_ConnectionTerminationPoint_findCtpsOnMultiplePorts", "description": "
Intention : RETRIEVER
findCtpsOnMultiplePorts:
class-level [object finder] (retriever) API findCtpsOnMultiplePorts
of class netw.ConnectionTerminationPoint
DescendantInfo:
opticalequipment.EthernetCtp
DescendantInfo:
tdm.AUn
DescendantInfo:
oth.OdukPtf
DescendantInfo:
optical.Odu1PtfChannel
DescendantInfo:
oth.OdukNimSubStructure
DescendantInfo:
netw.LogicalQosConstrainedInterfaceCtp
DescendantInfo:
rtr.IpAddressLikeCtp
DescendantInfo:
rtr.VirtualInterfaceCtp
DescendantInfo:
netw.PhysicalInterfaceCtp
DescendantInfo:
opticalequipment.OtuCtp
DescendantInfo:
opticalequipment.OduCtp
DescendantInfo:
opticalequipment.Ots
DescendantInfo:
opticalequipment.OmsOch
DescendantInfo:
optical.LoOdukChannel
DescendantInfo:
oth.Otuk
DescendantInfo:
oth.OduPoolOdukPtf
DescendantInfo:
rtr.UnnumberedInterfaceCtp
DescendantInfo:
opticalequipment.GmreOduCtpSubStructure
DescendantInfo:
oth.Oduk
DescendantInfo:
opticalequipment.OduCtpSubStructure
DescendantInfo:
opticalequipment.Oms
DescendantInfo:
rtr.DirectInterfaceCtp
DescendantInfo:
netw.QosConstrainedCtp
DescendantInfo:
tdm.TdmFacility
DescendantInfo:
netw.LogicalInterfaceCtp
DescendantInfo:
rtr.VirtualRouterIpAddress
DescendantInfo:
opticalequipment.OchCtp
DescendantInfo:
opticalequipment.OpticalInterfaceCtp
DescendantInfo:
optical.OptsgChannel
DescendantInfo:
rtr.VirtualRouterSubscriberPrefix
DescendantInfo:
oth.OdukNim
DescendantInfo:
opticalequipment.OmsOchIf
DescendantInfo:
opticalequipment.OduTermination
DescendantInfo:
opticalequipment.OpticalPortCtp
DescendantInfo:
opticalequipment.OtuTermination


", "operationId": "rest_netw_ConnectionTerminationPoint_findCtpsOnMultiplePorts", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findCtpsOnMultiplePorts" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findCtpsOnMultiplePortsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/ConnectionTerminationPoint/findCtpsOnMultiplePortsWithFilter": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_ConnectionTerminationPoint_findCtpsOnMultiplePortsWithFilter", "description": "
Intention : RETRIEVER
findCtpsOnMultiplePortsWithFilter:
class-level [object finder] (retriever) API findCtpsOnMultiplePortsWithFilter
of class netw.ConnectionTerminationPoint
DescendantInfo:
opticalequipment.EthernetCtp
DescendantInfo:
tdm.AUn
DescendantInfo:
oth.OdukPtf
DescendantInfo:
optical.Odu1PtfChannel
DescendantInfo:
oth.OdukNimSubStructure
DescendantInfo:
netw.LogicalQosConstrainedInterfaceCtp
DescendantInfo:
rtr.IpAddressLikeCtp
DescendantInfo:
rtr.VirtualInterfaceCtp
DescendantInfo:
netw.PhysicalInterfaceCtp
DescendantInfo:
opticalequipment.OtuCtp
DescendantInfo:
opticalequipment.OduCtp
DescendantInfo:
opticalequipment.Ots
DescendantInfo:
opticalequipment.OmsOch
DescendantInfo:
optical.LoOdukChannel
DescendantInfo:
oth.Otuk
DescendantInfo:
oth.OduPoolOdukPtf
DescendantInfo:
rtr.UnnumberedInterfaceCtp
DescendantInfo:
opticalequipment.GmreOduCtpSubStructure
DescendantInfo:
oth.Oduk
DescendantInfo:
opticalequipment.OduCtpSubStructure
DescendantInfo:
opticalequipment.Oms
DescendantInfo:
rtr.DirectInterfaceCtp
DescendantInfo:
netw.QosConstrainedCtp
DescendantInfo:
tdm.TdmFacility
DescendantInfo:
netw.LogicalInterfaceCtp
DescendantInfo:
rtr.VirtualRouterIpAddress
DescendantInfo:
opticalequipment.OchCtp
DescendantInfo:
opticalequipment.OpticalInterfaceCtp
DescendantInfo:
optical.OptsgChannel
DescendantInfo:
rtr.VirtualRouterSubscriberPrefix
DescendantInfo:
oth.OdukNim
DescendantInfo:
opticalequipment.OmsOchIf
DescendantInfo:
opticalequipment.OduTermination
DescendantInfo:
opticalequipment.OpticalPortCtp
DescendantInfo:
opticalequipment.OtuTermination


", "operationId": "rest_netw_ConnectionTerminationPoint_findCtpsOnMultiplePortsWithFilter", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findCtpsOnMultiplePortsWithFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findCtpsOnMultiplePortsWithFilterResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/DiscoveredPhysicalLink/cleanUpReference": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_DiscoveredPhysicalLink_cleanUpReference", "operationId": "rest_netw_DiscoveredPhysicalLink_cleanUpReference", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/DiscoveredPhysicalLink/cleanUpReferenceInTopologyGroup": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_DiscoveredPhysicalLink_cleanUpReferenceInTopologyGroup", "operationId": "rest_netw_DiscoveredPhysicalLink_cleanUpReferenceInTopologyGroup", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/DiscoveredPhysicalLink/cleanUpReferenceSelected": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_DiscoveredPhysicalLink_cleanUpReferenceSelected", "operationId": "rest_netw_DiscoveredPhysicalLink_cleanUpReferenceSelected", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/DiscoveredPhysicalLink/clearReference": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_DiscoveredPhysicalLink_clearReference", "operationId": "rest_netw_DiscoveredPhysicalLink_clearReference", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/DiscoveredPhysicalLink/clearReferenceInTopologyGroup": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_DiscoveredPhysicalLink_clearReferenceInTopologyGroup", "operationId": "rest_netw_DiscoveredPhysicalLink_clearReferenceInTopologyGroup", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/DiscoveredPhysicalLink/clearReferenceSelected": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_DiscoveredPhysicalLink_clearReferenceSelected", "operationId": "rest_netw_DiscoveredPhysicalLink_clearReferenceSelected", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/DiscoveredPhysicalLink/deleteDuplicatePhysicalLinks": { "delete": { "tags": [ "samo_netw" ], "summary": "rest_netw_DiscoveredPhysicalLink_deleteDuplicatePhysicalLinks", "operationId": "rest_netw_DiscoveredPhysicalLink_deleteDuplicatePhysicalLinks", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/DiscoveredPhysicalLink/setReference": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_DiscoveredPhysicalLink_setReference", "operationId": "rest_netw_DiscoveredPhysicalLink_setReference", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/DiscoveredPhysicalLink/setReferenceInTopologyGroup": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_DiscoveredPhysicalLink_setReferenceInTopologyGroup", "operationId": "rest_netw_DiscoveredPhysicalLink_setReferenceInTopologyGroup", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/DiscoveredPhysicalLink/setReferenceSelected": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_DiscoveredPhysicalLink_setReferenceSelected", "operationId": "rest_netw_DiscoveredPhysicalLink_setReferenceSelected", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/Group/addNetworkElementsToGroup/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_Group_addNetworkElementsToGroup", "description": "Adds a new NE to an existing group.

Intention : MODIFIER
addNetworkElementsToGroup:
instance-level modifier API addNetworkElementsToGroup
of class netw.Group
DescendantInfo:
netw.VlanGroup
DescendantInfo:
netw.SimpleGroup
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_netw_Group_addNetworkElementsToGroup", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/addNetworkElementsToGroupResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/Group/configure/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_Group_configure", "description": "
Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure
of class netw.Group
This API follows hierarchical config model rules.
DescendantInfo:
netw.VlanGroup
DescendantInfo:
netw.SimpleGroup
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_netw_Group_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/Group/findGroupBindings/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_Group_findGroupBindings", "description": "
Intention : RETRIEVER
findGroupBindings:
instance-level [object finder] (retriever) API findGroupBindings
of class netw.Group
DescendantInfo:
netw.VlanGroup
DescendantInfo:
netw.SimpleGroup
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_netw_Group_findGroupBindings", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findGroupBindingsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/Group/findNetworkElementsAssignableToGroup/{instanceFullName}": { "get": { "tags": [ "samo_netw" ], "summary": "rest_netw_Group_findNetworkElementsAssignableToGroup", "description": "
Intention : RETRIEVER
findNetworkElementsAssignableToGroup:
instance-level [object finder] (retriever) API findNetworkElementsAssignableToGroup
of class netw.Group
DescendantInfo:
netw.VlanGroup
DescendantInfo:
netw.SimpleGroup
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_netw_Group_findNetworkElementsAssignableToGroup", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "aInMultiGroupAllowed", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "aInGroupMode", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "aInHeadEnds", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findNetworkElementsAssignableToGroupResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/Group/findNetworkElementsInGroup/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_Group_findNetworkElementsInGroup", "description": "
Intention : RETRIEVER
findNetworkElementsInGroup:
instance-level [object finder] (retriever) API findNetworkElementsInGroup
of class netw.Group
DescendantInfo:
netw.VlanGroup
DescendantInfo:
netw.SimpleGroup
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_netw_Group_findNetworkElementsInGroup", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findNetworkElementsInGroupResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/Group/removeNetworkElementsFromGroup/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_Group_removeNetworkElementsFromGroup", "description": "Removes a NE from an existing group.

Intention : MODIFIER
removeNetworkElementsFromGroup:
instance-level [administrative deletion] (modifier) API removeNetworkElementsFromGroup
of class netw.Group
DescendantInfo:
netw.VlanGroup
DescendantInfo:
netw.SimpleGroup
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_netw_Group_removeNetworkElementsFromGroup", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/removeNetworkElementsFromGroupResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/GroupBinding/configure/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_GroupBinding_configure", "description": "
Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure
of class netw.GroupBinding
This API follows hierarchical config model rules.
DescendantInfo:
netw.VlanGroupBinding
DescendantInfo:
netw.SimpleGroupBinding
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_netw_GroupBinding_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/GroupDirector/findGroupsContainingObject": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_GroupDirector_findGroupsContainingObject", "description": "
Intention : RETRIEVER
findGroupsContainingObject:
class-level [object finder] (retriever) API findGroupsContainingObject on default instance groups of class netw.GroupDirector


", "operationId": "rest_netw_GroupDirector_findGroupsContainingObject", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findGroupsContainingObject" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findGroupsContainingObjectResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/GroupManager/configure/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_GroupManager_configure", "description": "
Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure
of class netw.GroupManager
This API follows hierarchical config model rules.
DescendantInfo:
netw.VlanGroupManager
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_netw_GroupManager_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/GroupManager/findCandidateGroupsForNewMembers/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_GroupManager_findCandidateGroupsForNewMembers", "description": "
Intention : RETRIEVER
findCandidateGroupsForNewMembers:
instance-level [object finder] (retriever) API findCandidateGroupsForNewMembers
of class netw.GroupManager
DescendantInfo:
netw.VlanGroupManager
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_netw_GroupManager_findCandidateGroupsForNewMembers", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findCandidateGroupsForNewMembersResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/GroupManager/findGroups/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_GroupManager_findGroups", "description": "
Intention : RETRIEVER
findGroups:
instance-level [object finder] (retriever) API findGroups
of class netw.GroupManager
DescendantInfo:
netw.VlanGroupManager
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_netw_GroupManager_findGroups", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findGroupsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/GroupManager/findNonMembers/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_GroupManager_findNonMembers", "description": "
Intention : RETRIEVER
findNonMembers:
instance-level [object finder] (retriever) API findNonMembers
of class netw.GroupManager
DescendantInfo:
netw.VlanGroupManager
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_netw_GroupManager_findNonMembers", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findNonMembers" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findNonMembersResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/NeStub/discover/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_NeStub_discover", "operationId": "rest_netw_NeStub_discover", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/Network/removeNe": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_Network_removeNe", "operationId": "rest_netw_Network_removeNe", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/NetworkElement/associatePeerNode/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_NetworkElement_associatePeerNode", "operationId": "rest_netw_NetworkElement_associatePeerNode", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/NetworkElement/cleanUpInconsistenciesOnNode/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_NetworkElement_cleanUpInconsistenciesOnNode", "operationId": "rest_netw_NetworkElement_cleanUpInconsistenciesOnNode", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/NetworkElement/coldReboot/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_NetworkElement_coldReboot", "operationId": "rest_netw_NetworkElement_coldReboot", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/NetworkElement/connectToConsole/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_NetworkElement_connectToConsole", "description": "
Intention : MODIFIER
connectToConsole:
instance-level modifier API connectToConsole
of class netw.NetworkElement
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_netw_NetworkElement_connectToConsole", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/connectToConsoleResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/NetworkElement/dissociatePeerNode/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_NetworkElement_dissociatePeerNode", "operationId": "rest_netw_NetworkElement_dissociatePeerNode", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/NetworkElement/doInconsistenciesExistOnNode/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_NetworkElement_doInconsistenciesExistOnNode", "description": "
Intention : RETRIEVER
doInconsistenciesExistOnNode:
instance-level retriever API doInconsistenciesExistOnNode
of class netw.NetworkElement
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_netw_NetworkElement_doInconsistenciesExistOnNode", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/doInconsistenciesExistOnNodeResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/NetworkElement/executeCli/{instanceFullName}": { "put": { "tags": [ "samo_netw" ], "summary": "rest_netw_NetworkElement_executeCli", "description": "Execute a single raw CLI command on this Network Element.

Intention : RETRIEVER
executeCli:
instance-level retriever API executeCli
of class netw.NetworkElement
instanceFullName : distinguished/instance name of called object
Any output that was generated by the NE as a
result of the command.

", "operationId": "rest_netw_NetworkElement_executeCli", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeCliResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/NetworkElement/executeMultiCli/{instanceFullName}": { "put": { "tags": [ "samo_netw" ], "summary": "rest_netw_NetworkElement_executeMultiCli", "description": "Execute multiple CLI commands on this Network Element.

Intention : RETRIEVER
executeMultiCli:
instance-level retriever API executeMultiCli
of class netw.NetworkElement
instanceFullName : distinguished/instance name of called object
Any output that was generated by the NE as a
result of the commands.

", "operationId": "rest_netw_NetworkElement_executeMultiCli", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeMultiCliResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/NetworkElement/fullResync/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_NetworkElement_fullResync", "operationId": "rest_netw_NetworkElement_fullResync", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/NetworkElement/fullResyncMulti/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_NetworkElement_fullResyncMulti", "operationId": "rest_netw_NetworkElement_fullResyncMulti", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/NetworkElement/getSearchResult/{instanceFullName}": { "get": { "tags": [ "samo_netw" ], "summary": "rest_netw_NetworkElement_getSearchResult", "description": "
Intention : RETRIEVER
getSearchResult:
instance-level retriever API getSearchResult
of class netw.NetworkElement
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_netw_NetworkElement_getSearchResult", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "aInXmlSearchCmd", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getSearchResultResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/NetworkElement/getSearchSuggestionCache/{instanceFullName}": { "get": { "tags": [ "samo_netw" ], "summary": "rest_netw_NetworkElement_getSearchSuggestionCache", "description": "
Intention : RETRIEVER
getSearchSuggestionCache:
instance-level retriever API getSearchSuggestionCache
of class netw.NetworkElement
instanceFullName : distinguished/instance name of called object
A map of attribute list by classname.

", "operationId": "rest_netw_NetworkElement_getSearchSuggestionCache", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "aInDeprecatedEnable", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getSearchSuggestionCacheResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/NetworkElement/reconfigure/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_NetworkElement_reconfigure", "operationId": "rest_netw_NetworkElement_reconfigure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/NetworkElement/reconfigureMulti/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_NetworkElement_reconfigureMulti", "operationId": "rest_netw_NetworkElement_reconfigureMulti", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/NetworkElement/registerHDMDashboard/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_NetworkElement_registerHDMDashboard", "operationId": "rest_netw_NetworkElement_registerHDMDashboard", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/NetworkElement/requestClearSystemStatsDataTrigger": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_NetworkElement_requestClearSystemStatsDataTrigger", "description": "Request clearing of Data-Triggered Subscriber Host Stats with the specified parameters.
The siteId is required.
When this method returns resources for the clear have been allocated but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearSystemStatsDataTrigger:
class-level modifier API requestClearSystemStatsDataTrigger
of class netw.NetworkElement

A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_netw_NetworkElement_requestClearSystemStatsDataTrigger", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClearSystemStatsDataTriggerStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearSystemStatsDataTriggerResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/NetworkElement/requestResyncCfmComponentLimit/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_NetworkElement_requestResyncCfmComponentLimit", "operationId": "rest_netw_NetworkElement_requestResyncCfmComponentLimit", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/NetworkElement/requestResyncCfmGlobalOpcode/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_NetworkElement_requestResyncCfmGlobalOpcode", "operationId": "rest_netw_NetworkElement_requestResyncCfmGlobalOpcode", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/NetworkElement/requestResyncOamPerfReqTypes/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_NetworkElement_requestResyncOamPerfReqTypes", "operationId": "rest_netw_NetworkElement_requestResyncOamPerfReqTypes", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/NetworkElement/requestResyncTwampSrvSessions/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_NetworkElement_requestResyncTwampSrvSessions", "operationId": "rest_netw_NetworkElement_requestResyncTwampSrvSessions", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/NetworkElement/requestSavePythonScript": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_NetworkElement_requestSavePythonScript", "operationId": "rest_netw_NetworkElement_requestSavePythonScript", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestSavePythonScript" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/NetworkElement/resyncDetNatScript/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_NetworkElement_resyncDetNatScript", "operationId": "rest_netw_NetworkElement_resyncDetNatScript", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/NetworkElement/saveDetNatScript/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_NetworkElement_saveDetNatScript", "operationId": "rest_netw_NetworkElement_saveDetNatScript", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/NetworkElement/setToActive/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_NetworkElement_setToActive", "operationId": "rest_netw_NetworkElement_setToActive", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/NetworkElement/setToStandby/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_NetworkElement_setToStandby", "operationId": "rest_netw_NetworkElement_setToStandby", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/NetworkElement/synchronizeACL/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_NetworkElement_synchronizeACL", "operationId": "rest_netw_NetworkElement_synchronizeACL", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/NetworkElement/unregisterHDMDashboard/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_NetworkElement_unregisterHDMDashboard", "operationId": "rest_netw_NetworkElement_unregisterHDMDashboard", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/NetworkElement/updateFromPeerNode/{instanceFullName}": { "put": { "tags": [ "samo_netw" ], "summary": "rest_netw_NetworkElement_updateFromPeerNode", "operationId": "rest_netw_NetworkElement_updateFromPeerNode", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/NetworkElement/warmReboot/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_NetworkElement_warmReboot", "operationId": "rest_netw_NetworkElement_warmReboot", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/NodeDiscoveryControl/ping/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_NodeDiscoveryControl_ping", "operationId": "rest_netw_NodeDiscoveryControl_ping", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/NodeDiscoveryControl/pingAndGetResult/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_NodeDiscoveryControl_pingAndGetResult", "description": "Execute network element reachability test based on network element management connection type
and return the ping status enum {{mediation.PingStatus}}. It waits for the result and then returns
so there may be delay due to network or timeout.

Intention : RETRIEVER
pingAndGetResult:
instance-level retriever API pingAndGetResult
of class netw.NodeDiscoveryControl
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_netw_NodeDiscoveryControl_pingAndGetResult", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pingAndGetResultResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/PhysicalInterfaceCtp/findServiceReadyCtpsPerNode": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_PhysicalInterfaceCtp_findServiceReadyCtpsPerNode", "description": "
Intention : RETRIEVER
findServiceReadyCtpsPerNode:
class-level [object finder] (retriever) API findServiceReadyCtpsPerNode
of class netw.PhysicalInterfaceCtp


", "operationId": "rest_netw_PhysicalInterfaceCtp_findServiceReadyCtpsPerNode", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findServiceReadyCtpsPerNode" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findServiceReadyCtpsPerNodeResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/SystemOperGroup/findMeps/{instanceFullName}": { "get": { "tags": [ "samo_netw" ], "summary": "rest_netw_SystemOperGroup_findMeps", "description": "
Intention : RETRIEVER
findMeps:
instance-level [object finder] (retriever) API findMeps
of class netw.SystemOperGroup
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_netw_SystemOperGroup_findMeps", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findMepsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/SystemOperGroup/findPorts/{instanceFullName}": { "get": { "tags": [ "samo_netw" ], "summary": "rest_netw_SystemOperGroup_findPorts", "description": "
Intention : RETRIEVER
findPorts:
instance-level [object finder] (retriever) API findPorts
of class netw.SystemOperGroup
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_netw_SystemOperGroup_findPorts", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findPortsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/Topology/configureDiscoveryRule": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_Topology_configureDiscoveryRule", "description": "
Intention : MODIFIER
configureDiscoveryRule:
instance-level [hierarchical administrative configuration/modification] (modifier) API configureDiscoveryRule on default instance network:topology of class netw.Topology
This API follows hierarchical config model rules.


", "operationId": "rest_netw_Topology_configureDiscoveryRule", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopologyDiscoveryRuleConfigInfo" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureDiscoveryRuleResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/Topology/findUnDiscoveredNodes": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_Topology_findUnDiscoveredNodes", "description": "Finds nodes within a set of discovery rules that have not been discovered.

Intention : RETRIEVER
findUnDiscoveredNodes:
instance-level [object finder] (retriever) API findUnDiscoveredNodes on default instance network:topology of class netw.Topology

List of Mgmt IP addresses corresponding to the nodes in all specified discovery rule
instances that have not been discovered.

", "operationId": "rest_netw_Topology_findUnDiscoveredNodes", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findUnDiscoveredNodesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/TopologyDiscoveryRule/assignNodes/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_TopologyDiscoveryRule_assignNodes", "operationId": "rest_netw_TopologyDiscoveryRule_assignNodes", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/TopologyDiscoveryRule/configureRuleElement/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_TopologyDiscoveryRule_configureRuleElement", "description": "
Intention : MODIFIER
configureRuleElement:
instance-level [hierarchical administrative configuration/modification] (modifier) API configureRuleElement
of class netw.TopologyDiscoveryRule
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_netw_TopologyDiscoveryRule_configureRuleElement", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopologyDiscoveryRuleElementConfigInfo" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureRuleElementResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/TopologyDiscoveryRule/findDiscoveredNodes/{instanceFullName}": { "get": { "tags": [ "samo_netw" ], "summary": "rest_netw_TopologyDiscoveryRule_findDiscoveredNodes", "description": "Finds nodes within this discovery rule that have been discovered.

Intention : RETRIEVER
findDiscoveredNodes:
instance-level [object finder] (retriever) API findDiscoveredNodes
of class netw.TopologyDiscoveryRule
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_netw_TopologyDiscoveryRule_findDiscoveredNodes", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findDiscoveredNodesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/TopologyDiscoveryRule/findUnDiscoveredNodes/{instanceFullName}": { "get": { "tags": [ "samo_netw" ], "summary": "rest_netw_TopologyDiscoveryRule_findUnDiscoveredNodes", "description": "Finds nodes within this discovery rule that have not been discovered.

Intention : RETRIEVER
findUnDiscoveredNodes:
instance-level [object finder] (retriever) API findUnDiscoveredNodes
of class netw.TopologyDiscoveryRule
instanceFullName : distinguished/instance name of called object
List of Mgmt IP addresses corresponding to the nodes in the specified discovery rule
instance that have not been discovered.

", "operationId": "rest_netw_TopologyDiscoveryRule_findUnDiscoveredNodes", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findUnDiscoveredNodesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/TopologyDiscoveryRule/force/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_TopologyDiscoveryRule_force", "operationId": "rest_netw_TopologyDiscoveryRule_force", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/TopologyGroup/deleteTopologyGroupAndBindings/{instanceFullName}": { "delete": { "tags": [ "samo_netw" ], "summary": "rest_netw_TopologyGroup_deleteTopologyGroupAndBindings", "operationId": "rest_netw_TopologyGroup_deleteTopologyGroupAndBindings", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/TopologyGroup/getBindingsForTopologyGroup": { "get": { "tags": [ "samo_netw" ], "summary": "rest_netw_TopologyGroup_getBindingsForTopologyGroup", "description": "
Intention : RETRIEVER
getBindingsForTopologyGroup:
class-level retriever API getBindingsForTopologyGroup
of class netw.TopologyGroup


", "operationId": "rest_netw_TopologyGroup_getBindingsForTopologyGroup", "parameters": [ { "name": "topologyGroupName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getBindingsForTopologyGroupResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/TopologyGroupManager/configureTopologyGroup": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_TopologyGroupManager_configureTopologyGroup", "description": "
Intention : MODIFIER
configureTopologyGroup:
instance-level [hierarchical administrative configuration/modification] (modifier) API configureTopologyGroup on default instance topologyGroup of class netw.TopologyGroupManager
This API follows hierarchical config model rules.


", "operationId": "rest_netw_TopologyGroupManager_configureTopologyGroup", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureTopologyGroup" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureTopologyGroupResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/TopologyGroupManager/createTopologyGroupBindingForObject": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_TopologyGroupManager_createTopologyGroupBindingForObject", "operationId": "rest_netw_TopologyGroupManager_createTopologyGroupBindingForObject", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createTopologyGroupBindingForObject" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/TopologyGroupManager/getNesAndSubgroupsForTopologyGroup": { "get": { "tags": [ "samo_netw" ], "summary": "rest_netw_TopologyGroupManager_getNesAndSubgroupsForTopologyGroup", "description": "
Intention : RETRIEVER
getNesAndSubgroupsForTopologyGroup:
class-level retriever API getNesAndSubgroupsForTopologyGroup on default instance topologyGroup of class netw.TopologyGroupManager


", "operationId": "rest_netw_TopologyGroupManager_getNesAndSubgroupsForTopologyGroup", "parameters": [ { "name": "topologyGroupName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getNesAndSubgroupsForTopologyGroupResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netw/TopologyGroupManager/moveTopologyGroupForObjects": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_TopologyGroupManager_moveTopologyGroupForObjects", "operationId": "rest_netw_TopologyGroupManager_moveTopologyGroupForObjects", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/moveTopologyGroupForObjects" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/VlanGroup/addLeafNode/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_VlanGroup_addLeafNode", "operationId": "rest_netw_VlanGroup_addLeafNode", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/VlanGroup/autoL3VPNInit/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_VlanGroup_autoL3VPNInit", "operationId": "rest_netw_VlanGroup_autoL3VPNInit", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/VlanGroup/autoMplsEnable/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_VlanGroup_autoMplsEnable", "operationId": "rest_netw_VlanGroup_autoMplsEnable", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/VlanGroup/dynamicL3VPNInit/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_VlanGroup_dynamicL3VPNInit", "operationId": "rest_netw_VlanGroup_dynamicL3VPNInit", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/VlanGroup/dynamicRemoveNodes/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_VlanGroup_dynamicRemoveNodes", "operationId": "rest_netw_VlanGroup_dynamicRemoveNodes", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/VlanGroup/removeLeafNode/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_VlanGroup_removeLeafNode", "operationId": "rest_netw_VlanGroup_removeLeafNode", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netw/VlanGroup/removeNodes/{instanceFullName}": { "post": { "tags": [ "samo_netw" ], "summary": "rest_netw_VlanGroup_removeNodes", "operationId": "rest_netw_VlanGroup_removeNodes", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ptp/IEEEPTPPeer/resetPTPCounters/{instanceFullName}": { "post": { "tags": [ "samo_ptp" ], "summary": "rest_ptp_IEEEPTPPeer_resetPTPCounters", "operationId": "rest_ptp_IEEEPTPPeer_resetPTPCounters", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ptp/IEEEPTPSyncDomain/findPtpPeers/{instanceFullName}": { "post": { "tags": [ "samo_ptp" ], "summary": "rest_ptp_IEEEPTPSyncDomain_findPtpPeers", "operationId": "rest_ptp_IEEEPTPSyncDomain_findPtpPeers", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findPtpPeers" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ptp/IEEEPTPSyncManager/createBidirMonitoredIpPath": { "post": { "tags": [ "samo_ptp" ], "summary": "rest_ptp_IEEEPTPSyncManager_createBidirMonitoredIpPath", "operationId": "rest_ptp_IEEEPTPSyncManager_createBidirMonitoredIpPath", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ptp/IEEEPTPSyncManager/createMonitoredIpPath": { "post": { "tags": [ "samo_ptp" ], "summary": "rest_ptp_IEEEPTPSyncManager_createMonitoredIpPath", "operationId": "rest_ptp_IEEEPTPSyncManager_createMonitoredIpPath", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/rca/RcaManager/asyncCheckConfig": { "post": { "tags": [ "samo_rca" ], "summary": "rest_rca_RcaManager_asyncCheckConfig", "operationId": "rest_rca_RcaManager_asyncCheckConfig", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/asyncCheckConfig" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/rca/RcaManager/checkConfig": { "post": { "tags": [ "samo_rca" ], "summary": "rest_rca_RcaManager_checkConfig", "description": "call validate on the object

Intention : MODIFIER
checkConfig:
class-level modifier API checkConfig on default instance rca-mgr of class rca.RcaManager


", "operationId": "rest_rca_RcaManager_checkConfig", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkConfig" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/checkConfigResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rca/RcaManager/deleteProblems": { "delete": { "tags": [ "samo_rca" ], "summary": "rest_rca_RcaManager_deleteProblems", "operationId": "rest_rca_RcaManager_deleteProblems", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/rca/RcaManager/fixProblem": { "post": { "tags": [ "samo_rca" ], "summary": "rest_rca_RcaManager_fixProblem", "description": "call to fix the problem on the object

Intention : RETRIEVER
fixProblem:
class-level retriever API fixProblem on default instance rca-mgr of class rca.RcaManager


", "operationId": "rest_rca_RcaManager_fixProblem", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fixProblem" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fixProblemResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rca/RcaManager/preFixProblem": { "post": { "tags": [ "samo_rca" ], "summary": "rest_rca_RcaManager_preFixProblem", "description": "call to show what will be impact by fixing this problem or can be fixed.

Intention : MODIFIER
preFixProblem:
class-level modifier API preFixProblem on default instance rca-mgr of class rca.RcaManager


", "operationId": "rest_rca_RcaManager_preFixProblem", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preFixProblem" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preFixProblemResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/url/decode/framework/query": { "post": { "tags": [ "samo_url" ], "summary": "rest_url_decode_string_framework", "description": "An API service to decode Query parameters. It can be used to show how Query parameters can be decoded. Developpers can use this interface to see the result of the decoded string as a query parameter. ", "operationId": "rest_url_decode_string_framework", "parameters": [ { "name": "instanceFullName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/x-www-form-urlencoded" ], "type": "string" } } ], "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/URLDecoderResult" } } } }, "204": { "description": "Result will return synchronously", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/URLDecoderResult" } } } }, "400": { "description": "Not found", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/url/decode/queryparam": { "post": { "tags": [ "samo_url" ], "summary": "rest_url_query_findInstance", "description": "Test Query Parameter Decoding.\nAn API service to decode a query parameters. It can be used to show how query parameters can be decoded. Developpers can use this interface to see the result of the decoded string as a query parameter. The string being decoded can have many iterations.For example, the client makes the following HTTP request using a double ecoding string. See the encoding example:\n\n POST /v2/url/decode/queryparam?instanceFullName=XATzChm4-macsmgr%25253Aca-a%252B%252523%252Bb%252B%252525%252Bc%252B%252524%252Bd%252B%252521%252Be%252B%252526%252B*%25253Ascak%25253Apsk-1 HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n Content-Type: application/json\n\n 1 \n\n", "operationId": "rest_url_query_findInstance", "parameters": [ { "name": "instanceFullName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/URLDecoderResult" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/url/decode/{instanceFullName}/pathparam": { "post": { "tags": [ "samo_url" ], "summary": "rest_url_decode_string", "description": "An API service to decode a path parameters. It can be used to show how path parameters can be decoded. Developpers can use this interface to see the result of the decoded string as a path parameter. The string being decoded can have many iterations.For example, the client makes the following HTTP request using a double ecoding string. See the encoding example:\n\n POST /v2/url/decode/XATzChm4-macsmgr%25253Aca-a%252B%252523%252Bb%252B%252525%252Bc%252B%252524%252Bd%252B%252521%252Be%252B%252526%252B*%25253Ascak%25253Apsk-1%25255C%25252B/pathparam HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n Content-Type: application/json\n\n 2 \n\n", "operationId": "rest_url_decode_string", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "integer", "format": "int32" } } }, "required": false }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/URLDecoderResult" } } } }, "204": { "description": "Result will return synchronously", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/URLDecoderResult" } } } }, "400": { "description": "Not found", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/url/encode": { "post": { "tags": [ "samo_url" ], "summary": "rest_url_encode_string", "description": "An API service to encode a path parameters. It can be used to show how path parameters can be encoded. Developpers can use this interface to see the result of the encoded string as a path parameter. The string being encoded can have many encoded iterations.For example, the client makes the following HTTP request:\n\n POST /v2/url/encode HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n Content-Type: application/json\n\n { \n \"stringToEncode\": \"XATzChm4-macsmgr:ca-a # b % c $ d ! e & *:scak:psk-1\"\n \"encodingIteration\": \"2\" \n }\n\n", "operationId": "rest_url_encode_string", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/URLToEncode" } } }, "required": false }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "text/plain": { "schema": { "type": "string" } } } }, "204": { "description": "Result will return synchronously", "headers": {}, "content": { "text/plain": { "schema": { "type": "string" } } } }, "400": { "description": "Not found", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/spanrules/ServiceCreationSpanRule/findAssociatedSamUserGroups/{instanceFullName}": { "post": { "tags": [ "samo_spanrules" ], "summary": "rest_spanrules_ServiceCreationSpanRule_findAssociatedSamUserGroups", "description": "Finds all user groups that are assigned to the format or range policies under this span rule.

Intention : RETRIEVER
findAssociatedSamUserGroups:
instance-level [object finder] (retriever) API findAssociatedSamUserGroups
of class spanrules.ServiceCreationSpanRule
instanceFullName : distinguished/instance name of called object
List of object summaries

", "operationId": "rest_spanrules_ServiceCreationSpanRule_findAssociatedSamUserGroups", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAssociatedSamUserGroupsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/spanrules/ServiceCreationSpanRule/findAssociatedSamUsers/{instanceFullName}": { "post": { "tags": [ "samo_spanrules" ], "summary": "rest_spanrules_ServiceCreationSpanRule_findAssociatedSamUsers", "description": "Finds all users that are assigned to the format or range policies under this span rule.

Intention : RETRIEVER
findAssociatedSamUsers:
instance-level [object finder] (retriever) API findAssociatedSamUsers
of class spanrules.ServiceCreationSpanRule
instanceFullName : distinguished/instance name of called object
List of object summaries

", "operationId": "rest_spanrules_ServiceCreationSpanRule_findAssociatedSamUsers", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAssociatedSamUsersResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/log/LogPolicy/purge": { "post": { "tags": [ "samo_log" ], "summary": "rest_log_LogPolicy_purge", "operationId": "rest_log_LogPolicy_purge", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/purge" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/nqueue/Policy/findMDAs/{instanceFullName}": { "get": { "tags": [ "samo_nqueue" ], "summary": "rest_nqueue_Policy_findMDAs", "description": "
Intention : RETRIEVER
findMDAs:
instance-level [object finder] (retriever) API findMDAs
of class nqueue.Policy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_nqueue_Policy_findMDAs", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findMDAsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/nqueue/Policy/findPorts/{instanceFullName}": { "get": { "tags": [ "samo_nqueue" ], "summary": "rest_nqueue_Policy_findPorts", "description": "
Intention : RETRIEVER
findPorts:
instance-level [object finder] (retriever) API findPorts
of class nqueue.Policy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_nqueue_Policy_findPorts", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findPortsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/clear/ClearCommandManager/retrieveClearRequest": { "post": { "tags": [ "samo_clear" ], "summary": "rest_clear_ClearCommandManager_retrieveClearRequest", "description": "Retrieve a request to obtain its result.

Intention : RETRIEVER
retrieveClearRequest:
instance-level retriever API retrieveClearRequest on default instance clear-cmd-mgr of class clear.ClearCommandManager

The request referenced by the handle or null if the handle
has become invalid (the request is cleaned up by NFM-P or it
has been reused for a more recent clear request).

", "operationId": "rest_clear_ClearCommandManager_retrieveClearRequest", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestHandleStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveClearRequestResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v1/managedobjects": { "post": { "tags": [ "samo_managed objects" ], "summary": "rest_createChild", "description": "Returns JSON-formatted data upon successful creation of the object. For example, to create a child object, make the following HTTP request. \n\n POST /v1/managedobjects HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA\n Content-Type: application/json\n {\n \"fdn\": \"pollerManager\",\n \"configInfo\": {\n \"fullClassName\": \"security.MediationPolicy\",\n \"properties\": {\n \"snmpPort\": 161,\n \"securityModel\": \"snmpv3\",\n \"displayedName\": \"SnmpV3 - for eNB28\",\n \"ftpUserName\": \"admin\",\n \"ftpReadTimeout\": 500,\n \"userObjectPointer\": \"SR Local User:initial_snm\",\n \"netconfPort\": 8300,\n \"netconfRetry\": 0,\n \"snmpTimeout\": 20000,\n \"fileTransferType\": \"ftp\",\n \"cliCommunicationProtocol\": \"telnet\",\n \"community\": \"private\",\n \"netconfConnectTimeout\": 100,\n \"cliUserName\": \"user_name\",\n \"snmpRetry\": 2,\n \"ftpConnectTimeout\": 115,\n \"netconfUserPassword\": \"@t9n;_EBQb\"\n \n } \n } \n } \n \n\nNote: Unset properties are supported by this endpoint.\nNote:Support for the ‘/nfm-p/rest/api/v1’ API will be available up to NSP 22.11 and removed in NSP 23.03.", "operationId": "rest_createChild", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestfulConfigurationContainer" } } }, "required": false }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "type": "string" } } } }, "201": { "description": "Successful request. The child object has been created", "headers": {}, "content": {} }, "400": { "description": "Bad request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "403": { "description": "Access denied", "headers": {}, "content": {} }, "404": { "description": "Object not found", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v1/managedobjects/children": { "post": { "tags": [ "samo_managed objects" ], "summary": "findWithChildren", "description": "Returns a JSON-formatted response for this FDN and all children specified by the fullClassNameList. For example, the client makes the following HTTP request:\n \n\n POST /v1/managedobjects/children HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n Content-Type: application/json\n\n {\"fdn\":\"securityManager\", \"fullClassNameList\":[\"security.User\",\"security.UserGroup\"]}\n\n\nNote: Support for the ‘/nfm-p/rest/api/v1’ API will be available up to NSP 22.11 and removed in NSP 23.03. ", "operationId": "findWithChildren", "parameters": [], "requestBody": { "description": "The desired FDN and the children class names", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FndAndClassList" }, { "description": "The desired FDN and the children class names" } ] } } }, "required": false }, "responses": { "200": { "description": "Successful request, the object specified by this FDN and its immediate children specified by the fullClassNameList are returned.", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" } } } } }, "400": { "description": "Invalid parameter", "headers": {}, "content": {} }, "404": { "description": "ManagedObjects not found", "headers": {}, "content": {} }, "500": { "description": "Internal server error", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v1/managedobjects/search": { "post": { "tags": [ "samo_managed objects" ], "summary": "queryForClassesWithFilter", "description": "Returns a JSON-formatted response representing the object identified by this fullClassNameList and simpleAttributeAndFilter.\n For example, the client makes the following HTTP request:\n\n POST /v1/managedobjects/search HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n Content-Type: application/json\n\n { \"fullClassName\": \"security.User\", \"simpleAttributeAndFilter\": { \"userName\":\"admin\"} }\n\nNote: Filter is optional. If filter is configured, all objects whose attributes match the filter are returned. \n\n POST /v1/managedobjects/search HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n Content-Type: application/json\n { \"fullClassName\": \"security.User\"} \n\nWhen using the endpoint with no filter, all instances of that specific class, will be returned.\nNote: Support for the ‘/nfm-p/rest/api/v1’ API will be available up to NSP 22.11 and removed in NSP 23.03.", "operationId": "queryForClassesWithFilter", "parameters": [], "requestBody": { "description": "Configured parameter values of the object for which to search.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SearchClassData" }, { "description": "Configured parameter values of the object for which to search." } ] } } }, "required": true }, "responses": { "200": { "description": "Successful retrieval of class instance", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" }, "description": "" } } } }, "404": { "description": "Invalid input parameter", "headers": {}, "content": {} }, "500": { "description": "Internal server error", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v1/managedobjects/searchWithFilter": { "post": { "tags": [ "samo_managed objects" ], "summary": "queryForClassesWithRestFilter", "description": "Returns a JSON-formatted response representing the object identified by this fullClass, filterExpression and resultFilter.\n For example, the client makes the following HTTP request:\n\n POST /v1/managedobjects/searchWithFilter HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n Content-Type: application/json\n\n { \n \"fullClassName\": \"security.UserGroup\", \n \"resultFilter\":[\"name\",\"spanOfControlProfileName\",\"description\"], \n \"filterExpression\": \"groupName='admin' OR scopeOfCommandProfileName='admin'\" \n }\n\nNote: Filter is optional. If filter is configured, all objects whose attributes match the filter are returned. \n\n POST /v1/managedobjects/searchWithFilter HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n Content-Type: application/json\n { \"fullClassName\": \"security.User\"} \n\nWhen using the endpoint with no filter, all instances of that specific class, will be returned.\nNote: Support for the ‘/nfm-p/rest/api/v1’ API will be available up to NSP 22.11 and removed in NSP 23.03.", "operationId": "queryForClassesWithRestFilter", "parameters": [], "requestBody": { "description": "Configured parameter values of the object for which to search.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FindClassWithFilter" }, { "description": "Configured parameter values of the object for which to search." } ] } } }, "required": true }, "responses": { "200": { "description": "Successful retrieval of class instance", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" }, "description": "" } } } }, "404": { "description": "Invalid input parameter", "headers": {}, "content": {} }, "500": { "description": "Internal server error", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v1/managedobjects/{fdn}": { "get": { "tags": [ "samo_managed objects" ], "summary": "produceJSON", "description": "Returns a JSON-formatted response for a given managed object. For example, to find an object using NFM-P's FDN, make the following HTTP request:\n\n GET /v1/managedobjects/securityManager HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA\n Content-Type: application/json\n\n\n The NFM-P server returns JSON-formatted data for the requested FDN.\n\nNote: Client applications using this endpoint should apply html encoding twice to the FDN path parameter.\n Support for the ‘/nfm-p/rest/api/v1’ API will be available up to NSP 22.11 and removed in NSP 23.03.", "operationId": "produceJSON", "parameters": [ { "name": "fdn", "in": "path", "description": "FDN of the NFM-P managed object for which to search.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful request, the Managed Object is returned", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" } } } } }, "400": { "description": "Invalid FDN supplied", "headers": {}, "content": {} }, "404": { "description": "ManagedObject not found", "headers": {}, "content": {} }, "500": { "description": "Internal server error", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] }, "put": { "tags": [ "samo_managed objects" ], "summary": "rest_modify", "description": "This method returns the newly-configured parameters of the object. For example, the client makes the following HTTP request: \n POST /v1/managedobjects/pollerManager%3Amediation-security-2 HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA\n Content-Type: application/json\n \n {\n \"fullClassName\": \"security.MediationPolicy\",\n \"properties\": {\n \"snmpPort\": 161,\n \"securityModel\": \"snmpv3\",\n \"displayedName\": \"SnmpV3 - for eNB299\",\n \"ftpUserName\": \"admin\",\n \"ftpReadTimeout\": 500,\n \"userObjectPointer\": \"SR Local User:initial_snm\",\n \"netconfPort\": 8300,\n \"netconfRetry\": 0,\n \"snmpTimeout\": 20000,\n \"fileTransferType\": \"ftp\",\n \"cliCommunicationProtocol\": \"telnet\",\n \"community\": \"private\",\n \"netconfConnectTimeout\": 100,\n \"cliUserName\": \"user_name\",\n \"snmpRetry\": 2,\n \"ftpConnectTimeout\": 115,\n \"netconfUserPassword\": \"@t9n;_EBQb\"\n } \n } \n \n \n Client applications using this endpoint should apply html encoding twice to the FDN path parameter.\n \nThe 'fullClassName' attribute is the packageName.className of the object itself.\n \nThe attribute 'children' is not applicable. Please refer to the implementation node for more information.\n\nNote: Unset properties are supported by this endpoint.\nSupport for the ‘/nfm-p/rest/api/v1’ API will be available up to NSP 22.11 and removed in NSP 23.03.", "operationId": "rest_modify", "parameters": [ { "name": "fdn", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configInfo" } } }, "required": false }, "responses": { "200": { "description": "Successful request. The object and children have been created and/or modified", "headers": {}, "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "403": { "description": "Access denied", "headers": {}, "content": {} }, "404": { "description": "Object not found", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] }, "delete": { "tags": [ "samo_managed objects" ], "summary": "rest_GenericObject_deleteInstance", "description": "This method does not return any data on successful deletion of an object. For example, to delete an object using NFM-P's FDN, make the following HTTP request. \n\n DELETE /v1/managedobjects/pollerManager%253Amediation-security-8 HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA\n Content-Type: application/json\n\n\n\n\nNote: Client applications using this endpoint should apply html encoding twice to the FDN path parameter.\nSupport for the ‘/nfm-p/rest/api/v1’ API will be available up to NSP 22.11 and removed in NSP 23.03.", "operationId": "rest_GenericObject_deleteInstance", "parameters": [ { "name": "fdn", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successful request, object has been deleted. No content is returned as part of the response.", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "403": { "description": "Access denied", "headers": {}, "content": {} }, "404": { "description": "Object not found", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v1/managedobjects/{fdn}/children": { "post": { "tags": [ "samo_managed objects" ], "summary": "findWithChildren", "description": "Returns a JSON-formatted response for this FDN and all children specified by the array of childClassName and resultFilter list. For example, the client makes the following HTTP request:\n \n\n POST /v1/managedobjects/securityManager/children HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 1eW2zZEKjY3r9WS6Ek7QAiUatKlplVaNWiTM7ElAQ0M%3D\n Content-Type: application/json\n\n [ {\"childClassName\":\"security.UserGroup\", \"resultFilter\":[\"name\",\"scopeOfCommandProfileName\"]} ]\n\n\nNote: Support for the ‘/nfm-p/rest/api/v1’ API will be available up to NSP 22.11 and removed in NSP 23.03.", "operationId": "PostfindWithChildren", "parameters": [ { "name": "fdn", "in": "path", "description": "The desired FDN and the children class names", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FindChildWithResultFilter" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Successful request, the object specified by this FDN and its immediate children specified by the fullClassNameList are returned.", "headers": {}, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" } } } } }, "400": { "description": "Invalid parameter", "headers": {}, "content": {} }, "404": { "description": "ManagedObjects not found", "headers": {}, "content": {} }, "500": { "description": "Internal server error", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/netca/CardStatsTCAProfile/clearPMCountersForSelected": { "post": { "tags": [ "samo_netca" ], "summary": "rest_netca_CardStatsTCAProfile_clearPMCountersForSelected", "operationId": "rest_netca_CardStatsTCAProfile_clearPMCountersForSelected", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clearPMCountersForSelected" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/netca/CardStatsTCAProfile/findPorts/{instanceFullName}": { "get": { "tags": [ "samo_netca" ], "summary": "rest_netca_CardStatsTCAProfile_findPorts", "description": "
Intention : RETRIEVER
findPorts:
instance-level [object finder] (retriever) API findPorts
of class netca.CardStatsTCAProfile
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_netca_CardStatsTCAProfile_findPorts", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findPortsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rip/AuthenticationKey/removeAuthenticationKey/{instanceFullName}": { "post": { "tags": [ "samo_rip" ], "summary": "rest_rip_AuthenticationKey_removeAuthenticationKey", "operationId": "rest_rip_AuthenticationKey_removeAuthenticationKey", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/rip/Interface/configure/{instanceFullName}": { "post": { "tags": [ "samo_rip" ], "summary": "rest_rip_Interface_configure", "description": "
Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure
of class rip.Interface
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_rip_Interface_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rip/Site/configure/{instanceFullName}": { "post": { "tags": [ "samo_rip" ], "summary": "rest_rip_Site_configure", "description": "
Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure
of class rip.Site
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_rip_Site_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/l2fib/FibEntry/clearFib": { "post": { "tags": [ "samo_l2fib" ], "summary": "rest_l2fib_FibEntry_clearFib", "operationId": "rest_l2fib_FibEntry_clearFib", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/l2fib/FibEntry/defineFibEntries": { "post": { "tags": [ "samo_l2fib" ], "summary": "rest_l2fib_FibEntry_defineFibEntries", "operationId": "rest_l2fib_FibEntry_defineFibEntries", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/defineFibEntries" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/l2fib/FibEntry/defineFibEntry": { "post": { "tags": [ "samo_l2fib" ], "summary": "rest_l2fib_FibEntry_defineFibEntry", "operationId": "rest_l2fib_FibEntry_defineFibEntry", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/defineFibEntry" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/l2fib/FibEntry/forceAutocomplete": { "post": { "tags": [ "samo_l2fib" ], "summary": "rest_l2fib_FibEntry_forceAutocomplete", "operationId": "rest_l2fib_FibEntry_forceAutocomplete", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/l2fib/FibEntry/makeEntryFibStatic": { "post": { "tags": [ "samo_l2fib" ], "summary": "rest_l2fib_FibEntry_makeEntryFibStatic", "operationId": "rest_l2fib_FibEntry_makeEntryFibStatic", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/l2fib/FibEntry/makeFibStatic": { "post": { "tags": [ "samo_l2fib" ], "summary": "rest_l2fib_FibEntry_makeFibStatic", "operationId": "rest_l2fib_FibEntry_makeFibStatic", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/l2fib/FibEntry/removeFibEntry": { "post": { "tags": [ "samo_l2fib" ], "summary": "rest_l2fib_FibEntry_removeFibEntry", "operationId": "rest_l2fib_FibEntry_removeFibEntry", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/l2fib/FibEntry/resync": { "post": { "tags": [ "samo_l2fib" ], "summary": "rest_l2fib_FibEntry_resync", "operationId": "rest_l2fib_FibEntry_resync", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/l2fib/MFibEntry/getDefinedObject/{instanceFullName}": { "get": { "tags": [ "samo_l2fib" ], "summary": "rest_l2fib_MFibEntry_getDefinedObject", "description": "Retrieves the access interface or circuit on which the mfib entry is defined.

Intention : RETRIEVER
getDefinedObject:
instance-level retriever API getDefinedObject
of class l2fib.MFibEntry
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_l2fib_MFibEntry_getDefinedObject", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getDefinedObjectResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/l2fib/MFibEntry/resync": { "post": { "tags": [ "samo_l2fib" ], "summary": "rest_l2fib_MFibEntry_resync", "operationId": "rest_l2fib_MFibEntry_resync", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sbtsperf/SbtsPMPolicy/findSbtsNodes": { "get": { "tags": [ "samo_sbtsperf" ], "summary": "rest_sbtsperf_SbtsPMPolicy_findSbtsNodes", "description": "Find all managed Sbts eNodeBs for the specified Performance Management polling policy assigned.

Intention : RETRIEVER
findSbtsNodes:
class-level [object finder] (retriever) API findSbtsNodes
of class sbtsperf.SbtsPMPolicy
DescendantInfo:
sbtsperf.SbtsNodePMPolicy


", "operationId": "rest_sbtsperf_SbtsPMPolicy_findSbtsNodes", "parameters": [ { "name": "policyId", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findSbtsNodesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sbtsperf/SbtsPMPolicy/invokeCatchup": { "post": { "tags": [ "samo_sbtsperf" ], "summary": "rest_sbtsperf_SbtsPMPolicy_invokeCatchup", "operationId": "rest_sbtsperf_SbtsPMPolicy_invokeCatchup", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "integer", "format": "int32" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sbtsperf/SbtsPMPolicy/invokeSbtssCatchup": { "post": { "tags": [ "samo_sbtsperf" ], "summary": "rest_sbtsperf_SbtsPMPolicy_invokeSbtssCatchup", "operationId": "rest_sbtsperf_SbtsPMPolicy_invokeSbtssCatchup", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invokeSbtssCatchup" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/vprn/AbstractSite/requestClearIgmpHostTracking/{instanceFullName}": { "post": { "tags": [ "samo_vprn" ], "summary": "rest_vprn_AbstractSite_requestClearIgmpHostTracking", "description": "Request clearing of all IGMP Host Tracking information for this site.
When this method returns resources for the clear have been allocated
but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearIgmpHostTracking:
instance-level modifier API requestClearIgmpHostTracking
of class vprn.AbstractSite
DescendantInfo:
vprn.Site
DescendantInfo:
vprn.DVRSSite
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_vprn_AbstractSite_requestClearIgmpHostTracking", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "boolean" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearIgmpHostTrackingResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vprn/GroupInterface/requestPolicyAccountStatsClear/{instanceFullName}": { "post": { "tags": [ "samo_vprn" ], "summary": "rest_vprn_GroupInterface_requestPolicyAccountStatsClear", "description": "Request clearing of Policy Accounting Statistics on this interface.
When this method returns resources for the clear have been allocated
but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestPolicyAccountStatsClear:
instance-level modifier API requestPolicyAccountStatsClear
of class vprn.GroupInterface
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_vprn_GroupInterface_requestPolicyAccountStatsClear", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestPolicyAccountStatsClear" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestPolicyAccountStatsClearResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vprn/L3AccessInterface/requestPolicyAccountStatsClear/{instanceFullName}": { "post": { "tags": [ "samo_vprn" ], "summary": "rest_vprn_L3AccessInterface_requestPolicyAccountStatsClear", "description": "Request clearing of Policy Accounting Statistics on this interface.
When this method returns resources for the clear have been allocated
but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestPolicyAccountStatsClear:
instance-level modifier API requestPolicyAccountStatsClear
of class vprn.L3AccessInterface
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_vprn_L3AccessInterface_requestPolicyAccountStatsClear", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestPolicyAccountStatsClear" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestPolicyAccountStatsClearResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vprn/MSap/requestClearMsap/{instanceFullName}": { "post": { "tags": [ "samo_vprn" ], "summary": "rest_vprn_MSap_requestClearMsap", "description": "Request clearing of this MSAP.
When this method returns resources for the clear have been allocated
but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearMsap:
instance-level modifier API requestClearMsap
of class vprn.MSap
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_vprn_MSap_requestClearMsap", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearMsapResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vprn/MSap/retrieveMsap": { "post": { "tags": [ "samo_vprn" ], "summary": "rest_vprn_MSap_retrieveMsap", "description": "Method used to retrieve MSAP information from the NFM-P database if the MSAP exists there,
or return an empty MSAP object except for a populated serviceId retrieved from the network

Intention : RETRIEVER
retrieveMsap:
class-level retriever API retrieveMsap
of class vprn.MSap


", "operationId": "rest_vprn_MSap_retrieveMsap", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveMsap" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveMsapResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vprn/ServiceAccessPoint/requestClearIgmpHostTracking/{instanceFullName}": { "post": { "tags": [ "samo_vprn" ], "summary": "rest_vprn_ServiceAccessPoint_requestClearIgmpHostTracking", "description": "Request clearing of all IGMP Host Tracking information for this ServiceAccessPoint.
When this method returns resources for the clear have been allocated
but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearIgmpHostTracking:
instance-level modifier API requestClearIgmpHostTracking
of class vprn.ServiceAccessPoint
DescendantInfo:
vprn.MSap
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_vprn_ServiceAccessPoint_requestClearIgmpHostTracking", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "boolean" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearIgmpHostTrackingResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vprn/Site/getExportRouteTargets": { "get": { "tags": [ "samo_vprn" ], "summary": "rest_vprn_Site_getExportRouteTargets", "description": "The export route targets for this site

Intention : RETRIEVER
getExportRouteTargets:
class-level retriever API getExportRouteTargets
of class vprn.Site


", "operationId": "rest_vprn_Site_getExportRouteTargets", "parameters": [ { "name": "SiteName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getExportRouteTargetsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vprn/Site/getImportRouteTargets": { "get": { "tags": [ "samo_vprn" ], "summary": "rest_vprn_Site_getImportRouteTargets", "description": "The import route targets for this site

Intention : RETRIEVER
getImportRouteTargets:
class-level retriever API getImportRouteTargets
of class vprn.Site


", "operationId": "rest_vprn_Site_getImportRouteTargets", "parameters": [ { "name": "SiteName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getImportRouteTargetsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vprn/Site/retrieveVRFRoutes": { "post": { "tags": [ "samo_vprn" ], "summary": "rest_vprn_Site_retrieveVRFRoutes", "description": "FDN of the site
FDN of the service.
Prefix of the Hop in the route table.
Method used to query the NE for VRF routes on a particular service.

Intention : RETRIEVER
retrieveVRFRoutes:
class-level retriever API retrieveVRFRoutes
of class vprn.Site


", "operationId": "rest_vprn_Site_retrieveVRFRoutes", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveVRFRoutes" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveVRFRoutesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/policytestutil/BGPPolicyTestUtilityManager/execute/{instanceFullName}": { "put": { "tags": [ "samo_policytestutil" ], "summary": "rest_policytestutil_BGPPolicyTestUtilityManager_execute", "operationId": "rest_policytestutil_BGPPolicyTestUtilityManager_execute", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topology/AbstractImpactAnalysisTimeRange/impactAnalysis/{instanceFullName}": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_AbstractImpactAnalysisTimeRange_impactAnalysis", "description": "Used to calculate the historical impact analysis results.

Intention : MODIFIER
impactAnalysis:
instance-level modifier API impactAnalysis
of class topology.AbstractImpactAnalysisTimeRange
DescendantInfo:
topology.BgpImpactAnalysisTimeRange
DescendantInfo:
topology.ServiceImpactAnalysisTimeRange
DescendantInfo:
topology.ServiceBgpImpactAnalysisTimeRange
DescendantInfo:
topology.CompSvcImpactAnalysisTimeRange
DescendantInfo:
topology.ImpactAnalysisTimeRange
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_topology_AbstractImpactAnalysisTimeRange_impactAnalysis", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/impactAnalysisResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/AbstractImpactAnalysisTimeRange/impactAnalysisDetails/{instanceFullName}": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_AbstractImpactAnalysisTimeRange_impactAnalysisDetails", "description": "Details for Historical Impact Analysis results.

Intention : MODIFIER
impactAnalysisDetails:
instance-level modifier API impactAnalysisDetails
of class topology.AbstractImpactAnalysisTimeRange
DescendantInfo:
topology.BgpImpactAnalysisTimeRange
DescendantInfo:
topology.ServiceImpactAnalysisTimeRange
DescendantInfo:
topology.ServiceBgpImpactAnalysisTimeRange
DescendantInfo:
topology.CompSvcImpactAnalysisTimeRange
DescendantInfo:
topology.ImpactAnalysisTimeRange
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_topology_AbstractImpactAnalysisTimeRange_impactAnalysisDetails", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/impactAnalysisDetails" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/impactAnalysisDetailsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/Area/cleanUpReference/{instanceFullName}": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_Area_cleanUpReference", "operationId": "rest_topology_Area_cleanUpReference", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topology/Area/findAllCheckpoints/{instanceFullName}": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_Area_findAllCheckpoints", "description": "Find all the checkpoints that exist for this checkpointable
object.

Intention : RETRIEVER
findAllCheckpoints:
instance-level [object finder] (retriever) API findAllCheckpoints
of class topology.Area
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_topology_Area_findAllCheckpoints", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAllCheckpointsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/AutonomousSystem/cleanUpReference/{instanceFullName}": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_AutonomousSystem_cleanUpReference", "operationId": "rest_topology_AutonomousSystem_cleanUpReference", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topology/AutonomousSystem/findActivePrimaryStaticRoutes/{instanceFullName}": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_AutonomousSystem_findActivePrimaryStaticRoutes", "description": "finds all static routes on this admin domain that have the lowest metric for that destination AND are active

Intention : RETRIEVER
findActivePrimaryStaticRoutes:
instance-level [object finder] (retriever) API findActivePrimaryStaticRoutes
of class topology.AutonomousSystem
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_topology_AutonomousSystem_findActivePrimaryStaticRoutes", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findActivePrimaryStaticRoutes" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findActivePrimaryStaticRoutesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/AutonomousSystem/findActiveSecondaryStaticRoutes/{instanceFullName}": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_AutonomousSystem_findActiveSecondaryStaticRoutes", "description": "finds all static routes on this admin domain that do not have the lowest metric for that destination AND are active

Intention : RETRIEVER
findActiveSecondaryStaticRoutes:
instance-level [object finder] (retriever) API findActiveSecondaryStaticRoutes
of class topology.AutonomousSystem
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_topology_AutonomousSystem_findActiveSecondaryStaticRoutes", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findActiveSecondaryStaticRoutes" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findActiveSecondaryStaticRoutesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/AutonomousSystem/findAllStaticRoutes/{instanceFullName}": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_AutonomousSystem_findAllStaticRoutes", "description": "finds all static routes on this admin domain

Intention : RETRIEVER
findAllStaticRoutes:
instance-level [object finder] (retriever) API findAllStaticRoutes
of class topology.AutonomousSystem
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_topology_AutonomousSystem_findAllStaticRoutes", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAllStaticRoutes" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAllStaticRoutesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/AutonomousSystem/findInactivePrimaryStaticRoutes/{instanceFullName}": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_AutonomousSystem_findInactivePrimaryStaticRoutes", "description": "finds all static routes on this admin domain that have the lowest metric for that destination AND are inactive

Intention : RETRIEVER
findInactivePrimaryStaticRoutes:
instance-level [object finder] (retriever) API findInactivePrimaryStaticRoutes
of class topology.AutonomousSystem
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_topology_AutonomousSystem_findInactivePrimaryStaticRoutes", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findInactivePrimaryStaticRoutes" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findInactivePrimaryStaticRoutesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/AutonomousSystem/findInactiveSecondaryStaticRoutes/{instanceFullName}": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_AutonomousSystem_findInactiveSecondaryStaticRoutes", "description": "finds all static routes on this admin domain that do not have the lowest metric for that destination AND are inactive

Intention : RETRIEVER
findInactiveSecondaryStaticRoutes:
instance-level [object finder] (retriever) API findInactiveSecondaryStaticRoutes
of class topology.AutonomousSystem
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_topology_AutonomousSystem_findInactiveSecondaryStaticRoutes", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findInactiveSecondaryStaticRoutes" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findInactiveSecondaryStaticRoutesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/BaseLink/findObjectsOnLinkOssi/{instanceFullName}": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_BaseLink_findObjectsOnLinkOssi", "description": "Find all the associated IP Path Monitors that exist on IGP Link(s).

Intention : RETRIEVER
findObjectsOnLinkOssi:
instance-level [object finder] (retriever) API findObjectsOnLinkOssi
of class topology.BaseLink
DescendantInfo:
topology.IsisLink
DescendantInfo:
topology.NonRoutedLink
DescendantInfo:
topology.OspfLink
DescendantInfo:
topology.IgpLink
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_topology_BaseLink_findObjectsOnLinkOssi", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findObjectsOnLinkOssi" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findObjectsOnLinkOssiResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/BgpAutonomousSystem/retrieveBgpEventTopNContributers/{instanceFullName}": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_BgpAutonomousSystem_retrieveBgpEventTopNContributers", "description": "
Intention : RETRIEVER
retrieveBgpEventTopNContributers:
instance-level retriever API retrieveBgpEventTopNContributers
of class topology.BgpAutonomousSystem
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_topology_BgpAutonomousSystem_retrieveBgpEventTopNContributers", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveBgpEventTopNContributers" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveBgpEventTopNContributersResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/BgpAutonomousSystem/updateBgpAsTopology/{instanceFullName}": { "put": { "tags": [ "samo_topology" ], "summary": "rest_topology_BgpAutonomousSystem_updateBgpAsTopology", "operationId": "rest_topology_BgpAutonomousSystem_updateBgpAsTopology", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topology/BgpAutonomousSystem/updateBgpRibInfo/{instanceFullName}": { "put": { "tags": [ "samo_topology" ], "summary": "rest_topology_BgpAutonomousSystem_updateBgpRibInfo", "operationId": "rest_topology_BgpAutonomousSystem_updateBgpRibInfo", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topology/BgpAutonomousSystem/updateBgpRouteTargets/{instanceFullName}": { "put": { "tags": [ "samo_topology" ], "summary": "rest_topology_BgpAutonomousSystem_updateBgpRouteTargets", "operationId": "rest_topology_BgpAutonomousSystem_updateBgpRouteTargets", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topology/BgpEventPartitionManager/cleanupEvents": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_BgpEventPartitionManager_cleanupEvents", "operationId": "rest_topology_BgpEventPartitionManager_cleanupEvents", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topology/BgpEventPartitionManager/cleanupOldestPartition": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_BgpEventPartitionManager_cleanupOldestPartition", "operationId": "rest_topology_BgpEventPartitionManager_cleanupOldestPartition", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topology/BgpEventPartitionManager/retrieveBgpEventStartFromBgpStatInterval": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_BgpEventPartitionManager_retrieveBgpEventStartFromBgpStatInterval", "description": "
Intention : RETRIEVER
retrieveBgpEventStartFromBgpStatInterval:
instance-level retriever API retrieveBgpEventStartFromBgpStatInterval on default instance BePrtMgr of class topology.BgpEventPartitionManager


", "operationId": "rest_topology_BgpEventPartitionManager_retrieveBgpEventStartFromBgpStatInterval", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveBgpEventStartFromBgpStatInterval" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveBgpEventStartFromBgpStatIntervalResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/BgpImpactAnalysisTimeRange/bgpImpactAnalysis/{instanceFullName}": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_BgpImpactAnalysisTimeRange_bgpImpactAnalysis", "description": "Used to calculate the bgp historical impact analysis results.

Intention : MODIFIER
bgpImpactAnalysis:
instance-level modifier API bgpImpactAnalysis
of class topology.BgpImpactAnalysisTimeRange
DescendantInfo:
topology.ServiceBgpImpactAnalysisTimeRange
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_topology_BgpImpactAnalysisTimeRange_bgpImpactAnalysis", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bgpImpactAnalysisResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/BgpImpactAnalysisTimeRange/bgpImpactAnalysisDetails/{instanceFullName}": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_BgpImpactAnalysisTimeRange_bgpImpactAnalysisDetails", "description": "Details for Historical Impact Analysis results. Reason can be specified.
Reason has the following int values:
Unreachable at least once during this period =1,
Advertised as a New route at least once =2,
Added at least once =3,
Flapped = 4,
Redundancy Lost at least once = 5,
Switched Next Hop, Same Originator = 6,
Switched Next Hop, Different Originator = 7,
Switched at least once to longer AS-Path = 8,
MED change at least once = 9,
Throttled BGP events count = 10

Intention : RETRIEVER
bgpImpactAnalysisDetails:
instance-level retriever API bgpImpactAnalysisDetails
of class topology.BgpImpactAnalysisTimeRange
DescendantInfo:
topology.ServiceBgpImpactAnalysisTimeRange
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_topology_BgpImpactAnalysisTimeRange_bgpImpactAnalysisDetails", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bgpImpactAnalysisDetails" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bgpImpactAnalysisDetailsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/BgpImpactAnalysisTimeRange/bgpPerNextHopEventAnalysis/{instanceFullName}": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_BgpImpactAnalysisTimeRange_bgpPerNextHopEventAnalysis", "description": "
Intention : RETRIEVER
bgpPerNextHopEventAnalysis:
instance-level retriever API bgpPerNextHopEventAnalysis
of class topology.BgpImpactAnalysisTimeRange
DescendantInfo:
topology.ServiceBgpImpactAnalysisTimeRange
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_topology_BgpImpactAnalysisTimeRange_bgpPerNextHopEventAnalysis", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bgpPerNextHopEventAnalysisResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/BgpImpactAnalysisTimeRange/bgpPerNextHopSummary/{instanceFullName}": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_BgpImpactAnalysisTimeRange_bgpPerNextHopSummary", "description": "
Intention : RETRIEVER
bgpPerNextHopSummary:
instance-level retriever API bgpPerNextHopSummary
of class topology.BgpImpactAnalysisTimeRange
DescendantInfo:
topology.ServiceBgpImpactAnalysisTimeRange
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_topology_BgpImpactAnalysisTimeRange_bgpPerNextHopSummary", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bgpPerNextHopSummary" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bgpPerNextHopSummaryResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/BgpImpactAnalysisTimeRange/bgpPrefixAnalysis/{instanceFullName}": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_BgpImpactAnalysisTimeRange_bgpPrefixAnalysis", "description": "
Intention : RETRIEVER
bgpPrefixAnalysis:
instance-level retriever API bgpPrefixAnalysis
of class topology.BgpImpactAnalysisTimeRange
DescendantInfo:
topology.ServiceBgpImpactAnalysisTimeRange
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_topology_BgpImpactAnalysisTimeRange_bgpPrefixAnalysis", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bgpPrefixAnalysisResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/BgpImpactAnalysisTimeRange/bgpRetrieveEventForNextHop/{instanceFullName}": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_BgpImpactAnalysisTimeRange_bgpRetrieveEventForNextHop", "description": "Details for Historical Impact Analysis results.

Intention : RETRIEVER
bgpRetrieveEventForNextHop:
instance-level retriever API bgpRetrieveEventForNextHop
of class topology.BgpImpactAnalysisTimeRange
DescendantInfo:
topology.ServiceBgpImpactAnalysisTimeRange
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_topology_BgpImpactAnalysisTimeRange_bgpRetrieveEventForNextHop", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bgpRetrieveEventForNextHop" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bgpRetrieveEventForNextHopResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/BgpMonitoredPrefix/bulkDelete": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_BgpMonitoredPrefix_bulkDelete", "operationId": "rest_topology_BgpMonitoredPrefix_bulkDelete", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topology/BgpMonitoredPrefix/captureCurrentPrefix/{instanceFullName}": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_BgpMonitoredPrefix_captureCurrentPrefix", "operationId": "rest_topology_BgpMonitoredPrefix_captureCurrentPrefix", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topology/BgpPrefixList/abortRetrievePrefixList": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_BgpPrefixList_abortRetrievePrefixList", "operationId": "rest_topology_BgpPrefixList_abortRetrievePrefixList", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topology/Checkpoint/autoCreateCheckpoints": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_Checkpoint_autoCreateCheckpoints", "operationId": "rest_topology_Checkpoint_autoCreateCheckpoints", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/autoCreateCheckpoints" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topology/Checkpoint/forceCleanupCheckpoints": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_Checkpoint_forceCleanupCheckpoints", "operationId": "rest_topology_Checkpoint_forceCleanupCheckpoints", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topology/Checkpoint/getCpTopology": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_Checkpoint_getCpTopology", "description": "
Intention : RETRIEVER
getCpTopology:
class-level retriever API getCpTopology
of class topology.Checkpoint
DescendantInfo:
topology.OspfCheckpoint
DescendantInfo:
topology.IsisCheckpoint


", "operationId": "rest_topology_Checkpoint_getCpTopology", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getCpTopology" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getCpTopologyResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/Cpaa/switchover/{instanceFullName}": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_Cpaa_switchover", "operationId": "rest_topology_Cpaa_switchover", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topology/CpamStatisticManager/enableUtilizationStats": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_CpamStatisticManager_enableUtilizationStats", "operationId": "rest_topology_CpamStatisticManager_enableUtilizationStats", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topology/CpamStatisticManager/getIfUtilizationStats": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_CpamStatisticManager_getIfUtilizationStats", "description": "Retrieves statistics for interface utilization.

Intention : RETRIEVER
getIfUtilizationStats:
class-level retriever API getIfUtilizationStats on default instance statsMgr of class topology.CpamStatisticManager


", "operationId": "rest_topology_CpamStatisticManager_getIfUtilizationStats", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getIfUtilizationStats" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getIfUtilizationStatsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/CpamStatisticManager/getIfsForUtilizationRange": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_CpamStatisticManager_getIfsForUtilizationRange", "description": "Retrieves the list of interfaces for a utilization range.

Intention : RETRIEVER
getIfsForUtilizationRange:
class-level retriever API getIfsForUtilizationRange on default instance statsMgr of class topology.CpamStatisticManager

The list of interface utilization detail information.

", "operationId": "rest_topology_CpamStatisticManager_getIfsForUtilizationRange", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getIfsForUtilizationRange" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getIfsForUtilizationRangeResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/IgpLink/findAllCheckpoints/{instanceFullName}": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_IgpLink_findAllCheckpoints", "description": "Find all the checkpoints that exist for this checkpointable
object.

Intention : RETRIEVER
findAllCheckpoints:
instance-level [object finder] (retriever) API findAllCheckpoints
of class topology.IgpLink
DescendantInfo:
topology.IsisLink
DescendantInfo:
topology.OspfLink
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_topology_IgpLink_findAllCheckpoints", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAllCheckpointsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/IgpMonitoredPrefix/captureCurrentPrefix/{instanceFullName}": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_IgpMonitoredPrefix_captureCurrentPrefix", "operationId": "rest_topology_IgpMonitoredPrefix_captureCurrentPrefix", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topology/IgpPrefixList/abortRetrievePrefixList": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_IgpPrefixList_abortRetrievePrefixList", "operationId": "rest_topology_IgpPrefixList_abortRetrievePrefixList", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topology/NREdgeDiscoveryPolicy/executeNonRoutedEdgeDiscoveryPolicy/{instanceFullName}": { "put": { "tags": [ "samo_topology" ], "summary": "rest_topology_NREdgeDiscoveryPolicy_executeNonRoutedEdgeDiscoveryPolicy", "operationId": "rest_topology_NREdgeDiscoveryPolicy_executeNonRoutedEdgeDiscoveryPolicy", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topology/RouteManager/deregisterRoutes/{instanceFullName}": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_RouteManager_deregisterRoutes", "operationId": "rest_topology_RouteManager_deregisterRoutes", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RouteKey" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topology/RouteManager/rebuildRoutes/{instanceFullName}": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_RouteManager_rebuildRoutes", "operationId": "rest_topology_RouteManager_rebuildRoutes", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RouteKey" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topology/RouteManager/registerRoutes/{instanceFullName}": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_RouteManager_registerRoutes", "operationId": "rest_topology_RouteManager_registerRoutes", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RouteKey" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topology/RouteManager/retrieveRoutes/{instanceFullName}": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_RouteManager_retrieveRoutes", "description": "Used by the application to retrieve the paths for the given
set of route keys.

Intention : RETRIEVER
retrieveRoutes:
instance-level retriever API retrieveRoutes
of class topology.RouteManager
DescendantInfo:
monpath.InternalRouteManager
instanceFullName : distinguished/instance name of called object
A map of the {code}topology.RouteKey{ code} to a
RouteResult.

", "operationId": "rest_topology_RouteManager_retrieveRoutes", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RouteKey" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveRoutesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/RouteProfileManager/retrieveVpnBgpRouteProfilesAssociatedWithService": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_RouteProfileManager_retrieveVpnBgpRouteProfilesAssociatedWithService", "description": "
Intention : RETRIEVER
retrieveVpnBgpRouteProfilesAssociatedWithService:
class-level retriever API retrieveVpnBgpRouteProfilesAssociatedWithService on default instance rtPrfMgr of class topology.RouteProfileManager


", "operationId": "rest_topology_RouteProfileManager_retrieveVpnBgpRouteProfilesAssociatedWithService", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveVpnBgpRouteProfilesAssociatedWithService" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveVpnBgpRouteProfilesAssociatedWithServiceResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/Router/findAllCheckpoints/{instanceFullName}": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_Router_findAllCheckpoints", "description": "Find all the checkpoints that exist for this checkpointable
object.

Intention : RETRIEVER
findAllCheckpoints:
instance-level [object finder] (retriever) API findAllCheckpoints
of class topology.Router
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_topology_Router_findAllCheckpoints", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAllCheckpointsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/RoutingAlarmManager/getRoutingAlarmTypes": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_RoutingAlarmManager_getRoutingAlarmTypes", "description": "
Intention : RETRIEVER
getRoutingAlarmTypes:
class-level retriever API getRoutingAlarmTypes on default instance tpgy-rtr-alarm-mgr of class topology.RoutingAlarmManager


", "operationId": "rest_topology_RoutingAlarmManager_getRoutingAlarmTypes", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getRoutingAlarmTypesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/ServiceBgpImpactAnalysisTimeRange/getRdRtPairings/{instanceFullName}": { "get": { "tags": [ "samo_topology" ], "summary": "rest_topology_ServiceBgpImpactAnalysisTimeRange_getRdRtPairings", "description": "
Intention : RETRIEVER
getRdRtPairings:
instance-level retriever API getRdRtPairings
of class topology.ServiceBgpImpactAnalysisTimeRange
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_topology_ServiceBgpImpactAnalysisTimeRange_getRdRtPairings", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getRdRtPairingsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/Subnet/findAllCheckpoints/{instanceFullName}": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_Subnet_findAllCheckpoints", "description": "Find all the checkpoints that exist for this checkpointable
object.

Intention : RETRIEVER
findAllCheckpoints:
instance-level [object finder] (retriever) API findAllCheckpoints
of class topology.Subnet
DescendantInfo:
topology.IsisSubnet
DescendantInfo:
topology.OspfSubnet
DescendantInfo:
topology.NonRoutedSubnet
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_topology_Subnet_findAllCheckpoints", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAllCheckpointsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/TopologyManager/constrainedShortestPathFirstGraphExt": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_TopologyManager_constrainedShortestPathFirstGraphExt", "description": "Performs a constrained shortest path (CSPF) calculation from the given source
to the given destination, using the given constraints, as known by the specified IGP
protocol.

Intention : RETRIEVER
constrainedShortestPathFirstGraphExt:
class-level retriever API constrainedShortestPathFirstGraphExt on default instance tpgy-mgr of class topology.TopologyManager

The constrained shortest path graph.

", "operationId": "rest_topology_TopologyManager_constrainedShortestPathFirstGraphExt", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/constrainedShortestPathFirstGraphExt" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/constrainedShortestPathFirstGraphExtResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/TopologyManager/highlightLFANextHops": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_TopologyManager_highlightLFANextHops", "description": "Performs a LFA calculation from the given source
to the given destination, using both OSPF and ISIS protocols
(or both) as necessary

Intention : RETRIEVER
highlightLFANextHops:
class-level retriever API highlightLFANextHops on default instance tpgy-mgr of class topology.TopologyManager

The shortest path graph.

", "operationId": "rest_topology_TopologyManager_highlightLFANextHops", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/highlightLFANextHops" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/highlightLFANextHopsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/TopologyManager/igpShortestPathFirstGraphExt": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_TopologyManager_igpShortestPathFirstGraphExt", "description": "Performs a shortest path calculation from the given source
to the given destination, using both OSPF and ISIS protocols
(or both) as necessary.

Intention : RETRIEVER
igpShortestPathFirstGraphExt:
class-level retriever API igpShortestPathFirstGraphExt on default instance tpgy-mgr of class topology.TopologyManager

The shortest path graph.

", "operationId": "rest_topology_TopologyManager_igpShortestPathFirstGraphExt", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/igpShortestPathFirstGraphExt" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/igpShortestPathFirstGraphExtResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/TopologyManager/igpShortestPathFirstGraphSet": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_TopologyManager_igpShortestPathFirstGraphSet", "description": "Performs a shortest path calculation from the given source (routerId, ipv4 or ipv6 prefix)
to the given destination (routerId, ipv4 or ipv6 prefix), using both OSPF and ISIS protocols
(or both) as necessary.

Intention : RETRIEVER
igpShortestPathFirstGraphSet:
class-level retriever API igpShortestPathFirstGraphSet on default instance tpgy-mgr of class topology.TopologyManager

The set of shortest path graph.

", "operationId": "rest_topology_TopologyManager_igpShortestPathFirstGraphSet", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/igpShortestPathFirstGraphSet" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/igpShortestPathFirstGraphSetResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/TopologyManager/nextHopExt": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_TopologyManager_nextHopExt", "description": "Calculates the next hop from all routers in the source
set to the given destination FEC.

Intention : RETRIEVER
nextHopExt:
class-level retriever API nextHopExt on default instance tpgy-mgr of class topology.TopologyManager

The next hops, in the form of shortest path graphs,
one for each source.

", "operationId": "rest_topology_TopologyManager_nextHopExt", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nextHopExt" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/nextHopExtResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/TopologyManager/retrieveBgpEventsFilter": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_TopologyManager_retrieveBgpEventsFilter", "description": "Retrieve Historical BGP Event data from database

Intention : RETRIEVER
retrieveBgpEventsFilter:
instance-level retriever API retrieveBgpEventsFilter on default instance tpgy-mgr of class topology.TopologyManager


", "operationId": "rest_topology_TopologyManager_retrieveBgpEventsFilter", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveBgpEventsFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveBgpEventsFilterResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/TopologyManager/retrieveBgpPrefixList": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_TopologyManager_retrieveBgpPrefixList", "operationId": "rest_topology_TopologyManager_retrieveBgpPrefixList", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveBgpPrefixList" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topology/TopologyManager/retrieveIgpPrefixList": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_TopologyManager_retrieveIgpPrefixList", "operationId": "rest_topology_TopologyManager_retrieveIgpPrefixList", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveIgpPrefixList" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topology/TopologyManager/retrieveProfiledBgpEventsFilter": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_TopologyManager_retrieveProfiledBgpEventsFilter", "description": "Retrieve Historical BGP Event data from database

Intention : RETRIEVER
retrieveProfiledBgpEventsFilter:
instance-level retriever API retrieveProfiledBgpEventsFilter on default instance tpgy-mgr of class topology.TopologyManager


", "operationId": "rest_topology_TopologyManager_retrieveProfiledBgpEventsFilter", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveProfiledBgpEventsFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveProfiledBgpEventsFilterResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/TopologyManager/retrieveProfiledBgpPrefixList": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_TopologyManager_retrieveProfiledBgpPrefixList", "operationId": "rest_topology_TopologyManager_retrieveProfiledBgpPrefixList", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topology/TopologyManager/retrieveServiceBgpInfo": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_TopologyManager_retrieveServiceBgpInfo", "description": "This method will retrieve BGP related information for a provided service FDN

Intention : RETRIEVER
retrieveServiceBgpInfo:
class-level retriever API retrieveServiceBgpInfo on default instance tpgy-mgr of class topology.TopologyManager


", "operationId": "rest_topology_TopologyManager_retrieveServiceBgpInfo", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveServiceBgpInfoResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/TopologyManager/shortestPathFirstGraphExt": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_TopologyManager_shortestPathFirstGraphExt", "description": "Performs a shortest path calculation from the given source
to the given destination, as known by the specified IGP
protocol.

Intention : RETRIEVER
shortestPathFirstGraphExt:
class-level retriever API shortestPathFirstGraphExt on default instance tpgy-mgr of class topology.TopologyManager

The shortest path graph.

", "operationId": "rest_topology_TopologyManager_shortestPathFirstGraphExt", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shortestPathFirstGraphExt" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shortestPathFirstGraphExtResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/TopologyManager/shortestPathFirstGraphSet": { "post": { "tags": [ "samo_topology" ], "summary": "rest_topology_TopologyManager_shortestPathFirstGraphSet", "description": "Performs a shortest path calculation from a given source (routerId, Ipv4 prefix, or Ipv6 prefix)
to a given destination(routerId, Ipv4 prefix, or Ipv6 prefix), as known by the specified IGP
protocol.

Intention : RETRIEVER
shortestPathFirstGraphSet:
class-level retriever API shortestPathFirstGraphSet on default instance tpgy-mgr of class topology.TopologyManager

The set of shortest path graph.

", "operationId": "rest_topology_TopologyManager_shortestPathFirstGraphSet", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shortestPathFirstGraphSet" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shortestPathFirstGraphSetResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/topology/TopologyManager/updateBgpAsTopology": { "put": { "tags": [ "samo_topology" ], "summary": "rest_topology_TopologyManager_updateBgpAsTopology", "operationId": "rest_topology_TopologyManager_updateBgpAsTopology", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topology/TopologyManager/updateBgpRibInfo": { "put": { "tags": [ "samo_topology" ], "summary": "rest_topology_TopologyManager_updateBgpRibInfo", "operationId": "rest_topology_TopologyManager_updateBgpRibInfo", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topology/TopologyManager/updateBgpRouteTargets": { "put": { "tags": [ "samo_topology" ], "summary": "rest_topology_TopologyManager_updateBgpRouteTargets", "operationId": "rest_topology_TopologyManager_updateBgpRouteTargets", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateBgpRouteTargets" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/topology/TopologyManager/updateTopology": { "put": { "tags": [ "samo_topology" ], "summary": "rest_topology_TopologyManager_updateTopology", "operationId": "rest_topology_TopologyManager_updateTopology", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateTopology" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/epipe/Epipe/restoreServiceForThroughputTest": { "post": { "tags": [ "samo_epipe" ], "summary": "rest_epipe_Epipe_restoreServiceForThroughputTest", "description": "Restore the service from the throughput test.

Intention : MODIFIER
restoreServiceForThroughputTest:
class-level modifier API restoreServiceForThroughputTest
of class epipe.Epipe

A list of error messages.

", "operationId": "rest_epipe_Epipe_restoreServiceForThroughputTest", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/restoreServiceForThroughputTestResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/firewall/FwEntryDefinition/renum": { "post": { "tags": [ "samo_firewall" ], "summary": "rest_firewall_FwEntryDefinition_renum", "operationId": "rest_firewall_FwEntryDefinition_renum", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/renum" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/firewall/FwPolicyDefinition/findAssociations": { "post": { "tags": [ "samo_firewall" ], "summary": "rest_firewall_FwPolicyDefinition_findAssociations", "description": "
Intention : RETRIEVER
findAssociations:
class-level [object finder] (retriever) API findAssociations
of class firewall.FwPolicyDefinition
DescendantInfo:
firewall.HostGroup
DescendantInfo:
firewall.Zone
DescendantInfo:
firewall.RuleSet
DescendantInfo:
firewall.ServiceGroup


", "operationId": "rest_firewall_FwPolicyDefinition_findAssociations", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAssociations" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAssociationsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/firewall/FwPolicyDefinition/findGlobalPoliciesForDistribution": { "get": { "tags": [ "samo_firewall" ], "summary": "rest_firewall_FwPolicyDefinition_findGlobalPoliciesForDistribution", "description": "
Intention : RETRIEVER
findGlobalPoliciesForDistribution:
class-level [object finder] (retriever) API findGlobalPoliciesForDistribution
of class firewall.FwPolicyDefinition
DescendantInfo:
firewall.HostGroup
DescendantInfo:
firewall.Zone
DescendantInfo:
firewall.RuleSet
DescendantInfo:
firewall.ServiceGroup


", "operationId": "rest_firewall_FwPolicyDefinition_findGlobalPoliciesForDistribution", "parameters": [ { "name": "aInSiteId", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "aInClassName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findGlobalPoliciesForDistributionResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/firewall/FwPolicyDefinition/findZoneAssociations": { "post": { "tags": [ "samo_firewall" ], "summary": "rest_firewall_FwPolicyDefinition_findZoneAssociations", "description": "
Intention : RETRIEVER
findZoneAssociations:
class-level [object finder] (retriever) API findZoneAssociations
of class firewall.FwPolicyDefinition
DescendantInfo:
firewall.HostGroup
DescendantInfo:
firewall.Zone
DescendantInfo:
firewall.RuleSet
DescendantInfo:
firewall.ServiceGroup


", "operationId": "rest_firewall_FwPolicyDefinition_findZoneAssociations", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findZoneAssociationsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/aosredundancy/AOSMultiChassisGroup/deleteAOSMultiChassisGroup/{instanceFullName}": { "delete": { "tags": [ "samo_aosredundancy" ], "summary": "rest_aosredundancy_AOSMultiChassisGroup_deleteAOSMultiChassisGroup", "operationId": "rest_aosredundancy_AOSMultiChassisGroup_deleteAOSMultiChassisGroup", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/aosredundancy/AOSVFLinkGroup/deleteVFLinkGroup/{instanceFullName}": { "delete": { "tags": [ "samo_aosredundancy" ], "summary": "rest_aosredundancy_AOSVFLinkGroup_deleteVFLinkGroup", "operationId": "rest_aosredundancy_AOSVFLinkGroup_deleteVFLinkGroup", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/tpsperf/TPSPMPolicy/findTPSs": { "get": { "tags": [ "samo_tpsperf" ], "summary": "rest_tpsperf_TPSPMPolicy_findTPSs", "description": "Find all managed TPSs for the specified Performance Management polling policy assigned.

Intention : RETRIEVER
findTPSs:
class-level [object finder] (retriever) API findTPSs
of class tpsperf.TPSPMPolicy
DescendantInfo:
tpsperf.TPSOSUPMPolicy


", "operationId": "rest_tpsperf_TPSPMPolicy_findTPSs", "parameters": [ { "name": "policyId", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findTPSsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vrrp/AuthenticationKey/removeAuthenticationKey/{instanceFullName}": { "post": { "tags": [ "samo_vrrp" ], "summary": "rest_vrrp_AuthenticationKey_removeAuthenticationKey", "operationId": "rest_vrrp_AuthenticationKey_removeAuthenticationKey", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/vrrp/Policy/findSrrpInstances/{instanceFullName}": { "post": { "tags": [ "samo_vrrp" ], "summary": "rest_vrrp_Policy_findSrrpInstances", "description": "
Intention : RETRIEVER
findSrrpInstances:
instance-level [object finder] (retriever) API findSrrpInstances
of class vrrp.Policy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_vrrp_Policy_findSrrpInstances", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findSrrpInstancesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vrrp/Policy/findVrrpInstances/{instanceFullName}": { "post": { "tags": [ "samo_vrrp" ], "summary": "rest_vrrp_Policy_findVrrpInstances", "description": "
Intention : RETRIEVER
findVrrpInstances:
instance-level [object finder] (retriever) API findVrrpInstances
of class vrrp.Policy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_vrrp_Policy_findVrrpInstances", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findVrrpInstancesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vrrp/VrrpVirtualRouter/addVrrpInstances/{instanceFullName}": { "post": { "tags": [ "samo_vrrp" ], "summary": "rest_vrrp_VrrpVirtualRouter_addVrrpInstances", "operationId": "rest_vrrp_VrrpVirtualRouter_addVrrpInstances", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/vrrp/VrrpVirtualRouter/createVrrpInstance/{instanceFullName}": { "post": { "tags": [ "samo_vrrp" ], "summary": "rest_vrrp_VrrpVirtualRouter_createVrrpInstance", "description": "creates a vrrp Instance and adds a VRInstance to this Virtual Router
Backup address is automatically configured for this Instance.

Intention : MODIFIER
createVrrpInstance:
instance-level [administrative creation] (modifier) API createVrrpInstance
of class vrrp.VrrpVirtualRouter
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_vrrp_VrrpVirtualRouter_createVrrpInstance", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createVrrpInstance" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createVrrpInstanceResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vrrp/VrrpVirtualRouter/findInstances": { "post": { "tags": [ "samo_vrrp" ], "summary": "rest_vrrp_VrrpVirtualRouter_findInstances", "description": "finds vrrp Instances that have same vrId and
that parent L3Interface has a Subnet which the backupAddress falls
in

Intention : RETRIEVER
findInstances:
class-level [object finder] (retriever) API findInstances
of class vrrp.VrrpVirtualRouter


", "operationId": "rest_vrrp_VrrpVirtualRouter_findInstances", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findInstances" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findInstancesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vrrp/VrrpVirtualRouter/findL3Interfaces": { "post": { "tags": [ "samo_vrrp" ], "summary": "rest_vrrp_VrrpVirtualRouter_findL3Interfaces", "description": "finds L3Interface has a Subnet which the
backupAddress falls in and does have a vrrp instance already created
with passed in Vrid

Intention : RETRIEVER
findL3Interfaces:
class-level [object finder] (retriever) API findL3Interfaces
of class vrrp.VrrpVirtualRouter


", "operationId": "rest_vrrp_VrrpVirtualRouter_findL3Interfaces", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findL3Interfaces" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findL3InterfacesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vrrp/VrrpVirtualRouter/removeInstances/{instanceFullName}": { "post": { "tags": [ "samo_vrrp" ], "summary": "rest_vrrp_VrrpVirtualRouter_removeInstances", "operationId": "rest_vrrp_VrrpVirtualRouter_removeInstances", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/statistics/SamPerformanceStats/configure/{instanceFullName}": { "post": { "tags": [ "samo_statistics" ], "summary": "rest_statistics_SamPerformanceStats_configure", "description": "This method is used to modify a NFM-P performance statistic.

Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure
of class statistics.SamPerformanceStats
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object
Object full name of NFM-P performance statistic that is modified.

", "operationId": "rest_statistics_SamPerformanceStats_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/statistics/SamPerformanceStatsManager/collect": { "post": { "tags": [ "samo_statistics" ], "summary": "rest_statistics_SamPerformanceStatsManager_collect", "operationId": "rest_statistics_SamPerformanceStatsManager_collect", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/statistics/SamPerformanceStatsManager/configure": { "post": { "tags": [ "samo_statistics" ], "summary": "rest_statistics_SamPerformanceStatsManager_configure", "description": "This method is used to configure a NFM-P performance statistic.

Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure on default instance samPerformanceStatsManager of class statistics.SamPerformanceStatsManager
This API follows hierarchical config model rules.

An object full name of the NFM-P statistic instance (configured).

", "operationId": "rest_statistics_SamPerformanceStatsManager_configure", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rtr/AdminGroupPolicy/findAdminGroups": { "post": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_AdminGroupPolicy_findAdminGroups", "description": "
Intention : RETRIEVER
findAdminGroups:
class-level [object finder] (retriever) API findAdminGroups
of class rtr.AdminGroupPolicy


", "operationId": "rest_rtr_AdminGroupPolicy_findAdminGroups", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAdminGroups" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAdminGroupsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rtr/AdminGroupPolicy/findFlexAlgoDefinitions/{instanceFullName}": { "post": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_AdminGroupPolicy_findFlexAlgoDefinitions", "description": "
Intention : RETRIEVER
findFlexAlgoDefinitions:
instance-level [object finder] (retriever) API findFlexAlgoDefinitions
of class rtr.AdminGroupPolicy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_rtr_AdminGroupPolicy_findFlexAlgoDefinitions", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findFlexAlgoDefinitions" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findFlexAlgoDefinitionsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rtr/AdminGroupPolicy/findInterfaces/{instanceFullName}": { "post": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_AdminGroupPolicy_findInterfaces", "description": "
Intention : RETRIEVER
findInterfaces:
instance-level [object finder] (retriever) API findInterfaces
of class rtr.AdminGroupPolicy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_rtr_AdminGroupPolicy_findInterfaces", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findInterfaces" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findInterfacesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rtr/AdminGroupPolicy/findLspPaths/{instanceFullName}": { "post": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_AdminGroupPolicy_findLspPaths", "description": "
Intention : RETRIEVER
findLspPaths:
instance-level [object finder] (retriever) API findLspPaths
of class rtr.AdminGroupPolicy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_rtr_AdminGroupPolicy_findLspPaths", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findLspPathsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rtr/AdminGroupPolicy/findLsps/{instanceFullName}": { "post": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_AdminGroupPolicy_findLsps", "description": "
Intention : RETRIEVER
findLsps:
instance-level [object finder] (retriever) API findLsps
of class rtr.AdminGroupPolicy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_rtr_AdminGroupPolicy_findLsps", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findLspsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rtr/AdminGroupPolicy/findRouteNextHopPolicyTemplates/{instanceFullName}": { "post": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_AdminGroupPolicy_findRouteNextHopPolicyTemplates", "description": "
Intention : RETRIEVER
findRouteNextHopPolicyTemplates:
instance-level [object finder] (retriever) API findRouteNextHopPolicyTemplates
of class rtr.AdminGroupPolicy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_rtr_AdminGroupPolicy_findRouteNextHopPolicyTemplates", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findRouteNextHopPolicyTemplatesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rtr/FlexibleAlgorithmDefinition/findAssociatedObjects/{instanceFullName}": { "post": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_FlexibleAlgorithmDefinition_findAssociatedObjects", "description": "
Intention : RETRIEVER
findAssociatedObjects:
instance-level [object finder] (retriever) API findAssociatedObjects
of class rtr.FlexibleAlgorithmDefinition
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_rtr_FlexibleAlgorithmDefinition_findAssociatedObjects", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAssociatedObjects" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAssociatedObjectsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rtr/Group/shutDown/{instanceFullName}": { "post": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_Group_shutDown", "operationId": "rest_rtr_Group_shutDown", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/rtr/Group/turnUp/{instanceFullName}": { "post": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_Group_turnUp", "operationId": "rest_rtr_Group_turnUp", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/rtr/IPPacketReassemblySpecifics/findReassemblyPorts/{instanceFullName}": { "post": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_IPPacketReassemblySpecifics_findReassemblyPorts", "description": "Find ports which can perform IP Packet Reassembly.

Intention : RETRIEVER
findReassemblyPorts:
instance-level [object finder] (retriever) API findReassemblyPorts
of class rtr.IPPacketReassemblySpecifics
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_rtr_IPPacketReassemblySpecifics_findReassemblyPorts", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findReassemblyPortsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rtr/MultiHomingInterface/removeIpAddress/{instanceFullName}": { "post": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_MultiHomingInterface_removeIpAddress", "description": "
Intention : MODIFIER
removeIpAddress:
instance-level [administrative deletion] (modifier) API removeIpAddress
of class rtr.MultiHomingInterface
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_rtr_MultiHomingInterface_removeIpAddress", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/removeIpAddressResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rtr/NetworkInterface/findGmplsLoopbackInterfaceAddresses": { "get": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_NetworkInterface_findGmplsLoopbackInterfaceAddresses", "description": "Find all addresses configured on a Network Interface of type gmpls-loopback.

Intention : RETRIEVER
findGmplsLoopbackInterfaceAddresses:
class-level [object finder] (retriever) API findGmplsLoopbackInterfaceAddresses
of class rtr.NetworkInterface


", "operationId": "rest_rtr_NetworkInterface_findGmplsLoopbackInterfaceAddresses", "parameters": [ { "name": "siteId", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findGmplsLoopbackInterfaceAddressesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rtr/NetworkInterface/findLinkMapProfiles": { "get": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_NetworkInterface_findLinkMapProfiles", "description": "Find LAG Link Mapping Profiles which are associated with this LAG.

Intention : RETRIEVER
findLinkMapProfiles:
class-level [object finder] (retriever) API findLinkMapProfiles
of class rtr.NetworkInterface


", "operationId": "rest_rtr_NetworkInterface_findLinkMapProfiles", "parameters": [ { "name": "portPointer", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findLinkMapProfilesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rtr/NetworkInterface/findQueueQroupPolicesAppliedOnPort": { "get": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_NetworkInterface_findQueueQroupPolicesAppliedOnPort", "description": "
Intention : RETRIEVER
findQueueQroupPolicesAppliedOnPort:
class-level [object finder] (retriever) API findQueueQroupPolicesAppliedOnPort
of class rtr.NetworkInterface


", "operationId": "rest_rtr_NetworkInterface_findQueueQroupPolicesAppliedOnPort", "parameters": [ { "name": "portPointer", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findQueueQroupPolicesAppliedOnPortResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rtr/NetworkInterface/requestPolicyAccountStatsClear/{instanceFullName}": { "post": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_NetworkInterface_requestPolicyAccountStatsClear", "description": "Request clearing of Policy Accounting Statistics on this interface.
When this method returns resources for the clear have been allocated
but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestPolicyAccountStatsClear:
instance-level modifier API requestPolicyAccountStatsClear
of class rtr.NetworkInterface
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_rtr_NetworkInterface_requestPolicyAccountStatsClear", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestPolicyAccountStatsClear" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestPolicyAccountStatsClearResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rtr/Peer/shutDown/{instanceFullName}": { "post": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_Peer_shutDown", "operationId": "rest_rtr_Peer_shutDown", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/rtr/Peer/turnUp/{instanceFullName}": { "post": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_Peer_turnUp", "operationId": "rest_rtr_Peer_turnUp", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/rtr/ProtocolSite/shutDown/{instanceFullName}": { "post": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_ProtocolSite_shutDown", "operationId": "rest_rtr_ProtocolSite_shutDown", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/rtr/ProtocolSite/turnUp/{instanceFullName}": { "post": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_ProtocolSite_turnUp", "operationId": "rest_rtr_ProtocolSite_turnUp", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/rtr/ReplicationSegmentPolicyNextHop/configureReplicationLabels": { "post": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_ReplicationSegmentPolicyNextHop_configureReplicationLabels", "operationId": "rest_rtr_ReplicationSegmentPolicyNextHop_configureReplicationLabels", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureReplicationLabels" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/rtr/RoutingInstanceSite/configureMultipleInstances": { "post": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_RoutingInstanceSite_configureMultipleInstances", "description": "This is used to configure a network interface on multiple routing
instances

Intention : MODIFIER
configureMultipleInstances:
class-level [hierarchical administrative configuration/modification] (modifier) API configureMultipleInstances
of class rtr.RoutingInstanceSite
This API follows hierarchical config model rules.
DescendantInfo:
rtr.VirtualRouter
DescendantInfo:
vprn.RoutingInstanceSite


", "operationId": "rest_rtr_RoutingInstanceSite_configureMultipleInstances", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureMultipleInstances" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureMultipleInstancesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rtr/SharedRiskLinkGroup/findInterfaces/{instanceFullName}": { "post": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_SharedRiskLinkGroup_findInterfaces", "description": "
Intention : RETRIEVER
findInterfaces:
instance-level [object finder] (retriever) API findInterfaces
of class rtr.SharedRiskLinkGroup
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_rtr_SharedRiskLinkGroup_findInterfaces", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findInterfaces" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findInterfacesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rtr/StaticArp/find": { "post": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_StaticArp_find", "description": "
Intention : RETRIEVER
find:
class-level [object finder] (retriever) API find
of class rtr.StaticArp


", "operationId": "rest_rtr_StaticArp_find", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rtr/StaticRoute/retrieveVRFStaticRoutes": { "post": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_StaticRoute_retrieveVRFStaticRoutes", "description": "FDN of the site.
FDN of the service.
Static Route Tag.
Method used to query the NE for VRF static routes on a particular service.

Intention : RETRIEVER
retrieveVRFStaticRoutes:
class-level retriever API retrieveVRFStaticRoutes
of class rtr.StaticRoute


", "operationId": "rest_rtr_StaticRoute_retrieveVRFStaticRoutes", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveVRFStaticRoutes" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveVRFStaticRoutesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rtr/VirtualInterface/configureIpAddresses/{instanceFullName}": { "post": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_VirtualInterface_configureIpAddresses", "description": "
Intention : MODIFIER
configureIpAddresses:
instance-level [hierarchical administrative configuration/modification] (modifier) API configureIpAddresses
of class rtr.VirtualInterface
This API follows hierarchical config model rules.
DescendantInfo:
vprn.NetworkInterface
DescendantInfo:
rtr.NetworkInterface
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_rtr_VirtualInterface_configureIpAddresses", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VirtualRouterIpAddressConfigInfo" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureIpAddressesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rtr/VirtualInterface/findByIpAddress": { "post": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_VirtualInterface_findByIpAddress", "description": "
Intention : RETRIEVER
findByIpAddress:
class-level [object finder] (retriever) API findByIpAddress
of class rtr.VirtualInterface
DescendantInfo:
vprn.NetworkInterface
DescendantInfo:
rtr.NetworkInterface


", "operationId": "rest_rtr_VirtualInterface_findByIpAddress", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findByIpAddress" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findByIpAddressResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rtr/VirtualInterface/findByIpAddressFilter": { "post": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_VirtualInterface_findByIpAddressFilter", "description": "
Intention : RETRIEVER
findByIpAddressFilter:
class-level [object finder] (retriever) API findByIpAddressFilter
of class rtr.VirtualInterface
DescendantInfo:
vprn.NetworkInterface
DescendantInfo:
rtr.NetworkInterface


", "operationId": "rest_rtr_VirtualInterface_findByIpAddressFilter", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findByIpAddressFilterResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rtr/VirtualInterface/findByIpAddressList": { "post": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_VirtualInterface_findByIpAddressList", "description": "
Intention : RETRIEVER
findByIpAddressList:
class-level [object finder] (retriever) API findByIpAddressList
of class rtr.VirtualInterface
DescendantInfo:
vprn.NetworkInterface
DescendantInfo:
rtr.NetworkInterface


", "operationId": "rest_rtr_VirtualInterface_findByIpAddressList", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findByIpAddressListResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rtr/VirtualInterface/findByName": { "post": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_VirtualInterface_findByName", "description": "
Intention : RETRIEVER
findByName:
class-level [object finder] (retriever) API findByName
of class rtr.VirtualInterface
DescendantInfo:
vprn.NetworkInterface
DescendantInfo:
rtr.NetworkInterface


", "operationId": "rest_rtr_VirtualInterface_findByName", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findByName" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findByNameResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rtr/VirtualInterface/findProtocols/{instanceFullName}": { "post": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_VirtualInterface_findProtocols", "description": "
Intention : RETRIEVER
findProtocols:
instance-level [object finder] (retriever) API findProtocols
of class rtr.VirtualInterface
DescendantInfo:
vprn.NetworkInterface
DescendantInfo:
rtr.NetworkInterface
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_rtr_VirtualInterface_findProtocols", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findProtocolsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rtr/VirtualInterface/removeIpAddress/{instanceFullName}": { "post": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_VirtualInterface_removeIpAddress", "description": "
Intention : MODIFIER
removeIpAddress:
instance-level [administrative deletion] (modifier) API removeIpAddress
of class rtr.VirtualInterface
DescendantInfo:
vprn.NetworkInterface
DescendantInfo:
rtr.NetworkInterface
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_rtr_VirtualInterface_removeIpAddress", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/removeIpAddressResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rtr/VirtualInterface/shutDown/{instanceFullName}": { "post": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_VirtualInterface_shutDown", "description": "
Intention : MODIFIER
shutDown:
instance-level [administrative shut down] (modifier) API shutDown
of class rtr.VirtualInterface
DescendantInfo:
vprn.NetworkInterface
DescendantInfo:
rtr.NetworkInterface
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_rtr_VirtualInterface_shutDown", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shutDownResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rtr/VirtualInterface/turnUp/{instanceFullName}": { "post": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_VirtualInterface_turnUp", "description": "
Intention : MODIFIER
turnUp:
instance-level [administrative turn up] (modifier) API turnUp
of class rtr.VirtualInterface
DescendantInfo:
vprn.NetworkInterface
DescendantInfo:
rtr.NetworkInterface
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_rtr_VirtualInterface_turnUp", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/turnUpResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rtr/VirtualRouterIpAddress/findSitesFor": { "post": { "tags": [ "samo_rtr" ], "summary": "rest_rtr_VirtualRouterIpAddress_findSitesFor", "description": "Find the sites used by the IP addresses identified by
the filter.

Intention : RETRIEVER
findSitesFor:
class-level [object finder] (retriever) API findSitesFor
of class rtr.VirtualRouterIpAddress
DescendantInfo:
rtr.VirtualRouterSubscriberPrefix


", "operationId": "rest_rtr_VirtualRouterIpAddress_findSitesFor", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findSitesFor" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findSitesForResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/vwmperf/VWMPMPolicy/findVWMs": { "get": { "tags": [ "samo_vwmperf" ], "summary": "rest_vwmperf_VWMPMPolicy_findVWMs", "description": "Find all managed VWMs for the specified Performance Management polling policy assigned.

Intention : RETRIEVER
findVWMs:
class-level [object finder] (retriever) API findVWMs
of class vwmperf.VWMPMPolicy
DescendantInfo:
vwmperf.OSUPMPolicy


", "operationId": "rest_vwmperf_VWMPMPolicy_findVWMs", "parameters": [ { "name": "policyId", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findVWMsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/AbstractPath/findOchCrossConnects/{instanceFullName}": { "get": { "tags": [ "samo_optical" ], "summary": "rest_optical_AbstractPath_findOchCrossConnects", "description": "This method finds all the OCh XCs along this path.

Intention : RETRIEVER
findOchCrossConnects:
instance-level [object finder] (retriever) API findOchCrossConnects
of class optical.AbstractPath
DescendantInfo:
optical.PreviewPath
DescendantInfo:
optical.TrailPath
DescendantInfo:
optical.ServicePath
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_optical_AbstractPath_findOchCrossConnects", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findOchCrossConnectsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/AbstractPath/findOdukCrossConnects/{instanceFullName}": { "get": { "tags": [ "samo_optical" ], "summary": "rest_optical_AbstractPath_findOdukCrossConnects", "description": "This method finds all OdukCrossConnect objects along this path.

Intention : RETRIEVER
findOdukCrossConnects:
instance-level [object finder] (retriever) API findOdukCrossConnects
of class optical.AbstractPath
DescendantInfo:
optical.PreviewPath
DescendantInfo:
optical.TrailPath
DescendantInfo:
optical.ServicePath
instanceFullName : distinguished/instance name of called object
List of ODUk Cross Connects

", "operationId": "rest_optical_AbstractPath_findOdukCrossConnects", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findOdukCrossConnectsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/AbstractPath/findTrails/{instanceFullName}": { "get": { "tags": [ "samo_optical" ], "summary": "rest_optical_AbstractPath_findTrails", "description": "This method finds all the underlying trails associated with this path.

Intention : RETRIEVER
findTrails:
instance-level [object finder] (retriever) API findTrails
of class optical.AbstractPath
DescendantInfo:
optical.PreviewPath
DescendantInfo:
optical.TrailPath
DescendantInfo:
optical.ServicePath
instanceFullName : distinguished/instance name of called object
List of trails

", "operationId": "rest_optical_AbstractPath_findTrails", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findTrailsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/AbstractPath/findVtsConnections/{instanceFullName}": { "get": { "tags": [ "samo_optical" ], "summary": "rest_optical_AbstractPath_findVtsConnections", "description": "This method finds all VtsConnection objects along this path.

Intention : RETRIEVER
findVtsConnections:
instance-level [object finder] (retriever) API findVtsConnections
of class optical.AbstractPath
DescendantInfo:
optical.PreviewPath
DescendantInfo:
optical.TrailPath
DescendantInfo:
optical.ServicePath
instanceFullName : distinguished/instance name of called object
List of Vts Cross Connects

", "operationId": "rest_optical_AbstractPath_findVtsConnections", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findVtsConnectionsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/AbstractPowerAdjustmentRule/abort/{instanceFullName}": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_AbstractPowerAdjustmentRule_abort", "operationId": "rest_optical_AbstractPowerAdjustmentRule_abort", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/AbstractPowerAdjustmentRule/execute/{instanceFullName}": { "put": { "tags": [ "samo_optical" ], "summary": "rest_optical_AbstractPowerAdjustmentRule_execute", "operationId": "rest_optical_AbstractPowerAdjustmentRule_execute", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/ApsGroup/findApplicableOdukFacilityObjects": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_ApsGroup_findApplicableOdukFacilityObjects", "description": "This method finds all applicable client working protection ODUk facility objects required for APS Group creation

Intention : RETRIEVER
findApplicableOdukFacilityObjects:
class-level [object finder] (retriever) API findApplicableOdukFacilityObjects
of class optical.ApsGroup


", "operationId": "rest_optical_ApsGroup_findApplicableOdukFacilityObjects", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findApplicableOdukFacilityObjects" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findApplicableOdukFacilityObjectsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/ApsGroup/findApplicablePorts": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_ApsGroup_findApplicablePorts", "description": "This method finds all applicable client working protection ports required for APS Group creation

Intention : RETRIEVER
findApplicablePorts:
class-level [object finder] (retriever) API findApplicablePorts
of class optical.ApsGroup


", "operationId": "rest_optical_ApsGroup_findApplicablePorts", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findApplicablePorts" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findApplicablePortsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/DiverseService/findSelectableServicesForDiverse": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_DiverseService_findSelectableServicesForDiverse", "description": "This method finds all unprotected services that can be selected for creating a diverse route service

Intention : RETRIEVER
findSelectableServicesForDiverse:
class-level [object finder] (retriever) API findSelectableServicesForDiverse
of class optical.DiverseService


", "operationId": "rest_optical_DiverseService_findSelectableServicesForDiverse", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findSelectableServicesForDiverseResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/EquipAlarmCategory/resyncPerObjectAsap": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_EquipAlarmCategory_resyncPerObjectAsap", "operationId": "rest_optical_EquipAlarmCategory_resyncPerObjectAsap", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/GmreSpecifics/resyncGmre": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_GmreSpecifics_resyncGmre", "operationId": "rest_optical_GmreSpecifics_resyncGmre", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/LoOdukChannel/createCrossConnect": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_LoOdukChannel_createCrossConnect", "operationId": "rest_optical_LoOdukChannel_createCrossConnect", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createCrossConnect" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/OCHTrail/findOchCrossConnects/{instanceFullName}": { "get": { "tags": [ "samo_optical" ], "summary": "rest_optical_OCHTrail_findOchCrossConnects", "description": "This method finds all the OCh XCs associated with this trail.

Intention : RETRIEVER
findOchCrossConnects:
instance-level [object finder] (retriever) API findOchCrossConnects
of class optical.OCHTrail
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_optical_OCHTrail_findOchCrossConnects", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findOchCrossConnectsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/OCStmSpecifics/bindAu/{instanceFullName}": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_OCStmSpecifics_bindAu", "operationId": "rest_optical_OCStmSpecifics_bindAu", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bindAu" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/OCStmSpecifics/collapseAu/{instanceFullName}": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_OCStmSpecifics_collapseAu", "operationId": "rest_optical_OCStmSpecifics_collapseAu", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/ODUTrail/resyncOchCrossConnects/{instanceFullName}": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_ODUTrail_resyncOchCrossConnects", "operationId": "rest_optical_ODUTrail_resyncOchCrossConnects", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/ODUTrail/startDelayMeasurement": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_ODUTrail_startDelayMeasurement", "operationId": "rest_optical_ODUTrail_startDelayMeasurement", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/ODUTrail/stopDelayMeasurement": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_ODUTrail_stopDelayMeasurement", "operationId": "rest_optical_ODUTrail_stopDelayMeasurement", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/OTPortSpecifics/findCardSlot": { "get": { "tags": [ "samo_optical" ], "summary": "rest_optical_OTPortSpecifics_findCardSlot", "description": "This method finds all the client ports which could be multicast to a Line Port.

Intention : RETRIEVER
findCardSlot:
class-level [object finder] (retriever) API findCardSlot
of class optical.OTPortSpecifics


", "operationId": "rest_optical_OTPortSpecifics_findCardSlot", "parameters": [ { "name": "portPointer", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findCardSlotResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/OTPortSpecifics/findMulticastClientPorts/{instanceFullName}": { "get": { "tags": [ "samo_optical" ], "summary": "rest_optical_OTPortSpecifics_findMulticastClientPorts", "description": "This method finds all the client ports which could be multicast to a Line Port.

Intention : RETRIEVER
findMulticastClientPorts:
instance-level [object finder] (retriever) API findMulticastClientPorts
of class optical.OTPortSpecifics
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_optical_OTPortSpecifics_findMulticastClientPorts", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "aInAttributeName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findMulticastClientPortsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/OTUTrail/findDataBearerLinks/{instanceFullName}": { "get": { "tags": [ "samo_optical" ], "summary": "rest_optical_OTUTrail_findDataBearerLinks", "description": "This method finds all the DataBearer links associated with this trail.

Intention : RETRIEVER
findDataBearerLinks:
instance-level [object finder] (retriever) API findDataBearerLinks
of class optical.OTUTrail
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_optical_OTUTrail_findDataBearerLinks", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findDataBearerLinksResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/OTUTrail/findOchCrossConnects/{instanceFullName}": { "get": { "tags": [ "samo_optical" ], "summary": "rest_optical_OTUTrail_findOchCrossConnects", "description": "This method finds all the OCh XCs associated with this trail.

Intention : RETRIEVER
findOchCrossConnects:
instance-level [object finder] (retriever) API findOchCrossConnects
of class optical.OTUTrail
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_optical_OTUTrail_findOchCrossConnects", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findOchCrossConnectsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/OchCrossConnect/findOchCrossConnects": { "get": { "tags": [ "samo_optical" ], "summary": "rest_optical_OchCrossConnect_findOchCrossConnects", "description": "This method finds all Och Cross Connects starting ending passing-through given port.

Intention : RETRIEVER
findOchCrossConnects:
class-level [object finder] (retriever) API findOchCrossConnects
of class optical.OchCrossConnect

List of OchCrossConnects under given physical port.

", "operationId": "rest_optical_OchCrossConnect_findOchCrossConnects", "parameters": [ { "name": "aInPortFdn", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findOchCrossConnectsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/OchCrossConnect/rekeyWithDuplicate": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_OchCrossConnect_rekeyWithDuplicate", "operationId": "rest_optical_OchCrossConnect_rekeyWithDuplicate", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/OcsAlarmProfile/findEntitiesForOcsAlarmProfile/{instanceFullName}": { "get": { "tags": [ "samo_optical" ], "summary": "rest_optical_OcsAlarmProfile_findEntitiesForOcsAlarmProfile", "description": "
Intention : RETRIEVER
findEntitiesForOcsAlarmProfile:
instance-level [object finder] (retriever) API findEntitiesForOcsAlarmProfile
of class optical.OcsAlarmProfile
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_optical_OcsAlarmProfile_findEntitiesForOcsAlarmProfile", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "aInEntityType", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "aInEqptCategory", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findEntitiesForOcsAlarmProfileResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/Odu1PtfChannel/createCrossConnect": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_Odu1PtfChannel_createCrossConnect", "operationId": "rest_optical_Odu1PtfChannel_createCrossConnect", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createCrossConnect" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/Odu1PtfChannel/updateTxTimeslot": { "put": { "tags": [ "samo_optical" ], "summary": "rest_optical_Odu1PtfChannel_updateTxTimeslot", "operationId": "rest_optical_Odu1PtfChannel_updateTxTimeslot", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateTxTimeslot" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/OpticalLink/findClientTrails/{instanceFullName}": { "get": { "tags": [ "samo_optical" ], "summary": "rest_optical_OpticalLink_findClientTrails", "description": "This method finds all immediate client trails (OTS OCH OCH) riding on this optical link.

Intention : RETRIEVER
findClientTrails:
instance-level [object finder] (retriever) API findClientTrails
of class optical.OpticalLink
instanceFullName : distinguished/instance name of called object
List of client trails riding on this optical link.

", "operationId": "rest_optical_OpticalLink_findClientTrails", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findClientTrailsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/OpticalLink/getChannelUsageList": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_OpticalLink_getChannelUsageList", "description": "This method returns list of optical channels riding on external optical links.
Channel usage record contains CWDM DWDM Channel Number, Link Id, Link Name, Link EndpointA, Link endpointB,
Site A End, Site B End, OTU OCH Trail Name, OTU OCH Trail rate, OTU OCH Trail Direction.

Intention : RETRIEVER
getChannelUsageList:
class-level retriever API getChannelUsageList
of class optical.OpticalLink

Optical Channel Usage List.

", "operationId": "rest_optical_OpticalLink_getChannelUsageList", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getChannelUsageListResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/OpticalLink/getChannelUsageListForNEGroups": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_OpticalLink_getChannelUsageListForNEGroups", "description": "This method returns list of optical channels riding on external optical links.
Channel usage record contains CWDM DWDM Channel Number, Link Id, Link Name, Link EndpointA, Link endpointB,
Site A End, Site B End, OTU OCH Trail Name, OTU OCH Trail rate, OTU OCH Trail Direction.

Intention : RETRIEVER
getChannelUsageListForNEGroups:
class-level retriever API getChannelUsageListForNEGroups
of class optical.OpticalLink

Optical Channel Usage List.

", "operationId": "rest_optical_OpticalLink_getChannelUsageListForNEGroups", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getChannelUsageListForNEGroups" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getChannelUsageListForNEGroupsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/OpticalNeProperties/performCardImageDownload/{instanceFullName}": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_OpticalNeProperties_performCardImageDownload", "operationId": "rest_optical_OpticalNeProperties_performCardImageDownload", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/OpticalNeProperties/resyncCardImage/{instanceFullName}": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_OpticalNeProperties_resyncCardImage", "operationId": "rest_optical_OpticalNeProperties_resyncCardImage", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/OpticalNeProperties/updateReadyForDownload/{instanceFullName}": { "put": { "tags": [ "samo_optical" ], "summary": "rest_optical_OpticalNeProperties_updateReadyForDownload", "operationId": "rest_optical_OpticalNeProperties_updateReadyForDownload", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateReadyForDownload" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/OpticalPort/getOpticalPortList": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_OpticalPort_getOpticalPortList", "description": "This method returns list of optical ports.

Intention : RETRIEVER
getOpticalPortList:
class-level retriever API getOpticalPortList
of class optical.OpticalPort

Optical Channel Usage List containing channel number, link name, ODU Trail name, ODU Trail rate etc.

", "operationId": "rest_optical_OpticalPort_getOpticalPortList", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getOpticalPortListResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/OpticalPortSpecifics/findCustomPorts/{instanceFullName}": { "get": { "tags": [ "samo_optical" ], "summary": "rest_optical_OpticalPortSpecifics_findCustomPorts", "description": "This method finds all ports applicable for the passed attribute name as input parameter.

Intention : RETRIEVER
findCustomPorts:
instance-level [object finder] (retriever) API findCustomPorts
of class optical.OpticalPortSpecifics
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_optical_OpticalPortSpecifics_findCustomPorts", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "aInAttributeName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findCustomPortsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/OpticalPortSpecifics/resyncAllWavekeys": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_OpticalPortSpecifics_resyncAllWavekeys", "operationId": "rest_optical_OpticalPortSpecifics_resyncAllWavekeys", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resyncAllWavekeys" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/OtdrScanSpecifics/executeScanCommand/{instanceFullName}": { "put": { "tags": [ "samo_optical" ], "summary": "rest_optical_OtdrScanSpecifics_executeScanCommand", "operationId": "rest_optical_OtdrScanSpecifics_executeScanCommand", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/OtdrScanTransfer/retrieveFile/{instanceFullName}": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_OtdrScanTransfer_retrieveFile", "operationId": "rest_optical_OtdrScanTransfer_retrieveFile", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/OtuOduSpecifics/updateTimeSlots": { "put": { "tags": [ "samo_optical" ], "summary": "rest_optical_OtuOduSpecifics_updateTimeSlots", "operationId": "rest_optical_OtuOduSpecifics_updateTimeSlots", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateTimeSlots" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/PointToPointConnection/findAssociatedServices/{instanceFullName}": { "get": { "tags": [ "samo_optical" ], "summary": "rest_optical_PointToPointConnection_findAssociatedServices", "description": "This method finds all the transport services riding on this connection.

Intention : RETRIEVER
findAssociatedServices:
instance-level [object finder] (retriever) API findAssociatedServices
of class optical.PointToPointConnection
DescendantInfo:
optical.CrossConnect
DescendantInfo:
gmpls.DbLink
DescendantInfo:
optical.LoOdukCrossConnect
DescendantInfo:
optical.OTCrossConnect
DescendantInfo:
optical.OTUTrail
DescendantInfo:
opticalrouting.LightPathSegment
DescendantInfo:
optical.VirtualOdukCrossConnect
DescendantInfo:
gmpls.DataBearerPointToPointConnection
DescendantInfo:
optical.OTSTrail
DescendantInfo:
oth.AbstractCrossConnect
DescendantInfo:
oth.AbstractOdukCrossConnect
DescendantInfo:
optical.OMSTrail
DescendantInfo:
optical.OchCrossConnectGroup
DescendantInfo:
gmpls.OpticalGLSPConnection
DescendantInfo:
optical.OchCrossConnect
DescendantInfo:
tdm.AbstractTDMCrossConnect
DescendantInfo:
optical.ODUTrail
DescendantInfo:
gmpls.RegenPair
DescendantInfo:
optical.VirtualOchCrossConnect
DescendantInfo:
oth.OdukCrossConnect
DescendantInfo:
optical.OCHTrail
DescendantInfo:
optical.ServicePath
DescendantInfo:
optical.OdukCrossConnect
DescendantInfo:
optical.PreviewPath
DescendantInfo:
oth.VirtualOdukCrossConnect
DescendantInfo:
opticalrouting.LightPath
DescendantInfo:
optical.STMTrail
DescendantInfo:
optical.TrailPath
DescendantInfo:
optical.Trail
DescendantInfo:
gmpls.VirtualOchCrossConnect
DescendantInfo:
optical.AbstractOchConnection
DescendantInfo:
optical.PortTrail
DescendantInfo:
optical.OptsgOdukCrossConnect
DescendantInfo:
optical.AbstractPath
DescendantInfo:
tdm.VcnCrossConnect
DescendantInfo:
gmpls.AbstractOpticalGLSPConnection
DescendantInfo:
optical.VtsConnection
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_optical_PointToPointConnection_findAssociatedServices", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAssociatedServicesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/PointToPointConnection/findHops/{instanceFullName}": { "get": { "tags": [ "samo_optical" ], "summary": "rest_optical_PointToPointConnection_findHops", "description": "This method finds all hops belonging to this connection in direction A->Z or Z->A.

Intention : RETRIEVER
findHops:
instance-level [object finder] (retriever) API findHops
of class optical.PointToPointConnection
DescendantInfo:
optical.CrossConnect
DescendantInfo:
gmpls.DbLink
DescendantInfo:
optical.LoOdukCrossConnect
DescendantInfo:
optical.OTCrossConnect
DescendantInfo:
optical.OTUTrail
DescendantInfo:
opticalrouting.LightPathSegment
DescendantInfo:
optical.VirtualOdukCrossConnect
DescendantInfo:
gmpls.DataBearerPointToPointConnection
DescendantInfo:
optical.OTSTrail
DescendantInfo:
oth.AbstractCrossConnect
DescendantInfo:
oth.AbstractOdukCrossConnect
DescendantInfo:
optical.OMSTrail
DescendantInfo:
optical.OchCrossConnectGroup
DescendantInfo:
gmpls.OpticalGLSPConnection
DescendantInfo:
optical.OchCrossConnect
DescendantInfo:
tdm.AbstractTDMCrossConnect
DescendantInfo:
optical.ODUTrail
DescendantInfo:
gmpls.RegenPair
DescendantInfo:
optical.VirtualOchCrossConnect
DescendantInfo:
oth.OdukCrossConnect
DescendantInfo:
optical.OCHTrail
DescendantInfo:
optical.ServicePath
DescendantInfo:
optical.OdukCrossConnect
DescendantInfo:
optical.PreviewPath
DescendantInfo:
oth.VirtualOdukCrossConnect
DescendantInfo:
opticalrouting.LightPath
DescendantInfo:
optical.STMTrail
DescendantInfo:
optical.TrailPath
DescendantInfo:
optical.Trail
DescendantInfo:
gmpls.VirtualOchCrossConnect
DescendantInfo:
optical.AbstractOchConnection
DescendantInfo:
optical.PortTrail
DescendantInfo:
optical.OptsgOdukCrossConnect
DescendantInfo:
optical.AbstractPath
DescendantInfo:
tdm.VcnCrossConnect
DescendantInfo:
gmpls.AbstractOpticalGLSPConnection
DescendantInfo:
optical.VtsConnection
instanceFullName : distinguished/instance name of called object
List of hops in A->Z or Z->A direction.

", "operationId": "rest_optical_PointToPointConnection_findHops", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "reverseDirection", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findHopsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/PointToPointConnection/findOpticalLinks/{instanceFullName}": { "get": { "tags": [ "samo_optical" ], "summary": "rest_optical_PointToPointConnection_findOpticalLinks", "description": "This method finds all optical links that are part of this connection.

Intention : RETRIEVER
findOpticalLinks:
instance-level [object finder] (retriever) API findOpticalLinks
of class optical.PointToPointConnection
DescendantInfo:
optical.CrossConnect
DescendantInfo:
gmpls.DbLink
DescendantInfo:
optical.LoOdukCrossConnect
DescendantInfo:
optical.OTCrossConnect
DescendantInfo:
optical.OTUTrail
DescendantInfo:
opticalrouting.LightPathSegment
DescendantInfo:
optical.VirtualOdukCrossConnect
DescendantInfo:
gmpls.DataBearerPointToPointConnection
DescendantInfo:
optical.OTSTrail
DescendantInfo:
oth.AbstractCrossConnect
DescendantInfo:
oth.AbstractOdukCrossConnect
DescendantInfo:
optical.OMSTrail
DescendantInfo:
optical.OchCrossConnectGroup
DescendantInfo:
gmpls.OpticalGLSPConnection
DescendantInfo:
optical.OchCrossConnect
DescendantInfo:
tdm.AbstractTDMCrossConnect
DescendantInfo:
optical.ODUTrail
DescendantInfo:
gmpls.RegenPair
DescendantInfo:
optical.VirtualOchCrossConnect
DescendantInfo:
oth.OdukCrossConnect
DescendantInfo:
optical.OCHTrail
DescendantInfo:
optical.ServicePath
DescendantInfo:
optical.OdukCrossConnect
DescendantInfo:
optical.PreviewPath
DescendantInfo:
oth.VirtualOdukCrossConnect
DescendantInfo:
opticalrouting.LightPath
DescendantInfo:
optical.STMTrail
DescendantInfo:
optical.TrailPath
DescendantInfo:
optical.Trail
DescendantInfo:
gmpls.VirtualOchCrossConnect
DescendantInfo:
optical.AbstractOchConnection
DescendantInfo:
optical.PortTrail
DescendantInfo:
optical.OptsgOdukCrossConnect
DescendantInfo:
optical.AbstractPath
DescendantInfo:
tdm.VcnCrossConnect
DescendantInfo:
gmpls.AbstractOpticalGLSPConnection
DescendantInfo:
optical.VtsConnection
instanceFullName : distinguished/instance name of called object
List of optical links that are part of this connection.

", "operationId": "rest_optical_PointToPointConnection_findOpticalLinks", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findOpticalLinksResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/PointToPointConnection/getHopsCount/{instanceFullName}": { "get": { "tags": [ "samo_optical" ], "summary": "rest_optical_PointToPointConnection_getHopsCount", "description": "This method finds hops count belonging to this connection in direction A->Z or Z->A.

Intention : RETRIEVER
getHopsCount:
instance-level retriever API getHopsCount
of class optical.PointToPointConnection
DescendantInfo:
optical.CrossConnect
DescendantInfo:
gmpls.DbLink
DescendantInfo:
optical.LoOdukCrossConnect
DescendantInfo:
optical.OTCrossConnect
DescendantInfo:
optical.OTUTrail
DescendantInfo:
opticalrouting.LightPathSegment
DescendantInfo:
optical.VirtualOdukCrossConnect
DescendantInfo:
gmpls.DataBearerPointToPointConnection
DescendantInfo:
optical.OTSTrail
DescendantInfo:
oth.AbstractCrossConnect
DescendantInfo:
oth.AbstractOdukCrossConnect
DescendantInfo:
optical.OMSTrail
DescendantInfo:
optical.OchCrossConnectGroup
DescendantInfo:
gmpls.OpticalGLSPConnection
DescendantInfo:
optical.OchCrossConnect
DescendantInfo:
tdm.AbstractTDMCrossConnect
DescendantInfo:
optical.ODUTrail
DescendantInfo:
gmpls.RegenPair
DescendantInfo:
optical.VirtualOchCrossConnect
DescendantInfo:
oth.OdukCrossConnect
DescendantInfo:
optical.OCHTrail
DescendantInfo:
optical.ServicePath
DescendantInfo:
optical.OdukCrossConnect
DescendantInfo:
optical.PreviewPath
DescendantInfo:
oth.VirtualOdukCrossConnect
DescendantInfo:
opticalrouting.LightPath
DescendantInfo:
optical.STMTrail
DescendantInfo:
optical.TrailPath
DescendantInfo:
optical.Trail
DescendantInfo:
gmpls.VirtualOchCrossConnect
DescendantInfo:
optical.AbstractOchConnection
DescendantInfo:
optical.PortTrail
DescendantInfo:
optical.OptsgOdukCrossConnect
DescendantInfo:
optical.AbstractPath
DescendantInfo:
tdm.VcnCrossConnect
DescendantInfo:
gmpls.AbstractOpticalGLSPConnection
DescendantInfo:
optical.VtsConnection
instanceFullName : distinguished/instance name of called object
Number of hops in A->Z or Z->A direction.

", "operationId": "rest_optical_PointToPointConnection_getHopsCount", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "reverseDirection", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getHopsCountResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/PointToPointConnection/isConnectionReversed/{instanceFullName}": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_PointToPointConnection_isConnectionReversed", "description": "This method checks whether connection endpoints reversed or not.

Intention : RETRIEVER
isConnectionReversed:
instance-level retriever API isConnectionReversed
of class optical.PointToPointConnection
DescendantInfo:
optical.CrossConnect
DescendantInfo:
gmpls.DbLink
DescendantInfo:
optical.LoOdukCrossConnect
DescendantInfo:
optical.OTCrossConnect
DescendantInfo:
optical.OTUTrail
DescendantInfo:
opticalrouting.LightPathSegment
DescendantInfo:
optical.VirtualOdukCrossConnect
DescendantInfo:
gmpls.DataBearerPointToPointConnection
DescendantInfo:
optical.OTSTrail
DescendantInfo:
oth.AbstractCrossConnect
DescendantInfo:
oth.AbstractOdukCrossConnect
DescendantInfo:
optical.OMSTrail
DescendantInfo:
optical.OchCrossConnectGroup
DescendantInfo:
gmpls.OpticalGLSPConnection
DescendantInfo:
optical.OchCrossConnect
DescendantInfo:
tdm.AbstractTDMCrossConnect
DescendantInfo:
optical.ODUTrail
DescendantInfo:
gmpls.RegenPair
DescendantInfo:
optical.VirtualOchCrossConnect
DescendantInfo:
oth.OdukCrossConnect
DescendantInfo:
optical.OCHTrail
DescendantInfo:
optical.ServicePath
DescendantInfo:
optical.OdukCrossConnect
DescendantInfo:
optical.PreviewPath
DescendantInfo:
oth.VirtualOdukCrossConnect
DescendantInfo:
opticalrouting.LightPath
DescendantInfo:
optical.STMTrail
DescendantInfo:
optical.TrailPath
DescendantInfo:
optical.Trail
DescendantInfo:
gmpls.VirtualOchCrossConnect
DescendantInfo:
optical.AbstractOchConnection
DescendantInfo:
optical.PortTrail
DescendantInfo:
optical.OptsgOdukCrossConnect
DescendantInfo:
optical.AbstractPath
DescendantInfo:
tdm.VcnCrossConnect
DescendantInfo:
gmpls.AbstractOpticalGLSPConnection
DescendantInfo:
optical.VtsConnection
instanceFullName : distinguished/instance name of called object
True if connection reversed, else false.

", "operationId": "rest_optical_PointToPointConnection_isConnectionReversed", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/isConnectionReversedResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/PortTCAProfileAssigner/clearCounters/{instanceFullName}": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_PortTCAProfileAssigner_clearCounters", "operationId": "rest_optical_PortTCAProfileAssigner_clearCounters", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/PreviewPath/findHops/{instanceFullName}": { "get": { "tags": [ "samo_optical" ], "summary": "rest_optical_PreviewPath_findHops", "description": "This method finds all preview hops belonging to this connection in direction A->Z or Z->A.

Intention : RETRIEVER
findHops:
instance-level [object finder] (retriever) API findHops
of class optical.PreviewPath
instanceFullName : distinguished/instance name of called object
List of hops in A->Z or Z->A direction.

", "operationId": "rest_optical_PreviewPath_findHops", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "traversalType", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findHopsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/ServicePath/findVcnCrossConnects/{instanceFullName}": { "get": { "tags": [ "samo_optical" ], "summary": "rest_optical_ServicePath_findVcnCrossConnects", "description": "This method finds all the underlying vcn cross connects associated with this path.

Intention : RETRIEVER
findVcnCrossConnects:
instance-level [object finder] (retriever) API findVcnCrossConnects
of class optical.ServicePath
instanceFullName : distinguished/instance name of called object
List of VCN XCs

", "operationId": "rest_optical_ServicePath_findVcnCrossConnects", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findVcnCrossConnectsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/ServiceSite/findValidTerminatingPortsForService": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_ServiceSite_findValidTerminatingPortsForService", "description": "
Intention : RETRIEVER
findValidTerminatingPortsForService:
class-level [object finder] (retriever) API findValidTerminatingPortsForService
of class optical.ServiceSite


", "operationId": "rest_optical_ServiceSite_findValidTerminatingPortsForService", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findValidTerminatingPortsForService" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findValidTerminatingPortsForServiceResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/ServiceSite/findValidTerminatingPortsForServiceControlPlane": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_ServiceSite_findValidTerminatingPortsForServiceControlPlane", "description": "
Intention : RETRIEVER
findValidTerminatingPortsForServiceControlPlane:
class-level [object finder] (retriever) API findValidTerminatingPortsForServiceControlPlane
of class optical.ServiceSite


", "operationId": "rest_optical_ServiceSite_findValidTerminatingPortsForServiceControlPlane", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findValidTerminatingPortsForServiceControlPlane" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findValidTerminatingPortsForServiceControlPlaneResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/Trail/completeTrails": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_Trail_completeTrails", "operationId": "rest_optical_Trail_completeTrails", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/Trail/configureAinsMode/{instanceFullName}": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_Trail_configureAinsMode", "description": "This method transitions the trail to Automatic In-Service mode.

Intention : MODIFIER
configureAinsMode:
instance-level [hierarchical administrative configuration/modification] (modifier) API configureAinsMode
of class optical.Trail
This API follows hierarchical config model rules.
DescendantInfo:
optical.OTSTrail
DescendantInfo:
optical.STMTrail
DescendantInfo:
optical.OCHTrail
DescendantInfo:
optical.OMSTrail
DescendantInfo:
optical.PortTrail
DescendantInfo:
optical.OTUTrail
DescendantInfo:
optical.ODUTrail
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_optical_Trail_configureAinsMode", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureAinsModeResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/Trail/configureMaintenanceMode/{instanceFullName}": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_Trail_configureMaintenanceMode", "description": "This method transitions the trail to maintenance mode.

Intention : MODIFIER
configureMaintenanceMode:
instance-level [hierarchical administrative configuration/modification] (modifier) API configureMaintenanceMode
of class optical.Trail
This API follows hierarchical config model rules.
DescendantInfo:
optical.OTSTrail
DescendantInfo:
optical.STMTrail
DescendantInfo:
optical.OCHTrail
DescendantInfo:
optical.OMSTrail
DescendantInfo:
optical.PortTrail
DescendantInfo:
optical.OTUTrail
DescendantInfo:
optical.ODUTrail
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_optical_Trail_configureMaintenanceMode", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureMaintenanceModeResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/Trail/deleteTrails": { "delete": { "tags": [ "samo_optical" ], "summary": "rest_optical_Trail_deleteTrails", "operationId": "rest_optical_Trail_deleteTrails", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/Trail/discoverClientTrails": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_Trail_discoverClientTrails", "operationId": "rest_optical_Trail_discoverClientTrails", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/Trail/discoverTrail": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_Trail_discoverTrail", "operationId": "rest_optical_Trail_discoverTrail", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/discoverTrail" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/Trail/discoverTrails": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_Trail_discoverTrails", "operationId": "rest_optical_Trail_discoverTrails", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/Trail/findAllServerTrails/{instanceFullName}": { "get": { "tags": [ "samo_optical" ], "summary": "rest_optical_Trail_findAllServerTrails", "description": "This method finds all server trails for this trail.

Intention : RETRIEVER
findAllServerTrails:
instance-level [object finder] (retriever) API findAllServerTrails
of class optical.Trail
DescendantInfo:
optical.OTSTrail
DescendantInfo:
optical.STMTrail
DescendantInfo:
optical.OCHTrail
DescendantInfo:
optical.OMSTrail
DescendantInfo:
optical.PortTrail
DescendantInfo:
optical.OTUTrail
DescendantInfo:
optical.ODUTrail
instanceFullName : distinguished/instance name of called object
List of server PointToPointConnection objects

", "operationId": "rest_optical_Trail_findAllServerTrails", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAllServerTrailsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/Trail/findAndCompleteTrail": { "get": { "tags": [ "samo_optical" ], "summary": "rest_optical_Trail_findAndCompleteTrail", "operationId": "rest_optical_Trail_findAndCompleteTrail", "parameters": [ { "name": "endpointAPointer", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "endpointZPointer", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "ignoreDirection", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/Trail/findApsGroups/{instanceFullName}": { "get": { "tags": [ "samo_optical" ], "summary": "rest_optical_Trail_findApsGroups", "description": "This method finds all APS groups used for this trail.

Intention : RETRIEVER
findApsGroups:
instance-level [object finder] (retriever) API findApsGroups
of class optical.Trail
DescendantInfo:
optical.OTSTrail
DescendantInfo:
optical.STMTrail
DescendantInfo:
optical.OCHTrail
DescendantInfo:
optical.OMSTrail
DescendantInfo:
optical.PortTrail
DescendantInfo:
optical.OTUTrail
DescendantInfo:
optical.ODUTrail
instanceFullName : distinguished/instance name of called object
List of APS groups

", "operationId": "rest_optical_Trail_findApsGroups", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findApsGroupsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/Trail/findClientTrails/{instanceFullName}": { "get": { "tags": [ "samo_optical" ], "summary": "rest_optical_Trail_findClientTrails", "description": "This method finds all client trails riding on this trail.

Intention : RETRIEVER
findClientTrails:
instance-level [object finder] (retriever) API findClientTrails
of class optical.Trail
DescendantInfo:
optical.OTSTrail
DescendantInfo:
optical.STMTrail
DescendantInfo:
optical.OCHTrail
DescendantInfo:
optical.OMSTrail
DescendantInfo:
optical.PortTrail
DescendantInfo:
optical.OTUTrail
DescendantInfo:
optical.ODUTrail
instanceFullName : distinguished/instance name of called object
List of client connections services

", "operationId": "rest_optical_Trail_findClientTrails", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findClientTrailsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/Trail/findServerTrails/{instanceFullName}": { "get": { "tags": [ "samo_optical" ], "summary": "rest_optical_Trail_findServerTrails", "description": "Given the protection state (unprotected working protection), this method finds
the matching server trails that this trail is riding on.

Intention : RETRIEVER
findServerTrails:
instance-level [object finder] (retriever) API findServerTrails
of class optical.Trail
DescendantInfo:
optical.OTSTrail
DescendantInfo:
optical.STMTrail
DescendantInfo:
optical.OCHTrail
DescendantInfo:
optical.OMSTrail
DescendantInfo:
optical.PortTrail
DescendantInfo:
optical.OTUTrail
DescendantInfo:
optical.ODUTrail
instanceFullName : distinguished/instance name of called object
List of server PointToPointConnection objects

", "operationId": "rest_optical_Trail_findServerTrails", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "aInProtectionState", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findServerTrailsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/Trail/rekeyConnection/{instanceFullName}": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_Trail_rekeyConnection", "operationId": "rest_optical_Trail_rekeyConnection", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "integer", "format": "int32" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/Trail/shutDown/{instanceFullName}": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_Trail_shutDown", "operationId": "rest_optical_Trail_shutDown", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "boolean" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/Trail/turnUp/{instanceFullName}": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_Trail_turnUp", "operationId": "rest_optical_Trail_turnUp", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "boolean" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/Trail/unmanageTrails": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_Trail_unmanageTrails", "operationId": "rest_optical_Trail_unmanageTrails", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/TrailSite/findValidTerminationPointsForTrail": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_TrailSite_findValidTerminationPointsForTrail", "description": "
Intention : RETRIEVER
findValidTerminationPointsForTrail:
class-level [object finder] (retriever) API findValidTerminationPointsForTrail
of class optical.TrailSite


", "operationId": "rest_optical_TrailSite_findValidTerminationPointsForTrail", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findValidTerminationPointsForTrail" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findValidTerminationPointsForTrailResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/TransportService/completeService": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_TransportService_completeService", "operationId": "rest_optical_TransportService_completeService", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/TransportService/configureAinsMode/{instanceFullName}": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_TransportService_configureAinsMode", "description": "This method transitions the service to Automatic In-Service mode.

Intention : MODIFIER
configureAinsMode:
instance-level [hierarchical administrative configuration/modification] (modifier) API configureAinsMode
of class optical.TransportService
This API follows hierarchical config model rules.
DescendantInfo:
optical.MultipointTransportService
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_optical_TransportService_configureAinsMode", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureAinsModeResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/TransportService/configureMaintenanceMode/{instanceFullName}": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_TransportService_configureMaintenanceMode", "description": "This method transitions the service to maintenance mode.

Intention : MODIFIER
configureMaintenanceMode:
instance-level [hierarchical administrative configuration/modification] (modifier) API configureMaintenanceMode
of class optical.TransportService
This API follows hierarchical config model rules.
DescendantInfo:
optical.MultipointTransportService
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_optical_TransportService_configureMaintenanceMode", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureMaintenanceModeResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/TransportService/deleteServices": { "delete": { "tags": [ "samo_optical" ], "summary": "rest_optical_TransportService_deleteServices", "operationId": "rest_optical_TransportService_deleteServices", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/TransportService/deleteWithODUTrail/{instanceFullName}": { "delete": { "tags": [ "samo_optical" ], "summary": "rest_optical_TransportService_deleteWithODUTrail", "operationId": "rest_optical_TransportService_deleteWithODUTrail", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/TransportService/discoverService": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_TransportService_discoverService", "operationId": "rest_optical_TransportService_discoverService", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/TransportService/discoverServiceNEs": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_TransportService_discoverServiceNEs", "operationId": "rest_optical_TransportService_discoverServiceNEs", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/TransportService/discoverServiceOnTrails": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_TransportService_discoverServiceOnTrails", "operationId": "rest_optical_TransportService_discoverServiceOnTrails", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/TransportService/findAllServicePaths/{instanceFullName}": { "get": { "tags": [ "samo_optical" ], "summary": "rest_optical_TransportService_findAllServicePaths", "description": "This method returns all the ServicePath objects for this transport service

Intention : RETRIEVER
findAllServicePaths:
instance-level [object finder] (retriever) API findAllServicePaths
of class optical.TransportService
DescendantInfo:
optical.MultipointTransportService
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_optical_TransportService_findAllServicePaths", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAllServicePathsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/TransportService/findApsGroups/{instanceFullName}": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_TransportService_findApsGroups", "description": "This method finds all APS Groups used for this service

Intention : RETRIEVER
findApsGroups:
instance-level [object finder] (retriever) API findApsGroups
of class optical.TransportService
DescendantInfo:
optical.MultipointTransportService
instanceFullName : distinguished/instance name of called object
List of APS groups

", "operationId": "rest_optical_TransportService_findApsGroups", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findApsGroupsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/TransportService/findServicePath/{instanceFullName}": { "get": { "tags": [ "samo_optical" ], "summary": "rest_optical_TransportService_findServicePath", "description": "This method returns the ServicePath object with serviceMode matching the in

Intention : RETRIEVER
findServicePath:
instance-level [object finder] (retriever) API findServicePath
of class optical.TransportService
DescendantInfo:
optical.MultipointTransportService
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_optical_TransportService_findServicePath", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "serviceMode", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findServicePathResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/TransportService/getAlarms/{instanceFullName}": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_TransportService_getAlarms", "description": "This method returns alarms on all failed objects in
a service.It used by Optical Service View web app.

Intention : RETRIEVER
getAlarms:
instance-level retriever API getAlarms
of class optical.TransportService
DescendantInfo:
optical.MultipointTransportService
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_optical_TransportService_getAlarms", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getAlarmsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/TransportService/getHopsCount": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_TransportService_getHopsCount", "description": "This method finds hops count belonging to this connection in direction A->Z or Z->A.

Intention : RETRIEVER
getHopsCount:
class-level retriever API getHopsCount
of class optical.TransportService
DescendantInfo:
optical.MultipointTransportService

Number of hops in A->Z Z->A direction.

", "operationId": "rest_optical_TransportService_getHopsCount", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getHopsCount" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getHopsCountResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/TransportService/lightPathTrace": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_TransportService_lightPathTrace", "description": "Given a physical port and ITUChannel, this method traces the optical channel across the shelf.

Intention : RETRIEVER
lightPathTrace:
class-level retriever API lightPathTrace
of class optical.TransportService
DescendantInfo:
optical.MultipointTransportService


", "operationId": "rest_optical_TransportService_lightPathTrace", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lightPathTrace" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lightPathTraceResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/optical/TransportService/recomputeStates": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_TransportService_recomputeStates", "operationId": "rest_optical_TransportService_recomputeStates", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/TransportService/rekeyConnection/{instanceFullName}": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_TransportService_rekeyConnection", "operationId": "rest_optical_TransportService_rekeyConnection", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "integer", "format": "int32" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/TransportService/shutDown/{instanceFullName}": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_TransportService_shutDown", "operationId": "rest_optical_TransportService_shutDown", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "boolean" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/TransportService/turnUpService/{instanceFullName}": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_TransportService_turnUpService", "operationId": "rest_optical_TransportService_turnUpService", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "boolean" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/TransportService/unmanageServices": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_TransportService_unmanageServices", "operationId": "rest_optical_TransportService_unmanageServices", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/VtsAlarmCategory/resyncPerVtsObjectAsap": { "post": { "tags": [ "samo_optical" ], "summary": "rest_optical_VtsAlarmCategory_resyncPerVtsObjectAsap", "operationId": "rest_optical_VtsAlarmCategory_resyncPerVtsObjectAsap", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resyncPerVtsObjectAsap" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/optical/VtsConnection/findValidTerminatingPortsForVtsConnection": { "get": { "tags": [ "samo_optical" ], "summary": "rest_optical_VtsConnection_findValidTerminatingPortsForVtsConnection", "description": "
Intention : RETRIEVER
findValidTerminatingPortsForVtsConnection:
class-level [object finder] (retriever) API findValidTerminatingPortsForVtsConnection
of class optical.VtsConnection


", "operationId": "rest_optical_VtsConnection_findValidTerminatingPortsForVtsConnection", "parameters": [ { "name": "aInSiteId", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "aInOtherEndpointFdn", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findValidTerminatingPortsForVtsConnectionResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/nge/Domain/configureDomainSites/{instanceFullName}": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_Domain_configureDomainSites", "description": "This method creates NGE Domain Site objects.

Intention : MODIFIER
configureDomainSites:
instance-level [hierarchical administrative configuration/modification] (modifier) API configureDomainSites
of class nge.Domain
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_nge_Domain_configureDomainSites", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureDomainSitesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/nge/Domain/configureKeyGroupEthBindings/{instanceFullName}": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_Domain_configureKeyGroupEthBindings", "description": "This method creates Key Group L2 Ethernet Ports objects.

Intention : MODIFIER
configureKeyGroupEthBindings:
instance-level [hierarchical administrative configuration/modification] (modifier) API configureKeyGroupEthBindings
of class nge.Domain
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_nge_Domain_configureKeyGroupEthBindings", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureKeyGroupEthBindingsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/nge/Domain/configureKeyGroupRIBindings/{instanceFullName}": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_Domain_configureKeyGroupRIBindings", "description": "This method creates Key Group L3 Router Interface objects.

Intention : MODIFIER
configureKeyGroupRIBindings:
instance-level [hierarchical administrative configuration/modification] (modifier) API configureKeyGroupRIBindings
of class nge.Domain
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_nge_Domain_configureKeyGroupRIBindings", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureKeyGroupRIBindingsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/nge/Domain/disableEthEncryption/{instanceFullName}": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_Domain_disableEthEncryption", "operationId": "rest_nge_Domain_disableEthEncryption", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/nge/Domain/disableRIEncryption/{instanceFullName}": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_Domain_disableRIEncryption", "operationId": "rest_nge_Domain_disableRIEncryption", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/nge/Domain/enableEthEncryption/{instanceFullName}": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_Domain_enableEthEncryption", "operationId": "rest_nge_Domain_enableEthEncryption", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/nge/Domain/enableRIEncryption/{instanceFullName}": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_Domain_enableRIEncryption", "operationId": "rest_nge_Domain_enableRIEncryption", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/nge/Domain/ngeDiscoveryDomainSites/{instanceFullName}": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_Domain_ngeDiscoveryDomainSites", "operationId": "rest_nge_Domain_ngeDiscoveryDomainSites", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/nge/GatewayInterface/findGatewayInterfacesWithRiBinding/{instanceFullName}": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_GatewayInterface_findGatewayInterfacesWithRiBinding", "description": "NGE discovery multiple nodes

Intention : MODIFIER
findGatewayInterfacesWithRiBinding:
instance-level [object finder] (modifier) API findGatewayInterfacesWithRiBinding
of class nge.GatewayInterface
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_nge_GatewayInterface_findGatewayInterfacesWithRiBinding", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findGatewayInterfacesWithRiBindingResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/nge/GroupEncryptionLabel/removeLocalGroupEncryptionLabels/{instanceFullName}": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_GroupEncryptionLabel_removeLocalGroupEncryptionLabels", "operationId": "rest_nge_GroupEncryptionLabel_removeLocalGroupEncryptionLabels", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/nge/KeyGroup/configureKeyGroupPwBindings/{instanceFullName}": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_KeyGroup_configureKeyGroupPwBindings", "description": "This method creates key group PW Template binding objects.

Intention : MODIFIER
configureKeyGroupPwBindings:
instance-level [hierarchical administrative configuration/modification] (modifier) API configureKeyGroupPwBindings
of class nge.KeyGroup
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_nge_KeyGroup_configureKeyGroupPwBindings", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureKeyGroupPwBindingsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/nge/KeyGroup/configureKeyGroupSdpBindings/{instanceFullName}": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_KeyGroup_configureKeyGroupSdpBindings", "description": "This method creates key group SDP binding objects.

Intention : MODIFIER
configureKeyGroupSdpBindings:
instance-level [hierarchical administrative configuration/modification] (modifier) API configureKeyGroupSdpBindings
of class nge.KeyGroup
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_nge_KeyGroup_configureKeyGroupSdpBindings", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureKeyGroupSdpBindingsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/nge/KeyGroup/configureKeyGroupWlanGwBindings/{instanceFullName}": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_KeyGroup_configureKeyGroupWlanGwBindings", "description": "This method creates key group WLAN Gateway binding objects.

Intention : MODIFIER
configureKeyGroupWlanGwBindings:
instance-level [hierarchical administrative configuration/modification] (modifier) API configureKeyGroupWlanGwBindings
of class nge.KeyGroup
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_nge_KeyGroup_configureKeyGroupWlanGwBindings", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureKeyGroupWlanGwBindingsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/nge/KeyGroup/configureVprnEncryptionServices/{instanceFullName}": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_KeyGroup_configureVprnEncryptionServices", "description": "This method creates key group VRF binding objects.

Intention : MODIFIER
configureVprnEncryptionServices:
instance-level [hierarchical administrative configuration/modification] (modifier) API configureVprnEncryptionServices
of class nge.KeyGroup
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_nge_KeyGroup_configureVprnEncryptionServices", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureVprnEncryptionServicesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/nge/KeyGroup/disableDomainEthEncryption/{instanceFullName}": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_KeyGroup_disableDomainEthEncryption", "operationId": "rest_nge_KeyGroup_disableDomainEthEncryption", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/nge/KeyGroup/disableDomainRIEncryption/{instanceFullName}": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_KeyGroup_disableDomainRIEncryption", "operationId": "rest_nge_KeyGroup_disableDomainRIEncryption", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/nge/KeyGroup/disablePwEncryption/{instanceFullName}": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_KeyGroup_disablePwEncryption", "operationId": "rest_nge_KeyGroup_disablePwEncryption", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/nge/KeyGroup/disableSdpEncryption/{instanceFullName}": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_KeyGroup_disableSdpEncryption", "operationId": "rest_nge_KeyGroup_disableSdpEncryption", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/nge/KeyGroup/disableVprnEncryption/{instanceFullName}": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_KeyGroup_disableVprnEncryption", "operationId": "rest_nge_KeyGroup_disableVprnEncryption", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/nge/KeyGroup/disableWlanGwEncryption/{instanceFullName}": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_KeyGroup_disableWlanGwEncryption", "operationId": "rest_nge_KeyGroup_disableWlanGwEncryption", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/nge/KeyGroup/enableDomainEthEncryption/{instanceFullName}": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_KeyGroup_enableDomainEthEncryption", "operationId": "rest_nge_KeyGroup_enableDomainEthEncryption", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/nge/KeyGroup/enableDomainRIEncryption/{instanceFullName}": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_KeyGroup_enableDomainRIEncryption", "operationId": "rest_nge_KeyGroup_enableDomainRIEncryption", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/nge/KeyGroup/enablePwEncryption/{instanceFullName}": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_KeyGroup_enablePwEncryption", "operationId": "rest_nge_KeyGroup_enablePwEncryption", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/nge/KeyGroup/enableSdpEncryption/{instanceFullName}": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_KeyGroup_enableSdpEncryption", "operationId": "rest_nge_KeyGroup_enableSdpEncryption", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/nge/KeyGroup/enableVprnEncryption/{instanceFullName}": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_KeyGroup_enableVprnEncryption", "operationId": "rest_nge_KeyGroup_enableVprnEncryption", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/nge/KeyGroup/enableWlanGwEncryption/{instanceFullName}": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_KeyGroup_enableWlanGwEncryption", "operationId": "rest_nge_KeyGroup_enableWlanGwEncryption", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/nge/KeyGroup/encryptAll/{instanceFullName}": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_KeyGroup_encryptAll", "operationId": "rest_nge_KeyGroup_encryptAll", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/nge/KeyGroup/removeLocalKeyGroups/{instanceFullName}": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_KeyGroup_removeLocalKeyGroups", "operationId": "rest_nge_KeyGroup_removeLocalKeyGroups", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/nge/NGEScheduledTask/getRekeyProgressInfo": { "get": { "tags": [ "samo_nge" ], "summary": "rest_nge_NGEScheduledTask_getRekeyProgressInfo", "description": "Retrieve the rekey progress info.

Intention : MODIFIER
getRekeyProgressInfo:
class-level modifier API getRekeyProgressInfo
of class nge.NGEScheduledTask


", "operationId": "rest_nge_NGEScheduledTask_getRekeyProgressInfo", "parameters": [ { "name": "ngeScheduledTaskFullName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getRekeyProgressInfoResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/nge/NGEScheduledTask/resetRekeyTimes/{instanceFullName}": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_NGEScheduledTask_resetRekeyTimes", "operationId": "rest_nge_NGEScheduledTask_resetRekeyTimes", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/nge/NGEScheduledTask/startManualRekey/{instanceFullName}": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_NGEScheduledTask_startManualRekey", "operationId": "rest_nge_NGEScheduledTask_startManualRekey", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/startManualRekey" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/nge/RekeyProgress/forceRekey": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_RekeyProgress_forceRekey", "operationId": "rest_nge_RekeyProgress_forceRekey", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "integer", "format": "int32" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/nge/RekeyProgress/refreshInfo": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_RekeyProgress_refreshInfo", "operationId": "rest_nge_RekeyProgress_refreshInfo", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "integer", "format": "int32" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/nge/RekeyProgress/stopRekey": { "post": { "tags": [ "samo_nge" ], "summary": "rest_nge_RekeyProgress_stopRekey", "operationId": "rest_nge_RekeyProgress_stopRekey", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "integer", "format": "int32" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/gmplsuni/GmplsLsp/findTunnelGroupEndpointMembers/{instanceFullName}": { "post": { "tags": [ "samo_gmplsuni" ], "summary": "rest_gmplsuni_GmplsLsp_findTunnelGroupEndpointMembers", "description": "Finds all tunnel group endpoint members associated with this UNI GLSP.

Intention : RETRIEVER
findTunnelGroupEndpointMembers:
instance-level [object finder] (retriever) API findTunnelGroupEndpointMembers
of class gmplsuni.GmplsLsp
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_gmplsuni_GmplsLsp_findTunnelGroupEndpointMembers", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findTunnelGroupEndpointMembers" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findTunnelGroupEndpointMembersResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/gmplsuni/ProvisionedPath/findGLSPs/{instanceFullName}": { "post": { "tags": [ "samo_gmplsuni" ], "summary": "rest_gmplsuni_ProvisionedPath_findGLSPs", "description": "Finds all UNI GLSPs associated with this GMPLS provisioned path.

Intention : RETRIEVER
findGLSPs:
instance-level [object finder] (retriever) API findGLSPs
of class gmplsuni.ProvisionedPath
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_gmplsuni_ProvisionedPath_findGLSPs", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findGLSPs" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findGLSPsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/gmplsuni/TunnelGroupEndpointMember/navigateToFarEndMember/{instanceFullName}": { "post": { "tags": [ "samo_gmplsuni" ], "summary": "rest_gmplsuni_TunnelGroupEndpointMember_navigateToFarEndMember", "description": "Returns the FDN of the far-end member (the one with the same session name), or \"\" if the far-end member is not configured.

Intention : RETRIEVER
navigateToFarEndMember:
instance-level retriever API navigateToFarEndMember
of class gmplsuni.TunnelGroupEndpointMember
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_gmplsuni_TunnelGroupEndpointMember_navigateToFarEndMember", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/navigateToFarEndMemberResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sitesec/CpmFilterQueue/requestClearCpmFilterQueue/{instanceFullName}": { "post": { "tags": [ "samo_sitesec" ], "summary": "rest_sitesec_CpmFilterQueue_requestClearCpmFilterQueue", "description": "Request clearing of CPM Filter Queue using this local policy.
When this method returns resources for the clear have been allocated
but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearCpmFilterQueue:
instance-level modifier API requestClearCpmFilterQueue
of class sitesec.CpmFilterQueue
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_sitesec_CpmFilterQueue_requestClearCpmFilterQueue", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearCpmFilterQueueResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sitesec/CpmIpFilterEntryBase/renum": { "post": { "tags": [ "samo_sitesec" ], "summary": "rest_sitesec_CpmIpFilterEntryBase_renum", "operationId": "rest_sitesec_CpmIpFilterEntryBase_renum", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/renum" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sitesec/CpmIpFilterEntryBase/requestClearCpmIpFilter/{instanceFullName}": { "post": { "tags": [ "samo_sitesec" ], "summary": "rest_sitesec_CpmIpFilterEntryBase_requestClearCpmIpFilter", "description": "Request clearing of CPM IP Filter using this local policy.
When this method returns resources for the clear have been allocated
but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearCpmIpFilter:
instance-level modifier API requestClearCpmIpFilter
of class sitesec.CpmIpFilterEntryBase
DescendantInfo:
sitesec.CpmIpFilterEntry
DescendantInfo:
sitesec.CpmIPv6FilterEntry
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_sitesec_CpmIpFilterEntryBase_requestClearCpmIpFilter", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "boolean" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearCpmIpFilterResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sitesec/CpmMacFilterEntry/renum": { "post": { "tags": [ "samo_sitesec" ], "summary": "rest_sitesec_CpmMacFilterEntry_renum", "operationId": "rest_sitesec_CpmMacFilterEntry_renum", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/renum" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sitesec/CpmMacFilterEntry/requestClearCpmMacFilter/{instanceFullName}": { "post": { "tags": [ "samo_sitesec" ], "summary": "rest_sitesec_CpmMacFilterEntry_requestClearCpmMacFilter", "description": "Request clearing of CPM MAC Filter using this local policy.
When this method returns resources for the clear have been allocated
but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearCpmMacFilter:
instance-level modifier API requestClearCpmMacFilter
of class sitesec.CpmMacFilterEntry
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_sitesec_CpmMacFilterEntry_requestClearCpmMacFilter", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "boolean" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearCpmMacFilterResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sitesec/LocalUser/clearPasswordHistory": { "post": { "tags": [ "samo_sitesec" ], "summary": "rest_sitesec_LocalUser_clearPasswordHistory", "operationId": "rest_sitesec_LocalUser_clearPasswordHistory", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sitesec/LocalUser/unlockUser": { "post": { "tags": [ "samo_sitesec" ], "summary": "rest_sitesec_LocalUser_unlockUser", "operationId": "rest_sitesec_LocalUser_unlockUser", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sitesec/MacMafEntry/renum": { "post": { "tags": [ "samo_sitesec" ], "summary": "rest_sitesec_MacMafEntry_renum", "operationId": "rest_sitesec_MacMafEntry_renum", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/renum" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sitesec/MafEntryBase/renum": { "post": { "tags": [ "samo_sitesec" ], "summary": "rest_sitesec_MafEntryBase_renum", "operationId": "rest_sitesec_MafEntryBase_renum", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/renum" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sitesec/SiteSystemSecurity/configure/{instanceFullName}": { "post": { "tags": [ "samo_sitesec" ], "summary": "rest_sitesec_SiteSystemSecurity_configure", "description": "
Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure
of class sitesec.SiteSystemSecurity
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_sitesec_SiteSystemSecurity_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sitesec/UserProfileEntry/renum": { "post": { "tags": [ "samo_sitesec" ], "summary": "rest_sitesec_UserProfileEntry_renum", "operationId": "rest_sitesec_UserProfileEntry_renum", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/renum" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/tdm/TdmFacility/findApsGroup/{instanceFullName}": { "get": { "tags": [ "samo_tdm" ], "summary": "rest_tdm_TdmFacility_findApsGroup", "description": "This method finds all the associated APS group

Intention : RETRIEVER
findApsGroup:
instance-level [object finder] (retriever) API findApsGroup
of class tdm.TdmFacility
DescendantInfo:
tdm.AUn
instanceFullName : distinguished/instance name of called object
List of TDM FacilityProtectionGroupList

", "operationId": "rest_tdm_TdmFacility_findApsGroup", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findApsGroupResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/tdm/TdmFacility/findVcnCrossConnects/{instanceFullName}": { "get": { "tags": [ "samo_tdm" ], "summary": "rest_tdm_TdmFacility_findVcnCrossConnects", "description": "This method finds all the associated TDM cross connect

Intention : RETRIEVER
findVcnCrossConnects:
instance-level [object finder] (retriever) API findVcnCrossConnects
of class tdm.TdmFacility
DescendantInfo:
tdm.AUn
instanceFullName : distinguished/instance name of called object
List of TDM CrossConnect

", "operationId": "rest_tdm_TdmFacility_findVcnCrossConnects", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findVcnCrossConnectsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/tdm/TdmFacilityProtectionGroup/findVcnCrossConnects/{instanceFullName}": { "get": { "tags": [ "samo_tdm" ], "summary": "rest_tdm_TdmFacilityProtectionGroup_findVcnCrossConnects", "description": "This method finds all the underlying TDM cross connect

Intention : RETRIEVER
findVcnCrossConnects:
instance-level [object finder] (retriever) API findVcnCrossConnects
of class tdm.TdmFacilityProtectionGroup
instanceFullName : distinguished/instance name of called object
List of TDM CrossConnect

", "operationId": "rest_tdm_TdmFacilityProtectionGroup_findVcnCrossConnects", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findVcnCrossConnectsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/tdm/TdmFacilityProtectionGroup/unProtect": { "post": { "tags": [ "samo_tdm" ], "summary": "rest_tdm_TdmFacilityProtectionGroup_unProtect", "operationId": "rest_tdm_TdmFacilityProtectionGroup_unProtect", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unProtect" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/tdm/VcnCrossConnect/findValidAunCtpsForNewVcnXc": { "get": { "tags": [ "samo_tdm" ], "summary": "rest_tdm_VcnCrossConnect_findValidAunCtpsForNewVcnXc", "description": "This method finds all Aun Ctps not part of any existing Vcn Cross Connects.

Intention : RETRIEVER
findValidAunCtpsForNewVcnXc:
class-level [object finder] (retriever) API findValidAunCtpsForNewVcnXc
of class tdm.VcnCrossConnect


", "operationId": "rest_tdm_VcnCrossConnect_findValidAunCtpsForNewVcnXc", "parameters": [ { "name": "siteId", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "rate", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "ctpAPointer", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "ctpZPointer", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "isBiDirectional", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "isAEndSelection", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "boolean" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findValidAunCtpsForNewVcnXcResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mdaxconnect/MdaXconnectMac/findAnchorPorts/{instanceFullName}": { "post": { "tags": [ "samo_mdaxconnect" ], "summary": "rest_mdaxconnect_MdaXconnectMac_findAnchorPorts", "description": "
Intention : RETRIEVER
findAnchorPorts:
instance-level [object finder] (retriever) API findAnchorPorts
of class mdaxconnect.MdaXconnectMac
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mdaxconnect_MdaXconnectMac_findAnchorPorts", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAnchorPortsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mdaxconnect/MdaXconnectMac/findLoopbacks/{instanceFullName}": { "post": { "tags": [ "samo_mdaxconnect" ], "summary": "rest_mdaxconnect_MdaXconnectMac_findLoopbacks", "description": "
Intention : RETRIEVER
findLoopbacks:
instance-level [object finder] (retriever) API findLoopbacks
of class mdaxconnect.MdaXconnectMac
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mdaxconnect_MdaXconnectMac_findLoopbacks", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findLoopbacksResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mdaxconnect/MdaXconnectMac/getDependencyCount/{instanceFullName}": { "get": { "tags": [ "samo_mdaxconnect" ], "summary": "rest_mdaxconnect_MdaXconnectMac_getDependencyCount", "description": "
Intention : RETRIEVER
getDependencyCount:
instance-level retriever API getDependencyCount
of class mdaxconnect.MdaXconnectMac
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mdaxconnect_MdaXconnectMac_getDependencyCount", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getDependencyCountResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sas/AbstractTest/execute/{instanceFullName}": { "put": { "tags": [ "samo_sas" ], "summary": "rest_sas_AbstractTest_execute", "operationId": "rest_sas_AbstractTest_execute", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sas/AbstractTest/stop/{instanceFullName}": { "post": { "tags": [ "samo_sas" ], "summary": "rest_sas_AbstractTest_stop", "operationId": "rest_sas_AbstractTest_stop", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sas/MplsDmSession/requestClearOamPmDmRawStats/{instanceFullName}": { "post": { "tags": [ "samo_sas" ], "summary": "rest_sas_MplsDmSession_requestClearOamPmDmRawStats", "description": "Request clearing of Oam Pm Raw Stats.
When this method returns resources for the clear have been allocated
but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearOamPmDmRawStats:
instance-level modifier API requestClearOamPmDmRawStats
of class sas.MplsDmSession
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_sas_MplsDmSession_requestClearOamPmDmRawStats", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearOamPmDmRawStatsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sas/PMSessionTest/stopTest/{instanceFullName}": { "post": { "tags": [ "samo_sas" ], "summary": "rest_sas_PMSessionTest_stopTest", "operationId": "rest_sas_PMSessionTest_stopTest", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sas/StreamingDelayTemplate/findTests/{instanceFullName}": { "post": { "tags": [ "samo_sas" ], "summary": "rest_sas_StreamingDelayTemplate_findTests", "description": "
Intention : RETRIEVER
findTests:
instance-level [object finder] (retriever) API findTests
of class sas.StreamingDelayTemplate
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_sas_StreamingDelayTemplate_findTests", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findTestsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sas/TWLSession/requestClearOamPmTwlRawStats/{instanceFullName}": { "post": { "tags": [ "samo_sas" ], "summary": "rest_sas_TWLSession_requestClearOamPmTwlRawStats", "description": "Request clearing of Oam Pm Raw Stats.
When this method returns resources for the clear have been allocated
but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearOamPmTwlRawStats:
instance-level modifier API requestClearOamPmTwlRawStats
of class sas.TWLSession
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_sas_TWLSession_requestClearOamPmTwlRawStats", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearOamPmTwlRawStatsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sas/Test/adhocExecuteAndWait": { "post": { "tags": [ "samo_sas" ], "summary": "rest_sas_Test_adhocExecuteAndWait", "description": "Creates and executes a new STM test. This method waits
until the test is complete and all results are
retrieved before returning from the network.

Intention : MODIFIER
adhocExecuteAndWait:
class-level modifier API adhocExecuteAndWait
of class sas.Test
DescendantInfo:
vwmsas.PrbsTest
DescendantInfo:
ethernetoam.AbstractCfmTest
DescendantInfo:
mpls.LdpTreeTrace
DescendantInfo:
service.Y1564TestHead
DescendantInfo:
sas.Trace
DescendantInfo:
service.MacPurge
DescendantInfo:
mpls.P2MPLspPing
DescendantInfo:
aossas.CPETestGroupHead
DescendantInfo:
ethernetoam.CfmLinkTrace
DescendantInfo:
ethernetoam.CfmOneWaySlm
DescendantInfo:
mpls.LspTrace
DescendantInfo:
ethernetoam.AbstractCfmDiagnostic
DescendantInfo:
ethernetoam.CfmSingleEndedLossTest
DescendantInfo:
ancp.AncpLoopback
DescendantInfo:
ethernetoam.CcTest
DescendantInfo:
svt.TunnelPing
DescendantInfo:
atm.AtmPing
DescendantInfo:
service.Y1564TestHeadBiDirectional
DescendantInfo:
sas.Ping
DescendantInfo:
svt.VccvTrace
DescendantInfo:
ethernetoam.CfmTwoWayDelayTest
DescendantInfo:
icmp.DnsPing
DescendantInfo:
sas.VxlanPing
DescendantInfo:
vprn.VprnPing
DescendantInfo:
icmp.IcmpPing
DescendantInfo:
ethernetoam.CfmLoopback
DescendantInfo:
ethernetoam.CcmTest
DescendantInfo:
ethernetoam.CfmTwoWaySlm
DescendantInfo:
multicast.Mtrace
DescendantInfo:
ethernetoam.CfmOneWayDelayTest
DescendantInfo:
service.CpePing
DescendantInfo:
service.MacPing
DescendantInfo:
multicast.Mrinfo
DescendantInfo:
bier.BierTrace
DescendantInfo:
service.MacTrace
DescendantInfo:
bier.BierPing
DescendantInfo:
mpls.P2MPLspTrace
DescendantInfo:
service.MacPopulate
DescendantInfo:
svt.VccvPing
DescendantInfo:
multicast.Mtrace2
DescendantInfo:
vprn.VprnTrace
DescendantInfo:
ltesas.GtpPing
DescendantInfo:
ethernetoam.CfmEthTest
DescendantInfo:
aossas.CPETestHead
DescendantInfo:
sas.PseudoTest
DescendantInfo:
icmp.IcmpTrace
DescendantInfo:
svt.MtuPing
DescendantInfo:
ethernetoam.CfmLMTest
DescendantInfo:
sas.Action
DescendantInfo:
service.SitePing
DescendantInfo:
mpls.LspPing
DescendantInfo:
multicast.MfibPing

The final result of the test execution.

", "operationId": "rest_sas_Test_adhocExecuteAndWait", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adhocExecuteAndWait" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/adhocExecuteAndWaitResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sas/Test/executeAndWait/{instanceFullName}": { "put": { "tags": [ "samo_sas" ], "summary": "rest_sas_Test_executeAndWait", "description": "Immediately starts running an already existing STM test.
This method waits until the test is complete and all
results are retrieved before returning from the network.

Intention : MODIFIER
executeAndWait:
instance-level modifier API executeAndWait
of class sas.Test
DescendantInfo:
vwmsas.PrbsTest
DescendantInfo:
ethernetoam.AbstractCfmTest
DescendantInfo:
mpls.LdpTreeTrace
DescendantInfo:
service.Y1564TestHead
DescendantInfo:
sas.Trace
DescendantInfo:
service.MacPurge
DescendantInfo:
mpls.P2MPLspPing
DescendantInfo:
aossas.CPETestGroupHead
DescendantInfo:
ethernetoam.CfmLinkTrace
DescendantInfo:
ethernetoam.CfmOneWaySlm
DescendantInfo:
mpls.LspTrace
DescendantInfo:
ethernetoam.AbstractCfmDiagnostic
DescendantInfo:
ethernetoam.CfmSingleEndedLossTest
DescendantInfo:
ancp.AncpLoopback
DescendantInfo:
ethernetoam.CcTest
DescendantInfo:
svt.TunnelPing
DescendantInfo:
atm.AtmPing
DescendantInfo:
service.Y1564TestHeadBiDirectional
DescendantInfo:
sas.Ping
DescendantInfo:
svt.VccvTrace
DescendantInfo:
ethernetoam.CfmTwoWayDelayTest
DescendantInfo:
icmp.DnsPing
DescendantInfo:
sas.VxlanPing
DescendantInfo:
vprn.VprnPing
DescendantInfo:
icmp.IcmpPing
DescendantInfo:
ethernetoam.CfmLoopback
DescendantInfo:
ethernetoam.CcmTest
DescendantInfo:
ethernetoam.CfmTwoWaySlm
DescendantInfo:
multicast.Mtrace
DescendantInfo:
ethernetoam.CfmOneWayDelayTest
DescendantInfo:
service.CpePing
DescendantInfo:
service.MacPing
DescendantInfo:
multicast.Mrinfo
DescendantInfo:
bier.BierTrace
DescendantInfo:
service.MacTrace
DescendantInfo:
bier.BierPing
DescendantInfo:
mpls.P2MPLspTrace
DescendantInfo:
service.MacPopulate
DescendantInfo:
svt.VccvPing
DescendantInfo:
multicast.Mtrace2
DescendantInfo:
vprn.VprnTrace
DescendantInfo:
ltesas.GtpPing
DescendantInfo:
ethernetoam.CfmEthTest
DescendantInfo:
aossas.CPETestHead
DescendantInfo:
sas.PseudoTest
DescendantInfo:
icmp.IcmpTrace
DescendantInfo:
svt.MtuPing
DescendantInfo:
ethernetoam.CfmLMTest
DescendantInfo:
sas.Action
DescendantInfo:
service.SitePing
DescendantInfo:
mpls.LspPing
DescendantInfo:
multicast.MfibPing
instanceFullName : distinguished/instance name of called object
The final result of the test execution.

", "operationId": "rest_sas_Test_executeAndWait", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "integer", "format": "int64" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeAndWaitResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sas/Test/setNeSchedulableAdminState/{instanceFullName}": { "post": { "tags": [ "samo_sas" ], "summary": "rest_sas_Test_setNeSchedulableAdminState", "operationId": "rest_sas_Test_setNeSchedulableAdminState", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "integer", "format": "int32" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sas/TestManager/CfmResourceUsageResync": { "post": { "tags": [ "samo_sas" ], "summary": "rest_sas_TestManager_CfmResourceUsageResync", "operationId": "rest_sas_TestManager_CfmResourceUsageResync", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sas/TestManager/CfmVlanDefaultMdResync": { "post": { "tags": [ "samo_sas" ], "summary": "rest_sas_TestManager_CfmVlanDefaultMdResync", "operationId": "rest_sas_TestManager_CfmVlanDefaultMdResync", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sas/TestManager/archiveMultipleTestResults": { "post": { "tags": [ "samo_sas" ], "summary": "rest_sas_TestManager_archiveMultipleTestResults", "operationId": "rest_sas_TestManager_archiveMultipleTestResults", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sas/TestManager/archiveTest": { "post": { "tags": [ "samo_sas" ], "summary": "rest_sas_TestManager_archiveTest", "operationId": "rest_sas_TestManager_archiveTest", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sas/TestManager/archiveTestResult": { "post": { "tags": [ "samo_sas" ], "summary": "rest_sas_TestManager_archiveTestResult", "operationId": "rest_sas_TestManager_archiveTestResult", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/archiveTestResult" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sas/TestManager/deleteTests": { "delete": { "tags": [ "samo_sas" ], "summary": "rest_sas_TestManager_deleteTests", "operationId": "rest_sas_TestManager_deleteTests", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sas/TestManager/executeOamTestContext": { "put": { "tags": [ "samo_sas" ], "summary": "rest_sas_TestManager_executeOamTestContext", "description": "This method triggers OAM Context Test Generation and Execution.

Intention : MODIFIER
executeOamTestContext:
instance-level modifier API executeOamTestContext on default instance sas of class sas.TestManager


", "operationId": "rest_sas_TestManager_executeOamTestContext", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeOamTestContext" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeOamTestContextResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sas/TestManager/executeValidator": { "put": { "tags": [ "samo_sas" ], "summary": "rest_sas_TestManager_executeValidator", "description": "Starts executing the validator tests for the given tested entities.
It can only execute the validator if there is one associated
with the tested entity.
The return value holds the names of tested entities that could
be validated (i.e. there was a validator associated with the tested entity).
In other words if the tested entity name is in the input list but not in the
output list there is no validator associated with that tested entity.

Intention : MODIFIER
executeValidator:
class-level modifier API executeValidator on default instance sas of class sas.TestManager


", "operationId": "rest_sas_TestManager_executeValidator", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeValidatorResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sas/TestManager/findEmptyValidatorTestSuites": { "post": { "tags": [ "samo_sas" ], "summary": "rest_sas_TestManager_findEmptyValidatorTestSuites", "description": "The return value holds the names of test suites that do not
have any associated tests.
In order to succesfully execute a validation (see method 'executeValidator')
the tested entity must have exactly one test suite associated which test
suite has parameter 'sasValidator' set to true.

Intention : RETRIEVER
findEmptyValidatorTestSuites:
instance-level [object finder] (retriever) API findEmptyValidatorTestSuites on default instance sas of class sas.TestManager


", "operationId": "rest_sas_TestManager_findEmptyValidatorTestSuites", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findEmptyValidatorTestSuitesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sas/TestManager/findPMSessionsNEs": { "post": { "tags": [ "samo_sas" ], "summary": "rest_sas_TestManager_findPMSessionsNEs", "description": "The return value holds the names of Network Elements that have IOM3 cards and
support the capabilities cfmDmmSession and cfmSlmSession.
These are the nodes that support PMSessions.

Intention : RETRIEVER
findPMSessionsNEs:
class-level [object finder] (retriever) API findPMSessionsNEs on default instance sas of class sas.TestManager


", "operationId": "rest_sas_TestManager_findPMSessionsNEs", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findPMSessionsNEsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sas/TestManager/findPMSessionsVPRNSites": { "post": { "tags": [ "samo_sas" ], "summary": "rest_sas_TestManager_findPMSessionsVPRNSites", "description": "The return value holds the names of Network Elements that support TWL sessions
and are part of the specified service.

Intention : RETRIEVER
findPMSessionsVPRNSites:
class-level [object finder] (retriever) API findPMSessionsVPRNSites on default instance sas of class sas.TestManager


", "operationId": "rest_sas_TestManager_findPMSessionsVPRNSites", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findPMSessionsVPRNSites" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findPMSessionsVPRNSitesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sas/TestManager/generateStmDefaults": { "post": { "tags": [ "samo_sas" ], "summary": "rest_sas_TestManager_generateStmDefaults", "description": "
Intention : MODIFIER
generateStmDefaults:
class-level modifier API generateStmDefaults on default instance sas of class sas.TestManager


", "operationId": "rest_sas_TestManager_generateStmDefaults", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generateStmDefaults" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generateStmDefaultsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sas/TestManager/generateTeTests": { "post": { "tags": [ "samo_sas" ], "summary": "rest_sas_TestManager_generateTeTests", "operationId": "rest_sas_TestManager_generateTeTests", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generateTeTests" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sas/TestManager/generateTests": { "post": { "tags": [ "samo_sas" ], "summary": "rest_sas_TestManager_generateTests", "operationId": "rest_sas_TestManager_generateTests", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sas/TestManager/oneTimeValidate": { "post": { "tags": [ "samo_sas" ], "summary": "rest_sas_TestManager_oneTimeValidate", "description": "One Time Validation

Intention : MODIFIER
oneTimeValidate:
instance-level modifier API oneTimeValidate on default instance sas of class sas.TestManager


", "operationId": "rest_sas_TestManager_oneTimeValidate", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oneTimeValidate" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/oneTimeValidateResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sas/TestManager/propagateMepTestOptions": { "post": { "tags": [ "samo_sas" ], "summary": "rest_sas_TestManager_propagateMepTestOptions", "operationId": "rest_sas_TestManager_propagateMepTestOptions", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sas/TestManager/resolveTarget": { "post": { "tags": [ "samo_sas" ], "summary": "rest_sas_TestManager_resolveTarget", "description": "
Intention : RETRIEVER
resolveTarget:
class-level retriever API resolveTarget on default instance sas of class sas.TestManager


", "operationId": "rest_sas_TestManager_resolveTarget", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resolveTargetResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sas/TestManager/stopContinuousTests": { "post": { "tags": [ "samo_sas" ], "summary": "rest_sas_TestManager_stopContinuousTests", "description": "This method stops one or more continuous tests, or continuous test suites.
The return value holds the names of the Continuously executed tests that need to be stopped.
'tests' is a list containing the name of the tests, or testsuites to stop. Only applicable for
continuous tests or test suites
'testOrTestsuite' is 1 for test suites, 3 for individual tests.

Intention : MODIFIER
stopContinuousTests:
class-level modifier API stopContinuousTests on default instance sas of class sas.TestManager


", "operationId": "rest_sas_TestManager_stopContinuousTests", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stopContinuousTests" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stopContinuousTestsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sas/TestManager/stopNeSchedulableTests": { "post": { "tags": [ "samo_sas" ], "summary": "rest_sas_TestManager_stopNeSchedulableTests", "operationId": "rest_sas_TestManager_stopNeSchedulableTests", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sas/TestPolicy/updateAllTestSuites/{instanceFullName}": { "put": { "tags": [ "samo_sas" ], "summary": "rest_sas_TestPolicy_updateAllTestSuites", "operationId": "rest_sas_TestPolicy_updateAllTestSuites", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sas/TestSuite/addTest/{instanceFullName}": { "post": { "tags": [ "samo_sas" ], "summary": "rest_sas_TestSuite_addTest", "operationId": "rest_sas_TestSuite_addTest", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/addTest" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sas/TestSuite/addTestedEntities/{instanceFullName}": { "post": { "tags": [ "samo_sas" ], "summary": "rest_sas_TestSuite_addTestedEntities", "operationId": "rest_sas_TestSuite_addTestedEntities", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/addTestedEntities" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sas/TestSuite/addTests/{instanceFullName}": { "post": { "tags": [ "samo_sas" ], "summary": "rest_sas_TestSuite_addTests", "operationId": "rest_sas_TestSuite_addTests", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/addTests" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sas/TestSuite/generateTests/{instanceFullName}": { "post": { "tags": [ "samo_sas" ], "summary": "rest_sas_TestSuite_generateTests", "operationId": "rest_sas_TestSuite_generateTests", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sas/TestSuite/getNumberOfTests/{instanceFullName}": { "get": { "tags": [ "samo_sas" ], "summary": "rest_sas_TestSuite_getNumberOfTests", "description": "Returns the number of tests in this testsuite

Intention : RETRIEVER
getNumberOfTests:
instance-level retriever API getNumberOfTests
of class sas.TestSuite
instanceFullName : distinguished/instance name of called object
The number of tests in this testsuite.

", "operationId": "rest_sas_TestSuite_getNumberOfTests", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getNumberOfTestsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sas/TestSuite/removeTest/{instanceFullName}": { "post": { "tags": [ "samo_sas" ], "summary": "rest_sas_TestSuite_removeTest", "operationId": "rest_sas_TestSuite_removeTest", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/removeTest" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sas/TestSuite/removeTests/{instanceFullName}": { "post": { "tags": [ "samo_sas" ], "summary": "rest_sas_TestSuite_removeTests", "operationId": "rest_sas_TestSuite_removeTests", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/removeTests" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sas/TestedEntity/execute/{instanceFullName}": { "put": { "tags": [ "samo_sas" ], "summary": "rest_sas_TestedEntity_execute", "operationId": "rest_sas_TestedEntity_execute", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/selfconfig/PreProvisionedNe/createPreProvNeFromTemplate": { "post": { "tags": [ "samo_selfconfig" ], "summary": "rest_selfconfig_PreProvisionedNe_createPreProvNeFromTemplate", "description": "Create a PreProvisioning NE based on a template

Intention : MODIFIER
createPreProvNeFromTemplate:
class-level [administrative creation] (modifier) API createPreProvNeFromTemplate
of class selfconfig.PreProvisionedNe

Name of the generated WorkOrder file and SessionFdn of the created activation session if submitWOToActivationSession = true (else SessionFdn=\"\")

", "operationId": "rest_selfconfig_PreProvisionedNe_createPreProvNeFromTemplate", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePreProvNeParam" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createPreProvNeFromTemplateResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/selfconfig/PreProvisionedNeState/deletePreProvNe/{instanceFullName}": { "delete": { "tags": [ "samo_selfconfig" ], "summary": "rest_selfconfig_PreProvisionedNeState_deletePreProvNe", "operationId": "rest_selfconfig_PreProvisionedNeState_deletePreProvNe", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/selfconfig/PreProvisionedNeState/proceedToNextStage/{instanceFullName}": { "post": { "tags": [ "samo_selfconfig" ], "summary": "rest_selfconfig_PreProvisionedNeState_proceedToNextStage", "operationId": "rest_selfconfig_PreProvisionedNeState_proceedToNextStage", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/selfconfig/PreProvisionedNeState/retrySelfConfiguration/{instanceFullName}": { "post": { "tags": [ "samo_selfconfig" ], "summary": "rest_selfconfig_PreProvisionedNeState_retrySelfConfiguration", "operationId": "rest_selfconfig_PreProvisionedNeState_retrySelfConfiguration", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/lte/EPSPath/drillDown/{instanceFullName}": { "post": { "tags": [ "samo_lte" ], "summary": "rest_lte_EPSPath_drillDown", "operationId": "rest_lte_EPSPath_drillDown", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/lte/EPSPath/drillDownPaths": { "post": { "tags": [ "samo_lte" ], "summary": "rest_lte_EPSPath_drillDownPaths", "operationId": "rest_lte_EPSPath_drillDownPaths", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/lte/EPSPeer/createMobileService/{instanceFullName}": { "post": { "tags": [ "samo_lte" ], "summary": "rest_lte_EPSPeer_createMobileService", "operationId": "rest_lte_EPSPeer_createMobileService", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/lte/MmeEpsPeerSummary/retrieveEnbLinkStatus": { "post": { "tags": [ "samo_lte" ], "summary": "rest_lte_MmeEpsPeerSummary_retrieveEnbLinkStatus", "description": "Query the list of links from a WMM CMM with the specified siteId to an eNB matching the MCC, MNC and macroEnbId

Intention : RETRIEVER
retrieveEnbLinkStatus:
class-level retriever API retrieveEnbLinkStatus
of class lte.MmeEpsPeerSummary


", "operationId": "rest_lte_MmeEpsPeerSummary_retrieveEnbLinkStatus", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveEnbLinkStatus" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveEnbLinkStatusResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/lte/MmeEpsPeerSummary/retrieveEpsPeers": { "post": { "tags": [ "samo_lte" ], "summary": "rest_lte_MmeEpsPeerSummary_retrieveEpsPeers", "description": "Query a list of High Volume EPS Peers whose type are the same as the querying EPS Peer Summary instance.
Results will be stored in a list of temporary Info Objects and will not be stored in the NFM-P Data Base.
To ignore filtering results based on either AdminState or OperState, set the parameter to '0'.
WARNING: Depending on the number of peers present on the node, once you start the retrieval process,
the task may be large and may take several minutes to complete.

Intention : RETRIEVER
retrieveEpsPeers:
class-level retriever API retrieveEpsPeers
of class lte.MmeEpsPeerSummary


", "operationId": "rest_lte_MmeEpsPeerSummary_retrieveEpsPeers", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveEpsPeers" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveEpsPeersResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/lte/MmeEpsPeerSummary/setEpsPeerAdminState": { "post": { "tags": [ "samo_lte" ], "summary": "rest_lte_MmeEpsPeerSummary_setEpsPeerAdminState", "operationId": "rest_lte_MmeEpsPeerSummary_setEpsPeerAdminState", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setEpsPeerAdminState" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/lte/PDNGateway/findAllNetworkElementsHavingPDNGateways": { "post": { "tags": [ "samo_lte" ], "summary": "rest_lte_PDNGateway_findAllNetworkElementsHavingPDNGateways", "description": "Find all the Network elements that -all- the PDNGateways belong to

Intention : RETRIEVER
findAllNetworkElementsHavingPDNGateways:
class-level [object finder] (retriever) API findAllNetworkElementsHavingPDNGateways
of class lte.PDNGateway


", "operationId": "rest_lte_PDNGateway_findAllNetworkElementsHavingPDNGateways", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAllNetworkElementsHavingPDNGatewaysResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ethernetequipment/HsmdaEgressSecondaryShaper/configureSecondaryShapers": { "post": { "tags": [ "samo_ethernetequipment" ], "summary": "rest_ethernetequipment_HsmdaEgressSecondaryShaper_configureSecondaryShapers", "description": "This method creates Secondary Shapers under multiple physical ports.

Intention : MODIFIER
configureSecondaryShapers:
class-level [hierarchical administrative configuration/modification] (modifier) API configureSecondaryShapers
of class ethernetequipment.HsmdaEgressSecondaryShaper
This API follows hierarchical config model rules.

Map of failed Hsmda Egress Secondary Shapers parent fullnames and Exceptions.
Also one of the configured Hsmda Egress Secondary Shapers info objects

", "operationId": "rest_ethernetequipment_HsmdaEgressSecondaryShaper_configureSecondaryShapers", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureSecondaryShapers" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureSecondaryShapersResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/security/CpamLicense/clearRouterLimitExceedDueToMultiAdditions": { "post": { "tags": [ "samo_security" ], "summary": "rest_security_CpamLicense_clearRouterLimitExceedDueToMultiAdditions", "operationId": "rest_security_CpamLicense_clearRouterLimitExceedDueToMultiAdditions", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/security/SamJmsTopicManager/stopOssConnection": { "post": { "tags": [ "samo_security" ], "summary": "rest_security_SamJmsTopicManager_stopOssConnection", "operationId": "rest_security_SamJmsTopicManager_stopOssConnection", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/security/SamLicensePoints/getLicensePointsInventory/{instanceFullName}": { "get": { "tags": [ "samo_security" ], "summary": "rest_security_SamLicensePoints_getLicensePointsInventory", "description": "Returns license points consumption on each licensed object in a map of map with product id and site id as keys

Intention : RETRIEVER
getLicensePointsInventory:
instance-level retriever API getLicensePointsInventory
of class security.SamLicensePoints
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_security_SamLicensePoints_getLicensePointsInventory", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getLicensePointsInventoryResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/security/Span/makeObjectsExplicit/{instanceFullName}": { "post": { "tags": [ "samo_security" ], "summary": "rest_security_Span_makeObjectsExplicit", "operationId": "rest_security_Span_makeObjectsExplicit", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/security/Span/makeObjectsImplicit/{instanceFullName}": { "post": { "tags": [ "samo_security" ], "summary": "rest_security_Span_makeObjectsImplicit", "operationId": "rest_security_Span_makeObjectsImplicit", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/security/TSecurityManager/getServerVersion": { "get": { "tags": [ "samo_security" ], "summary": "rest_security_TSecurityManager_getServerVersion", "description": "This method retrieves the NFM-P Server Version.

Intention : RETRIEVER
getServerVersion:
class-level retriever API getServerVersion on default instance securityManager of class security.TSecurityManager


", "operationId": "rest_security_TSecurityManager_getServerVersion", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getServerVersionResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/security/TSecurityManager/getUXPrefs": { "get": { "tags": [ "samo_security" ], "summary": "rest_security_TSecurityManager_getUXPrefs", "description": "Retrieve UX specific configuration.

Intention : RETRIEVER
getUXPrefs:
class-level retriever API getUXPrefs on default instance securityManager of class security.TSecurityManager

The preferences.

", "operationId": "rest_security_TSecurityManager_getUXPrefs", "parameters": [ { "name": "prefName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "userName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getUXPrefsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/security/TSecurityManager/reAssignUser": { "post": { "tags": [ "samo_security" ], "summary": "rest_security_TSecurityManager_reAssignUser", "operationId": "rest_security_TSecurityManager_reAssignUser", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reAssignUser" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/security/TSecurityManager/removeUXPrefs": { "post": { "tags": [ "samo_security" ], "summary": "rest_security_TSecurityManager_removeUXPrefs", "operationId": "rest_security_TSecurityManager_removeUXPrefs", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/removeUXPrefs" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/security/TSecurityManager/resumeUser": { "post": { "tags": [ "samo_security" ], "summary": "rest_security_TSecurityManager_resumeUser", "operationId": "rest_security_TSecurityManager_resumeUser", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/security/TSecurityManager/saveUXPrefs": { "post": { "tags": [ "samo_security" ], "summary": "rest_security_TSecurityManager_saveUXPrefs", "description": "Save UX based preferences.

Intention : MODIFIER
saveUXPrefs:
class-level modifier API saveUXPrefs on default instance securityManager of class security.TSecurityManager

The full name of the newly created preference.

", "operationId": "rest_security_TSecurityManager_saveUXPrefs", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/saveUXPrefs" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/saveUXPrefsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/security/TSecurityManager/suspendUser": { "post": { "tags": [ "samo_security" ], "summary": "rest_security_TSecurityManager_suspendUser", "operationId": "rest_security_TSecurityManager_suspendUser", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/security/User/getUXPrefs/{instanceFullName}": { "get": { "tags": [ "samo_security" ], "summary": "rest_security_User_getUXPrefs", "description": "Retrieve UX specific configuration.

Intention : RETRIEVER
getUXPrefs:
instance-level retriever API getUXPrefs
of class security.User
instanceFullName : distinguished/instance name of called object
The preferences.

", "operationId": "rest_security_User_getUXPrefs", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "prefName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getUXPrefsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/security/User/removeUXPrefs/{instanceFullName}": { "post": { "tags": [ "samo_security" ], "summary": "rest_security_User_removeUXPrefs", "operationId": "rest_security_User_removeUXPrefs", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/security/User/saveUXPrefs/{instanceFullName}": { "post": { "tags": [ "samo_security" ], "summary": "rest_security_User_saveUXPrefs", "description": "Save UX based preferences.

Intention : MODIFIER
saveUXPrefs:
instance-level modifier API saveUXPrefs
of class security.User
instanceFullName : distinguished/instance name of called object
The full name of the newly created preference.

", "operationId": "rest_security_User_saveUXPrefs", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/saveUXPrefs" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/saveUXPrefsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/security/UserGroup/getUXPrefs/{instanceFullName}": { "get": { "tags": [ "samo_security" ], "summary": "rest_security_UserGroup_getUXPrefs", "description": "Retrieve UX specific configuration.

Intention : RETRIEVER
getUXPrefs:
instance-level retriever API getUXPrefs
of class security.UserGroup
instanceFullName : distinguished/instance name of called object
The preferences.

", "operationId": "rest_security_UserGroup_getUXPrefs", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "prefName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getUXPrefsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/security/UserGroup/removeUXPrefs/{instanceFullName}": { "post": { "tags": [ "samo_security" ], "summary": "rest_security_UserGroup_removeUXPrefs", "operationId": "rest_security_UserGroup_removeUXPrefs", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/security/UserGroup/saveUXPrefs/{instanceFullName}": { "post": { "tags": [ "samo_security" ], "summary": "rest_security_UserGroup_saveUXPrefs", "description": "Save UX based preferences.

Intention : MODIFIER
saveUXPrefs:
instance-level modifier API saveUXPrefs
of class security.UserGroup
instanceFullName : distinguished/instance name of called object
The full name of the newly created preference.

", "operationId": "rest_security_UserGroup_saveUXPrefs", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/saveUXPrefs" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/saveUXPrefsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/file/LogDefinition/findFiles/{instanceFullName}": { "post": { "tags": [ "samo_file" ], "summary": "rest_file_LogDefinition_findFiles", "description": "
Intention : RETRIEVER
findFiles:
instance-level [object finder] (retriever) API findFiles
of class file.LogDefinition
DescendantInfo:
accounting.Policy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_file_LogDefinition_findFiles", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findFilesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/file/Policy/findAccessInterfaces/{instanceFullName}": { "post": { "tags": [ "samo_file" ], "summary": "rest_file_Policy_findAccessInterfaces", "description": "
Intention : RETRIEVER
findAccessInterfaces:
instance-level [object finder] (retriever) API findAccessInterfaces
of class file.Policy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_file_Policy_findAccessInterfaces", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAccessInterfacesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/file/Policy/findLogPolicy/{instanceFullName}": { "post": { "tags": [ "samo_file" ], "summary": "rest_file_Policy_findLogPolicy", "description": "
Intention : RETRIEVER
findLogPolicy:
instance-level [object finder] (retriever) API findLogPolicy
of class file.Policy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_file_Policy_findLogPolicy", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findLogPolicyResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/file/Policy/findNetworkInterfaces/{instanceFullName}": { "post": { "tags": [ "samo_file" ], "summary": "rest_file_Policy_findNetworkInterfaces", "description": "
Intention : RETRIEVER
findNetworkInterfaces:
instance-level [object finder] (retriever) API findNetworkInterfaces
of class file.Policy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_file_Policy_findNetworkInterfaces", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findNetworkInterfacesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/file/Policy/findPorts/{instanceFullName}": { "post": { "tags": [ "samo_file" ], "summary": "rest_file_Policy_findPorts", "description": "
Intention : RETRIEVER
findPorts:
instance-level [object finder] (retriever) API findPorts
of class file.Policy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_file_Policy_findPorts", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findPortsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/file/Policy/findSdpBindings/{instanceFullName}": { "post": { "tags": [ "samo_file" ], "summary": "rest_file_Policy_findSdpBindings", "description": "
Intention : RETRIEVER
findSdpBindings:
instance-level [object finder] (retriever) API findSdpBindings
of class file.Policy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_file_Policy_findSdpBindings", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findSdpBindingsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/file/Policy/findSdpTunnels/{instanceFullName}": { "post": { "tags": [ "samo_file" ], "summary": "rest_file_Policy_findSdpTunnels", "description": "
Intention : RETRIEVER
findSdpTunnels:
instance-level [object finder] (retriever) API findSdpTunnels
of class file.Policy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_file_Policy_findSdpTunnels", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findSdpTunnelsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/file/Policy/findServiceIpInterfaces/{instanceFullName}": { "post": { "tags": [ "samo_file" ], "summary": "rest_file_Policy_findServiceIpInterfaces", "description": "
Intention : RETRIEVER
findServiceIpInterfaces:
instance-level [object finder] (retriever) API findServiceIpInterfaces
of class file.Policy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_file_Policy_findServiceIpInterfaces", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findServiceIpInterfacesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/qosprofile/McfrEgressQosProfile/classesResetToDefault/{instanceFullName}": { "post": { "tags": [ "samo_qosprofile" ], "summary": "rest_qosprofile_McfrEgressQosProfile_classesResetToDefault", "operationId": "rest_qosprofile_McfrEgressQosProfile_classesResetToDefault", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/qosprofile/McfrEgressQosProfile/findMcfrBundles/{instanceFullName}": { "post": { "tags": [ "samo_qosprofile" ], "summary": "rest_qosprofile_McfrEgressQosProfile_findMcfrBundles", "description": "Finds the MCFR bundles using the McfrEgressQosProfile.

Intention : RETRIEVER
findMcfrBundles:
instance-level [object finder] (retriever) API findMcfrBundles
of class qosprofile.McfrEgressQosProfile
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_qosprofile_McfrEgressQosProfile_findMcfrBundles", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findMcfrBundlesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/qosprofile/McfrIngressQosProfile/classesResetToDefault/{instanceFullName}": { "post": { "tags": [ "samo_qosprofile" ], "summary": "rest_qosprofile_McfrIngressQosProfile_classesResetToDefault", "operationId": "rest_qosprofile_McfrIngressQosProfile_classesResetToDefault", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/qosprofile/McfrIngressQosProfile/findMcfrBundles/{instanceFullName}": { "post": { "tags": [ "samo_qosprofile" ], "summary": "rest_qosprofile_McfrIngressQosProfile_findMcfrBundles", "description": "Finds the MCFR bundles using the McfrIngressQosProfile.

Intention : RETRIEVER
findMcfrBundles:
instance-level [object finder] (retriever) API findMcfrBundles
of class qosprofile.McfrIngressQosProfile
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_qosprofile_McfrIngressQosProfile_findMcfrBundles", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findMcfrBundlesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/qosprofile/MlpppEgressQosProfile/FCsResetToDefault/{instanceFullName}": { "post": { "tags": [ "samo_qosprofile" ], "summary": "rest_qosprofile_MlpppEgressQosProfile_FCsResetToDefault", "operationId": "rest_qosprofile_MlpppEgressQosProfile_FCsResetToDefault", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/qosprofile/MlpppEgressQosProfile/classesResetToDefault/{instanceFullName}": { "post": { "tags": [ "samo_qosprofile" ], "summary": "rest_qosprofile_MlpppEgressQosProfile_classesResetToDefault", "operationId": "rest_qosprofile_MlpppEgressQosProfile_classesResetToDefault", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/qosprofile/MlpppEgressQosProfile/findMlpppBundles/{instanceFullName}": { "post": { "tags": [ "samo_qosprofile" ], "summary": "rest_qosprofile_MlpppEgressQosProfile_findMlpppBundles", "description": "Finds the MLPPP bundles using the MlpppEgressQosProfile.

Intention : RETRIEVER
findMlpppBundles:
instance-level [object finder] (retriever) API findMlpppBundles
of class qosprofile.MlpppEgressQosProfile
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_qosprofile_MlpppEgressQosProfile_findMlpppBundles", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findMlpppBundlesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/qosprofile/MlpppIngressQosProfile/classesResetToDefault/{instanceFullName}": { "post": { "tags": [ "samo_qosprofile" ], "summary": "rest_qosprofile_MlpppIngressQosProfile_classesResetToDefault", "operationId": "rest_qosprofile_MlpppIngressQosProfile_classesResetToDefault", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/qosprofile/MlpppIngressQosProfile/findMlpppBundles/{instanceFullName}": { "post": { "tags": [ "samo_qosprofile" ], "summary": "rest_qosprofile_MlpppIngressQosProfile_findMlpppBundles", "description": "Finds the MLPPP bundles using the MlpppIngressQosProfile.

Intention : RETRIEVER
findMlpppBundles:
instance-level [object finder] (retriever) API findMlpppBundles
of class qosprofile.MlpppIngressQosProfile
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_qosprofile_MlpppIngressQosProfile_findMlpppBundles", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findMlpppBundlesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/bier/Bier/resyncBierDatabase/{instanceFullName}": { "post": { "tags": [ "samo_bier" ], "summary": "rest_bier_Bier_resyncBierDatabase", "operationId": "rest_bier_Bier_resyncBierDatabase", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ntp/NTP/loadAuthKey/{instanceFullName}": { "post": { "tags": [ "samo_ntp" ], "summary": "rest_ntp_NTP_loadAuthKey", "operationId": "rest_ntp_NTP_loadAuthKey", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/icmp/IcmpPing/cancelIcmpTest/{instanceFullName}": { "delete": { "tags": [ "samo_icmp" ], "summary": "rest_icmp_IcmpPing_cancelIcmpTest", "operationId": "rest_icmp_IcmpPing_cancelIcmpTest", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/pae802_1x/RadiusServerItem/find": { "post": { "tags": [ "samo_pae802_1x" ], "summary": "rest_pae802_1x_RadiusServerItem_find", "description": "
Intention : RETRIEVER
find:
class-level [object finder] (retriever) API find
of class pae802_1x.RadiusServerItem


", "operationId": "rest_pae802_1x_RadiusServerItem_find", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/pae802_1x/RadiusServerPolicy/findPorts/{instanceFullName}": { "post": { "tags": [ "samo_pae802_1x" ], "summary": "rest_pae802_1x_RadiusServerPolicy_findPorts", "description": "
Intention : RETRIEVER
findPorts:
instance-level [object finder] (retriever) API findPorts
of class pae802_1x.RadiusServerPolicy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_pae802_1x_RadiusServerPolicy_findPorts", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findPortsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/pae802_1x/Site/shutDown/{instanceFullName}": { "post": { "tags": [ "samo_pae802_1x" ], "summary": "rest_pae802_1x_Site_shutDown", "operationId": "rest_pae802_1x_Site_shutDown", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/pae802_1x/Site/turnUp/{instanceFullName}": { "post": { "tags": [ "samo_pae802_1x" ], "summary": "rest_pae802_1x_Site_turnUp", "operationId": "rest_pae802_1x_Site_turnUp", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/subscr/Subscriber/populateTo/{instanceFullName}": { "post": { "tags": [ "samo_subscr" ], "summary": "rest_subscr_Subscriber_populateTo", "description": "Populates the subscriber site with the site IP Address

Intention : MODIFIER
populateTo:
instance-level modifier API populateTo
of class subscr.Subscriber
instanceFullName : distinguished/instance name of called object
Set of subscriber site's full-names which were populated.

", "operationId": "rest_subscr_Subscriber_populateTo", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/populateToResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sasqos/Match/renum": { "post": { "tags": [ "samo_sasqos" ], "summary": "rest_sasqos_Match_renum", "operationId": "rest_sasqos_Match_renum", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/renum" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sasqos/MplsLspExpMap/findNetworkInterfaces/{instanceFullName}": { "get": { "tags": [ "samo_sasqos" ], "summary": "rest_sasqos_MplsLspExpMap_findNetworkInterfaces", "description": "
Intention : RETRIEVER
findNetworkInterfaces:
instance-level [object finder] (retriever) API findNetworkInterfaces
of class sasqos.MplsLspExpMap
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_sasqos_MplsLspExpMap_findNetworkInterfaces", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findNetworkInterfacesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sasqos/NQueue/findPorts/{instanceFullName}": { "get": { "tags": [ "samo_sasqos" ], "summary": "rest_sasqos_NQueue_findPorts", "description": "
Intention : RETRIEVER
findPorts:
instance-level [object finder] (retriever) API findPorts
of class sasqos.NQueue
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_sasqos_NQueue_findPorts", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findPortsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sasqos/Network/findNetworkInterfaces/{instanceFullName}": { "post": { "tags": [ "samo_sasqos" ], "summary": "rest_sasqos_Network_findNetworkInterfaces", "description": "
Intention : RETRIEVER
findNetworkInterfaces:
instance-level [object finder] (retriever) API findNetworkInterfaces
of class sasqos.Network
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_sasqos_Network_findNetworkInterfaces", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findNetworkInterfacesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sasqos/Network/findPorts/{instanceFullName}": { "post": { "tags": [ "samo_sasqos" ], "summary": "rest_sasqos_Network_findPorts", "description": "
Intention : RETRIEVER
findPorts:
instance-level [object finder] (retriever) API findPorts
of class sasqos.Network
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_sasqos_Network_findPorts", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findPortsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sasqos/PortAccessEgress/findPorts/{instanceFullName}": { "post": { "tags": [ "samo_sasqos" ], "summary": "rest_sasqos_PortAccessEgress_findPorts", "description": "
Intention : RETRIEVER
findPorts:
instance-level [object finder] (retriever) API findPorts
of class sasqos.PortAccessEgress
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_sasqos_PortAccessEgress_findPorts", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findPortsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sasqos/PortScheduler/findPorts/{instanceFullName}": { "get": { "tags": [ "samo_sasqos" ], "summary": "rest_sasqos_PortScheduler_findPorts", "description": "
Intention : RETRIEVER
findPorts:
instance-level [object finder] (retriever) API findPorts
of class sasqos.PortScheduler
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_sasqos_PortScheduler_findPorts", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findPortsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sasqos/QosPool/configure/{instanceFullName}": { "post": { "tags": [ "samo_sasqos" ], "summary": "rest_sasqos_QosPool_configure", "description": "
Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure
of class sasqos.QosPool
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_sasqos_QosPool_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QosPoolConfigInfo" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sasqos/Remark/findAccessInterfaces/{instanceFullName}": { "get": { "tags": [ "samo_sasqos" ], "summary": "rest_sasqos_Remark_findAccessInterfaces", "description": "
Intention : RETRIEVER
findAccessInterfaces:
instance-level [object finder] (retriever) API findAccessInterfaces
of class sasqos.Remark
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_sasqos_Remark_findAccessInterfaces", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAccessInterfacesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sasqos/Remark/findNetworkInterfaces/{instanceFullName}": { "get": { "tags": [ "samo_sasqos" ], "summary": "rest_sasqos_Remark_findNetworkInterfaces", "description": "
Intention : RETRIEVER
findNetworkInterfaces:
instance-level [object finder] (retriever) API findNetworkInterfaces
of class sasqos.Remark
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_sasqos_Remark_findNetworkInterfaces", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findNetworkInterfacesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sasqos/Remark/findPorts/{instanceFullName}": { "get": { "tags": [ "samo_sasqos" ], "summary": "rest_sasqos_Remark_findPorts", "description": "
Intention : RETRIEVER
findPorts:
instance-level [object finder] (retriever) API findPorts
of class sasqos.Remark
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_sasqos_Remark_findPorts", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findPortsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sasqos/SystemResourceProfilePolicy/findCards/{instanceFullName}": { "get": { "tags": [ "samo_sasqos" ], "summary": "rest_sasqos_SystemResourceProfilePolicy_findCards", "description": "
Intention : RETRIEVER
findCards:
instance-level [object finder] (retriever) API findCards
of class sasqos.SystemResourceProfilePolicy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_sasqos_SystemResourceProfilePolicy_findCards", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findCardsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/adp/Domain/addManagedNodes/{instanceFullName}": { "post": { "tags": [ "samo_adp" ], "summary": "rest_adp_Domain_addManagedNodes", "operationId": "rest_adp_Domain_addManagedNodes", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/adp/Domain/findManagedNodes/{instanceFullName}": { "post": { "tags": [ "samo_adp" ], "summary": "rest_adp_Domain_findManagedNodes", "description": "d

Intention : RETRIEVER
findManagedNodes:
instance-level [object finder] (retriever) API findManagedNodes
of class adp.Domain
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_adp_Domain_findManagedNodes", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findManagedNodesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/adp/Domain/findVprnService": { "post": { "tags": [ "samo_adp" ], "summary": "rest_adp_Domain_findVprnService", "description": "Method used to query the VPRN Services Based on the HeadNode.
Fetch the services that relates to Head nodes (i.e. the count of that service will be >1).

Intention : RETRIEVER
findVprnService:
class-level [object finder] (retriever) API findVprnService
of class adp.Domain

VPRN Service Objects Based on the headNodes.

", "operationId": "rest_adp_Domain_findVprnService", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findVprnServiceResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/adp/Domain/importFromXML/{instanceFullName}": { "post": { "tags": [ "samo_adp" ], "summary": "rest_adp_Domain_importFromXML", "operationId": "rest_adp_Domain_importFromXML", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/importFromXML" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/adp/Domain/importSerialNumbersFromXML/{instanceFullName}": { "post": { "tags": [ "samo_adp" ], "summary": "rest_adp_Domain_importSerialNumbersFromXML", "operationId": "rest_adp_Domain_importSerialNumbersFromXML", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/importSerialNumbersFromXML" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/nfv/VNFManager/discoverVnf/{instanceFullName}": { "post": { "tags": [ "samo_nfv" ], "summary": "rest_nfv_VNFManager_discoverVnf", "description": "Checks if the VNF supplied is dicovered. If not it refreshes the cbam AP to find it.

Intention : MODIFIER
discoverVnf:
instance-level modifier API discoverVnf
of class nfv.VNFManager
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_nfv_VNFManager_discoverVnf", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/discoverVnfResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/aaa/IsaRadiusPolicy/removePassword/{instanceFullName}": { "post": { "tags": [ "samo_aaa" ], "summary": "rest_aaa_IsaRadiusPolicy_removePassword", "operationId": "rest_aaa_IsaRadiusPolicy_removePassword", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/aaa/IsaRadiusServer/clearSecret/{instanceFullName}": { "post": { "tags": [ "samo_aaa" ], "summary": "rest_aaa_IsaRadiusServer_clearSecret", "operationId": "rest_aaa_IsaRadiusServer_clearSecret", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/aaa/RadiusProxyServer/clearSecret/{instanceFullName}": { "post": { "tags": [ "samo_aaa" ], "summary": "rest_aaa_RadiusProxyServer_clearSecret", "operationId": "rest_aaa_RadiusProxyServer_clearSecret", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/aaa/RadiusServerPolicy/clearSecret/{instanceFullName}": { "post": { "tags": [ "samo_aaa" ], "summary": "rest_aaa_RadiusServerPolicy_clearSecret", "operationId": "rest_aaa_RadiusServerPolicy_clearSecret", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/aaa/RadiusServerPolicy/requestClearMessageBuffer/{instanceFullName}": { "post": { "tags": [ "samo_aaa" ], "summary": "rest_aaa_RadiusServerPolicy_requestClearMessageBuffer", "description": "
Intention : MODIFIER
requestClearMessageBuffer:
instance-level modifier API requestClearMessageBuffer
of class aaa.RadiusServerPolicy
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_aaa_RadiusServerPolicy_requestClearMessageBuffer", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearMessageBufferResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/aaa/RouteDownloadPolicy/forceDownload/{instanceFullName}": { "post": { "tags": [ "samo_aaa" ], "summary": "rest_aaa_RouteDownloadPolicy_forceDownload", "operationId": "rest_aaa_RouteDownloadPolicy_forceDownload", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/equipment/BaseCard/forceReboot/{instanceFullName}": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_BaseCard_forceReboot", "operationId": "rest_equipment_BaseCard_forceReboot", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/equipment/BaseCard/reset/{instanceFullName}": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_BaseCard_reset", "operationId": "rest_equipment_BaseCard_reset", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reset" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/equipment/BaseCard/softReset/{instanceFullName}": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_BaseCard_softReset", "operationId": "rest_equipment_BaseCard_softReset", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "boolean" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/equipment/Card/reboot/{instanceFullName}": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_Card_reboot", "operationId": "rest_equipment_Card_reboot", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/equipment/CardFirmware/cardColdReboot/{instanceFullName}": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_CardFirmware_cardColdReboot", "operationId": "rest_equipment_CardFirmware_cardColdReboot", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/equipment/CardFirmware/hitlessUpgrade/{instanceFullName}": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_CardFirmware_hitlessUpgrade", "operationId": "rest_equipment_CardFirmware_hitlessUpgrade", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/equipment/CardSlot/configurePSSCard": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_CardSlot_configurePSSCard", "description": "
Intention : MODIFIER
configurePSSCard:
class-level [hierarchical administrative configuration/modification] (modifier) API configurePSSCard
of class equipment.CardSlot
This API follows hierarchical config model rules.
DescendantInfo:
hip.EMSCardSlot


", "operationId": "rest_equipment_CardSlot_configurePSSCard", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configurePSSCard" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configurePSSCardResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/equipment/CardSwapTask/initiateCardSwap/{instanceFullName}": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_CardSwapTask_initiateCardSwap", "operationId": "rest_equipment_CardSwapTask_initiateCardSwap", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/equipment/ControlProcessor/rebootHold/{instanceFullName}": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_ControlProcessor_rebootHold", "operationId": "rest_equipment_ControlProcessor_rebootHold", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/equipment/ControlProcessor/rereadCpmBootOptions/{instanceFullName}": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_ControlProcessor_rereadCpmBootOptions", "operationId": "rest_equipment_ControlProcessor_rereadCpmBootOptions", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/equipment/ControlProcessor/switchToRedundantCpm/{instanceFullName}": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_ControlProcessor_switchToRedundantCpm", "operationId": "rest_equipment_ControlProcessor_switchToRedundantCpm", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/equipment/DryContact/findValidAmplifierCardsforConnectedTo/{instanceFullName}": { "get": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_DryContact_findValidAmplifierCardsforConnectedTo", "description": "
Intention : RETRIEVER
findValidAmplifierCardsforConnectedTo:
instance-level [object finder] (retriever) API findValidAmplifierCardsforConnectedTo
of class equipment.DryContact
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_equipment_DryContact_findValidAmplifierCardsforConnectedTo", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "aInSiteId", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "aInShelfId", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "aInSlotId", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findValidAmplifierCardsforConnectedToResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/equipment/Equipment/getDependencyCount/{instanceFullName}": { "get": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_Equipment_getDependencyCount", "description": "
Intention : RETRIEVER
getDependencyCount:
instance-level retriever API getDependencyCount
of class equipment.Equipment
DescendantInfo:
equipment.PowerSupply
DescendantInfo:
equipment.ShelfPDU
DescendantInfo:
opticalequipment.VtsChannel
DescendantInfo:
sonetequipment.Sts12Channel
DescendantInfo:
equipment.PowerSupplyTray
DescendantInfo:
hip.EMSShelf
DescendantInfo:
equipment.FAM
DescendantInfo:
equipment.MediaAdaptor
DescendantInfo:
equipment.Fan
DescendantInfo:
equipment.XiomCardSlot
DescendantInfo:
equipment.Memory
DescendantInfo:
radioequipment.RadioChannel
DescendantInfo:
hip.EMSBaseCard
DescendantInfo:
equipment.MCMCard
DescendantInfo:
equipment.CCM
DescendantInfo:
sonetequipment.TributaryChannel
DescendantInfo:
equipment.DaughterCard
DescendantInfo:
sonetequipment.Sts192Channel
DescendantInfo:
ethernettunnel.EthernetTunnelEndpoint
DescendantInfo:
mdaxconnect.AnchorPort
DescendantInfo:
sonetequipment.Sts1Channel
DescendantInfo:
sonetequipment.Sts3Channel
DescendantInfo:
ccag.CcagPathCcSapSap
DescendantInfo:
equipment.ActiveReplaceableUnit
DescendantInfo:
sonetequipment.Sts48Channel
DescendantInfo:
equipment.BaseCard
DescendantInfo:
equipment.PwPort
DescendantInfo:
hip.EMSDaughterCardSlot
DescendantInfo:
equipment.PhysicalShelf
DescendantInfo:
equipment.VWMFan
DescendantInfo:
equipment.PCMTray
DescendantInfo:
equipment.Fru
DescendantInfo:
equipment.LEDPanel
DescendantInfo:
hip.EMSDaughterCard
DescendantInfo:
equipment.SFMSlot
DescendantInfo:
equipment.StackConfiguration
DescendantInfo:
equipment.InterConnectPort
DescendantInfo:
equipment.Tray
DescendantInfo:
pxc.PortCrossConnectSubPort
DescendantInfo:
equipment.VWMCardSlot
DescendantInfo:
hip.EMSRack
DescendantInfo:
equipment.MCMCardSlot
DescendantInfo:
mwa.MwLink
DescendantInfo:
equipment.VwmShelf
DescendantInfo:
sonetequipment.TributaryGroup
DescendantInfo:
tdmequipment.VoiceChannel
DescendantInfo:
tdmequipment.DS3E3Channel
DescendantInfo:
dctr.AbstractVirtualPortInstance
DescendantInfo:
equipment.Card
DescendantInfo:
flex.FlexPort
DescendantInfo:
sonetequipment.Tug3Group
DescendantInfo:
equipment.PowerModule
DescendantInfo:
tdmequipment.SerialChannel
DescendantInfo:
netw.PortGroup
DescendantInfo:
equipment.PhysicalPort
DescendantInfo:
equipment.VWMShelfController
DescendantInfo:
equipment.HardDiskDrive
DescendantInfo:
equipment.Shelf
DescendantInfo:
equipment.VWMCard
DescendantInfo:
equipment.RALARM
DescendantInfo:
esa.EsaVirtualPort
DescendantInfo:
equipment.ManagementPort
DescendantInfo:
equipment.RTM
DescendantInfo:
equipment.Slot
DescendantInfo:
equipment.SlotPDU
DescendantInfo:
equipment.CPMInterConnectPort
DescendantInfo:
sonetequipment.Group
DescendantInfo:
opticalequipment.OpticalChannel
DescendantInfo:
bundle.ApsInterface
DescendantInfo:
lag.Interface
DescendantInfo:
equipment.Connector
DescendantInfo:
aps.ApsGroup
DescendantInfo:
equipment.PowerConnectionModules
DescendantInfo:
equipment.SFMInterConnectPort
DescendantInfo:
ccag.CcagPathCc
DescendantInfo:
ccag.CcagPathCcNetSap
DescendantInfo:
tdmequipment.TdmChannel
DescendantInfo:
equipment.Processor
DescendantInfo:
equipment.Channel
DescendantInfo:
equipment.AMC
DescendantInfo:
equipment.Rack
DescendantInfo:
aggregation.PortAggregationGroup
DescendantInfo:
radioequipment.UBTChannel
DescendantInfo:
equipment.AtcaPort
DescendantInfo:
dctr.GatewayVirtualPortInstance
DescendantInfo:
hip.EMSCardSlot
DescendantInfo:
aosredundancy.VFLink
DescendantInfo:
equipment.Cpu
DescendantInfo:
sonetequipment.SonetChannel
DescendantInfo:
dctr.VirtualPortInstance
DescendantInfo:
equipment.PassiveReplaceableUnit
DescendantInfo:
equipment.ScadaBranch
DescendantInfo:
tdmequipment.DS1E1Channel
DescendantInfo:
gmplsuni.TunnelGroupEndpoint
DescendantInfo:
equipment.ProcessorCard
DescendantInfo:
equipment.FlashMemory
DescendantInfo:
equipment.PowerShelf
DescendantInfo:
equipment.EquipmentHolder
DescendantInfo:
equipment.DaughterCardSlot
DescendantInfo:
equipment.AtcaCard
DescendantInfo:
equipment.IOCard
DescendantInfo:
ipsec.IPSecConnectionPoint
DescendantInfo:
sonetequipment.Tu3Channel
DescendantInfo:
tdmequipment.DS0ChannelGroup
DescendantInfo:
tdmequipment.DataChannel
DescendantInfo:
equipment.ForwardingPlane
DescendantInfo:
equipment.CardSlot
DescendantInfo:
equipment.Disk
DescendantInfo:
equipment.SwitchFabricProcessor
DescendantInfo:
equipment.FanTray
DescendantInfo:
equipment.SasVirtualPort
DescendantInfo:
equipment.ControlProcessor
DescendantInfo:
equipment.XiomCard
DescendantInfo:
equipment.LogicalUnit
DescendantInfo:
equipment.ReplaceableUnit
DescendantInfo:
bundle.Interface
DescendantInfo:
equipment.LogicalPort
DescendantInfo:
hip.EMSPort
DescendantInfo:
protection.PortProtectionGroup
DescendantInfo:
equipment.Port
DescendantInfo:
sonetequipment.Sts768Channel
DescendantInfo:
ccag.CcagPathCcSapNet
DescendantInfo:
tdmequipment.SerialSocket
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_equipment_Equipment_getDependencyCount", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getDependencyCountResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/equipment/MCMCardSlot/removeMCMCard/{instanceFullName}": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_MCMCardSlot_removeMCMCard", "description": "
Intention : MODIFIER
removeMCMCard:
instance-level [administrative deletion] (modifier) API removeMCMCard
of class equipment.MCMCardSlot
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_equipment_MCMCardSlot_removeMCMCard", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/removeMCMCardResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/equipment/MdaStaticMacFdb/clearFib": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_MdaStaticMacFdb_clearFib", "operationId": "rest_equipment_MdaStaticMacFdb_clearFib", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clearFib" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/equipment/MdaStaticMacFdb/resync": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_MdaStaticMacFdb_resync", "operationId": "rest_equipment_MdaStaticMacFdb_resync", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/equipment/NeCardSwapTask/initiateCardSwap/{instanceFullName}": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_NeCardSwapTask_initiateCardSwap", "operationId": "rest_equipment_NeCardSwapTask_initiateCardSwap", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/equipment/PCMTray/removePcm/{instanceFullName}": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_PCMTray_removePcm", "description": "
Intention : MODIFIER
removePcm:
instance-level [administrative deletion] (modifier) API removePcm
of class equipment.PCMTray
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_equipment_PCMTray_removePcm", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/removePcmResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/equipment/PhysicalPort/requestClearEfmOamEventLogs/{instanceFullName}": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_PhysicalPort_requestClearEfmOamEventLogs", "description": "Request clearing of EFM-OAM Event Logs.
When this method returns resources for the clear have been allocated
but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearEfmOamEventLogs:
instance-level modifier API requestClearEfmOamEventLogs
of class equipment.PhysicalPort
DescendantInfo:
hip.EMSPort
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_equipment_PhysicalPort_requestClearEfmOamEventLogs", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearEfmOamEventLogsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/equipment/PhysicalPort/requestClearSubVlanStats": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_PhysicalPort_requestClearSubVlanStats", "description": "Request clearing of Subscriber VLAN statistics.
Statistics will be for all service access points with the corresponding
port id and outer encap value.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearSubVlanStats:
class-level modifier API requestClearSubVlanStats
of class equipment.PhysicalPort
DescendantInfo:
hip.EMSPort

A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_equipment_PhysicalPort_requestClearSubVlanStats", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearSubVlanStats" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearSubVlanStatsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/equipment/PhysicalPort/requestResyncEfmOamEventLogs/{instanceFullName}": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_PhysicalPort_requestResyncEfmOamEventLogs", "operationId": "rest_equipment_PhysicalPort_requestResyncEfmOamEventLogs", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/equipment/PhysicalPort/requestResyncEfmOamEventStats/{instanceFullName}": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_PhysicalPort_requestResyncEfmOamEventStats", "operationId": "rest_equipment_PhysicalPort_requestResyncEfmOamEventStats", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/equipment/PhysicalPort/requestResyncEfmOamPeerInfo/{instanceFullName}": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_PhysicalPort_requestResyncEfmOamPeerInfo", "operationId": "rest_equipment_PhysicalPort_requestResyncEfmOamPeerInfo", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/equipment/Port/getMigrationResult": { "get": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_Port_getMigrationResult", "description": "Method to migrate port from Access to Hybrid mode.

Intention : ACCESSOR
getMigrationResult:
class-level accessor API getMigrationResult
of class equipment.Port
DescendantInfo:
opticalequipment.VtsChannel
DescendantInfo:
sonetequipment.Sts12Channel
DescendantInfo:
sonetequipment.Group
DescendantInfo:
opticalequipment.OpticalChannel
DescendantInfo:
bundle.ApsInterface
DescendantInfo:
lag.Interface
DescendantInfo:
equipment.Connector
DescendantInfo:
aps.ApsGroup
DescendantInfo:
radioequipment.RadioChannel
DescendantInfo:
ccag.CcagPathCc
DescendantInfo:
sonetequipment.TributaryChannel
DescendantInfo:
ccag.CcagPathCcNetSap
DescendantInfo:
tdmequipment.TdmChannel
DescendantInfo:
sonetequipment.Sts192Channel
DescendantInfo:
equipment.Channel
DescendantInfo:
ethernettunnel.EthernetTunnelEndpoint
DescendantInfo:
mdaxconnect.AnchorPort
DescendantInfo:
sonetequipment.Sts1Channel
DescendantInfo:
sonetequipment.Sts3Channel
DescendantInfo:
ccag.CcagPathCcSapSap
DescendantInfo:
sonetequipment.Sts48Channel
DescendantInfo:
aggregation.PortAggregationGroup
DescendantInfo:
radioequipment.UBTChannel
DescendantInfo:
equipment.AtcaPort
DescendantInfo:
dctr.GatewayVirtualPortInstance
DescendantInfo:
equipment.PwPort
DescendantInfo:
aosredundancy.VFLink
DescendantInfo:
sonetequipment.SonetChannel
DescendantInfo:
dctr.VirtualPortInstance
DescendantInfo:
equipment.ScadaBranch
DescendantInfo:
tdmequipment.DS1E1Channel
DescendantInfo:
gmplsuni.TunnelGroupEndpoint
DescendantInfo:
pxc.PortCrossConnectSubPort
DescendantInfo:
ipsec.IPSecConnectionPoint
DescendantInfo:
sonetequipment.Tu3Channel
DescendantInfo:
tdmequipment.DS0ChannelGroup
DescendantInfo:
tdmequipment.DataChannel
DescendantInfo:
mwa.MwLink
DescendantInfo:
sonetequipment.TributaryGroup
DescendantInfo:
tdmequipment.VoiceChannel
DescendantInfo:
tdmequipment.DS3E3Channel
DescendantInfo:
dctr.AbstractVirtualPortInstance
DescendantInfo:
equipment.SasVirtualPort
DescendantInfo:
flex.FlexPort
DescendantInfo:
sonetequipment.Tug3Group
DescendantInfo:
tdmequipment.SerialChannel
DescendantInfo:
netw.PortGroup
DescendantInfo:
equipment.PhysicalPort
DescendantInfo:
equipment.LogicalUnit
DescendantInfo:
bundle.Interface
DescendantInfo:
equipment.LogicalPort
DescendantInfo:
hip.EMSPort
DescendantInfo:
protection.PortProtectionGroup
DescendantInfo:
esa.EsaVirtualPort
DescendantInfo:
equipment.ManagementPort
DescendantInfo:
sonetequipment.Sts768Channel
DescendantInfo:
ccag.CcagPathCcSapNet
DescendantInfo:
tdmequipment.SerialSocket


", "operationId": "rest_equipment_Port_getMigrationResult", "parameters": [ { "name": "distinguishedName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getMigrationResultResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/equipment/Port/migrateMode": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_Port_migrateMode", "operationId": "rest_equipment_Port_migrateMode", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/migrateMode" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/equipment/PortGroup/firmwareUpgrade/{instanceFullName}": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_PortGroup_firmwareUpgrade", "operationId": "rest_equipment_PortGroup_firmwareUpgrade", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/equipment/PowerModule/removePowerModule/{instanceFullName}": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_PowerModule_removePowerModule", "description": "
Intention : MODIFIER
removePowerModule:
instance-level [administrative deletion] (modifier) API removePowerModule
of class equipment.PowerModule
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_equipment_PowerModule_removePowerModule", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/removePowerModuleResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/equipment/PowerShelf/removePowerShelf/{instanceFullName}": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_PowerShelf_removePowerShelf", "description": "
Intention : MODIFIER
removePowerShelf:
instance-level [administrative deletion] (modifier) API removePowerShelf
of class equipment.PowerShelf
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_equipment_PowerShelf_removePowerShelf", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/removePowerShelfResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/equipment/PowerSupplyTray/removePowerSupply/{instanceFullName}": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_PowerSupplyTray_removePowerSupply", "description": "
Intention : MODIFIER
removePowerSupply:
instance-level [administrative deletion] (modifier) API removePowerSupply
of class equipment.PowerSupplyTray
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_equipment_PowerSupplyTray_removePowerSupply", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/removePowerSupplyResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/equipment/PwPort/requestClearSubVlanStats": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_PwPort_requestClearSubVlanStats", "description": "Request clearing of Subscriber VLAN statistics.
Statistics will be for all service access points with the corresponding
port id and outer encap value.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearSubVlanStats:
class-level modifier API requestClearSubVlanStats
of class equipment.PwPort

A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_equipment_PwPort_requestClearSubVlanStats", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearSubVlanStats" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearSubVlanStatsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/equipment/Shelf/deleteShelf/{instanceFullName}": { "delete": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_Shelf_deleteShelf", "operationId": "rest_equipment_Shelf_deleteShelf", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/equipment/Shelf/findApsGroups/{instanceFullName}": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_Shelf_findApsGroups", "description": "
Intention : RETRIEVER
findApsGroups:
instance-level [object finder] (retriever) API findApsGroups
of class equipment.Shelf
DescendantInfo:
hip.EMSShelf
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_equipment_Shelf_findApsGroups", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findApsGroupsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/equipment/Shelf/reboot/{instanceFullName}": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_Shelf_reboot", "operationId": "rest_equipment_Shelf_reboot", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/equipment/Shelf/rebootWithFirmwareUpgrade/{instanceFullName}": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_Shelf_rebootWithFirmwareUpgrade", "operationId": "rest_equipment_Shelf_rebootWithFirmwareUpgrade", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/equipment/Shelf/removeShelf/{instanceFullName}": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_Shelf_removeShelf", "operationId": "rest_equipment_Shelf_removeShelf", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/equipment/Shelf/switchToRedundantEC/{instanceFullName}": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_Shelf_switchToRedundantEC", "operationId": "rest_equipment_Shelf_switchToRedundantEC", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/equipment/Shelf/switchovercmm/{instanceFullName}": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_Shelf_switchovercmm", "operationId": "rest_equipment_Shelf_switchovercmm", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/equipment/Shelf/vcTakeOver/{instanceFullName}": { "post": { "tags": [ "samo_equipment" ], "summary": "rest_equipment_Shelf_vcTakeOver", "operationId": "rest_equipment_Shelf_vcTakeOver", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/squeue/Policy/findAccessInterfaces/{instanceFullName}": { "get": { "tags": [ "samo_squeue" ], "summary": "rest_squeue_Policy_findAccessInterfaces", "description": "
Intention : RETRIEVER
findAccessInterfaces:
instance-level [object finder] (retriever) API findAccessInterfaces
of class squeue.Policy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_squeue_Policy_findAccessInterfaces", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAccessInterfacesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/squeue/Policy/findServiceAccessPoints/{instanceFullName}": { "get": { "tags": [ "samo_squeue" ], "summary": "rest_squeue_Policy_findServiceAccessPoints", "description": "
Intention : RETRIEVER
findServiceAccessPoints:
instance-level [object finder] (retriever) API findServiceAccessPoints
of class squeue.Policy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_squeue_Policy_findServiceAccessPoints", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findServiceAccessPointsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/squeue/Policy/findServiceInterfaces/{instanceFullName}": { "get": { "tags": [ "samo_squeue" ], "summary": "rest_squeue_Policy_findServiceInterfaces", "description": "
Intention : RETRIEVER
findServiceInterfaces:
instance-level [object finder] (retriever) API findServiceInterfaces
of class squeue.Policy
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_squeue_Policy_findServiceInterfaces", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findServiceInterfacesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/dynsvc/DynSvcAuthentication/clearPassword/{instanceFullName}": { "post": { "tags": [ "samo_dynsvc" ], "summary": "rest_dynsvc_DynSvcAuthentication_clearPassword", "operationId": "rest_dynsvc_DynSvcAuthentication_clearPassword", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/dynsvc/DynSvcDataTrigger/requestClearDynSvcDataTrigger": { "post": { "tags": [ "samo_dynsvc" ], "summary": "rest_dynsvc_DynSvcDataTrigger_requestClearDynSvcDataTrigger", "description": "Request clearing of Dynamic Service Data-Triggers with the specified parameters.
The siteId and sapId are required.
When this method returns resources for the clear have been allocated but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearDynSvcDataTrigger:
class-level modifier API requestClearDynSvcDataTrigger
of class dynsvc.DynSvcDataTrigger

A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_dynsvc_DynSvcDataTrigger_requestClearDynSvcDataTrigger", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClearDynSvcDataTriggerStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearDynSvcDataTriggerResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/dynsvc/DynSvcDataTrigger/retrieveDynSvcDataTriggers": { "post": { "tags": [ "samo_dynsvc" ], "summary": "rest_dynsvc_DynSvcDataTrigger_retrieveDynSvcDataTriggers", "description": "
Intention : RETRIEVER
retrieveDynSvcDataTriggers:
class-level retriever API retrieveDynSvcDataTriggers
of class dynsvc.DynSvcDataTrigger


", "operationId": "rest_dynsvc_DynSvcDataTrigger_retrieveDynSvcDataTriggers", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveDynSvcDataTriggers" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveDynSvcDataTriggersResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/dynsvc/DynSvcNeConfig/retrieveRootObjects": { "post": { "tags": [ "samo_dynsvc" ], "summary": "rest_dynsvc_DynSvcNeConfig_retrieveRootObjects", "description": "Method used to query the NE for Root Objects.

Intention : RETRIEVER
retrieveRootObjects:
class-level retriever API retrieveRootObjects
of class dynsvc.DynSvcNeConfig


", "operationId": "rest_dynsvc_DynSvcNeConfig_retrieveRootObjects", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DynSvcInfoRetrievalStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveRootObjectsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/dynsvc/DynSvcNeConfig/retrieveScriptSnippets": { "post": { "tags": [ "samo_dynsvc" ], "summary": "rest_dynsvc_DynSvcNeConfig_retrieveScriptSnippets", "description": "Method used to query the NE for Script Snippets.

Intention : RETRIEVER
retrieveScriptSnippets:
class-level retriever API retrieveScriptSnippets
of class dynsvc.DynSvcNeConfig


", "operationId": "rest_dynsvc_DynSvcNeConfig_retrieveScriptSnippets", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DynSvcInfoRetrievalStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveScriptSnippetsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/dynsvc/DynSvcSnippetInfo/retrieveScriptSnippetReferences": { "post": { "tags": [ "samo_dynsvc" ], "summary": "rest_dynsvc_DynSvcSnippetInfo_retrieveScriptSnippetReferences", "description": "Method used to query the NE for Script References.

Intention : RETRIEVER
retrieveScriptSnippetReferences:
class-level retriever API retrieveScriptSnippetReferences
of class dynsvc.DynSvcSnippetInfo


", "operationId": "rest_dynsvc_DynSvcSnippetInfo_retrieveScriptSnippetReferences", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DynSvcSnippetInfoRetrievalStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveScriptSnippetReferencesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/dynsvc/DynSvcSnippetInfo/retrieveScriptSnippetReservedIdentifiers": { "post": { "tags": [ "samo_dynsvc" ], "summary": "rest_dynsvc_DynSvcSnippetInfo_retrieveScriptSnippetReservedIdentifiers", "description": "Method used to query the NE for Script Reserved Identifiers.

Intention : RETRIEVER
retrieveScriptSnippetReservedIdentifiers:
class-level retriever API retrieveScriptSnippetReservedIdentifiers
of class dynsvc.DynSvcSnippetInfo


", "operationId": "rest_dynsvc_DynSvcSnippetInfo_retrieveScriptSnippetReservedIdentifiers", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DynSvcSnippetInfoRetrievalStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveScriptSnippetReservedIdentifiersResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/dynsvc/DynSvcSnippetInfo/retrieveScriptSnippetRootObjects": { "post": { "tags": [ "samo_dynsvc" ], "summary": "rest_dynsvc_DynSvcSnippetInfo_retrieveScriptSnippetRootObjects", "description": "Method used to query the NE for Script Root Objects.

Intention : RETRIEVER
retrieveScriptSnippetRootObjects:
class-level retriever API retrieveScriptSnippetRootObjects
of class dynsvc.DynSvcSnippetInfo


", "operationId": "rest_dynsvc_DynSvcSnippetInfo_retrieveScriptSnippetRootObjects", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DynSvcSnippetInfoRetrievalStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveScriptSnippetRootObjectsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/svq/AggregationScheduler/configure/{instanceFullName}": { "post": { "tags": [ "samo_svq" ], "summary": "rest_svq_AggregationScheduler_configure", "description": "
Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure
of class svq.AggregationScheduler
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_svq_AggregationScheduler_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/pppoe/MlpppBundle/retrieveMlpppBundles": { "post": { "tags": [ "samo_pppoe" ], "summary": "rest_pppoe_MlpppBundle_retrieveMlpppBundles", "description": "Method used to retrieve Retrieving MLPPP Bundle(s) from NE.

Intention : RETRIEVER
retrieveMlpppBundles:
class-level retriever API retrieveMlpppBundles
of class pppoe.MlpppBundle


", "operationId": "rest_pppoe_MlpppBundle_retrieveMlpppBundles", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievingMlpppBundleStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveMlpppBundlesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/pppoe/PPPPolicy/removePppDefaultPassword/{instanceFullName}": { "post": { "tags": [ "samo_pppoe" ], "summary": "rest_pppoe_PPPPolicy_removePppDefaultPassword", "operationId": "rest_pppoe_PPPPolicy_removePppDefaultPassword", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/pppoe/PPPSession/retrievePppSessions": { "post": { "tags": [ "samo_pppoe" ], "summary": "rest_pppoe_PPPSession_retrievePppSessions", "description": "Method used to retrieve a PPP session from NE.

Intention : RETRIEVER
retrievePppSessions:
class-level retriever API retrievePppSessions
of class pppoe.PPPSession


", "operationId": "rest_pppoe_PPPSession_retrievePppSessions", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrievePppSessions" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrievePppSessionsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/pppoe/PPPSessionRadiusClassAttribute/retrievePPPSessionRadiusClasses": { "post": { "tags": [ "samo_pppoe" ], "summary": "rest_pppoe_PPPSessionRadiusClassAttribute_retrievePPPSessionRadiusClasses", "description": "Method used to query the NE for the PPP Session RADIUS Class Attributes
related to the specified PPP Session.

Intention : RETRIEVER
retrievePPPSessionRadiusClasses:
class-level retriever API retrievePPPSessionRadiusClasses
of class pppoe.PPPSessionRadiusClassAttribute


", "operationId": "rest_pppoe_PPPSessionRadiusClassAttribute_retrievePPPSessionRadiusClasses", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrievePPPSessionRadiusClasses" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrievePPPSessionRadiusClassesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/pppoe/PPPoASession/retrievePPPoASessions": { "post": { "tags": [ "samo_pppoe" ], "summary": "rest_pppoe_PPPoASession_retrievePPPoASessions", "description": "Method used to query the NE for the PPPoA session(s) for.

Intention : RETRIEVER
retrievePPPoASessions:
class-level retriever API retrievePPPoASessions
of class pppoe.PPPoASession


", "operationId": "rest_pppoe_PPPoASession_retrievePPPoASessions", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrievePPPoASessions" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrievePPPoASessionsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/pppoe/PPPoESession/retrievePPPoESessions": { "post": { "tags": [ "samo_pppoe" ], "summary": "rest_pppoe_PPPoESession_retrievePPPoESessions", "description": "Method used to query the NE for the PPPoE session(s) for.

Intention : RETRIEVER
retrievePPPoESessions:
class-level retriever API retrievePPPoESessions
of class pppoe.PPPoESession


", "operationId": "rest_pppoe_PPPoESession_retrievePPPoESessions", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrievePPPoESessions" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrievePPPoESessionsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/spb/AccessInterface/findFateSharedInterfaces": { "post": { "tags": [ "samo_spb" ], "summary": "rest_spb_AccessInterface_findFateSharedInterfaces", "description": "Performs retrieval of all fated shared user SAP interfaces for SPB control service.

Intention : RETRIEVER
findFateSharedInterfaces:
class-level [object finder] (retriever) API findFateSharedInterfaces
of class spb.AccessInterface


", "operationId": "rest_spb_AccessInterface_findFateSharedInterfaces", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findFateSharedInterfaces" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findFateSharedInterfacesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/spb/AccessStaticIsid/retrieveStaticIsids": { "post": { "tags": [ "samo_spb" ], "summary": "rest_spb_AccessStaticIsid_retrieveStaticIsids", "description": "Method used to query the NE for SPB Static ISIDs associated with SAPs of the service.

Intention : RETRIEVER
retrieveStaticIsids:
class-level retriever API retrieveStaticIsids
of class spb.AccessStaticIsid


", "operationId": "rest_spb_AccessStaticIsid_retrieveStaticIsids", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveStaticIsids" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveStaticIsidsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/spb/SpokeSdpBindingInterface/findFateSharedInterfaces": { "post": { "tags": [ "samo_spb" ], "summary": "rest_spb_SpokeSdpBindingInterface_findFateSharedInterfaces", "description": "Performs retrieval of all fated shared user Spoke SDP Binding interfaces for SPB control service.

Intention : RETRIEVER
findFateSharedInterfaces:
class-level [object finder] (retriever) API findFateSharedInterfaces
of class spb.SpokeSdpBindingInterface


", "operationId": "rest_spb_SpokeSdpBindingInterface_findFateSharedInterfaces", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findFateSharedInterfaces" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findFateSharedInterfacesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/spb/SpokeSdpBindingStaticIsid/retrieveStaticIsids": { "post": { "tags": [ "samo_spb" ], "summary": "rest_spb_SpokeSdpBindingStaticIsid_retrieveStaticIsids", "description": "Method used to query the NE for SPB Static ISIDs associated with Spoke SDP Bindings of the service.

Intention : RETRIEVER
retrieveStaticIsids:
class-level retriever API retrieveStaticIsids
of class spb.SpokeSdpBindingStaticIsid


", "operationId": "rest_spb_SpokeSdpBindingStaticIsid_retrieveStaticIsids", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveStaticIsids" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveStaticIsidsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/dctr/AbstractVirtualComponentGlobal/getVirtualComponents": { "get": { "tags": [ "samo_dctr" ], "summary": "rest_dctr_AbstractVirtualComponentGlobal_getVirtualComponents", "description": "Gets the Virtual Machines and Containers for the VPRN or VPLS service or service site, service scope, or POD.

Intention : RETRIEVER
getVirtualComponents:
class-level retriever API getVirtualComponents
of class dctr.AbstractVirtualComponentGlobal
DescendantInfo:
dctr.Container
DescendantInfo:
dctr.VirtualMachine


", "operationId": "rest_dctr_AbstractVirtualComponentGlobal_getVirtualComponents", "parameters": [ { "name": "aInSName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getVirtualComponentsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/dctr/AbstractVirtualPort/setDefaultFlowAttributes/{instanceFullName}": { "post": { "tags": [ "samo_dctr" ], "summary": "rest_dctr_AbstractVirtualPort_setDefaultFlowAttributes", "operationId": "rest_dctr_AbstractVirtualPort_setDefaultFlowAttributes", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setDefaultFlowAttributes" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/dctr/AbstractVirtualSite/findAccessInterfaces/{instanceFullName}": { "get": { "tags": [ "samo_dctr" ], "summary": "rest_dctr_AbstractVirtualSite_findAccessInterfaces", "description": "Find the Access Interfaces associated with a given vSwitch-Site.

Intention : RETRIEVER
findAccessInterfaces:
instance-level [object finder] (retriever) API findAccessInterfaces
of class dctr.AbstractVirtualSite
DescendantInfo:
dctr.VplsVirtualSite
DescendantInfo:
dctr.VprnVirtualSite
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_dctr_AbstractVirtualSite_findAccessInterfaces", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAccessInterfacesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/dctr/AbstractVirtualSite/findControlInstances/{instanceFullName}": { "get": { "tags": [ "samo_dctr" ], "summary": "rest_dctr_AbstractVirtualSite_findControlInstances", "description": "Find the control instances for a given vSwitch-Site.

Intention : RETRIEVER
findControlInstances:
instance-level [object finder] (retriever) API findControlInstances
of class dctr.AbstractVirtualSite
DescendantInfo:
dctr.VplsVirtualSite
DescendantInfo:
dctr.VprnVirtualSite
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_dctr_AbstractVirtualSite_findControlInstances", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findControlInstancesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/dctr/AbstractVirtualSite/findUpstreamRouters/{instanceFullName}": { "get": { "tags": [ "samo_dctr" ], "summary": "rest_dctr_AbstractVirtualSite_findUpstreamRouters", "description": "Find the Underlay Routers for a given vSwitch-Site.

Intention : RETRIEVER
findUpstreamRouters:
instance-level [object finder] (retriever) API findUpstreamRouters
of class dctr.AbstractVirtualSite
DescendantInfo:
dctr.VplsVirtualSite
DescendantInfo:
dctr.VprnVirtualSite
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_dctr_AbstractVirtualSite_findUpstreamRouters", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findUpstreamRoutersResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/dctr/AbstractVirtualSite/findVirtualPorts/{instanceFullName}": { "get": { "tags": [ "samo_dctr" ], "summary": "rest_dctr_AbstractVirtualSite_findVirtualPorts", "description": "Find the Virtual Ports associated with a given vSwitch-Site.

Intention : RETRIEVER
findVirtualPorts:
instance-level [object finder] (retriever) API findVirtualPorts
of class dctr.AbstractVirtualSite
DescendantInfo:
dctr.VplsVirtualSite
DescendantInfo:
dctr.VprnVirtualSite
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_dctr_AbstractVirtualSite_findVirtualPorts", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findVirtualPortsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/dctr/AbstractVirtualSwitchGlobal/discoverUpstreamRouters/{instanceFullName}": { "post": { "tags": [ "samo_dctr" ], "summary": "rest_dctr_AbstractVirtualSwitchGlobal_discoverUpstreamRouters", "operationId": "rest_dctr_AbstractVirtualSwitchGlobal_discoverUpstreamRouters", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/dctr/AuditManager/audit": { "post": { "tags": [ "samo_dctr" ], "summary": "rest_dctr_AuditManager_audit", "description": "Starts Audit action for all the objects under the hierarchy of the named objects in the input list.

Intention : MODIFIER
audit:
class-level modifier API audit on default instance voa-mgr of class dctr.AuditManager

The current state of the audit

", "operationId": "rest_dctr_AuditManager_audit", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditParam" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/auditResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/dctr/AuditManager/getResult": { "post": { "tags": [ "samo_dctr" ], "summary": "rest_dctr_AuditManager_getResult", "description": "Returns the result of a completed audit operation (the final state can be failure !!!).

Intention : RETRIEVER
getResult:
class-level retriever API getResult on default instance voa-mgr of class dctr.AuditManager

The results from the last audit.

", "operationId": "rest_dctr_AuditManager_getResult", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getResult" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getResultResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/dctr/AuditManager/getStatus": { "post": { "tags": [ "samo_dctr" ], "summary": "rest_dctr_AuditManager_getStatus", "description": "Gets the latest state of the audit operation.

Intention : RETRIEVER
getStatus:
class-level retriever API getStatus on default instance voa-mgr of class dctr.AuditManager

The current state of the audit

", "operationId": "rest_dctr_AuditManager_getStatus", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditParam" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getStatusResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/dctr/DCInventoryRecord/getDCInventory": { "post": { "tags": [ "samo_dctr" ], "summary": "rest_dctr_DCInventoryRecord_getDCInventory", "description": "returns a DCInventoryRecord filled with count values as specified in the input filter

Intention : RETRIEVER
getDCInventory:
class-level retriever API getDCInventory
of class dctr.DCInventoryRecord


", "operationId": "rest_dctr_DCInventoryRecord_getDCInventory", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getDCInventory" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getDCInventoryResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/dctr/DataCenter/discoverOverlayPath": { "post": { "tags": [ "samo_dctr" ], "summary": "rest_dctr_DataCenter_discoverOverlayPath", "description": "
Intention : RETRIEVER
discoverOverlayPath:
class-level retriever API discoverOverlayPath
of class dctr.DataCenter


", "operationId": "rest_dctr_DataCenter_discoverOverlayPath", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/discoverOverlayPath" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/discoverOverlayPathResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/dctr/DataCenter/getFlows": { "get": { "tags": [ "samo_dctr" ], "summary": "rest_dctr_DataCenter_getFlows", "description": "Retrieves Flows Between Two Virtual Machines using OSSI.

Intention : RETRIEVER
getFlows:
class-level retriever API getFlows
of class dctr.DataCenter


", "operationId": "rest_dctr_DataCenter_getFlows", "parameters": [ { "name": "srcVPortFDN", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "dstVPortFDN", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "transProtocol", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "dstPort", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "activeFlowsCount", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getFlowsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/dctr/NsgGroup/findNsgsInGroup/{instanceFullName}": { "get": { "tags": [ "samo_dctr" ], "summary": "rest_dctr_NsgGroup_findNsgsInGroup", "description": "Find the Nsgs associated with a given Nsg Group.

Intention : RETRIEVER
findNsgsInGroup:
instance-level [object finder] (retriever) API findNsgsInGroup
of class dctr.NsgGroup
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_dctr_NsgGroup_findNsgsInGroup", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findNsgsInGroupResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/dctr/NsgUbrGroup/findNsgUbrsInGroup/{instanceFullName}": { "get": { "tags": [ "samo_dctr" ], "summary": "rest_dctr_NsgUbrGroup_findNsgUbrsInGroup", "description": "Find the Nsg Ubrs associated with a given Nsg Ubr Group.

Intention : RETRIEVER
findNsgUbrsInGroup:
instance-level [object finder] (retriever) API findNsgUbrsInGroup
of class dctr.NsgUbrGroup
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_dctr_NsgUbrGroup_findNsgUbrsInGroup", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findNsgUbrsInGroupResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/dctr/UpstreamRouterBinding/getUpstreamRouters": { "post": { "tags": [ "samo_dctr" ], "summary": "rest_dctr_UpstreamRouterBinding_getUpstreamRouters", "description": "Retrieve the Underlay Routers for a given target in a service.

Intention : RETRIEVER
getUpstreamRouters:
class-level retriever API getUpstreamRouters
of class dctr.UpstreamRouterBinding


", "operationId": "rest_dctr_UpstreamRouterBinding_getUpstreamRouters", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getUpstreamRouters" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getUpstreamRoutersResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/dctr/VSD/resyncVSwitches/{instanceFullName}": { "post": { "tags": [ "samo_dctr" ], "summary": "rest_dctr_VSD_resyncVSwitches", "operationId": "rest_dctr_VSD_resyncVSwitches", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/dctr/VirtualNode/getVirtualComponentsForVnode": { "get": { "tags": [ "samo_dctr" ], "summary": "rest_dctr_VirtualNode_getVirtualComponentsForVnode", "description": "Gets the Parent Virtual Components for the instance

Intention : RETRIEVER
getVirtualComponentsForVnode:
class-level retriever API getVirtualComponentsForVnode
of class dctr.VirtualNode


", "operationId": "rest_dctr_VirtualNode_getVirtualComponentsForVnode", "parameters": [ { "name": "aInVnodeIp", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getVirtualComponentsForVnodeResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/dctr/VirtualNode/getVirtualPortsForVnode": { "get": { "tags": [ "samo_dctr" ], "summary": "rest_dctr_VirtualNode_getVirtualPortsForVnode", "description": "Gets the Parent Virtual Machines for the instance

Intention : RETRIEVER
getVirtualPortsForVnode:
class-level retriever API getVirtualPortsForVnode
of class dctr.VirtualNode


", "operationId": "rest_dctr_VirtualNode_getVirtualPortsForVnode", "parameters": [ { "name": "aInVnodeIp", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getVirtualPortsForVnodeResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sonet/PtpPortRecoveredClockHistory/retrievePtpPortRecoveredClockHistory": { "post": { "tags": [ "samo_sonet" ], "summary": "rest_sonet_PtpPortRecoveredClockHistory_retrievePtpPortRecoveredClockHistory", "description": "Method used to query the NE for the recovered clock history of a particular PTPPort.

Intention : RETRIEVER
retrievePtpPortRecoveredClockHistory:
class-level retriever API retrievePtpPortRecoveredClockHistory
of class sonet.PtpPortRecoveredClockHistory
DescendantInfo:
sonet.PtpPortRecoveredClockHistoryMasterTwo
DescendantInfo:
sonet.PtpPortRecoveredClockHistoryMasterOne


", "operationId": "rest_sonet_PtpPortRecoveredClockHistory_retrievePtpPortRecoveredClockHistory", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrievePtpPortRecoveredClockHistory" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrievePtpPortRecoveredClockHistoryResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sonet/SiteSync/findSyncTimeLinks": { "post": { "tags": [ "samo_sonet" ], "summary": "rest_sonet_SiteSync_findSyncTimeLinks", "description": "
Intention : RETRIEVER
findSyncTimeLinks:
class-level [object finder] (retriever) API findSyncTimeLinks
of class sonet.SiteSync


", "operationId": "rest_sonet_SiteSync_findSyncTimeLinks", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findSyncTimeLinksResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sonet/SiteSync/findSyncTimeSources": { "post": { "tags": [ "samo_sonet" ], "summary": "rest_sonet_SiteSync_findSyncTimeSources", "description": "
Intention : RETRIEVER
findSyncTimeSources:
class-level [object finder] (retriever) API findSyncTimeSources
of class sonet.SiteSync


", "operationId": "rest_sonet_SiteSync_findSyncTimeSources", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findSyncTimeSources" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findSyncTimeSourcesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sonet/SiteSync/retrieveQualityTiming": { "post": { "tags": [ "samo_sonet" ], "summary": "rest_sonet_SiteSync_retrieveQualityTiming", "description": "
Intention : RETRIEVER
retrieveQualityTiming:
class-level retriever API retrieveQualityTiming
of class sonet.SiteSync

Map that holds the fdn of the network element this SiteSync is on
and its state (i.e. if either it should categorized as Red Yellow Green)

", "operationId": "rest_sonet_SiteSync_retrieveQualityTiming", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveQualityTimingResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/l2tp/GroupProfile/removePassword/{instanceFullName}": { "post": { "tags": [ "samo_l2tp" ], "summary": "rest_l2tp_GroupProfile_removePassword", "operationId": "rest_l2tp_GroupProfile_removePassword", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/l2tp/GroupProfile/retrieveEthernetSessions": { "post": { "tags": [ "samo_l2tp" ], "summary": "rest_l2tp_GroupProfile_retrieveEthernetSessions", "description": "Method used to retrieve Ethernet Tunnel session(s) from NE.

Intention : RETRIEVER
retrieveEthernetSessions:
class-level retriever API retrieveEthernetSessions
of class l2tp.GroupProfile


", "operationId": "rest_l2tp_GroupProfile_retrieveEthernetSessions", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/L2TPEthernetSessionStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveEthernetSessionsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/l2tp/GroupProfile/stopTunnels": { "post": { "tags": [ "samo_l2tp" ], "summary": "rest_l2tp_GroupProfile_stopTunnels", "operationId": "rest_l2tp_GroupProfile_stopTunnels", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stopTunnels" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/l2tp/L2TPSession/retrieveL2TPSessions": { "post": { "tags": [ "samo_l2tp" ], "summary": "rest_l2tp_L2TPSession_retrieveL2TPSessions", "description": "Method used to retrieve L2TP session(s) from NE.

Intention : RETRIEVER
retrieveL2TPSessions:
class-level retriever API retrieveL2TPSessions
of class l2tp.L2TPSession


", "operationId": "rest_l2tp_L2TPSession_retrieveL2TPSessions", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveL2TPSessions" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveL2TPSessionsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/l2tp/L2TPSession/retrieveL2TPv3EthernetTunnelStats": { "post": { "tags": [ "samo_l2tp" ], "summary": "rest_l2tp_L2TPSession_retrieveL2TPv3EthernetTunnelStats", "description": "Method used to retrieve L2TPv3 Ethernet session stats from NE.

Intention : RETRIEVER
retrieveL2TPv3EthernetTunnelStats:
class-level retriever API retrieveL2TPv3EthernetTunnelStats
of class l2tp.L2TPSession


", "operationId": "rest_l2tp_L2TPSession_retrieveL2TPv3EthernetTunnelStats", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveL2TPv3EthernetTunnelStatsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/l2tp/L2TPv3TunnelGroupConfig/removePassword/{instanceFullName}": { "post": { "tags": [ "samo_l2tp" ], "summary": "rest_l2tp_L2TPv3TunnelGroupConfig_removePassword", "operationId": "rest_l2tp_L2TPv3TunnelGroupConfig_removePassword", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/l2tp/L2TPv3VirtualRouterConfig/removePassword/{instanceFullName}": { "post": { "tags": [ "samo_l2tp" ], "summary": "rest_l2tp_L2TPv3VirtualRouterConfig_removePassword", "operationId": "rest_l2tp_L2TPv3VirtualRouterConfig_removePassword", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/l2tp/LacMlpppBundle/retrieveLacMlpppBundles": { "post": { "tags": [ "samo_l2tp" ], "summary": "rest_l2tp_LacMlpppBundle_retrieveLacMlpppBundles", "description": "Method used to retrieve Retrieving Lac MLPPP Bundle(s) from NE.

Intention : RETRIEVER
retrieveLacMlpppBundles:
class-level retriever API retrieveLacMlpppBundles
of class l2tp.LacMlpppBundle


", "operationId": "rest_l2tp_LacMlpppBundle_retrieveLacMlpppBundles", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievingLacMlpppBundleStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveLacMlpppBundlesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/l2tp/Site/removePassword/{instanceFullName}": { "post": { "tags": [ "samo_l2tp" ], "summary": "rest_l2tp_Site_removePassword", "operationId": "rest_l2tp_Site_removePassword", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/l2tp/TunnelProfile/drain": { "post": { "tags": [ "samo_l2tp" ], "summary": "rest_l2tp_TunnelProfile_drain", "operationId": "rest_l2tp_TunnelProfile_drain", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/drain" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/l2tp/TunnelProfile/removePassword/{instanceFullName}": { "post": { "tags": [ "samo_l2tp" ], "summary": "rest_l2tp_TunnelProfile_removePassword", "operationId": "rest_l2tp_TunnelProfile_removePassword", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/l2tp/TunnelProfile/stopTunnels": { "post": { "tags": [ "samo_l2tp" ], "summary": "rest_l2tp_TunnelProfile_stopTunnels", "operationId": "rest_l2tp_TunnelProfile_stopTunnels", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/stopTunnels" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v1/auth": { "post": { "tags": [ "samo_auth" ], "summary": "getAuthToken", "description": "Support for the ‘/nfm-p/rest/api/v1/auth’ API will be available up to NSP 22.11 and removed in NSP 23.03. Please use NSP gateway to authenticate a user and to refresh a token.\n\nSpecifies the authentication interface to be used to get a Bearer token or to refresh a Bearer token. \nFor example, the client makes the following HTTP request:\n \n\n POST /v1/auth HTTP/1.1\n Host: server.example.com\n Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW\n X-FORWARDED-FOR: RestClientAddress (Optional) \n Content-Type: application/json\n\n {\"grant_type\":\"client_credentials\"}\n\n The NFM-P server MUST authenticate the client. If the access token request is valid and authorized, the\n NFM-P issues an access token and a refresh token.\n If the request fails client,\n authentication or is invalid, the NFM-P server returns an\n error response as described in the API description.\n\n An example of a successful response:\n\n HTTP/1.1 200 OK\n Content-Type: application/json;charset=UTF-8\n X-tokenCreationTime: 1457712955143\n Cache-Control: no-store\n Pragma: no-cache\n\n {\n \"access_token\":\"2YotnFZFEjr1zCsicMWpAA\",\n \"token_type\":\"Bearer\",\n \"expires_in\":3600,\n \"refresh_token\":\"tGzv3JOkF0XG5Qx2TlKWIA\",\n }\n The bearer token is used to issue requests to all endpoints of this application. \nTo use the bearer token, construct a normal HTTP request and include an authorization header. \nFor example, to refresh a token, make the following HTTP request:\n :\n\n POST /v1/auth HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA\n Content-Type: application/json\n\n {\"grant_type\":\"refresh_token\", \"refresh_token\":\"tGzv3JOkF0XG5Qx2TlKWIA\"}\n\n An example successful response:\n\n HTTP/1.1 200 OK\n Content-Type: application/json;charset=UTF-8\n X-tokenCreationTime: 1457713599603\n Cache-Control: no-cache\n\n {\n \"access_token\":\"2YotnFZFEjr1zCsicMWpAF\",\n \"token_type\":\"Bearer\",\n \"expires_in\":3600,\n \"refresh_token\":\"tGzv3JOkF0XG5Qx2TlKWIB\",\n }\n

Bearer Token: \n A security token that can be used in the same way by any party in possession of \n it (a bearer). Using a bearer token does not \n require a bearer to prove possession of a cryptographic key material \n (proof-of-possession). \n", "operationId": "getAuthToken", "parameters": [], "requestBody": { "description": "The token type to supply", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" }, "description": "The token type to supply" } } }, "required": false }, "responses": { "200": { "description": "Successful authentication. A Bearer token is returned", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenAttribute" } } } }, "401": { "description": "Exceeded maximum number of connections for a given user", "headers": {}, "content": {} }, "412": { "description": "The specified grant type value is not supported", "headers": {}, "content": {} }, "500": { "description": "Internal server error", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/multichassis/AbstractMultiChassisPeer/findInstanceContainedPeers/{instanceFullName}": { "post": { "tags": [ "samo_multichassis" ], "summary": "rest_multichassis_AbstractMultiChassisPeer_findInstanceContainedPeers", "description": "
Intention : RETRIEVER
findInstanceContainedPeers:
instance-level [object finder] (retriever) API findInstanceContainedPeers
of class multichassis.AbstractMultiChassisPeer
DescendantInfo:
multichassis.PSSMultiChassisPeer
DescendantInfo:
multichassis.MultiChassisPeer
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_multichassis_AbstractMultiChassisPeer_findInstanceContainedPeers", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findInstanceContainedPeersResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/multichassis/AbstractMultiChassisPeer/pushDownPeerSyncSymmetricalConfig/{instanceFullName}": { "post": { "tags": [ "samo_multichassis" ], "summary": "rest_multichassis_AbstractMultiChassisPeer_pushDownPeerSyncSymmetricalConfig", "operationId": "rest_multichassis_AbstractMultiChassisPeer_pushDownPeerSyncSymmetricalConfig", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pushDownPeerSyncSymmetricalConfig" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/multichassis/AbstractMultiChassisPeer/resetPeerSyncProtocols/{instanceFullName}": { "post": { "tags": [ "samo_multichassis" ], "summary": "rest_multichassis_AbstractMultiChassisPeer_resetPeerSyncProtocols", "description": "Request reset the synchronization protocols if they are mismatched on two sites

Intention : MODIFIER
resetPeerSyncProtocols:
instance-level modifier API resetPeerSyncProtocols
of class multichassis.AbstractMultiChassisPeer
DescendantInfo:
multichassis.PSSMultiChassisPeer
DescendantInfo:
multichassis.MultiChassisPeer
instanceFullName : distinguished/instance name of called object
Resulting objects list.

", "operationId": "rest_multichassis_AbstractMultiChassisPeer_resetPeerSyncProtocols", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resetPeerSyncProtocolsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/multichassis/McOmcrStat/resyncMcOmcrStat": { "post": { "tags": [ "samo_multichassis" ], "summary": "rest_multichassis_McOmcrStat_resyncMcOmcrStat", "operationId": "rest_multichassis_McOmcrStat_resyncMcOmcrStat", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/multichassis/MultiChassisIPSecGroup/forceTagSync/{instanceFullName}": { "post": { "tags": [ "samo_multichassis" ], "summary": "rest_multichassis_MultiChassisIPSecGroup_forceTagSync", "operationId": "rest_multichassis_MultiChassisIPSecGroup_forceTagSync", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/multichassis/MultiChassisMobileGatewayGroup/mobilePeerSwitchOver/{instanceFullName}": { "post": { "tags": [ "samo_multichassis" ], "summary": "rest_multichassis_MultiChassisMobileGatewayGroup_mobilePeerSwitchOver", "operationId": "rest_multichassis_MultiChassisMobileGatewayGroup_mobilePeerSwitchOver", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "boolean" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/multichassis/MultiChassisMobileGatewayGroup/mobilePeerSwitchOverAbort/{instanceFullName}": { "post": { "tags": [ "samo_multichassis" ], "summary": "rest_multichassis_MultiChassisMobileGatewayGroup_mobilePeerSwitchOverAbort", "operationId": "rest_multichassis_MultiChassisMobileGatewayGroup_mobilePeerSwitchOverAbort", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/multichassis/MultiChassisMobileGatewayGroup/mobilePeerSwitchOverNow/{instanceFullName}": { "post": { "tags": [ "samo_multichassis" ], "summary": "rest_multichassis_MultiChassisMobileGatewayGroup_mobilePeerSwitchOverNow", "operationId": "rest_multichassis_MultiChassisMobileGatewayGroup_mobilePeerSwitchOverNow", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/multichassis/MultiChassisPeer/getDependencyCount/{instanceFullName}": { "get": { "tags": [ "samo_multichassis" ], "summary": "rest_multichassis_MultiChassisPeer_getDependencyCount", "description": "
Intention : RETRIEVER
getDependencyCount:
instance-level retriever API getDependencyCount
of class multichassis.MultiChassisPeer
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_multichassis_MultiChassisPeer_getDependencyCount", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getDependencyCountResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/multichassis/MultiChassisPeerMobileGateway/mobilePeerSwitchOver/{instanceFullName}": { "post": { "tags": [ "samo_multichassis" ], "summary": "rest_multichassis_MultiChassisPeerMobileGateway_mobilePeerSwitchOver", "operationId": "rest_multichassis_MultiChassisPeerMobileGateway_mobilePeerSwitchOver", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "boolean" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/multichassis/MultiChassisPeerMobileGateway/mobilePeerSwitchOverAbort/{instanceFullName}": { "post": { "tags": [ "samo_multichassis" ], "summary": "rest_multichassis_MultiChassisPeerMobileGateway_mobilePeerSwitchOverAbort", "operationId": "rest_multichassis_MultiChassisPeerMobileGateway_mobilePeerSwitchOverAbort", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/multichassis/MultiChassisPeerMobileGateway/mobilePeerSwitchOverNow/{instanceFullName}": { "post": { "tags": [ "samo_multichassis" ], "summary": "rest_multichassis_MultiChassisPeerMobileGateway_mobilePeerSwitchOverNow", "operationId": "rest_multichassis_MultiChassisPeerMobileGateway_mobilePeerSwitchOverNow", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/multichassis/MultiChassisRingNode/findAssociatedVplsSaps/{instanceFullName}": { "post": { "tags": [ "samo_multichassis" ], "summary": "rest_multichassis_MultiChassisRingNode_findAssociatedVplsSaps", "description": "Return a list of VPLS MVPLS SAPs that are protected by the Multi-Chassis Ring and associated
with this ring node.

Intention : RETRIEVER
findAssociatedVplsSaps:
instance-level [object finder] (retriever) API findAssociatedVplsSaps
of class multichassis.MultiChassisRingNode
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_multichassis_MultiChassisRingNode_findAssociatedVplsSaps", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findAssociatedVplsSapsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/multichassis/MultiChassisRingNode/findReferencedSaps/{instanceFullName}": { "post": { "tags": [ "samo_multichassis" ], "summary": "rest_multichassis_MultiChassisRingNode_findReferencedSaps", "description": "Return the list of the Multi Chassis Ring protected
EPIPE L2 Access Interface which has the reference of this ring node.

Intention : RETRIEVER
findReferencedSaps:
instance-level [object finder] (retriever) API findReferencedSaps
of class multichassis.MultiChassisRingNode
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_multichassis_MultiChassisRingNode_findReferencedSaps", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findReferencedSapsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/multichassis/MultiChassisRingNode/findReferencedStaticHosts/{instanceFullName}": { "post": { "tags": [ "samo_multichassis" ], "summary": "rest_multichassis_MultiChassisRingNode_findReferencedStaticHosts", "description": "Return the list of the anti-spoofing static host which has
the reference of this ring node.

Intention : RETRIEVER
findReferencedStaticHosts:
instance-level [object finder] (retriever) API findReferencedStaticHosts
of class multichassis.MultiChassisRingNode
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_multichassis_MultiChassisRingNode_findReferencedStaticHosts", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findReferencedStaticHostsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/multichassis/PeerSynchronizationProtocol/findSyncTags/{instanceFullName}": { "post": { "tags": [ "samo_multichassis" ], "summary": "rest_multichassis_PeerSynchronizationProtocol_findSyncTags", "description": "Find all the Sync Tags configured under this MC SynchronizatioProtocol.

Intention : RETRIEVER
findSyncTags:
instance-level [object finder] (retriever) API findSyncTags
of class multichassis.PeerSynchronizationProtocol
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_multichassis_PeerSynchronizationProtocol_findSyncTags", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindSyncTagsInputStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findSyncTagsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/openflow/OFFlowTableCounts/retrieveOFFlowTableCounts": { "post": { "tags": [ "samo_openflow" ], "summary": "rest_openflow_OFFlowTableCounts_retrieveOFFlowTableCounts", "description": "Method used to query the OF Switch for flow table counts.

Intention : RETRIEVER
retrieveOFFlowTableCounts:
class-level retriever API retrieveOFFlowTableCounts
of class openflow.OFFlowTableCounts


", "operationId": "rest_openflow_OFFlowTableCounts_retrieveOFFlowTableCounts", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveOFFlowTableCounts" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveOFFlowTableCountsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/generic/GenericObject/clearDeployer": { "post": { "tags": [ "samo_generic" ], "summary": "rest_generic_GenericObject_clearDeployer", "operationId": "rest_generic_GenericObject_clearDeployer", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/generic/GenericObject/compareObjects": { "post": { "tags": [ "samo_generic" ], "summary": "rest_generic_GenericObject_compareObjects", "description": "Performs a comparison starting at the 2 given objects.
The two objects must support object comparison and
be compatible, otherwise an exception is thrown.

Intention : RETRIEVER
compareObjects:
class-level retriever API compareObjects
of class generic.GenericObject

The results of the comparison.

", "operationId": "rest_generic_GenericObject_compareObjects", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compareObjects" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/compareObjectsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/generic/GenericObject/configureChildInstance": { "post": { "tags": [ "samo_generic" ], "summary": "rest_generic_GenericObject_configureChildInstance", "description": "Creates a child of the object with the desired configuration values for the child or children
objects, and optional grandchildren.

Intention : MODIFIER
configureChildInstance:
class-level [hierarchical administrative configuration/modification] (modifier) API configureChildInstance
of class generic.GenericObject
This API follows hierarchical config model rules.

Returns fullname of the child created.

", "operationId": "rest_generic_GenericObject_configureChildInstance", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureChildInstance" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureChildInstanceResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/generic/GenericObject/configureChildInstanceWithResult": { "post": { "tags": [ "samo_generic" ], "summary": "rest_generic_GenericObject_configureChildInstanceWithResult", "description": "Creates a child of an existing object. The method returns the newly configured parameters on the
child object and grandchildren, including parameters set due to associated conditions.

Intention : MODIFIER
configureChildInstanceWithResult:
class-level [hierarchical administrative configuration/modification] (modifier) API configureChildInstanceWithResult
of class generic.GenericObject
This API follows hierarchical config model rules.

Resulting child object (grandchildren included, if applicable).
Note that some classes do not return children. In such cases, this is specified in the class documentation.

", "operationId": "rest_generic_GenericObject_configureChildInstanceWithResult", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureChildInstanceWithResult" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureChildInstanceWithResultResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/generic/GenericObject/configureInstance": { "post": { "tags": [ "samo_generic" ], "summary": "rest_generic_GenericObject_configureInstance", "operationId": "rest_generic_GenericObject_configureInstance", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureInstance" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/generic/GenericObject/configureInstanceWithResult": { "post": { "tags": [ "samo_generic" ], "summary": "rest_generic_GenericObject_configureInstanceWithResult", "description": "Modifies an existing object and associated children. The method returns the newly
configured parameters on the object and child, including parameters set due to associated
conditions.

Intention : MODIFIER
configureInstanceWithResult:
class-level [hierarchical administrative configuration/modification] (modifier) API configureInstanceWithResult
of class generic.GenericObject
This API follows hierarchical config model rules.

Resulting object (children included, if requested, unless otherwise specified for this class in XML Reference).

", "operationId": "rest_generic_GenericObject_configureInstanceWithResult", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureInstanceWithResult" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureInstanceWithResultResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/generic/GenericObject/countInstance": { "post": { "tags": [ "samo_generic" ], "summary": "rest_generic_GenericObject_countInstance", "description": "Count the number of matched instances of a persisted class.

Intention : RETRIEVER
countInstance:
class-level retriever API countInstance
of class generic.GenericObject

Returns the number of instances.

", "operationId": "rest_generic_GenericObject_countInstance", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/countInstance" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/countInstanceResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/generic/GenericObject/deleteInstance": { "delete": { "tags": [ "samo_generic" ], "summary": "rest_generic_GenericObject_deleteInstance", "operationId": "rest_generic_GenericObject_deleteInstance", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/generic/GenericObject/filteredDelete": { "post": { "tags": [ "samo_generic" ], "summary": "rest_generic_GenericObject_filteredDelete", "operationId": "rest_generic_GenericObject_filteredDelete", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/filteredDelete" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/generic/GenericObject/filteredFind": { "post": { "tags": [ "samo_generic" ], "summary": "rest_generic_GenericObject_filteredFind", "description": "Retrieve a set of matched object(s) with the given instance full name and or its children. Depending on the
scope, the set could contain one object or the whole subtree.



Intention : RETRIEVER
filteredFind:
class-level retriever API filteredFind
of class generic.GenericObject

List of matched objects returned.

", "operationId": "rest_generic_GenericObject_filteredFind", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/filteredFind" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/filteredFindResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/generic/GenericObject/findInstance": { "get": { "tags": [ "samo_generic" ], "summary": "rest_generic_GenericObject_findInstance", "description": "Find the instance with the given full name.

Intention : RETRIEVER
findInstance:
class-level [object finder] (retriever) API findInstance
of class generic.GenericObject

Returns the instance.

", "operationId": "rest_generic_GenericObject_findInstance", "parameters": [ { "name": "instanceFullName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findInstanceResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/generic/GenericObject/findMultipleInstances": { "post": { "tags": [ "samo_generic" ], "summary": "rest_generic_GenericObject_findMultipleInstances", "description": "To find multiple instances with children hierarchy under each instance.
An exception log message is recorded in the server log file for any objects, that cannot be found for specified instance names.

Intention : RETRIEVER
findMultipleInstances:
class-level [object finder] (retriever) API findMultipleInstances
of class generic.GenericObject

List of instances.
Note that some classes do not return children. In such cases, this is specified in the class documentation.

", "operationId": "rest_generic_GenericObject_findMultipleInstances", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findMultipleInstancesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/generic/GenericObject/findMultipleInstancesShallow": { "post": { "tags": [ "samo_generic" ], "summary": "rest_generic_GenericObject_findMultipleInstancesShallow", "description": "To find multiple instances without children hierarchy under each instance.

Intention : RETRIEVER
findMultipleInstancesShallow:
class-level [object finder] (retriever) API findMultipleInstancesShallow
of class generic.GenericObject

list of instances.

", "operationId": "rest_generic_GenericObject_findMultipleInstancesShallow", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findMultipleInstancesShallowResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/generic/GenericObject/forceSubmitDeployer": { "post": { "tags": [ "samo_generic" ], "summary": "rest_generic_GenericObject_forceSubmitDeployer", "operationId": "rest_generic_GenericObject_forceSubmitDeployer", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/generic/GenericObject/getDeployer": { "get": { "tags": [ "samo_generic" ], "summary": "rest_generic_GenericObject_getDeployer", "description": "Find information about a specific deployer.

Intention : RETRIEVER
getDeployer:
class-level retriever API getDeployer
of class generic.GenericObject

Returns the deployer object.

", "operationId": "rest_generic_GenericObject_getDeployer", "parameters": [ { "name": "deployerName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getDeployerResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/generic/GenericObject/getDeployers": { "post": { "tags": [ "samo_generic" ], "summary": "rest_generic_GenericObject_getDeployers", "description": "Find information for deployers matching the specified filter with children hierarchy.

Intention : RETRIEVER
getDeployers:
class-level retriever API getDeployers
of class generic.GenericObject

Returns the list of deployers.

", "operationId": "rest_generic_GenericObject_getDeployers", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getDeployersResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/generic/GenericObject/getDeployersShallow": { "post": { "tags": [ "samo_generic" ], "summary": "rest_generic_GenericObject_getDeployersShallow", "description": "Retrieve matched deployers without children hierarchy.

Intention : RETRIEVER
getDeployersShallow:
class-level retriever API getDeployersShallow
of class generic.GenericObject

Returns the list of deployers.

", "operationId": "rest_generic_GenericObject_getDeployersShallow", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getDeployersShallowResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/generic/GenericObject/getIncrementalRequestID": { "get": { "tags": [ "samo_generic" ], "summary": "rest_generic_GenericObject_getIncrementalRequestID", "description": "
Intention : RETRIEVER
getIncrementalRequestID:
class-level retriever API getIncrementalRequestID
of class generic.GenericObject


", "operationId": "rest_generic_GenericObject_getIncrementalRequestID", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getIncrementalRequestIDResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/generic/GenericObject/multipleFilteredFind": { "post": { "tags": [ "samo_generic" ], "summary": "rest_generic_GenericObject_multipleFilteredFind", "description": "Retrieve a set of objects matching the specified search criteria with children hierarchy.

Intention : RETRIEVER
multipleFilteredFind:
class-level retriever API multipleFilteredFind
of class generic.GenericObject

List of objects retrieved.

", "operationId": "rest_generic_GenericObject_multipleFilteredFind", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/multipleFilteredFind" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/multipleFilteredFindResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/generic/GenericObject/removeMany": { "post": { "tags": [ "samo_generic" ], "summary": "rest_generic_GenericObject_removeMany", "operationId": "rest_generic_GenericObject_removeMany", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/generic/GenericObject/resumeDeploymentRetries": { "post": { "tags": [ "samo_generic" ], "summary": "rest_generic_GenericObject_resumeDeploymentRetries", "operationId": "rest_generic_GenericObject_resumeDeploymentRetries", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/generic/GenericObject/suspendDeploymentRetries": { "post": { "tags": [ "samo_generic" ], "summary": "rest_generic_GenericObject_suspendDeploymentRetries", "operationId": "rest_generic_GenericObject_suspendDeploymentRetries", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/generic/GenericObject/triggerCollect": { "post": { "tags": [ "samo_generic" ], "summary": "rest_generic_GenericObject_triggerCollect", "operationId": "rest_generic_GenericObject_triggerCollect", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/triggerCollect" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/generic/GenericObject/triggerIncrementalRequest": { "post": { "tags": [ "samo_generic" ], "summary": "rest_generic_GenericObject_triggerIncrementalRequest", "description": "This method starts a request for a specified application.
IncrementalRequestEvents are generated for start, incremental, failed and finished states.

Intention : RETRIEVER
triggerIncrementalRequest:
class-level [functionality trigger] (retriever) API triggerIncrementalRequest
of class generic.GenericObject

The incremental request ID is returned when the request is started.
The ID can be used to identify IncrementalRequestEvents for this request.

", "operationId": "rest_generic_GenericObject_triggerIncrementalRequest", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncrementalContext" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/triggerIncrementalRequestResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/generic/GenericObject/triggerIncrementalRequestWithRequestID": { "post": { "tags": [ "samo_generic" ], "summary": "rest_generic_GenericObject_triggerIncrementalRequestWithRequestID", "operationId": "rest_generic_GenericObject_triggerIncrementalRequestWithRequestID", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/triggerIncrementalRequestWithRequestID" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/generic/GenericObject/triggerResync": { "post": { "tags": [ "samo_generic" ], "summary": "rest_generic_GenericObject_triggerResync", "description": "To perform a non-scheduled resynchronization of an object.
The resynch request will not return until all related resync tasks have completed.

Intention : RETRIEVER
triggerResync:
class-level [functionality trigger] (retriever) API triggerResync
of class generic.GenericObject

Resulting status of the resync, as defined in taskmgmt.TaskStatus

", "operationId": "rest_generic_GenericObject_triggerResync", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/triggerResync" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/triggerResyncResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/generic/GenericObject/updateUserObjectLifecycleStates": { "put": { "tags": [ "samo_generic" ], "summary": "rest_generic_GenericObject_updateUserObjectLifecycleStates", "description": "Set user OLC States.

Intention : MODIFIER
updateUserObjectLifecycleStates:
class-level modifier API updateUserObjectLifecycleStates
of class generic.GenericObject


", "operationId": "rest_generic_GenericObject_updateUserObjectLifecycleStates", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateUserObjectLifecycleStates" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateUserObjectLifecycleStatesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/generic/GenericObject/updateUserObjectLifecycleStatesAndLocks": { "put": { "tags": [ "samo_generic" ], "summary": "rest_generic_GenericObject_updateUserObjectLifecycleStatesAndLocks", "description": "Set user OLC States.

Intention : MODIFIER
updateUserObjectLifecycleStatesAndLocks:
class-level modifier API updateUserObjectLifecycleStatesAndLocks
of class generic.GenericObject


", "operationId": "rest_generic_GenericObject_updateUserObjectLifecycleStatesAndLocks", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateUserObjectLifecycleStatesAndLocks" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateUserObjectLifecycleStatesAndLocksResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/generic/GenericObject/updateUserObjectLifecycleStatesAndLocksAndSchedules": { "put": { "tags": [ "samo_generic" ], "summary": "rest_generic_GenericObject_updateUserObjectLifecycleStatesAndLocksAndSchedules", "description": "Set user OLC Schedule.

Intention : MODIFIER
updateUserObjectLifecycleStatesAndLocksAndSchedules:
class-level modifier API updateUserObjectLifecycleStatesAndLocksAndSchedules
of class generic.GenericObject


", "operationId": "rest_generic_GenericObject_updateUserObjectLifecycleStatesAndLocksAndSchedules", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateUserObjectLifecycleStatesAndLocksAndSchedules" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateUserObjectLifecycleStatesAndLocksAndSchedulesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/generic/GenericObject/updateUserObjectLifecycleStatesAndSchedules": { "put": { "tags": [ "samo_generic" ], "summary": "rest_generic_GenericObject_updateUserObjectLifecycleStatesAndSchedules", "description": "Set user OLC Schedule.

Intention : MODIFIER
updateUserObjectLifecycleStatesAndSchedules:
class-level modifier API updateUserObjectLifecycleStatesAndSchedules
of class generic.GenericObject


", "operationId": "rest_generic_GenericObject_updateUserObjectLifecycleStatesAndSchedules", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateUserObjectLifecycleStatesAndSchedules" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateUserObjectLifecycleStatesAndSchedulesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/AbstractResSubscrTemplate/constructTemplatedObject/{instanceFullName}": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_AbstractResSubscrTemplate_constructTemplatedObject", "description": "Construct object from template

Intention : MODIFIER
constructTemplatedObject:
instance-level modifier API constructTemplatedObject
of class ressubscr.AbstractResSubscrTemplate
DescendantInfo:
ressubscr.ResSubscrPolicyTemplate
DescendantInfo:
ressubscr.ResSubscrACLVelocityTemplate
DescendantInfo:
ressubscr.ResSubscrVelocityTemplate
instanceFullName : distinguished/instance name of called object
Resulting templated object.

", "operationId": "rest_ressubscr_AbstractResSubscrTemplate_constructTemplatedObject", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/constructTemplatedObjectResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/AbstractResSubscrTemplate/update/{instanceFullName}": { "put": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_AbstractResSubscrTemplate_update", "description": "Method used to update this template

Intention : MODIFIER
update:
instance-level modifier API update
of class ressubscr.AbstractResSubscrTemplate
DescendantInfo:
ressubscr.ResSubscrPolicyTemplate
DescendantInfo:
ressubscr.ResSubscrACLVelocityTemplate
DescendantInfo:
ressubscr.ResSubscrVelocityTemplate
instanceFullName : distinguished/instance name of called object
List of FDNs affected Templated objects that were created from this Template

", "operationId": "rest_ressubscr_AbstractResSubscrTemplate_update", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/BrgProfile/clearPassword/{instanceFullName}": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_BrgProfile_clearPassword", "operationId": "rest_ressubscr_BrgProfile_clearPassword", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ressubscr/DhcpLeaseState/retrieveDhcpLease": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_DhcpLeaseState_retrieveDhcpLease", "description": "
Intention : RETRIEVER
retrieveDhcpLease:
class-level retriever API retrieveDhcpLease
of class ressubscr.DhcpLeaseState


", "operationId": "rest_ressubscr_DhcpLeaseState_retrieveDhcpLease", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveDhcpLease" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveDhcpLeaseResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/DhcpLeaseStateRadiusClassAttribute/retrieveDhcpLeaseStateRadiusClasses": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_DhcpLeaseStateRadiusClassAttribute_retrieveDhcpLeaseStateRadiusClasses", "description": "Method used to query the NE for the DHCP Lease State RADIUS Class Attributes
related to the specified DHCP Lease State.

Intention : RETRIEVER
retrieveDhcpLeaseStateRadiusClasses:
class-level retriever API retrieveDhcpLeaseStateRadiusClasses
of class ressubscr.DhcpLeaseStateRadiusClassAttribute


", "operationId": "rest_ressubscr_DhcpLeaseStateRadiusClassAttribute_retrieveDhcpLeaseStateRadiusClasses", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveDhcpLeaseStateRadiusClasses" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveDhcpLeaseStateRadiusClassesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/HostLockoutInfo/retrieveHostLockoutInfo": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_HostLockoutInfo_retrieveHostLockoutInfo", "description": "Method used to query a SAP for host lockout info.

Intention : RETRIEVER
retrieveHostLockoutInfo:
class-level retriever API retrieveHostLockoutInfo
of class ressubscr.HostLockoutInfo

List of CommonManagedEntityInformation.

", "operationId": "rest_ressubscr_HostLockoutInfo_retrieveHostLockoutInfo", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveHostLockoutInfo" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveHostLockoutInfoResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/HostTrackedSubscriber/retrieveHostTrackedSubscribers": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_HostTrackedSubscriber_retrieveHostTrackedSubscribers", "description": "Method to retrieve Host Tracked Subscribers.

Intention : RETRIEVER
retrieveHostTrackedSubscribers:
class-level retriever API retrieveHostTrackedSubscribers
of class ressubscr.HostTrackedSubscriber


", "operationId": "rest_ressubscr_HostTrackedSubscriber_retrieveHostTrackedSubscribers", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostTrackedSubscrRtrvStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveHostTrackedSubscribersResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/IPoESession/requestClearIpoeSessions": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_IPoESession_requestClearIpoeSessions", "description": "Request clearing the IPOE Session with the specified parameters.
The clearIpoeSessionConfig siteId and svcId parameters are required.
If using any other optional clearIpoeSessionConfig parameters, one of sapId or interfaceId must be set.
When this method returns resources for the clear have been allocated but the
clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.
Note: Currently circuitId and remoteId parameters are disregarded.

Intention : MODIFIER
requestClearIpoeSessions:
class-level modifier API requestClearIpoeSessions
of class ressubscr.IPoESession

A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_ressubscr_IPoESession_requestClearIpoeSessions", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClearIpoeSessionStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearIpoeSessionsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/IPoESession/retrieveIPoESessions": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_IPoESession_retrieveIPoESessions", "description": "Method used to query the NE for the IPoE session(s) for.

Intention : RETRIEVER
retrieveIPoESessions:
class-level retriever API retrieveIPoESessions
of class ressubscr.IPoESession


", "operationId": "rest_ressubscr_IPoESession_retrieveIPoESessions", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveIPoESessions" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveIPoESessionsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/IPoESessionRadiusClassAttribute/retrieveIPoESessionRadiusClasses": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_IPoESessionRadiusClassAttribute_retrieveIPoESessionRadiusClasses", "description": "Method used to query the NE for the IPoE Session RADIUS Class Attributes
related to the specified IPoE Session.

Intention : RETRIEVER
retrieveIPoESessionRadiusClasses:
class-level retriever API retrieveIPoESessionRadiusClasses
of class ressubscr.IPoESessionRadiusClassAttribute


", "operationId": "rest_ressubscr_IPoESessionRadiusClassAttribute_retrieveIPoESessionRadiusClasses", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveIPoESessionRadiusClasses" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveIPoESessionRadiusClassesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/ManagedSubscriberHost/retrieveManagedSubscriberHosts": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_ManagedSubscriberHost_retrieveManagedSubscriberHosts", "description": "
Intention : RETRIEVER
retrieveManagedSubscriberHosts:
class-level retriever API retrieveManagedSubscriberHosts
of class ressubscr.ManagedSubscriberHost


", "operationId": "rest_ressubscr_ManagedSubscriberHost_retrieveManagedSubscriberHosts", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveManagedSubscriberHosts" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveManagedSubscriberHostsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/ResidentialSubscriber/modifySubscriberIdent": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_ResidentialSubscriber_modifySubscriberIdent", "operationId": "rest_ressubscr_ResidentialSubscriber_modifySubscriberIdent", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ressubscr/ResidentialSubscriberInstance/clearSubscriberHostDhcp6LeaseState": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_ResidentialSubscriberInstance_clearSubscriberHostDhcp6LeaseState", "description": "Request clearing the Dynamic DHCPv6 lease state for the specified IPv6 address and
optional prefix length.
When this method returns resources for the clear have been allocated but the
clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
clearSubscriberHostDhcp6LeaseState:
class-level [functionality clearing] (modifier) API clearSubscriberHostDhcp6LeaseState
of class ressubscr.ResidentialSubscriberInstance

A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_ressubscr_ResidentialSubscriberInstance_clearSubscriberHostDhcp6LeaseState", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClearDhcp6LeaseStateConfiguration" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clearSubscriberHostDhcp6LeaseStateResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/ResidentialSubscriberInstance/clearSubscriberHostLeaseState/{instanceFullName}": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_ResidentialSubscriberInstance_clearSubscriberHostLeaseState", "description": "Request clearing the Dynamic DHCP lease state for the specified IP address.
When this method returns resources for the clear have been allocated but the
clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
clearSubscriberHostLeaseState:
instance-level [functionality clearing] (modifier) API clearSubscriberHostLeaseState
of class ressubscr.ResidentialSubscriberInstance
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_ressubscr_ResidentialSubscriberInstance_clearSubscriberHostLeaseState", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClearDhcpLeaseStateConfiguration" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clearSubscriberHostLeaseStateResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/ResidentialSubscriberInstance/requestClearHostIgmpHostTracking/{instanceFullName}": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_ResidentialSubscriberInstance_requestClearHostIgmpHostTracking", "description": "Request clearing of the IGMP Host Tracking information for a specific
host of the Subscriber instance.
When this method returns resources for the clear have been allocated
but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearHostIgmpHostTracking:
instance-level modifier API requestClearHostIgmpHostTracking
of class ressubscr.ResidentialSubscriberInstance
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_ressubscr_ResidentialSubscriberInstance_requestClearHostIgmpHostTracking", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearHostIgmpHostTracking" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearHostIgmpHostTrackingResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/ResidentialSubscriberInstance/requestClearIgmpHostTracking/{instanceFullName}": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_ResidentialSubscriberInstance_requestClearIgmpHostTracking", "description": "Request clearing of all IGMP Host Tracking information for this
Subscriber instance.
When this method returns resources for the clear have been allocated
but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearIgmpHostTracking:
instance-level modifier API requestClearIgmpHostTracking
of class ressubscr.ResidentialSubscriberInstance
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_ressubscr_ResidentialSubscriberInstance_requestClearIgmpHostTracking", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "boolean" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearIgmpHostTrackingResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/ResidentialSubscriberInstance/retrieveL2tpTunnels": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_ResidentialSubscriberInstance_retrieveL2tpTunnels", "description": "Method used to retrieve L2TP tunnel endpoint information on LNS from LAC.

Intention : RETRIEVER
retrieveL2tpTunnels:
class-level retriever API retrieveL2tpTunnels
of class ressubscr.ResidentialSubscriberInstance


", "operationId": "rest_ressubscr_ResidentialSubscriberInstance_retrieveL2tpTunnels", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/L2TPTunnelRetrievalStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveL2tpTunnelsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/ResidentialSubscriberInstance/retrieveResidentialSubscriber": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_ResidentialSubscriberInstance_retrieveResidentialSubscriber", "description": "Method used to retrieve Residential Subscriber Instance information from the network

Intention : RETRIEVER
retrieveResidentialSubscriber:
class-level retriever API retrieveResidentialSubscriber
of class ressubscr.ResidentialSubscriberInstance


", "operationId": "rest_ressubscr_ResidentialSubscriberInstance_retrieveResidentialSubscriber", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveResidentialSubscriber" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveResidentialSubscriberResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/ResidentialSubscriberInstance/retrieveSubscriberVirtualSubnets": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_ResidentialSubscriberInstance_retrieveSubscriberVirtualSubnets", "description": "Method to retrieve Subscribe rVirtual Subnets.

Intention : RETRIEVER
retrieveSubscriberVirtualSubnets:
class-level retriever API retrieveSubscriberVirtualSubnets
of class ressubscr.ResidentialSubscriberInstance


", "operationId": "rest_ressubscr_ResidentialSubscriberInstance_retrieveSubscriberVirtualSubnets", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievingVirtualSubnetStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveSubscriberVirtualSubnetsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/ResidentialSubscriberManager/clearDynamicHost": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_ResidentialSubscriberManager_clearDynamicHost", "description": "Request clearing the Dynamic DHCP lease state for the specified IP address.
When this method returns resources for the clear have been allocated but the
clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
clearDynamicHost:
instance-level [functionality clearing] (modifier) API clearDynamicHost on default instance res-subscr-mgr of class ressubscr.ResidentialSubscriberManager

A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_ressubscr_ResidentialSubscriberManager_clearDynamicHost", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClearHostStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clearDynamicHostResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/ResidentialSubscriberManager/clearSap": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_ResidentialSubscriberManager_clearSap", "description": "Request clearing all Dynamic DHCP(DHCP + IPoE DHCP6) lease state for the specified SAP.
When this method returns resources for the clear have been allocated but the
clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
clearSap:
instance-level [functionality clearing] (modifier) API clearSap on default instance res-subscr-mgr of class ressubscr.ResidentialSubscriberManager

A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_ressubscr_ResidentialSubscriberManager_clearSap", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClearSapStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clearSapResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/ResidentialSubscriberManager/createSubSvcComponents": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_ResidentialSubscriberManager_createSubSvcComponents", "description": "Creates (clones or overrides) the \"service component\" -
Subscriber profile, SLA profile(s) and the (scheduler
and QoS) policies these profiles or a SAP (in the
assigned model) are using.
Generally, this method will create new objects IFF the
ossAssignedName specified in the corresponding templates
parameter is not assigned to any of the existing profile
policy objects.

Intention : MODIFIER
createSubSvcComponents:
class-level [administrative creation] (modifier) API createSubSvcComponents on default instance res-subscr-mgr of class ressubscr.ResidentialSubscriberManager

The map of FDNs of (top-level) objects created
when executing this request.
The keys are the OSS assigned names passed in
the parameters \"templates\".
The values are the FDNs of NFM-P global profiles
policies created for this request.

", "operationId": "rest_ressubscr_ResidentialSubscriberManager_createSubSvcComponents", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createSubSvcComponents" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createSubSvcComponentsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/ResidentialSubscriberManager/createSubSvcComponentsDyn": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_ResidentialSubscriberManager_createSubSvcComponentsDyn", "description": "
Intention : MODIFIER
createSubSvcComponentsDyn:
class-level [administrative creation] (modifier) API createSubSvcComponentsDyn on default instance res-subscr-mgr of class ressubscr.ResidentialSubscriberManager

The map of FDNs of (top-level) objects created
when executing this request.
The keys are the OSS assigned names passed in
the parameters \"templates\", ingress egressAclNames, and ingress egressIpv6AclNames.
The values are the FDNs of NFM-P global profiles
policies created for this request.

", "operationId": "rest_ressubscr_ResidentialSubscriberManager_createSubSvcComponentsDyn", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceComponentsCreateConfiguration" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createSubSvcComponentsDynResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/ResidentialSubscriberManager/deleteSubSvcComponents": { "delete": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_ResidentialSubscriberManager_deleteSubSvcComponents", "description": "Deletes the \"service components\" - subscriber profile, SLA
profile(s), scheduler and QoS policies created both
explicitly and implicitly when executing method
createSubSvcComponents().

Intention : MODIFIER
deleteSubSvcComponents:
class-level [administrative deletion] (modifier) API deleteSubSvcComponents on default instance res-subscr-mgr of class ressubscr.ResidentialSubscriberManager

Success or failure.
Fails if a profile policy is still used by some
subscriber host SAP and hence can't be deleted.
Failure to delete scheduler and QoS policies
created implicitly when cloning subscriber of SLA
profiles IS NOT treated as an error.

", "operationId": "rest_ressubscr_ResidentialSubscriberManager_deleteSubSvcComponents", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleteSubSvcComponentsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/ResidentialSubscriberManager/retrieveResidentialSubscribers": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_ResidentialSubscriberManager_retrieveResidentialSubscribers", "description": "Method used to retrieve extended Residential Subscriber information from the network.
It can include also the information for the children classes as it is requested by invoker.

Intention : RETRIEVER
retrieveResidentialSubscribers:
class-level retriever API retrieveResidentialSubscribers on default instance res-subscr-mgr of class ressubscr.ResidentialSubscriberManager

Residential Subscriber Instance info object where only
persisted information about Residential Subscriber Instance is set.

", "operationId": "rest_ressubscr_ResidentialSubscriberManager_retrieveResidentialSubscribers", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveResidentialSubscribers" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveResidentialSubscribersResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/ResidentialSubscriberManager/triggerCollect": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_ResidentialSubscriberManager_triggerCollect", "operationId": "rest_ressubscr_ResidentialSubscriberManager_triggerCollect", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/triggerCollect" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ressubscr/ResidentialSubscriberManager/updateSubSvcComponentsDynAcl": { "put": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_ResidentialSubscriberManager_updateSubSvcComponentsDynAcl", "description": "Revise ACL objects that were created using Velocity Template
Typically, the method would be invoked after a Velocity Template modification

Intention : MODIFIER
updateSubSvcComponentsDynAcl:
class-level modifier API updateSubSvcComponentsDynAcl on default instance res-subscr-mgr of class ressubscr.ResidentialSubscriberManager

List of FDNs affected by Template modification

", "operationId": "rest_ressubscr_ResidentialSubscriberManager_updateSubSvcComponentsDynAcl", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateSubSvcComponentsDynAclResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/SlaProfileInstance/retrieveSlaProfileInstances": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_SlaProfileInstance_retrieveSlaProfileInstances", "description": "Method used to query the NE for SLA Profile Instance(s) which have RADIUS overrides.
SLA Profile Instances without overrides will not be retrieved

Intention : RETRIEVER
retrieveSlaProfileInstances:
class-level retriever API retrieveSlaProfileInstances
of class ressubscr.SlaProfileInstance


", "operationId": "rest_ressubscr_SlaProfileInstance_retrieveSlaProfileInstances", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveSlaProfileInstances" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveSlaProfileInstancesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/SubBrgAddressPool/retrieveAddrPools": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_SubBrgAddressPool_retrieveAddrPools", "description": "Method used to retrieve Subscriber IP Address pools of a BRG.

Intention : RETRIEVER
retrieveAddrPools:
class-level retriever API retrieveAddrPools
of class ressubscr.SubBrgAddressPool

List of bindings.

", "operationId": "rest_ressubscr_SubBrgAddressPool_retrieveAddrPools", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveAddrPools" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveAddrPoolsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/SubSlaacHostRadiusClassAttribute/retrieveSubSlaacHostRadiusClasses": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_SubSlaacHostRadiusClassAttribute_retrieveSubSlaacHostRadiusClasses", "description": "Method used to query the NE for the Residential Subscriber SLAAC Host RADIUS Class Attributes
related to the specified Residential Subscriber SLAAC Host.

Intention : RETRIEVER
retrieveSubSlaacHostRadiusClasses:
class-level retriever API retrieveSubSlaacHostRadiusClasses
of class ressubscr.SubSlaacHostRadiusClassAttribute


", "operationId": "rest_ressubscr_SubSlaacHostRadiusClassAttribute_retrieveSubSlaacHostRadiusClasses", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveSubSlaacHostRadiusClasses" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveSubSlaacHostRadiusClassesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/SubscrMacError/retrieveSubMacError": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_SubscrMacError_retrieveSubMacError", "description": "Method used to retrieve information about the error associated with the MAC detected by the subscriber from NE.

Intention : RETRIEVER
retrieveSubMacError:
class-level retriever API retrieveSubMacError
of class ressubscr.SubscrMacError


", "operationId": "rest_ressubscr_SubscrMacError_retrieveSubMacError", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveSubMacError" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveSubMacErrorResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/SubscrSapError/retrieveSubSapError": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_SubscrSapError_retrieveSubSapError", "description": "Method used to retrieve information about the error associated with the SAP detected by the subscriber from NE.

Intention : RETRIEVER
retrieveSubSapError:
class-level retriever API retrieveSubSapError
of class ressubscr.SubscrSapError


", "operationId": "rest_ressubscr_SubscrSapError_retrieveSubSapError", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveSubSapError" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveSubSapErrorResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/SubscrSdpError/retrieveSubSdpError": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_SubscrSdpError_retrieveSubSdpError", "description": "Method used to retrieve information about the errors associated with the SDP Bind detected by the subscriber from NE.

Intention : RETRIEVER
retrieveSubSdpError:
class-level retriever API retrieveSubSdpError
of class ressubscr.SubscrSdpError


", "operationId": "rest_ressubscr_SubscrSdpError_retrieveSubSdpError", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveSubSdpError" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveSubSdpErrorResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/SubscrUnknownError/retrieveSubUnknownError": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_SubscrUnknownError_retrieveSubUnknownError", "description": "Method used to retrieve information about the error for which system could not determine the originating SAP or SDP binding from NE.

Intention : RETRIEVER
retrieveSubUnknownError:
class-level retriever API retrieveSubUnknownError
of class ressubscr.SubscrUnknownError


", "operationId": "rest_ressubscr_SubscrUnknownError_retrieveSubUnknownError", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveSubUnknownError" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveSubUnknownErrorResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/SubscriberHost/findSlaProfileStringSuggestions": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_SubscriberHost_findSlaProfileStringSuggestions", "description": "Method used to retrieve a L2TP session from NE.

Intention : RETRIEVER
findSlaProfileStringSuggestions:
class-level [object finder] (retriever) API findSlaProfileStringSuggestions
of class ressubscr.SubscriberHost


", "operationId": "rest_ressubscr_SubscriberHost_findSlaProfileStringSuggestions", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findSlaProfileStringSuggestionsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/SubscriberHost/retrieveL2TPSession": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_SubscriberHost_retrieveL2TPSession", "description": "Method used to retrieve a L2TP session from NE.

Intention : RETRIEVER
retrieveL2TPSession:
class-level retriever API retrieveL2TPSession
of class ressubscr.SubscriberHost


", "operationId": "rest_ressubscr_SubscriberHost_retrieveL2TPSession", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/L2TPSessionRetrievalStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveL2TPSessionResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/SubscriberHost/retrieveSAPHosts": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_SubscriberHost_retrieveSAPHosts", "description": "Method used to query the NE for the currently active subscriber hosts for
a specified SAP. Additionally, the L2 Aware Host information will
be returned in the output when GTP Local Breakout is \"true\" for the host
and when the MAC Address and IP Address are specified in the request.

Intention : RETRIEVER
retrieveSAPHosts:
class-level retriever API retrieveSAPHosts
of class ressubscr.SubscriberHost

List of the subscriber hosts retrieved from the node(CommonManagedEntityInformation).

", "operationId": "rest_ressubscr_SubscriberHost_retrieveSAPHosts", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveSAPHosts" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveSAPHostsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/SubscriberHost/retrieveSubscriberHosts": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_SubscriberHost_retrieveSubscriberHosts", "description": "Method used to query the NE for the currently active subscriber hosts for
a specified subscriber.

Intention : RETRIEVER
retrieveSubscriberHosts:
class-level retriever API retrieveSubscriberHosts
of class ressubscr.SubscriberHost

List of Subscriber Hosts (CommonManagedEntityInformation) that were retrieved from the node.

", "operationId": "rest_ressubscr_SubscriberHost_retrieveSubscriberHosts", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveSubscriberHosts" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveSubscriberHostsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/SubscriberHostConfiguration/evalLeaseStatePerSap": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_SubscriberHostConfiguration_evalLeaseStatePerSap", "description": "
Intention : MODIFIER
evalLeaseStatePerSap:
class-level modifier API evalLeaseStatePerSap
of class ressubscr.SubscriberHostConfiguration
DescendantInfo:
arp.ArpHost
DescendantInfo:
ressubscr.SubscriberHost

Resulting objects list.

", "operationId": "rest_ressubscr_SubscriberHostConfiguration_evalLeaseStatePerSap", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvalLeaseStatePerSapStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/evalLeaseStatePerSapResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/SubscriberHostConfiguration/evalLeaseStatePerSapId": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_SubscriberHostConfiguration_evalLeaseStatePerSapId", "description": "
Intention : MODIFIER
evalLeaseStatePerSapId:
class-level modifier API evalLeaseStatePerSapId
of class ressubscr.SubscriberHostConfiguration
DescendantInfo:
arp.ArpHost
DescendantInfo:
ressubscr.SubscriberHost

Resulting objects list.

", "operationId": "rest_ressubscr_SubscriberHostConfiguration_evalLeaseStatePerSapId", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/evalLeaseStatePerSapIdResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/SubscriberHostConfiguration/updateMultipleSubscrHosts": { "put": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_SubscriberHostConfiguration_updateMultipleSubscrHosts", "description": "Method used to force to change properties of the SubscriberHost.
These properties are: subscriber profile, sla profile and application profile.
Method is also used to force re-evaluation of lease state.
Either change of subscriber profile, sla profile, application profile or
re-evaluation of lease state can be requested at one time.
This method can be used when serviceId is not known for a SubscriberHost, but subscrIdent,
siteId and ipAddress must be known.

Intention : RETRIEVER
updateMultipleSubscrHosts:
class-level retriever API updateMultipleSubscrHosts
of class ressubscr.SubscriberHostConfiguration
DescendantInfo:
arp.ArpHost
DescendantInfo:
ressubscr.SubscriberHost

Resulting objects list.

", "operationId": "rest_ressubscr_SubscriberHostConfiguration_updateMultipleSubscrHosts", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateMultipleSubscrHosts" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateMultipleSubscrHostsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/SubscriberHostCreditReset/resetCredit": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_SubscriberHostCreditReset_resetCredit", "operationId": "rest_ressubscr_SubscriberHostCreditReset_resetCredit", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ressubscr/SubscriberHostForceRenew/forceRenewSubscriberHost": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_SubscriberHostForceRenew_forceRenewSubscriberHost", "operationId": "rest_ressubscr_SubscriberHostForceRenew_forceRenewSubscriberHost", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ressubscr/SubscriberPccRuleEntry/retrievePccRule": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_SubscriberPccRuleEntry_retrievePccRule", "description": "Method used to query the NE for the PCC Rules

Intention : RETRIEVER
retrievePccRule:
class-level retriever API retrievePccRule
of class ressubscr.SubscriberPccRuleEntry


", "operationId": "rest_ressubscr_SubscriberPccRuleEntry_retrievePccRule", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrievePccRule" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrievePccRuleResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/SubscriberPccRuleEntry/retrievePccRulesPerSubscrHost": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_SubscriberPccRuleEntry_retrievePccRulesPerSubscrHost", "description": "Method used to query all PCC Rules used by a particular subscriber host present in the given NE.

Intention : RETRIEVER
retrievePccRulesPerSubscrHost:
class-level retriever API retrievePccRulesPerSubscrHost
of class ressubscr.SubscriberPccRuleEntry


", "operationId": "rest_ressubscr_SubscriberPccRuleEntry_retrievePccRulesPerSubscrHost", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrievePccRulesPerSubscrHost" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrievePccRulesPerSubscrHostResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/SubscriberQosOverride/retrieveSubscriberQosOverrides": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_SubscriberQosOverride_retrieveSubscriberQosOverrides", "description": "Method to retrieve Subscriber QoS Overrides.

Intention : RETRIEVER
retrieveSubscriberQosOverrides:
class-level retriever API retrieveSubscriberQosOverrides
of class ressubscr.SubscriberQosOverride


", "operationId": "rest_ressubscr_SubscriberQosOverride_retrieveSubscriberQosOverrides", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriberQosOverrideRtrvStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveSubscriberQosOverridesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ressubscr/SubscriberService/retrieveSubSvc": { "post": { "tags": [ "samo_ressubscr" ], "summary": "rest_ressubscr_SubscriberService_retrieveSubSvc", "description": "Method used to Subscriber Services from NE.

Intention : RETRIEVER
retrieveSubSvc:
class-level retriever API retrieveSubSvc
of class ressubscr.SubscriberService

List of Subsciber Services (CommonManagedEntityInformation)that were retrieved from the node.

", "operationId": "rest_ressubscr_SubscriberService_retrieveSubSvc", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveSubSvc" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveSubSvcResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/tdmequipment/AdaptiveClockHistory/retrieveAdaptiveClockHistory": { "post": { "tags": [ "samo_tdmequipment" ], "summary": "rest_tdmequipment_AdaptiveClockHistory_retrieveAdaptiveClockHistory", "description": "Method used to query the NE for the ACR history of a particular DS1E1Channel.

Intention : RETRIEVER
retrieveAdaptiveClockHistory:
class-level retriever API retrieveAdaptiveClockHistory
of class tdmequipment.AdaptiveClockHistory


", "operationId": "rest_tdmequipment_AdaptiveClockHistory_retrieveAdaptiveClockHistory", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveAdaptiveClockHistory" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveAdaptiveClockHistoryResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mplstp/BFDTemplate/findP2PLsp/{instanceFullName}": { "post": { "tags": [ "samo_mplstp" ], "summary": "rest_mplstp_BFDTemplate_findP2PLsp", "description": "
Intention : RETRIEVER
findP2PLsp:
instance-level [object finder] (retriever) API findP2PLsp
of class mplstp.BFDTemplate
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_mplstp_BFDTemplate_findP2PLsp", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findP2PLspResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/mplstp/GlobalTPLsp/createWithAutoFillForCompleteConnections": { "post": { "tags": [ "samo_mplstp" ], "summary": "rest_mplstp_GlobalTPLsp_createWithAutoFillForCompleteConnections", "operationId": "rest_mplstp_GlobalTPLsp_createWithAutoFillForCompleteConnections", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createWithAutoFillForCompleteConnections" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mplstp/GlobalTPLsp/createWithAutoFillForIncompleteConnections": { "post": { "tags": [ "samo_mplstp" ], "summary": "rest_mplstp_GlobalTPLsp_createWithAutoFillForIncompleteConnections", "operationId": "rest_mplstp_GlobalTPLsp_createWithAutoFillForIncompleteConnections", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createWithAutoFillForIncompleteConnections" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/multicastmgr/Domain/findGroupDomainBinding/{instanceFullName}": { "post": { "tags": [ "samo_multicastmgr" ], "summary": "rest_multicastmgr_Domain_findGroupDomainBinding", "description": "
Intention : RETRIEVER
findGroupDomainBinding:
instance-level [object finder] (retriever) API findGroupDomainBinding
of class multicastmgr.Domain
DescendantInfo:
multicastmgr.PimDomain
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_multicastmgr_Domain_findGroupDomainBinding", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findGroupDomainBindingResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/multicastmgr/Group/syncGroups": { "post": { "tags": [ "samo_multicastmgr" ], "summary": "rest_multicastmgr_Group_syncGroups", "operationId": "rest_multicastmgr_Group_syncGroups", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/syncGroups" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/multicastmgr/MulticastNetwork/createMulticastNetwork": { "post": { "tags": [ "samo_multicastmgr" ], "summary": "rest_multicastmgr_MulticastNetwork_createMulticastNetwork", "operationId": "rest_multicastmgr_MulticastNetwork_createMulticastNetwork", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createMulticastNetwork" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/multicastmgr/PimDomain/addRoutersToDomain/{instanceFullName}": { "post": { "tags": [ "samo_multicastmgr" ], "summary": "rest_multicastmgr_PimDomain_addRoutersToDomain", "operationId": "rest_multicastmgr_PimDomain_addRoutersToDomain", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/multicastmgr/PimDomain/deleteSGFromDomain/{instanceFullName}": { "delete": { "tags": [ "samo_multicastmgr" ], "summary": "rest_multicastmgr_PimDomain_deleteSGFromDomain", "operationId": "rest_multicastmgr_PimDomain_deleteSGFromDomain", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/multicastmgr/PimDomain/removeRoutersFromDomain/{instanceFullName}": { "post": { "tags": [ "samo_multicastmgr" ], "summary": "rest_multicastmgr_PimDomain_removeRoutersFromDomain", "operationId": "rest_multicastmgr_PimDomain_removeRoutersFromDomain", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/multicastmgr/PimDomain/resyncAnycastRPTable/{instanceFullName}": { "post": { "tags": [ "samo_multicastmgr" ], "summary": "rest_multicastmgr_PimDomain_resyncAnycastRPTable", "operationId": "rest_multicastmgr_PimDomain_resyncAnycastRPTable", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/multicastmgr/PimDomain/resyncRPTable/{instanceFullName}": { "post": { "tags": [ "samo_multicastmgr" ], "summary": "rest_multicastmgr_PimDomain_resyncRPTable", "operationId": "rest_multicastmgr_PimDomain_resyncRPTable", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/srpythonmgmt/PythonScript/reloadUrl": { "post": { "tags": [ "samo_srpythonmgmt" ], "summary": "rest_srpythonmgmt_PythonScript_reloadUrl", "operationId": "rest_srpythonmgmt_PythonScript_reloadUrl", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/activation/AbstractWorkOrder/retrieveWorkOrderXML/{instanceFullName}": { "post": { "tags": [ "samo_activation" ], "summary": "rest_activation_AbstractWorkOrder_retrieveWorkOrderXML", "description": "Get the work order as XML.

Intention : RETRIEVER
retrieveWorkOrderXML:
instance-level retriever API retrieveWorkOrderXML
of class activation.AbstractWorkOrder
DescendantInfo:
activation.WorkOrder
DescendantInfo:
activation.NeWorkOrder
instanceFullName : distinguished/instance name of called object
The work order.

", "operationId": "rest_activation_AbstractWorkOrder_retrieveWorkOrderXML", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveWorkOrderXMLResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/activation/ActivationManager/findWithWorkOrderScan": { "post": { "tags": [ "samo_activation" ], "summary": "rest_activation_ActivationManager_findWithWorkOrderScan", "description": "
Intention : RETRIEVER
findWithWorkOrderScan:
class-level [object finder] (retriever) API findWithWorkOrderScan on default instance actv-mgr of class activation.ActivationManager

Result object of shallow map of distinguished name into object summary structure and
paging information

", "operationId": "rest_activation_ActivationManager_findWithWorkOrderScan", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findWithWorkOrderScan" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findWithWorkOrderScanResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/activation/ActivationManager/scanWorkOrderRepository": { "post": { "tags": [ "samo_activation" ], "summary": "rest_activation_ActivationManager_scanWorkOrderRepository", "operationId": "rest_activation_ActivationManager_scanWorkOrderRepository", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/activation/Session/activate": { "post": { "tags": [ "samo_activation" ], "summary": "rest_activation_Session_activate", "operationId": "rest_activation_Session_activate", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/activate" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/activation/Session/activateAll": { "post": { "tags": [ "samo_activation" ], "summary": "rest_activation_Session_activateAll", "operationId": "rest_activation_Session_activateAll", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/activation/Session/addNeWorkOrders": { "post": { "tags": [ "samo_activation" ], "summary": "rest_activation_Session_addNeWorkOrders", "description": "Adds the NE work orders to the session.

Intention : MODIFIER
addNeWorkOrders:
class-level modifier API addNeWorkOrders
of class activation.Session

The set of NE work orders that failed to be added to session.

", "operationId": "rest_activation_Session_addNeWorkOrders", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/addNeWorkOrders" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/addNeWorkOrdersResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/activation/Session/addWorkOrder": { "post": { "tags": [ "samo_activation" ], "summary": "rest_activation_Session_addWorkOrder", "description": "Adds all NE work orders contained in the work order to the session.

Intention : MODIFIER
addWorkOrder:
class-level modifier API addWorkOrder
of class activation.Session

The set of NE work orders that failed to be added to session.

", "operationId": "rest_activation_Session_addWorkOrder", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/addWorkOrder" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/addWorkOrderResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/activation/Session/closeSession": { "post": { "tags": [ "samo_activation" ], "summary": "rest_activation_Session_closeSession", "operationId": "rest_activation_Session_closeSession", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/closeSession" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/activation/Session/fallback": { "post": { "tags": [ "samo_activation" ], "summary": "rest_activation_Session_fallback", "operationId": "rest_activation_Session_fallback", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fallback" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/activation/Session/load": { "post": { "tags": [ "samo_activation" ], "summary": "rest_activation_Session_load", "operationId": "rest_activation_Session_load", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/load" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/activation/Session/loadAll": { "post": { "tags": [ "samo_activation" ], "summary": "rest_activation_Session_loadAll", "operationId": "rest_activation_Session_loadAll", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/activation/Session/preactivate": { "post": { "tags": [ "samo_activation" ], "summary": "rest_activation_Session_preactivate", "operationId": "rest_activation_Session_preactivate", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preactivate" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/activation/Session/preactivateAll": { "post": { "tags": [ "samo_activation" ], "summary": "rest_activation_Session_preactivateAll", "operationId": "rest_activation_Session_preactivateAll", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/activation/Session/release": { "post": { "tags": [ "samo_activation" ], "summary": "rest_activation_Session_release", "operationId": "rest_activation_Session_release", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/release" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/activation/Session/removeNeWorkOrders": { "post": { "tags": [ "samo_activation" ], "summary": "rest_activation_Session_removeNeWorkOrders", "operationId": "rest_activation_Session_removeNeWorkOrders", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/removeNeWorkOrders" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/activation/Session/startSession": { "post": { "tags": [ "samo_activation" ], "summary": "rest_activation_Session_startSession", "operationId": "rest_activation_Session_startSession", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/activation/Session/updateAutoRelease": { "put": { "tags": [ "samo_activation" ], "summary": "rest_activation_Session_updateAutoRelease", "operationId": "rest_activation_Session_updateAutoRelease", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateAutoRelease" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/activation/Session/updateExclude": { "put": { "tags": [ "samo_activation" ], "summary": "rest_activation_Session_updateExclude", "operationId": "rest_activation_Session_updateExclude", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateExclude" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/activation/Session/updateSchedule": { "put": { "tags": [ "samo_activation" ], "summary": "rest_activation_Session_updateSchedule", "operationId": "rest_activation_Session_updateSchedule", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateSchedule" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/activation/Session/validateNeWorkOrders": { "post": { "tags": [ "samo_activation" ], "summary": "rest_activation_Session_validateNeWorkOrders", "operationId": "rest_activation_Session_validateNeWorkOrders", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validateNeWorkOrders" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/activation/Session/validateSession": { "post": { "tags": [ "samo_activation" ], "summary": "rest_activation_Session_validateSession", "operationId": "rest_activation_Session_validateSession", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validateSession" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/activation/Snapshot/abort/{instanceFullName}": { "post": { "tags": [ "samo_activation" ], "summary": "rest_activation_Snapshot_abort", "operationId": "rest_activation_Snapshot_abort", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/activation/Snapshot/addInclusionFilter/{instanceFullName}": { "post": { "tags": [ "samo_activation" ], "summary": "rest_activation_Snapshot_addInclusionFilter", "description": "This method adds a filter for monitored objects to
this supervision group. Filtered objects' class can't be
the class of subclass used by any other inclusion
filter in this group.

Intention : MODIFIER
addInclusionFilter:
instance-level modifier API addInclusionFilter
of class activation.Snapshot
instanceFullName : distinguished/instance name of called object
New value of the \"inclusionFilters\" property -
FDNs of all inclusion filters in this group.

", "operationId": "rest_activation_Snapshot_addInclusionFilter", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/addInclusionFilterResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/activation/Snapshot/extract/{instanceFullName}": { "post": { "tags": [ "samo_activation" ], "summary": "rest_activation_Snapshot_extract", "operationId": "rest_activation_Snapshot_extract", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/activation/Snapshot/removeInclusionFilter/{instanceFullName}": { "post": { "tags": [ "samo_activation" ], "summary": "rest_activation_Snapshot_removeInclusionFilter", "description": "This method removes a filter for monitored objects
from this supervision group.

Intention : MODIFIER
removeInclusionFilter:
instance-level [administrative deletion] (modifier) API removeInclusionFilter
of class activation.Snapshot
instanceFullName : distinguished/instance name of called object
New value of the \"inclusionFilters\" property -
FDNs of all inclusion filters in this group.

", "operationId": "rest_activation_Snapshot_removeInclusionFilter", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/removeInclusionFilterResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/activation/WorkOrder/createSession": { "post": { "tags": [ "samo_activation" ], "summary": "rest_activation_WorkOrder_createSession", "description": "Will Create a new Session based on the WorkOrder object we have access to.

Intention : MODIFIER
createSession:
class-level [administrative creation] (modifier) API createSession
of class activation.WorkOrder

The created Session object.

", "operationId": "rest_activation_WorkOrder_createSession", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createSessionResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/cac/CacManager/bookBwForReservedTunnel": { "post": { "tags": [ "samo_cac" ], "summary": "rest_cac_CacManager_bookBwForReservedTunnel", "operationId": "rest_cac_CacManager_bookBwForReservedTunnel", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/cac/CacManager/findServicesUsingTunnel": { "get": { "tags": [ "samo_cac" ], "summary": "rest_cac_CacManager_findServicesUsingTunnel", "description": "Retrieve Services that are currently using this Tunnel

Intention : RETRIEVER
findServicesUsingTunnel:
class-level [object finder] (retriever) API findServicesUsingTunnel on default instance cac-mgr of class cac.CacManager

The list of instances

", "operationId": "rest_cac_CacManager_findServicesUsingTunnel", "parameters": [ { "name": "aInTunnelFdn", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findServicesUsingTunnelResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/cac/CacManager/isCacEnabled": { "post": { "tags": [ "samo_cac" ], "summary": "rest_cac_CacManager_isCacEnabled", "description": "To check if CAC Bandwidth configuration is enabled on the services.

Intention : RETRIEVER
isCacEnabled:
class-level retriever API isCacEnabled on default instance cac-mgr of class cac.CacManager


", "operationId": "rest_cac_CacManager_isCacEnabled", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/isCacEnabledResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/cac/CacManager/verifyCac": { "post": { "tags": [ "samo_cac" ], "summary": "rest_cac_CacManager_verifyCac", "operationId": "rest_cac_CacManager_verifyCac", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/dhcp/AbstractAddressPool/dhcpStickyLeaseAction": { "post": { "tags": [ "samo_dhcp" ], "summary": "rest_dhcp_AbstractAddressPool_dhcpStickyLeaseAction", "description": "dhcpStickyLeaseAction allows to request an action to be performed upon a Sticky Lease instance.
To create a Sticky Lease instance, write the name of the entry to be created in aInHostName,
and set the required action in the object aInStickyLseActActionType.
NOTE: This method is only supported on Local DHCP v4 Server and Address Pool.

Intention : MODIFIER
dhcpStickyLeaseAction:
class-level modifier API dhcpStickyLeaseAction
of class dhcp.AbstractAddressPool
DescendantInfo:
dhcp.AddressPool
DescendantInfo:
dhcp.Address6Pool


", "operationId": "rest_dhcp_AbstractAddressPool_dhcpStickyLeaseAction", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dhcpStickyLeaseAction" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dhcpStickyLeaseActionResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/dhcp/AbstractDhcpServerFailover/forcePartnerDown": { "post": { "tags": [ "samo_dhcp" ], "summary": "rest_dhcp_AbstractDhcpServerFailover_forcePartnerDown", "description": "This method forces the failover partner-down only if failover operational state is
'No Communication'.

Intention : MODIFIER
forcePartnerDown:
class-level modifier API forcePartnerDown
of class dhcp.AbstractDhcpServerFailover
DescendantInfo:
dhcp.LocalDhcpPoolFailover
DescendantInfo:
dhcp.LocalDhcpServerFailover


", "operationId": "rest_dhcp_AbstractDhcpServerFailover_forcePartnerDown", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forcePartnerDown" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forcePartnerDownResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/dhcp/AddressPool/resyncDeclinedAddresses": { "post": { "tags": [ "samo_dhcp" ], "summary": "rest_dhcp_AddressPool_resyncDeclinedAddresses", "description": "This method gets the declined address entries from the network.

Intention : RETRIEVER
resyncDeclinedAddresses:
class-level retriever API resyncDeclinedAddresses
of class dhcp.AddressPool

The number of declined addresses.

", "operationId": "rest_dhcp_AddressPool_resyncDeclinedAddresses", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resyncDeclinedAddresses" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resyncDeclinedAddressesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/dhcp/AddressPool/resyncFreeAddresses": { "post": { "tags": [ "samo_dhcp" ], "summary": "rest_dhcp_AddressPool_resyncFreeAddresses", "description": "This method gets the free address entries from the network.

Intention : RETRIEVER
resyncFreeAddresses:
class-level retriever API resyncFreeAddresses
of class dhcp.AddressPool

The number of free addresses.

", "operationId": "rest_dhcp_AddressPool_resyncFreeAddresses", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resyncFreeAddresses" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resyncFreeAddressesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/dhcp/LocalDhcp6Server/showDhcp6Leases": { "post": { "tags": [ "samo_dhcp" ], "summary": "rest_dhcp_LocalDhcp6Server_showDhcp6Leases", "description": "This method retrieves from the network the leases for a local DHCPv6 server, by sending the CLI
command
show router [routerId] dhcp6 local-dhcp-server [serverName] leases [ip-address prefix] detail.
Method call example:


<dhcp.LocalDhcp6Server.showDhcp6Leases xmlns=\"xmlapi_1.0\">
<isSynchronized>true<<isSynchronized>
<clientId>user@1< clientId>
<systemScriptTargetConfigInfo>
<script.TargetScript>
<actionMask>
<bit>create< bit>
< actionMask>
<targetObjectFullName>network:38.120.169.240> targetObjectFullName>
<script.TargetParameter-Set>
<script.TargetParameter>
<actionMask>
<bit>create< bit>
< actionMask>
<value>Base> value>
<parameterName>>routerId< parameterName>
< script.TargetParameter>
<script.TargetParameter>
<actionMask>
<bit>create< bit>
< actionMask>
<value>server6> value>
<parameterName>>serverName< parameterName>
< script.TargetParameter>
<script.TargetParameter>
<actionMask>
<bit>create< bit>
< actionMask>
<value>2011:1:31:10:: 60< value>
<parameterName>ipAddress< parameterName>
< script.TargetParameter>
<script.TargetParameter>
<actionMask>
<bit>create< bit>
< actionMask>
<value>true< value>
<parameterName>detail< parameterName>
< script.TargetParameter>
< script.TargetParameter-Set>
< script.TargetScript>
< systemScriptTargetConfigInfo>
< script.ScriptManager.executeCLITargetScripts>

RouterId and serverName are required to be specified in the Target Parameter list.

Intention : RETRIEVER
showDhcp6Leases:
class-level retriever API showDhcp6Leases
of class dhcp.LocalDhcp6Server

The list of TargetScriptResultInfo objects identifying the status of the executed target
scripts.

", "operationId": "rest_dhcp_LocalDhcp6Server_showDhcp6Leases", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/showDhcp6Leases" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/showDhcp6LeasesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/dhcp/LocalDhcpServer/clearDhcpServerLeases": { "post": { "tags": [ "samo_dhcp" ], "summary": "rest_dhcp_LocalDhcpServer_clearDhcpServerLeases", "description": "Request clearing one or all leases of a given Local DHCP Server on Service ID .
The siteId dhcpSvrName is mandatory.
If serviceId is not given, the method will use the base routing instance.
ipAddress and prefix are optional. If not specified, all leases will be cleared, otherwise
lease on given ipAddress and prefix will be cleared.
Clear result will be displayed on Clear Status tab on given Local DHCP Server.

Intention : MODIFIER
clearDhcpServerLeases:
class-level [functionality clearing] (modifier) API clearDhcpServerLeases
of class dhcp.LocalDhcpServer

A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_dhcp_LocalDhcpServer_clearDhcpServerLeases", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClearDhcpLeaseStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clearDhcpServerLeasesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/dhcp/LocalDhcpServer/clearDhcpServerStickyLeases": { "post": { "tags": [ "samo_dhcp" ], "summary": "rest_dhcp_LocalDhcpServer_clearDhcpServerStickyLeases", "description": "Request clearing sticky leases of a given Local DHCP Server on Service ID.
The siteId dhcpSvrName is mandatory.
If serviceId is not specified, it will be Base routing instance as default.
If hostName is specified, lease for the given hostName will be cleared.
If hostName-Prefix is specified, leases for the given hosts starting with the specified prefix will be cleared.
hostName and hostName-Prefix are mutually exclusive. If both parameters are specified only hostName will be used
to clear the sticky lease.

Intention : MODIFIER
clearDhcpServerStickyLeases:
class-level [functionality clearing] (modifier) API clearDhcpServerStickyLeases
of class dhcp.LocalDhcpServer

A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_dhcp_LocalDhcpServer_clearDhcpServerStickyLeases", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClearDhcpStickyLeasesStruct" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clearDhcpServerStickyLeasesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/dhcp/LocalDhcpServer/resyncLeases": { "post": { "tags": [ "samo_dhcp" ], "summary": "rest_dhcp_LocalDhcpServer_resyncLeases", "description": "This method gets the free address entries from the network.

Intention : RETRIEVER
resyncLeases:
class-level retriever API resyncLeases
of class dhcp.LocalDhcpServer

The number of leases.

", "operationId": "rest_dhcp_LocalDhcpServer_resyncLeases", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resyncLeases" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/resyncLeasesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/dhcp/StickyLeaseData/retrieveStickyLeases": { "post": { "tags": [ "samo_dhcp" ], "summary": "rest_dhcp_StickyLeaseData_retrieveStickyLeases", "description": "Method used to retrieve Dhcp Server Sticky Leases.

Intention : RETRIEVER
retrieveStickyLeases:
class-level retriever API retrieveStickyLeases
of class dhcp.StickyLeaseData

List of Dhcp Server Sticky Leases.

", "operationId": "rest_dhcp_StickyLeaseData_retrieveStickyLeases", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveStickyLeases" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveStickyLeasesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/igmp/GroupInterfaceSapGroup/retrieveIgmpGroupIfSapGrp": { "post": { "tags": [ "samo_igmp" ], "summary": "rest_igmp_GroupInterfaceSapGroup_retrieveIgmpGroupIfSapGrp", "description": "Method used to query the NE for group address entries under a GroupInterfaceSap.

Intention : RETRIEVER
retrieveIgmpGroupIfSapGrp:
class-level retriever API retrieveIgmpGroupIfSapGrp
of class igmp.GroupInterfaceSapGroup


", "operationId": "rest_igmp_GroupInterfaceSapGroup_retrieveIgmpGroupIfSapGrp", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveIgmpGroupIfSapGrp" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveIgmpGroupIfSapGrpResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/igmp/GroupInterfaceSapGroupSource/retrieveIgmpGroupIfSapGrpSrc": { "post": { "tags": [ "samo_igmp" ], "summary": "rest_igmp_GroupInterfaceSapGroupSource_retrieveIgmpGroupIfSapGrpSrc", "description": "Method used to query the NE for source address entries under a GroupInterfaceSapGroup.

Intention : RETRIEVER
retrieveIgmpGroupIfSapGrpSrc:
class-level retriever API retrieveIgmpGroupIfSapGrpSrc
of class igmp.GroupInterfaceSapGroupSource


", "operationId": "rest_igmp_GroupInterfaceSapGroupSource_retrieveIgmpGroupIfSapGrpSrc", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveIgmpGroupIfSapGrpSrc" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveIgmpGroupIfSapGrpSrcResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/igmp/IgmpHost/retrieveIgmpHosts": { "post": { "tags": [ "samo_igmp" ], "summary": "rest_igmp_IgmpHost_retrieveIgmpHosts", "description": "Method used to query the network element for IGMP hosts and their IGMP Groups-Sources
associated with a specified subscriber; Bandwidth will be calculated if MCAC Policy is specified.

Intention : RETRIEVER
retrieveIgmpHosts:
class-level retriever API retrieveIgmpHosts
of class igmp.IgmpHost


", "operationId": "rest_igmp_IgmpHost_retrieveIgmpHosts", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveIgmpHosts" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveIgmpHostsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/igmp/Site/configure/{instanceFullName}": { "post": { "tags": [ "samo_igmp" ], "summary": "rest_igmp_Site_configure", "description": "
Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure
of class igmp.Site
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_igmp_Site_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/arp/ArpHostRadiusClassAttribute/retrieveArpHostRadiusClasses": { "post": { "tags": [ "samo_arp" ], "summary": "rest_arp_ArpHostRadiusClassAttribute_retrieveArpHostRadiusClasses", "description": "Method used to query the NE for the ARP Host RADIUS Class Attributes
related to the specified ARP Host.

Intention : RETRIEVER
retrieveArpHostRadiusClasses:
class-level retriever API retrieveArpHostRadiusClasses
of class arp.ArpHostRadiusClassAttribute


", "operationId": "rest_arp_ArpHostRadiusClassAttribute_retrieveArpHostRadiusClasses", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveArpHostRadiusClasses" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveArpHostRadiusClassesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v1/revoke": { "post": { "tags": [ "samo_revoke" ], "summary": "revokeToken", "description": "This endpoint is deprecated. Please use NSP gateway to revoke a token.\n \nTo revoke your token, make the following HTTP request:\n\n POST /v1/revoke HTTP/1.1\n Host: server.example.com\n Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA\n Content-Type: application/json\n\n {\"revoke_type\":\"token\", \"username\":\"my_username\"}\n\n An example of a successful response:\n\n HTTP/1.1 200 OK\n Content-Type: application/json;charset=UTF-8\n Cache-Control: no-cache\n\n {\n }\n The authorization server responds with HTTP status code 200 if the token has been revoked successfully, or if the client submitted a user name has no valid/active Bearer Token. Note: invalid username will not cause an error response since the client cannot handle such an error in a reasonable way. Moreover, the purpose of the revocation request (invalidation of the particular token) is already achieved.\nNote: Support for the ‘/nfm-p/rest/api/v1’ API will be available up to NSP 22.11 and removed in NSP 23.03.", "operationId": "revokeToken", "parameters": [], "requestBody": { "description": "The revoke parameters", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object" }, "description": "The revoke parameters" } } }, "required": false }, "responses": { "200": { "description": "successful revocation request", "headers": {}, "content": {} }, "400": { "description": "The specified revoke_type value is not supported", "headers": {}, "content": {} }, "500": { "description": "Internal server error", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/aps/ApsChannel/getDependencyCount/{instanceFullName}": { "get": { "tags": [ "samo_aps" ], "summary": "rest_aps_ApsChannel_getDependencyCount", "description": "
Intention : RETRIEVER
getDependencyCount:
instance-level retriever API getDependencyCount
of class aps.ApsChannel
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_aps_ApsChannel_getDependencyCount", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getDependencyCountResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/aps/ApsGroup/findInstanceChannelPorts/{instanceFullName}": { "post": { "tags": [ "samo_aps" ], "summary": "rest_aps_ApsGroup_findInstanceChannelPorts", "description": "
Intention : RETRIEVER
findInstanceChannelPorts:
instance-level [object finder] (retriever) API findInstanceChannelPorts
of class aps.ApsGroup
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_aps_ApsGroup_findInstanceChannelPorts", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findInstanceChannelPortsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/aps/MultiChassisApsGroupContainer/findInstanceApsGroups/{instanceFullName}": { "post": { "tags": [ "samo_aps" ], "summary": "rest_aps_MultiChassisApsGroupContainer_findInstanceApsGroups", "description": "
Intention : RETRIEVER
findInstanceApsGroups:
instance-level [object finder] (retriever) API findInstanceApsGroups
of class aps.MultiChassisApsGroupContainer
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_aps_MultiChassisApsGroupContainer_findInstanceApsGroups", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findInstanceApsGroupsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/aps/MultiChassisApsGroupContainer/getDependencyCount/{instanceFullName}": { "get": { "tags": [ "samo_aps" ], "summary": "rest_aps_MultiChassisApsGroupContainer_getDependencyCount", "description": "
Intention : RETRIEVER
getDependencyCount:
instance-level retriever API getDependencyCount
of class aps.MultiChassisApsGroupContainer
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_aps_MultiChassisApsGroupContainer_getDependencyCount", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getDependencyCountResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/lteuserstats/UserStatsManager/cancelAllQueries": { "delete": { "tags": [ "samo_lteuserstats" ], "summary": "rest_lteuserstats_UserStatsManager_cancelAllQueries", "operationId": "rest_lteuserstats_UserStatsManager_cancelAllQueries", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/lteuserstats/UserStatsManager/removeAllQueries": { "post": { "tags": [ "samo_lteuserstats" ], "summary": "rest_lteuserstats_UserStatsManager_removeAllQueries", "operationId": "rest_lteuserstats_UserStatsManager_removeAllQueries", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/lteuserstats/UserStatsQuery/executeQueryOnList": { "put": { "tags": [ "samo_lteuserstats" ], "summary": "rest_lteuserstats_UserStatsQuery_executeQueryOnList", "operationId": "rest_lteuserstats_UserStatsQuery_executeQueryOnList", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/lteuserstats/UserStatsQuery/shouldWarnUser": { "post": { "tags": [ "samo_lteuserstats" ], "summary": "rest_lteuserstats_UserStatsQuery_shouldWarnUser", "description": "
Intention : RETRIEVER
shouldWarnUser:
class-level retriever API shouldWarnUser
of class lteuserstats.UserStatsQuery


", "operationId": "rest_lteuserstats_UserStatsQuery_shouldWarnUser", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shouldWarnUserResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/antispoof/AntiSpoofingFilter/retrieveAntiSpoofingFilters": { "post": { "tags": [ "samo_antispoof" ], "summary": "rest_antispoof_AntiSpoofingFilter_retrieveAntiSpoofingFilters", "description": "
Intention : RETRIEVER
retrieveAntiSpoofingFilters:
class-level retriever API retrieveAntiSpoofingFilters
of class antispoof.AntiSpoofingFilter


", "operationId": "rest_antispoof_AntiSpoofingFilter_retrieveAntiSpoofingFilters", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveAntiSpoofingFilters" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retrieveAntiSpoofingFiltersResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sup/SummaryView/addGroups/{instanceFullName}": { "post": { "tags": [ "samo_sup" ], "summary": "rest_sup_SummaryView_addGroups", "description": "This method adds a set of supervision groups to this
summary view.

Intention : MODIFIER
addGroups:
instance-level modifier API addGroups
of class sup.SummaryView
instanceFullName : distinguished/instance name of called object
Set of all supervision group FDNs in this
summary view.

", "operationId": "rest_sup_SummaryView_addGroups", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/addGroupsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sup/SummaryView/getAlarms/{instanceFullName}": { "get": { "tags": [ "samo_sup" ], "summary": "rest_sup_SummaryView_getAlarms", "description": "This method returns alarms on all failed objects in
the supervision group in this summary view.

Intention : RETRIEVER
getAlarms:
instance-level retriever API getAlarms
of class sup.SummaryView
instanceFullName : distinguished/instance name of called object
Map of alarms.
The alarm full name is the map key.

", "operationId": "rest_sup_SummaryView_getAlarms", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "supervisionGroupName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getAlarmsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sup/SummaryView/getAlarmsWithFilter/{instanceFullName}": { "post": { "tags": [ "samo_sup" ], "summary": "rest_sup_SummaryView_getAlarmsWithFilter", "description": "This method returns alarms on all failed objects in
the supervision group in this summary view.

Intention : RETRIEVER
getAlarmsWithFilter:
instance-level retriever API getAlarmsWithFilter
of class sup.SummaryView
instanceFullName : distinguished/instance name of called object
Map of alarms.
The alarm full name is the map key.

", "operationId": "rest_sup_SummaryView_getAlarmsWithFilter", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getAlarmsWithFilter" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getAlarmsWithFilterResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sup/SummaryView/getCachedHistory/{instanceFullName}": { "post": { "tags": [ "samo_sup" ], "summary": "rest_sup_SummaryView_getCachedHistory", "description": "This method returns the accumulated history of one or
all supervision groups for this summary view.

Intention : RETRIEVER
getCachedHistory:
instance-level retriever API getCachedHistory
of class sup.SummaryView
instanceFullName : distinguished/instance name of called object
A map keyed by group name of GroupState
time ordered snapshots of supervision group
state history.

", "operationId": "rest_sup_SummaryView_getCachedHistory", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getCachedHistory" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getCachedHistoryResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sup/SummaryView/getMonitoredObjectsByClasses/{instanceFullName}": { "post": { "tags": [ "samo_sup" ], "summary": "rest_sup_SummaryView_getMonitoredObjectsByClasses", "description": "This method returns all objects of specified classes in
the supervision group in this summary view.

Intention : RETRIEVER
getMonitoredObjectsByClasses:
instance-level retriever API getMonitoredObjectsByClasses
of class sup.SummaryView
instanceFullName : distinguished/instance name of called object
Info info structures of monitored objects in
the group matching 'classes' parameter.
class.

", "operationId": "rest_sup_SummaryView_getMonitoredObjectsByClasses", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getMonitoredObjectsByClasses" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getMonitoredObjectsByClassesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sup/SummaryView/getMonitoredObjectsSummaries/{instanceFullName}": { "post": { "tags": [ "samo_sup" ], "summary": "rest_sup_SummaryView_getMonitoredObjectsSummaries", "description": "This method returns states of all or failed objects in
the supervision group in this summary view.

Intention : RETRIEVER
getMonitoredObjectsSummaries:
instance-level retriever API getMonitoredObjectsSummaries
of class sup.SummaryView
instanceFullName : distinguished/instance name of called object
Set of all monitored object FDNs in this
summary view.

", "operationId": "rest_sup_SummaryView_getMonitoredObjectsSummaries", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getMonitoredObjectsSummaries" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getMonitoredObjectsSummariesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sup/SummaryView/getNeTraceStatusObjectsByGroup/{instanceFullName}": { "get": { "tags": [ "samo_sup" ], "summary": "rest_sup_SummaryView_getNeTraceStatusObjectsByGroup", "description": "This method returns all NeTraceStatus objects in
the supervision group in this summary view.

Intention : RETRIEVER
getNeTraceStatusObjectsByGroup:
instance-level retriever API getNeTraceStatusObjectsByGroup
of class sup.SummaryView
instanceFullName : distinguished/instance name of called object
Info info structures of NeTraceStatus objects in
the group.
class.

", "operationId": "rest_sup_SummaryView_getNeTraceStatusObjectsByGroup", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "supervisionGroupName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getNeTraceStatusObjectsByGroupResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sup/SummaryView/getNumFailedCells/{instanceFullName}": { "get": { "tags": [ "samo_sup" ], "summary": "rest_sup_SummaryView_getNumFailedCells", "description": "This method returns the number of failed cells returns -1 if not enodeB.

Intention : RETRIEVER
getNumFailedCells:
instance-level retriever API getNumFailedCells
of class sup.SummaryView
instanceFullName : distinguished/instance name of called object
Info info structures of monitored objects in
the group matching 'classes' parameter.
class.

", "operationId": "rest_sup_SummaryView_getNumFailedCells", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "supervisionParentFDN", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getNumFailedCellsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sup/SummaryView/listGroups/{instanceFullName}": { "post": { "tags": [ "samo_sup" ], "summary": "rest_sup_SummaryView_listGroups", "description": "This method returns the list of supervision groups
in this summary view.

Intention : RETRIEVER
listGroups:
instance-level retriever API listGroups
of class sup.SummaryView
instanceFullName : distinguished/instance name of called object
Set of all supervision group FDNs in this
summary view.

", "operationId": "rest_sup_SummaryView_listGroups", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listGroupsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sup/SummaryView/removeGroups/{instanceFullName}": { "post": { "tags": [ "samo_sup" ], "summary": "rest_sup_SummaryView_removeGroups", "description": "This method removes a set of supervision groups from
this summary view.

Intention : MODIFIER
removeGroups:
instance-level [administrative deletion] (modifier) API removeGroups
of class sup.SummaryView
instanceFullName : distinguished/instance name of called object
Set of all supervision group FDNs in this
summary view.

", "operationId": "rest_sup_SummaryView_removeGroups", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/removeGroupsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sup/SummaryView/setBaseline/{instanceFullName}": { "post": { "tags": [ "samo_sup" ], "summary": "rest_sup_SummaryView_setBaseline", "description": "This method sets baseline (current moment in time) for
all future monitored \"*New*\" KPI events - e.g. new
alarms raised, new tests failures etc..

Intention : MODIFIER
setBaseline:
instance-level modifier API setBaseline
of class sup.SummaryView
instanceFullName : distinguished/instance name of called object
The time of setting the baseline.

", "operationId": "rest_sup_SummaryView_setBaseline", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setBaselineResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sup/SummaryView/setGroupBaseline/{instanceFullName}": { "post": { "tags": [ "samo_sup" ], "summary": "rest_sup_SummaryView_setGroupBaseline", "description": "This method sets baseline (current moment in time) for
the specified supervision group for all future monitored
\"*New*\" KPI events - e.g. new alarms raised, new tests
failures etc..

Intention : MODIFIER
setGroupBaseline:
instance-level modifier API setGroupBaseline
of class sup.SummaryView
instanceFullName : distinguished/instance name of called object
The time of setting the baseline.

", "operationId": "rest_sup_SummaryView_setGroupBaseline", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setGroupBaselineResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sup/SupervisionGroup/addInclusionFilter/{instanceFullName}": { "post": { "tags": [ "samo_sup" ], "summary": "rest_sup_SupervisionGroup_addInclusionFilter", "description": "This method adds a filter for monitored objects to
this supervision group. Filtered objects' class can't be
the class of subclass used by any other inclusion
filter in this group.

Intention : MODIFIER
addInclusionFilter:
instance-level modifier API addInclusionFilter
of class sup.SupervisionGroup
instanceFullName : distinguished/instance name of called object
New value of the \"inclusionFilters\" property -
FDNs of all inclusion filters in this group.

", "operationId": "rest_sup_SupervisionGroup_addInclusionFilter", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/addInclusionFilterResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sup/SupervisionGroup/addTriggerFilter/{instanceFullName}": { "post": { "tags": [ "samo_sup" ], "summary": "rest_sup_SupervisionGroup_addTriggerFilter", "description": "This method adds a filter for monitoring trigger
objects to this supervision group.

Intention : MODIFIER
addTriggerFilter:
instance-level modifier API addTriggerFilter
of class sup.SupervisionGroup
instanceFullName : distinguished/instance name of called object
Set of all trigger filter FDNS in this
supervision group. Filtered objects' class can't
be the class of subclass used by any other
trigger filter in this group.

", "operationId": "rest_sup_SupervisionGroup_addTriggerFilter", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/addTriggerFilterResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sup/SupervisionGroup/getHistoryBuffer/{instanceFullName}": { "post": { "tags": [ "samo_sup" ], "summary": "rest_sup_SupervisionGroup_getHistoryBuffer", "description": "This method returns the accumulated history of one or
all supervision groups for this summary view.

Intention : RETRIEVER
getHistoryBuffer:
instance-level retriever API getHistoryBuffer
of class sup.SupervisionGroup
instanceFullName : distinguished/instance name of called object
Time ordered snapshots of supervision group states.

", "operationId": "rest_sup_SupervisionGroup_getHistoryBuffer", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getHistoryBuffer" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getHistoryBufferResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sup/SupervisionGroup/getInfoWithMonitoredObjects/{instanceFullName}": { "get": { "tags": [ "samo_sup" ], "summary": "rest_sup_SupervisionGroup_getInfoWithMonitoredObjects", "description": "This method returns the info structure for this group
with the set of monitored objects filled in.

Intention : RETRIEVER
getInfoWithMonitoredObjects:
instance-level retriever API getInfoWithMonitoredObjects
of class sup.SupervisionGroup
instanceFullName : distinguished/instance name of called object
Time ordered snapshots of supervision group states.

", "operationId": "rest_sup_SupervisionGroup_getInfoWithMonitoredObjects", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getInfoWithMonitoredObjectsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sup/SupervisionGroup/listSummaryViews/{instanceFullName}": { "post": { "tags": [ "samo_sup" ], "summary": "rest_sup_SupervisionGroup_listSummaryViews", "description": "This method returns the set of summary views that
include this supervision group.

Intention : RETRIEVER
listSummaryViews:
instance-level retriever API listSummaryViews
of class sup.SupervisionGroup
instanceFullName : distinguished/instance name of called object
Set of all summary view FDNs that include
this supervision group.

", "operationId": "rest_sup_SupervisionGroup_listSummaryViews", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listSummaryViewsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sup/SupervisionGroup/removeInclusionFilter/{instanceFullName}": { "post": { "tags": [ "samo_sup" ], "summary": "rest_sup_SupervisionGroup_removeInclusionFilter", "description": "This method removes a filter for monitored objects
from this supervision group.

Intention : MODIFIER
removeInclusionFilter:
instance-level [administrative deletion] (modifier) API removeInclusionFilter
of class sup.SupervisionGroup
instanceFullName : distinguished/instance name of called object
New value of the \"inclusionFilters\" property -
FDNs of all inclusion filters in this group.

", "operationId": "rest_sup_SupervisionGroup_removeInclusionFilter", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/removeInclusionFilterResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sup/SupervisionGroup/removeTriggerFilter/{instanceFullName}": { "post": { "tags": [ "samo_sup" ], "summary": "rest_sup_SupervisionGroup_removeTriggerFilter", "description": "This method removes a filter for monitoring trigger
objects from this supervision group.

Intention : MODIFIER
removeTriggerFilter:
instance-level [administrative deletion] (modifier) API removeTriggerFilter
of class sup.SupervisionGroup
instanceFullName : distinguished/instance name of called object
Set of all trigger filter FDNS in this
supervision group.

", "operationId": "rest_sup_SupervisionGroup_removeTriggerFilter", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/removeTriggerFilterResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sup/SupervisionGroup/setBaseline/{instanceFullName}": { "post": { "tags": [ "samo_sup" ], "summary": "rest_sup_SupervisionGroup_setBaseline", "description": "This method sets baseline (current moment in time)
for all future monitored \"*New*\" KPI events - e.g.
new alarms raised, new tests failures etc..

Intention : MODIFIER
setBaseline:
instance-level modifier API setBaseline
of class sup.SupervisionGroup
instanceFullName : distinguished/instance name of called object
The time of setting the baseline.

", "operationId": "rest_sup_SupervisionGroup_setBaseline", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setBaselineResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sup/SupervisionManager/clearAllHistory": { "post": { "tags": [ "samo_sup" ], "summary": "rest_sup_SupervisionManager_clearAllHistory", "operationId": "rest_sup_SupervisionManager_clearAllHistory", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sup/SupervisionManager/dumpLog": { "post": { "tags": [ "samo_sup" ], "summary": "rest_sup_SupervisionManager_dumpLog", "description": "Writes details of the cache contents into the system
log.

Intention : RETRIEVER
dumpLog:
class-level retriever API dumpLog on default instance sup of class sup.SupervisionManager

Cache contents info.

", "operationId": "rest_sup_SupervisionManager_dumpLog", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dumpLog" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dumpLogResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sup/SupervisionManager/getGroupsByFdn": { "get": { "tags": [ "samo_sup" ], "summary": "rest_sup_SupervisionManager_getGroupsByFdn", "description": "This method returns a list of supervision group view fdns based on the monitored fdn.

Intention : RETRIEVER
getGroupsByFdn:
instance-level retriever API getGroupsByFdn on default instance sup of class sup.SupervisionManager

list of supervision group fdn.

", "operationId": "rest_sup_SupervisionManager_getGroupsByFdn", "parameters": [ { "name": "className", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "monitoredFdn", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getGroupsByFdnResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sup/SupervisionManager/getGroupsByFdnForUser": { "get": { "tags": [ "samo_sup" ], "summary": "rest_sup_SupervisionManager_getGroupsByFdnForUser", "description": "This method returns a supervision group view fdns based on the monitored fdn and the user's
access rights. At this moment, this method will be called only by service supervision to
enable access control. When the user searches a service or group on the search bar, this method
will be called and we will search that service supervision group and return its supervision
group and summary view (first match)

Intention : RETRIEVER
getGroupsByFdnForUser:
instance-level retriever API getGroupsByFdnForUser on default instance sup of class sup.SupervisionManager

Map of (supervision group, summary view)

", "operationId": "rest_sup_SupervisionManager_getGroupsByFdnForUser", "parameters": [ { "name": "className", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "monitoredFdn", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "user", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "appType", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getGroupsByFdnForUserResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sup/SupervisionManager/keepAliveUpdate": { "post": { "tags": [ "samo_sup" ], "summary": "rest_sup_SupervisionManager_keepAliveUpdate", "description": "This method refreshes the last access time of a given sup client (ping).

Intention : RETRIEVER
keepAliveUpdate:
class-level retriever API keepAliveUpdate on default instance sup of class sup.SupervisionManager

Period to which the SAM-S client must ping the server.

", "operationId": "rest_sup_SupervisionManager_keepAliveUpdate", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/keepAliveUpdateResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sup/SupervisionManager/rebuildCache": { "post": { "tags": [ "samo_sup" ], "summary": "rest_sup_SupervisionManager_rebuildCache", "operationId": "rest_sup_SupervisionManager_rebuildCache", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/sup/SupervisionManager/searchMonitoredObject": { "post": { "tags": [ "samo_sup" ], "summary": "rest_sup_SupervisionManager_searchMonitoredObject", "description": "This method returns list of supervision info for a monitored objects being searched for a given criteria.

Intention : RETRIEVER
searchMonitoredObject:
instance-level retriever API searchMonitoredObject on default instance sup of class sup.SupervisionManager


", "operationId": "rest_sup_SupervisionManager_searchMonitoredObject", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/searchMonitoredObject" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/searchMonitoredObjectResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sup/SupervisionManager/setBaseline": { "post": { "tags": [ "samo_sup" ], "summary": "rest_sup_SupervisionManager_setBaseline", "description": "This method sets baseline (current moment in time) for
all future monitored \"*New*\" KPI events - e.g. new
alarms raised, new tests failures etc..

Intention : MODIFIER
setBaseline:
class-level modifier API setBaseline on default instance sup of class sup.SupervisionManager

The time of setting the baseline.

", "operationId": "rest_sup_SupervisionManager_setBaseline", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/setBaselineResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/sup/SupervisionManager/takeSnapshot": { "post": { "tags": [ "samo_sup" ], "summary": "rest_sup_SupervisionManager_takeSnapshot", "description": "This method takes saves a snapshot of all monitored
groups states.

Intention : MODIFIER
takeSnapshot:
class-level modifier API takeSnapshot on default instance sup of class sup.SupervisionManager

Time the snapshot was taken at.

", "operationId": "rest_sup_SupervisionManager_takeSnapshot", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/takeSnapshotResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/pxc/PortCrossConnect/getDependencyCount/{instanceFullName}": { "get": { "tags": [ "samo_pxc" ], "summary": "rest_pxc_PortCrossConnect_getDependencyCount", "description": "
Intention : RETRIEVER
getDependencyCount:
instance-level retriever API getDependencyCount
of class pxc.PortCrossConnect
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_pxc_PortCrossConnect_getDependencyCount", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getDependencyCountResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/pxc/PortCrossConnectSubPort/requestClearEfmOamEventLogs/{instanceFullName}": { "post": { "tags": [ "samo_pxc" ], "summary": "rest_pxc_PortCrossConnectSubPort_requestClearEfmOamEventLogs", "description": "Request clearing of EFM-OAM Event Logs.
When this method returns resources for the clear have been allocated
but the clear has not been performed yet.
To retrieve the result eventually, use the returned request handle
as input param of the retrieveClearRequest method of the
clear.ClearCommandManager.

Intention : MODIFIER
requestClearEfmOamEventLogs:
instance-level modifier API requestClearEfmOamEventLogs
of class pxc.PortCrossConnectSubPort
instanceFullName : distinguished/instance name of called object
A request handle which allows the retrieval of the
request (and its result when it becomes available)
through the ClearCommandManager's retrieveClearRequest
method.

", "operationId": "rest_pxc_PortCrossConnectSubPort_requestClearEfmOamEventLogs", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/requestClearEfmOamEventLogsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/pxc/PortCrossConnectSubPort/requestResyncEfmOamEventLogs/{instanceFullName}": { "post": { "tags": [ "samo_pxc" ], "summary": "rest_pxc_PortCrossConnectSubPort_requestResyncEfmOamEventLogs", "operationId": "rest_pxc_PortCrossConnectSubPort_requestResyncEfmOamEventLogs", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/pxc/PortCrossConnectSubPort/requestResyncEfmOamEventStats/{instanceFullName}": { "post": { "tags": [ "samo_pxc" ], "summary": "rest_pxc_PortCrossConnectSubPort_requestResyncEfmOamEventStats", "operationId": "rest_pxc_PortCrossConnectSubPort_requestResyncEfmOamEventStats", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/pxc/PortCrossConnectSubPort/requestResyncEfmOamPeerInfo/{instanceFullName}": { "post": { "tags": [ "samo_pxc" ], "summary": "rest_pxc_PortCrossConnectSubPort_requestResyncEfmOamPeerInfo", "operationId": "rest_pxc_PortCrossConnectSubPort_requestResyncEfmOamPeerInfo", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/securitypolicy/SecurityPolicyEntryDefinition/renum": { "post": { "tags": [ "samo_securitypolicy" ], "summary": "rest_securitypolicy_SecurityPolicyEntryDefinition_renum", "operationId": "rest_securitypolicy_SecurityPolicyEntryDefinition_renum", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/renum" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/genericne/GenericNeProfile/configure/{instanceFullName}": { "post": { "tags": [ "samo_genericne" ], "summary": "rest_genericne_GenericNeProfile_configure", "description": "This method is used to modify a Generic NE Profile.

Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure
of class genericne.GenericNeProfile
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object
Object Full name of Generic NE Profile that is modified.

", "operationId": "rest_genericne_GenericNeProfile_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/genericne/GenericNeProfile/findScripts": { "get": { "tags": [ "samo_genericne" ], "summary": "rest_genericne_GenericNeProfile_findScripts", "description": "
Intention : RETRIEVER
findScripts:
class-level [object finder] (retriever) API findScripts
of class genericne.GenericNeProfile


", "operationId": "rest_genericne_GenericNeProfile_findScripts", "parameters": [ { "name": "productName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findScriptsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/genericne/GenericNeProfile/validateUpgradePath": { "post": { "tags": [ "samo_genericne" ], "summary": "rest_genericne_GenericNeProfile_validateUpgradePath", "description": "This method is used to validate the changing of the Driver Module.

Intention : RETRIEVER
validateUpgradePath:
class-level retriever API validateUpgradePath
of class genericne.GenericNeProfile

Upgrade result returned if specified in descriptor.xml

", "operationId": "rest_genericne_GenericNeProfile_validateUpgradePath", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validateUpgradePath" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validateUpgradePathResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/genericne/GenericNeProfileManager/configure": { "post": { "tags": [ "samo_genericne" ], "summary": "rest_genericne_GenericNeProfileManager_configure", "description": "This method is used to create and configure a Generic NE Profile.

Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure on default instance genericne-profile-manager of class genericne.GenericNeProfileManager
This API follows hierarchical config model rules.

The object full name of the Generic NE Profile (created or configured).

", "operationId": "rest_genericne_GenericNeProfileManager_configure", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/genericne/GenericNeProfileManager/getNesMultipleTypes": { "post": { "tags": [ "samo_genericne" ], "summary": "rest_genericne_GenericNeProfileManager_getNesMultipleTypes", "description": "Return all NEs for the given NE Types.

Intention : RETRIEVER
getNesMultipleTypes:
class-level retriever API getNesMultipleTypes on default instance genericne-profile-manager of class genericne.GenericNeProfileManager

List of NE Infos for the given NE type.

", "operationId": "rest_genericne_GenericNeProfileManager_getNesMultipleTypes", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getNesMultipleTypesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/AbstractScript/changeScriptVersion/{instanceFullName}": { "post": { "tags": [ "samo_script" ], "summary": "rest_script_AbstractScript_changeScriptVersion", "operationId": "rest_script_AbstractScript_changeScriptVersion", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/script/AbstractScript/configScriptVersion/{instanceFullName}": { "post": { "tags": [ "samo_script" ], "summary": "rest_script_AbstractScript_configScriptVersion", "description": "This method creates a version of the auto-config script template (and deletes the older version if exists).

Intention : MODIFIER
configScriptVersion:
instance-level [hierarchical administrative configuration/modification] (modifier) API configScriptVersion
of class script.AbstractScript
This API follows hierarchical config model rules.
DescendantInfo:
script.ControlScript
DescendantInfo:
script.Script
DescendantInfo:
script.XmlApiConfigTemplate
DescendantInfo:
script.AbstractXmlApiScript
DescendantInfo:
autoconfig.AutoConfigSrcProfile
DescendantInfo:
autoconfig.AutoConfigDestProfile
DescendantInfo:
script.XmlApiScript
instanceFullName : distinguished/instance name of called object
The newly created version information.

", "operationId": "rest_script_AbstractScript_configScriptVersion", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configScriptVersion" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configScriptVersionResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/AbstractScript/configureScript/{instanceFullName}": { "post": { "tags": [ "samo_script" ], "summary": "rest_script_AbstractScript_configureScript", "description": "This method modifies script information.

Intention : MODIFIER
configureScript:
instance-level [hierarchical administrative configuration/modification] (modifier) API configureScript
of class script.AbstractScript
This API follows hierarchical config model rules.
DescendantInfo:
script.ControlScript
DescendantInfo:
script.Script
DescendantInfo:
script.XmlApiConfigTemplate
DescendantInfo:
script.AbstractXmlApiScript
DescendantInfo:
autoconfig.AutoConfigSrcProfile
DescendantInfo:
autoconfig.AutoConfigDestProfile
DescendantInfo:
script.XmlApiScript
instanceFullName : distinguished/instance name of called object
The full name of the configured script.

", "operationId": "rest_script_AbstractScript_configureScript", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureScriptResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/AbstractScript/configureTarget/{instanceFullName}": { "post": { "tags": [ "samo_script" ], "summary": "rest_script_AbstractScript_configureTarget", "description": "This method creates a target associated to a script.

Intention : MODIFIER
configureTarget:
instance-level [hierarchical administrative configuration/modification] (modifier) API configureTarget
of class script.AbstractScript
This API follows hierarchical config model rules.
DescendantInfo:
script.ControlScript
DescendantInfo:
script.Script
DescendantInfo:
script.XmlApiConfigTemplate
DescendantInfo:
script.AbstractXmlApiScript
DescendantInfo:
autoconfig.AutoConfigSrcProfile
DescendantInfo:
autoconfig.AutoConfigDestProfile
DescendantInfo:
script.XmlApiScript
instanceFullName : distinguished/instance name of called object
The full name of the newly created target script.

", "operationId": "rest_script_AbstractScript_configureTarget", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureTargetResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/AbstractScript/configureTargets/{instanceFullName}": { "post": { "tags": [ "samo_script" ], "summary": "rest_script_AbstractScript_configureTargets", "description": "This method creates multiple targets associated to a script.

Intention : MODIFIER
configureTargets:
instance-level [hierarchical administrative configuration/modification] (modifier) API configureTargets
of class script.AbstractScript
This API follows hierarchical config model rules.
DescendantInfo:
script.ControlScript
DescendantInfo:
script.Script
DescendantInfo:
script.XmlApiConfigTemplate
DescendantInfo:
script.AbstractXmlApiScript
DescendantInfo:
autoconfig.AutoConfigSrcProfile
DescendantInfo:
autoconfig.AutoConfigDestProfile
DescendantInfo:
script.XmlApiScript
instanceFullName : distinguished/instance name of called object
The list of object summaries for the newly created targets.

", "operationId": "rest_script_AbstractScript_configureTargets", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureTargetsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/AbstractScript/createScriptVersion/{instanceFullName}": { "post": { "tags": [ "samo_script" ], "summary": "rest_script_AbstractScript_createScriptVersion", "description": "This method creates a version of the script.

Intention : MODIFIER
createScriptVersion:
instance-level [administrative creation] (modifier) API createScriptVersion
of class script.AbstractScript
DescendantInfo:
script.ControlScript
DescendantInfo:
script.Script
DescendantInfo:
script.XmlApiConfigTemplate
DescendantInfo:
script.AbstractXmlApiScript
DescendantInfo:
autoconfig.AutoConfigSrcProfile
DescendantInfo:
autoconfig.AutoConfigDestProfile
DescendantInfo:
script.XmlApiScript
instanceFullName : distinguished/instance name of called object
The newly created version information.

", "operationId": "rest_script_AbstractScript_createScriptVersion", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createScriptVersion" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createScriptVersionResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/AbstractVersion/getScriptContents": { "get": { "tags": [ "samo_script" ], "summary": "rest_script_AbstractVersion_getScriptContents", "description": "This method returns the script version contents (commands).

Intention : RETRIEVER
getScriptContents:
class-level retriever API getScriptContents
of class script.AbstractVersion
DescendantInfo:
script.ControlScriptVersion
DescendantInfo:
script.Version
DescendantInfo:
script.XmlApiVersion
DescendantInfo:
autoconfig.AutoConfigScript
DescendantInfo:
autoconfig.AutoConfigTemplate

The script versions body.

", "operationId": "rest_script_AbstractVersion_getScriptContents", "parameters": [ { "name": "objectFullName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getScriptContentsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/Bundle/addScripts/{instanceFullName}": { "post": { "tags": [ "samo_script" ], "summary": "rest_script_Bundle_addScripts", "operationId": "rest_script_Bundle_addScripts", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/script/Bundle/deleteBundleAndAssociatedScripts/{instanceFullName}": { "delete": { "tags": [ "samo_script" ], "summary": "rest_script_Bundle_deleteBundleAndAssociatedScripts", "operationId": "rest_script_Bundle_deleteBundleAndAssociatedScripts", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/script/Bundle/removeScripts/{instanceFullName}": { "post": { "tags": [ "samo_script" ], "summary": "rest_script_Bundle_removeScripts", "operationId": "rest_script_Bundle_removeScripts", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/script/ControlScript/associateExecutableScript/{instanceFullName}": { "post": { "tags": [ "samo_script" ], "summary": "rest_script_ControlScript_associateExecutableScript", "description": "This method will create an association (binding) between this control script and
another script.

Intention : MODIFIER
associateExecutableScript:
instance-level modifier API associateExecutableScript
of class script.ControlScript
instanceFullName : distinguished/instance name of called object
Returns the object the input parameter 'associatedObjectPointer' is referring to.

", "operationId": "rest_script_ControlScript_associateExecutableScript", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/associateExecutableScriptResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/ControlScript/associateHandlerScript/{instanceFullName}": { "post": { "tags": [ "samo_script" ], "summary": "rest_script_ControlScript_associateHandlerScript", "description": "This method will create an association (binding) between this control script and either
another script.

Intention : MODIFIER
associateHandlerScript:
instance-level modifier API associateHandlerScript
of class script.ControlScript
instanceFullName : distinguished/instance name of called object
Returns the object the input parameter 'associatedObjectPointer' is referring to.

", "operationId": "rest_script_ControlScript_associateHandlerScript", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/associateHandlerScriptResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/Result/getResultBody": { "get": { "tags": [ "samo_script" ], "summary": "rest_script_Result_getResultBody", "description": "This method returns the result body of the specified result object.

Intention : RETRIEVER
getResultBody:
class-level retriever API getResultBody
of class script.Result

The body of the result.

", "operationId": "rest_script_Result_getResultBody", "parameters": [ { "name": "objectFullName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getResultBodyResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/ResultManager/saveResult": { "post": { "tags": [ "samo_script" ], "summary": "rest_script_ResultManager_saveResult", "description": "This method saves a given result to result management.

Intention : MODIFIER
saveResult:
instance-level modifier API saveResult on default instance result-manager of class script.ResultManager

The full name of the newly created result object in result management.

", "operationId": "rest_script_ResultManager_saveResult", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/saveResult" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/saveResultResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/ScriptManager/cancelExecution": { "delete": { "tags": [ "samo_script" ], "summary": "rest_script_ScriptManager_cancelExecution", "description": "This method is used to cancel the execution of a script. If a script is currently
executing, it will not cancel it, it must wait until the script is finished. It
will cancel scripts that are queued to execute.

Intention : RETRIEVER
cancelExecution:
class-level retriever API cancelExecution on default instance script-manager of class script.ScriptManager

The full name list of all the targets that could be cancelled.

", "operationId": "rest_script_ScriptManager_cancelExecution", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cancelExecutionResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/ScriptManager/cancelRunningCliExecution": { "delete": { "tags": [ "samo_script" ], "summary": "rest_script_ScriptManager_cancelRunningCliExecution", "operationId": "rest_script_ScriptManager_cancelRunningCliExecution", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/script/ScriptManager/cancelScriptFlow": { "delete": { "tags": [ "samo_script" ], "summary": "rest_script_ScriptManager_cancelScriptFlow", "description": "This method will request to stop a running script flow.
It is not guaranteed that the script flow will be aborted.

Intention : RETRIEVER
cancelScriptFlow:
class-level retriever API cancelScriptFlow on default instance script-manager of class script.ScriptManager

Returns true if the request was succesfully submitted (it does not mean that the script execution was actually stopped).
Returns false if the cancel request could not be submitted (the script already finished execution or user has no
privileges to cancel this task).

", "operationId": "rest_script_ScriptManager_cancelScriptFlow", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cancelScriptFlowResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/ScriptManager/configure": { "post": { "tags": [ "samo_script" ], "summary": "rest_script_ScriptManager_configure", "description": "Create and modify a script through the script manager.

Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure on default instance script-manager of class script.ScriptManager
This API follows hierarchical config model rules.

The newly created scripts full name.

", "operationId": "rest_script_ScriptManager_configure", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/ScriptManager/executeCLIScript": { "put": { "tags": [ "samo_script" ], "summary": "rest_script_ScriptManager_executeCLIScript", "description": "This method is called to execute target scripts.


For example:


<script.ScriptManager.executeCLIScript xmlns=\"xmlapi_1.0\">
<isSynchronized>true< isSynchronized>
<clientId>user@1< clientId>
<targetScriptFullNameList>
<pointer>script-manager:script-4:target-script-1< pointer>
< targetScriptFullNameList>
<resultFilter>< resultFilter>
< script.ScriptManager.executeCLIScript>


Intention : RETRIEVER
executeCLIScript:
class-level retriever API executeCLIScript on default instance script-manager of class script.ScriptManager

The list of TargetScriptResultInfo objects identifying the status of the executed target scripts.

", "operationId": "rest_script_ScriptManager_executeCLIScript", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeCLIScript" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeCLIScriptResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/ScriptManager/executeCLITargetScripts": { "put": { "tags": [ "samo_script" ], "summary": "rest_script_ScriptManager_executeCLITargetScripts", "description": "This method is called to execute target scripts with runtime parameters.


For example:


<script.ScriptManager.executeCLITargetScripts xmlns=\"xmlapi_1.0\">
<isSynchronized>true<<isSynchronized>
<clientId>user@1< clientId>
<listOfTargetScriptConfigInfo>
<script.TargetScript>
<actionMask>
<bit>create< bit>
< actionMask>
<objectFullName>script-manager:script-6:target-script-1< objectFullName>
<script.TargetParameter-Set>
<script.TargetParameter>
<actionMask>
<bit>create< bit>
< actionMask>
<value>1< value>
<objectFullName>script-manager:script-6:target-script-1:target-parameter-bitmask2< objectFullName>
<parameterName>bitmask2< parameterName>
< script.TargetParameter>
<script.TargetParameter>
<actionMask>
<bit>create< bit>
< actionMask>
<value>1< value>
<objectFullName>script-manager:script-6:target-script-1:target-parameter-bitmask1< objectFullName>
<parameterName>bitmask1< parameterName>
< script.TargetParameter>
< script.TargetParameter-Set>
< script.TargetScript>
< listOfTargetScriptConfigInfo>
< script.ScriptManager.executeCLITargetScripts>


Intention : RETRIEVER
executeCLITargetScripts:
class-level retriever API executeCLITargetScripts on default instance script-manager of class script.ScriptManager

The list of TargetScriptResultInfo objects identifying the status of the executed target scripts.

", "operationId": "rest_script_ScriptManager_executeCLITargetScripts", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeCLITargetScripts" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeCLITargetScriptsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/ScriptManager/executeScript": { "put": { "tags": [ "samo_script" ], "summary": "rest_script_ScriptManager_executeScript", "description": "This method is called to execute target scripts.


For example:


<script.ScriptManager.executeScript xmlns=\"xmlapi_1.0\">
<isSynchronized>true< isSynchronized>
<clientId>user@1< clientId>
<targetScriptFullNameList>
<pointer>script-manager:xmlApiScript-6:target-script-1< pointer>
< targetScriptFullNameList>
< script.ScriptManager.executeScript>


Intention : RETRIEVER
executeScript:
class-level retriever API executeScript on default instance script-manager of class script.ScriptManager

The list of TargetScriptResultInfo objects identifying the status of the executed target scripts.

", "operationId": "rest_script_ScriptManager_executeScript", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeScript" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeScriptResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/ScriptManager/executeScriptFlow": { "put": { "tags": [ "samo_script" ], "summary": "rest_script_ScriptManager_executeScriptFlow", "description": "This method is called to execute a script synchronously.
Always latest versions are used, and target information is not stored,
instead it is passed in during execution.

Intention : RETRIEVER
executeScriptFlow:
class-level retriever API executeScriptFlow on default instance script-manager of class script.ScriptManager

The ScriptFlowExecutionResult object identifying the status and the result body of the executed script.

", "operationId": "rest_script_ScriptManager_executeScriptFlow", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeScriptFlow" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeScriptFlowResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/ScriptManager/executeSystemScripts": { "put": { "tags": [ "samo_script" ], "summary": "rest_script_ScriptManager_executeSystemScripts", "description": "This method is called to execute system scripts scripts. Versions are
not supported with system scripts, and target information is not stored,
instead it is passed in during execution.

Intention : RETRIEVER
executeSystemScripts:
class-level retriever API executeSystemScripts on default instance script-manager of class script.ScriptManager

The list of TargetScriptResultInfo objects identifying the status of the executed target scripts.

", "operationId": "rest_script_ScriptManager_executeSystemScripts", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeSystemScripts" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeSystemScriptsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/ScriptManager/executeTargetScripts": { "put": { "tags": [ "samo_script" ], "summary": "rest_script_ScriptManager_executeTargetScripts", "description": "This method is called to execute target scripts with runtime parameters.


For example:


<script.ScriptManager.executeTargetScripts xmlns=\"xmlapi_1.0\">
<isSynchronized>true< isSynchronized>
<clientId>user@1< clientId>
<listOfTargetScriptConfigInfo>
<script.TargetScript>
<actionMask>
<bit>create< bit>
< actionMask>
<objectFullName>script-manager:xmlApiScript-55:target-script-3< objectFullName>
<script.TargetParameter-Set>
<script.TargetParameter>
<actionMask>
<bit>create< bit>
< actionMask>
<value>slope.Policy< value>
<objectFullName>script-manager:xmlApiScript-55:target-script-3:target-parameter-classToFind< objectFullName>
<parameterName>classToFind< parameterName>
< script.TargetParameter>
< script.TargetParameter-Set>
< script.TargetScript>
< listOfTargetScriptConfigInfo>
<< script.ScriptManager.executeTargetScripts>


Intention : RETRIEVER
executeTargetScripts:
class-level retriever API executeTargetScripts on default instance script-manager of class script.ScriptManager

The list of TargetScriptResultInfo objects identifying the status of the executed target scripts.

", "operationId": "rest_script_ScriptManager_executeTargetScripts", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeTargetScripts" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeTargetScriptsResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/ScriptManager/executeTargetScriptsWithParameters": { "put": { "tags": [ "samo_script" ], "summary": "rest_script_ScriptManager_executeTargetScriptsWithParameters", "description": "
Intention : RETRIEVER
executeTargetScriptsWithParameters:
class-level retriever API executeTargetScriptsWithParameters on default instance script-manager of class script.ScriptManager

The list of TargetScriptResultInfo objects identifying the status of the executed target scripts.

", "operationId": "rest_script_ScriptManager_executeTargetScriptsWithParameters", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeTargetScriptsWithParameters" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeTargetScriptsWithParametersResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/ScriptManager/getBodyOfTargetScriptResult": { "get": { "tags": [ "samo_script" ], "summary": "rest_script_ScriptManager_getBodyOfTargetScriptResult", "description": "This method is called to get the result of an executed target script.

Intention : RETRIEVER
getBodyOfTargetScriptResult:
class-level retriever API getBodyOfTargetScriptResult on default instance script-manager of class script.ScriptManager

The result of the executed script (returned as a string).

", "operationId": "rest_script_ScriptManager_getBodyOfTargetScriptResult", "parameters": [ { "name": "targetScriptResultObjectFullName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getBodyOfTargetScriptResultResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/ScriptManager/previewScriptWithParameters": { "post": { "tags": [ "samo_script" ], "summary": "rest_script_ScriptManager_previewScriptWithParameters", "description": "
Intention : RETRIEVER
previewScriptWithParameters:
class-level retriever API previewScriptWithParameters on default instance script-manager of class script.ScriptManager

The preview result.

", "operationId": "rest_script_ScriptManager_previewScriptWithParameters", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/previewScriptWithParameters" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/previewScriptWithParametersResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/TargetParameter/configure/{instanceFullName}": { "post": { "tags": [ "samo_script" ], "summary": "rest_script_TargetParameter_configure", "description": "This method is used to create or configure target parameters.

Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure
of class script.TargetParameter
This API follows hierarchical config model rules.
DescendantInfo:
script.LargeTextTargetParameter
DescendantInfo:
script.TargetParameterItem
DescendantInfo:
script.JsonTargetParameter
DescendantInfo:
script.TargetParameterList
instanceFullName : distinguished/instance name of called object
The target parameter full name.

", "operationId": "rest_script_TargetParameter_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/TargetScript/cancelExecution/{instanceFullName}": { "delete": { "tags": [ "samo_script" ], "summary": "rest_script_TargetScript_cancelExecution", "description": "This method is used to cancel the execution of a target script. If a target script is currently
executing, it will not cancel it, it must wait until the target script is finished. It
will cancel a target script that is queued to execute.

Intention : RETRIEVER
cancelExecution:
instance-level retriever API cancelExecution
of class script.TargetScript
instanceFullName : distinguished/instance name of called object
True if it could be cancelled, false otherwise.

", "operationId": "rest_script_TargetScript_cancelExecution", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cancelExecutionResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/TargetScript/configure/{instanceFullName}": { "post": { "tags": [ "samo_script" ], "summary": "rest_script_TargetScript_configure", "description": "This method is used to configure the target script. It can be used to modify
the parameters or the name, but it can not be used to change the version (see
AbstractScript for more details).

Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure
of class script.TargetScript
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object
The target script full name.

", "operationId": "rest_script_TargetScript_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/TargetScript/executeCLIScript/{instanceFullName}": { "put": { "tags": [ "samo_script" ], "summary": "rest_script_TargetScript_executeCLIScript", "description": "This method is used to execute a CLI target script.


For example:


<script.TargetScript.executeCLIScript xmlns=\"xmlapi_1.0\">
<isSynchronized>true< isSynchronized>
<clientId>user@1< clientId>
<instanceFullName>script-manager:script-4:target-script-1< instanceFullName>
<resultFilter>< resultFilter>
< script.TargetScript.executeCLIScript>


Intention : RETRIEVER
executeCLIScript:
instance-level retriever API executeCLIScript
of class script.TargetScript
instanceFullName : distinguished/instance name of called object
The list of TargetScriptResultInfo object identifying the status of the executed target script.

", "operationId": "rest_script_TargetScript_executeCLIScript", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeCLIScript" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeCLIScriptResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/TargetScript/executeCLITargetScript/{instanceFullName}": { "put": { "tags": [ "samo_script" ], "summary": "rest_script_TargetScript_executeCLITargetScript", "description": "This method is used to execute a target script with runtime parameters.


For example:


<script.TargetScript.executeCLITargetScript xmlns=\"xmlapi_1.0\">
<isSynchronized>true< isSynchronized>
<clientId>user@1< clientId>
<instanceFullName>script-manager:script-17:target-script-1< instanceFullName>
<configInfo>
<item>
<key>script-manager:script-17:target-script-1:target-parameter-portId< key>
<value>
<script.TargetParameter>
<actionMask>
<bit>create< bit>
< actionMask>
<value>1 1 2< value>
<parameterName>portId< parameterName>
< script.TargetParameter>
< value>
<value>
<script.TargetParameter>
<actionMask>
<bit>create< bit>
< actionMask>
<value>1 1 2< value>
<parameterName>portId< parameterName>
< script.TargetParameter>
< value>
< item>
< configInfo>
< script.TargetScript.executeCLITargetScript>


Intention : RETRIEVER
executeCLITargetScript:
instance-level retriever API executeCLITargetScript
of class script.TargetScript
instanceFullName : distinguished/instance name of called object
The list of TargetScriptResultInfo object identifying the status of the executed target script.

", "operationId": "rest_script_TargetScript_executeCLITargetScript", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeCLITargetScript" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeCLITargetScriptResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/TargetScript/executeScript/{instanceFullName}": { "put": { "tags": [ "samo_script" ], "summary": "rest_script_TargetScript_executeScript", "description": "This method is used to execute a target script.


For example:


<script.TargetScript.executeScript xmlns=\"xmlapi_1.0\">
<isSynchronized>true< isSynchronized>
<clientId>user@1< clientId>
<instanceFullName>script-manager:xmlApiScript-56:target-script-3< instanceFullName>
<resultFilter>< resultFilter>
< script.TargetScript.executeScript>


Intention : RETRIEVER
executeScript:
instance-level retriever API executeScript
of class script.TargetScript
instanceFullName : distinguished/instance name of called object
The list of TargetScriptResultInfo object identifying the status of the executed target script.

", "operationId": "rest_script_TargetScript_executeScript", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeScript" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeScriptResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/TargetScript/executeTargetScript/{instanceFullName}": { "put": { "tags": [ "samo_script" ], "summary": "rest_script_TargetScript_executeTargetScript", "description": "This method is used to execute a target script with runtime parameters.


For example:


<script.TargetScript.executeTargetScript xmlns=\"xmlapi_1.0\">
<isSynchronized>true< isSynchronized>
<clientId>user@1< clientId>
<instanceFullName>script-manager:xmlApiScript-55:target-script-3< instanceFullName>
<configInfo>
<item>
<key>script-manager:xmlApiScript-55:target-script-3:target-parameter-classToFind< key>
<value>
<script.TargetParameter>
<actionMask>
<bit>create< bit>
< actionMask>
<value>rp.PolicyStatement< value>
<parameterName>classToFind< parameterName>
< script.TargetParameter>
< value>
< item>
< configInfo>
< script.TargetScript.executeTargetScript>


Intention : RETRIEVER
executeTargetScript:
instance-level retriever API executeTargetScript
of class script.TargetScript
instanceFullName : distinguished/instance name of called object
The list of TargetScriptResultInfo object identifying the status of the executed target script.

", "operationId": "rest_script_TargetScript_executeTargetScript", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeTargetScript" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeTargetScriptResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/TargetScript/preview/{instanceFullName}": { "post": { "tags": [ "samo_script" ], "summary": "rest_script_TargetScript_preview", "description": "This method is used to preview targets based on the script version
and the parameters configured for the target.

Intention : RETRIEVER
preview:
instance-level retriever API preview
of class script.TargetScript
instanceFullName : distinguished/instance name of called object
The preview result.

", "operationId": "rest_script_TargetScript_preview", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/previewResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/TargetScriptResult/getTargetScriptResult": { "get": { "tags": [ "samo_script" ], "summary": "rest_script_TargetScriptResult_getTargetScriptResult", "description": "This method returns the target script result for the specified full name.

Intention : RETRIEVER
getTargetScriptResult:
class-level retriever API getTargetScriptResult
of class script.TargetScriptResult

The target script result.

", "operationId": "rest_script_TargetScriptResult_getTargetScriptResult", "parameters": [ { "name": "objectFullName", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getTargetScriptResultResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/VelocityTemplate/reload": { "post": { "tags": [ "samo_script" ], "summary": "rest_script_VelocityTemplate_reload", "operationId": "rest_script_VelocityTemplate_reload", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/script/VelocityTemplate/store": { "post": { "tags": [ "samo_script" ], "summary": "rest_script_VelocityTemplate_store", "description": "Create modify the script and load it in Velocity engine.

Intention : MODIFIER
store:
class-level modifier API store
of class script.VelocityTemplate

The name of the newly defined or changed OSSI
command.
Empty string if the template passed in was
identical to an already defined one.

", "operationId": "rest_script_VelocityTemplate_store", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/store" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/storeResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/XmlApiConfigTemplate/associateTemplate/{instanceFullName}": { "post": { "tags": [ "samo_script" ], "summary": "rest_script_XmlApiConfigTemplate_associateTemplate", "description": "This method will create an association (binding) between this template and either
a) another template, or
b) a templatable object (an object that was created from this template).

Intention : MODIFIER
associateTemplate:
instance-level modifier API associateTemplate
of class script.XmlApiConfigTemplate
instanceFullName : distinguished/instance name of called object
Returns the object the input parameter 'associatedObjectPointer' is referring to.

", "operationId": "rest_script_XmlApiConfigTemplate_associateTemplate", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "string" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/associateTemplateResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/XmlApiConfigTemplate/convertOldTemplates": { "post": { "tags": [ "samo_script" ], "summary": "rest_script_XmlApiConfigTemplate_convertOldTemplates", "description": "This method is used to generate a template.
Depending on parameters specified by 'templateParams' the template can be generated
from a class or an instance.

Intention : MODIFIER
convertOldTemplates:
class-level modifier API convertOldTemplates
of class script.XmlApiConfigTemplate

The generated templates.

", "operationId": "rest_script_XmlApiConfigTemplate_convertOldTemplates", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convertOldTemplates" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/convertOldTemplatesResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/XmlApiConfigTemplate/execute/{instanceFullName}": { "put": { "tags": [ "samo_script" ], "summary": "rest_script_XmlApiConfigTemplate_execute", "description": "This method is used to configure (e.g. create) an object from a template.

Intention : MODIFIER
execute:
instance-level modifier API execute
of class script.XmlApiConfigTemplate
instanceFullName : distinguished/instance name of called object
The full names of the configured objects.

", "operationId": "rest_script_XmlApiConfigTemplate_execute", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TargetParameterConfigInfo" } } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/XmlApiConfigTemplate/executeMulti/{instanceFullName}": { "put": { "tags": [ "samo_script" ], "summary": "rest_script_XmlApiConfigTemplate_executeMulti", "description": "This method is used to configure (e.g. create) an object with children from a template.

Intention : MODIFIER
executeMulti:
instance-level modifier API executeMulti
of class script.XmlApiConfigTemplate
instanceFullName : distinguished/instance name of called object
The full names of the configured objects.

", "operationId": "rest_script_XmlApiConfigTemplate_executeMulti", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiTemplateTargetParameterMap" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeMultiResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/XmlApiConfigTemplate/generate": { "post": { "tags": [ "samo_script" ], "summary": "rest_script_XmlApiConfigTemplate_generate", "description": "This method is used to generate a template.
Depending on parameters specified by 'templateParams' the template can be generated
from a class or an instance.

Intention : MODIFIER
generate:
class-level modifier API generate
of class script.XmlApiConfigTemplate

The generated template.

", "operationId": "rest_script_XmlApiConfigTemplate_generate", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generate" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generateResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/script/XmlApiConfigTemplate/generateFromSample": { "post": { "tags": [ "samo_script" ], "summary": "rest_script_XmlApiConfigTemplate_generateFromSample", "description": "This method is used to generate a template from a sample.

Intention : MODIFIER
generateFromSample:
class-level modifier API generateFromSample
of class script.XmlApiConfigTemplate

The generated template.

", "operationId": "rest_script_XmlApiConfigTemplate_generateFromSample", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generateFromSample" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generateFromSampleResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ldp/AccountingFecPrefix/shutDown/{instanceFullName}": { "post": { "tags": [ "samo_ldp" ], "summary": "rest_ldp_AccountingFecPrefix_shutDown", "operationId": "rest_ldp_AccountingFecPrefix_shutDown", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ldp/AccountingFecPrefix/turnUp/{instanceFullName}": { "post": { "tags": [ "samo_ldp" ], "summary": "rest_ldp_AccountingFecPrefix_turnUp", "operationId": "rest_ldp_AccountingFecPrefix_turnUp", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ldp/AuthenticationKey/removeAuthenticationKey/{instanceFullName}": { "post": { "tags": [ "samo_ldp" ], "summary": "rest_ldp_AuthenticationKey_removeAuthenticationKey", "operationId": "rest_ldp_AuthenticationKey_removeAuthenticationKey", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ldp/Interface/configure/{instanceFullName}": { "post": { "tags": [ "samo_ldp" ], "summary": "rest_ldp_Interface_configure", "description": "
Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure
of class ldp.Interface
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_ldp_Interface_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ldp/Site/configure/{instanceFullName}": { "post": { "tags": [ "samo_ldp" ], "summary": "rest_ldp_Site_configure", "description": "
Intention : MODIFIER
configure:
instance-level [hierarchical administrative configuration/modification] (modifier) API configure
of class ldp.Site
This API follows hierarchical config model rules.
instanceFullName : distinguished/instance name of called object

", "operationId": "rest_ldp_Site_configure", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/aossas/CPETestGroupHead/cancelCPETestGroupExection/{instanceFullName}": { "delete": { "tags": [ "samo_aossas" ], "summary": "rest_aossas_CPETestGroupHead_cancelCPETestGroupExection", "operationId": "rest_aossas_CPETestGroupHead_cancelCPETestGroupExection", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/aossas/CPETestHead/cancelCPETestExection/{instanceFullName}": { "delete": { "tags": [ "samo_aossas" ], "summary": "rest_aossas_CPETestHead_cancelCPETestExection", "operationId": "rest_aossas_CPETestHead_cancelCPETestExection", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/rollback/RollbackNEInfo/configRedundancyRlbkSync": { "post": { "tags": [ "samo_rollback" ], "summary": "rest_rollback_RollbackNEInfo_configRedundancyRlbkSync", "operationId": "rest_rollback_RollbackNEInfo_configRedundancyRlbkSync", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configRedundancyRlbkSync" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/rollback/RollbackNEInfo/createRollbckCheckPt": { "post": { "tags": [ "samo_rollback" ], "summary": "rest_rollback_RollbackNEInfo_createRollbckCheckPt", "operationId": "rest_rollback_RollbackNEInfo_createRollbckCheckPt", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createRollbckCheckPt" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/rollback/RollbackNEInfo/createRollbckRescue": { "post": { "tags": [ "samo_rollback" ], "summary": "rest_rollback_RollbackNEInfo_createRollbckRescue", "operationId": "rest_rollback_RollbackNEInfo_createRollbckRescue", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/rollback/RollbackNEInfo/deleteRollbckCheckPt": { "delete": { "tags": [ "samo_rollback" ], "summary": "rest_rollback_RollbackNEInfo_deleteRollbckCheckPt", "operationId": "rest_rollback_RollbackNEInfo_deleteRollbckCheckPt", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/rollback/RollbackNEInfo/deleteRollbckRescue": { "delete": { "tags": [ "samo_rollback" ], "summary": "rest_rollback_RollbackNEInfo_deleteRollbckRescue", "operationId": "rest_rollback_RollbackNEInfo_deleteRollbckRescue", "parameters": [], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/rollback/RollbackNEInfo/executeCompareCheckpoint": { "put": { "tags": [ "samo_rollback" ], "summary": "rest_rollback_RollbackNEInfo_executeCompareCheckpoint", "description": "
Intention : RETRIEVER
executeCompareCheckpoint:
class-level retriever API executeCompareCheckpoint
of class rollback.RollbackNEInfo


", "operationId": "rest_rollback_RollbackNEInfo_executeCompareCheckpoint", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeCompareCheckpoint" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeCompareCheckpointResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rollback/RollbackNEInfo/executeViewCheckPoint": { "put": { "tags": [ "samo_rollback" ], "summary": "rest_rollback_RollbackNEInfo_executeViewCheckPoint", "description": "
Intention : RETRIEVER
executeViewCheckPoint:
class-level retriever API executeViewCheckPoint
of class rollback.RollbackNEInfo

The result of the executed command (returned as a string).

", "operationId": "rest_rollback_RollbackNEInfo_executeViewCheckPoint", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeViewCheckPoint" } } }, "required": false }, "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/executeViewCheckPointResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/rollback/RollbackNEInfo/redundancyRollbackSync": { "post": { "tags": [ "samo_rollback" ], "summary": "rest_rollback_RollbackNEInfo_redundancyRollbackSync", "operationId": "rest_rollback_RollbackNEInfo_redundancyRollbackSync", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/redundancyRollbackSync" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/rollback/RollbackNEInfo/revertRollbckCheckPt": { "post": { "tags": [ "samo_rollback" ], "summary": "rest_rollback_RollbackNEInfo_revertRollbckCheckPt", "operationId": "rest_rollback_RollbackNEInfo_revertRollbckCheckPt", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/revertRollbckCheckPt" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/rollback/RollbackNEInfo/revertRollbckRescue": { "post": { "tags": [ "samo_rollback" ], "summary": "rest_rollback_RollbackNEInfo_revertRollbckRescue", "operationId": "rest_rollback_RollbackNEInfo_revertRollbckRescue", "parameters": [], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ranradiom/RANRadioMeasureManager/findEnodeBsReadyForRadioMeasurement": { "get": { "tags": [ "samo_ranradiom" ], "summary": "rest_ranradiom_RANRadioMeasureManager_findEnodeBsReadyForRadioMeasurement", "description": "Returns the enodebs ok for a radio measurement action

Intention : RETRIEVER
findEnodeBsReadyForRadioMeasurement:
instance-level [object finder] (retriever) API findEnodeBsReadyForRadioMeasurement on default instance radiomgr of class ranradiom.RANRadioMeasureManager


", "operationId": "rest_ranradiom_RANRadioMeasureManager_findEnodeBsReadyForRadioMeasurement", "parameters": [ { "name": "Content-Type", "in": "header", "description": "", "required": true, "style": "simple", "schema": { "enum": [ "application/json" ], "type": "string" } } ], "responses": { "200": { "description": "Returns a successful object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/findEnodeBsReadyForRadioMeasurementResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ranradiom/RANRadioMeasureManager/refreshEnodeB": { "post": { "tags": [ "samo_ranradiom" ], "summary": "rest_ranradiom_RANRadioMeasureManager_refreshEnodeB", "operationId": "rest_ranradiom_RANRadioMeasureManager_refreshEnodeB", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ranradiom/RANRadioMeasureManager/refreshEnodeBWithResult": { "post": { "tags": [ "samo_ranradiom" ], "summary": "rest_ranradiom_RANRadioMeasureManager_refreshEnodeBWithResult", "description": "Launch enodeb radio measurement refresh

Intention : MODIFIER
refreshEnodeBWithResult:
instance-level modifier API refreshEnodeBWithResult on default instance radiomgr of class ranradiom.RANRadioMeasureManager


", "operationId": "rest_ranradiom_RANRadioMeasureManager_refreshEnodeBWithResult", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/refreshEnodeBWithResultResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ranradiom/RANRadioMeasureManager/startPolling": { "post": { "tags": [ "samo_ranradiom" ], "summary": "rest_ranradiom_RANRadioMeasureManager_startPolling", "operationId": "rest_ranradiom_RANRadioMeasureManager_startPolling", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/ranradiom/RANRadioMeasureManager/startPollingWithResult": { "post": { "tags": [ "samo_ranradiom" ], "summary": "rest_ranradiom_RANRadioMeasureManager_startPollingWithResult", "description": "This operation results in starting to poll the radio measurement table.

Intention : MODIFIER
startPollingWithResult:
instance-level modifier API startPollingWithResult on default instance radiomgr of class ranradiom.RANRadioMeasureManager


", "operationId": "rest_ranradiom_RANRadioMeasureManager_startPollingWithResult", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "200": { "description": "Returns a successfully modified object", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/startPollingWithResultResponse" } } } }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false, "security": [ { "api_key": [] } ] } }, "/v2/ranradiom/RANRadioMeasureManager/stopPolling": { "post": { "tags": [ "samo_ranradiom" ], "summary": "rest_ranradiom_RANRadioMeasureManager_stopPolling", "operationId": "rest_ranradiom_RANRadioMeasureManager_stopPolling", "parameters": [], "requestBody": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/mpr/BackhaulService/deployServiceAction/{instanceFullName}": { "post": { "tags": [ "samo_mpr" ], "summary": "rest_mpr_BackhaulService_deployServiceAction", "operationId": "rest_mpr_BackhaulService_deployServiceAction", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "string" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/flexi/AbstractMRBTS/btsResetToTest/{instanceFullName}": { "post": { "tags": [ "samo_flexi" ], "summary": "rest_flexi_AbstractMRBTS_btsResetToTest", "operationId": "rest_flexi_AbstractMRBTS_btsResetToTest", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/flexi/AbstractMRBTS/btsSwReset/{instanceFullName}": { "post": { "tags": [ "samo_flexi" ], "summary": "rest_flexi_AbstractMRBTS_btsSwReset", "operationId": "rest_flexi_AbstractMRBTS_btsSwReset", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/flexi/AbstractMRBTS/changeLocalUserPassword/{instanceFullName}": { "post": { "tags": [ "samo_flexi" ], "summary": "rest_flexi_AbstractMRBTS_changeLocalUserPassword", "operationId": "rest_flexi_AbstractMRBTS_changeLocalUserPassword", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/changeLocalUserPassword" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/flexi/AbstractMRBTS/changeMediationCredentials/{instanceFullName}": { "post": { "tags": [ "samo_flexi" ], "summary": "rest_flexi_AbstractMRBTS_changeMediationCredentials", "operationId": "rest_flexi_AbstractMRBTS_changeMediationCredentials", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "text/plain": { "schema": { "type": "integer", "format": "int32" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/flexi/AbstractMRBTS/configureCertificateManagementAuthParameters/{instanceFullName}": { "post": { "tags": [ "samo_flexi" ], "summary": "rest_flexi_AbstractMRBTS_configureCertificateManagementAuthParameters", "operationId": "rest_flexi_AbstractMRBTS_configureCertificateManagementAuthParameters", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureCertificateManagementAuthParameters" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/flexi/AbstractMRBTS/hwResync/{instanceFullName}": { "post": { "tags": [ "samo_flexi" ], "summary": "rest_flexi_AbstractMRBTS_hwResync", "operationId": "rest_flexi_AbstractMRBTS_hwResync", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/flexi/AbstractMRBTS/initializeCertificateManagement/{instanceFullName}": { "post": { "tags": [ "samo_flexi" ], "summary": "rest_flexi_AbstractMRBTS_initializeCertificateManagement", "operationId": "rest_flexi_AbstractMRBTS_initializeCertificateManagement", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/flexi/AbstractMRBTS/launchRFDiagnostics/{instanceFullName}": { "post": { "tags": [ "samo_flexi" ], "summary": "rest_flexi_AbstractMRBTS_launchRFDiagnostics", "operationId": "rest_flexi_AbstractMRBTS_launchRFDiagnostics", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/flexi/AbstractMRBTS/requestCertificateManagementKeyUpdate/{instanceFullName}": { "post": { "tags": [ "samo_flexi" ], "summary": "rest_flexi_AbstractMRBTS_requestCertificateManagementKeyUpdate", "operationId": "rest_flexi_AbstractMRBTS_requestCertificateManagementKeyUpdate", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/flexi/EquipmentStatesSpecifics/lock/{instanceFullName}": { "post": { "tags": [ "samo_flexi" ], "summary": "rest_flexi_EquipmentStatesSpecifics_lock", "operationId": "rest_flexi_EquipmentStatesSpecifics_lock", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/flexi/EquipmentStatesSpecifics/reset/{instanceFullName}": { "post": { "tags": [ "samo_flexi" ], "summary": "rest_flexi_EquipmentStatesSpecifics_reset", "operationId": "rest_flexi_EquipmentStatesSpecifics_reset", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/flexi/EquipmentStatesSpecifics/shutdown/{instanceFullName}": { "post": { "tags": [ "samo_flexi" ], "summary": "rest_flexi_EquipmentStatesSpecifics_shutdown", "operationId": "rest_flexi_EquipmentStatesSpecifics_shutdown", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/flexi/EquipmentStatesSpecifics/unlock/{instanceFullName}": { "post": { "tags": [ "samo_flexi" ], "summary": "rest_flexi_EquipmentStatesSpecifics_unlock", "operationId": "rest_flexi_EquipmentStatesSpecifics_unlock", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } }, "/v2/flexi/ProcessingBase/configureAtomicList/{instanceFullName}": { "post": { "tags": [ "samo_flexi" ], "summary": "rest_flexi_ProcessingBase_configureAtomicList", "operationId": "rest_flexi_ProcessingBase_configureAtomicList", "parameters": [ { "name": "instanceFullName", "in": "path", "description": "", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configureAtomicList" } } }, "required": false }, "responses": { "204": { "description": "No content. Successful request", "headers": {}, "content": {} }, "401": { "description": "Unauthorized", "headers": {}, "content": {} }, "404": { "description": "Not found", "headers": {}, "content": {} }, "500": { "description": "Internal server problems", "headers": {}, "content": {} } }, "deprecated": false } } }, "components": { "schemas": { "requestClearSystemStatsDataTriggerResponse": { "title": "requestClearSystemStatsDataTriggerResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for NetworkElement.requestClearSystemStatsDataTrigger to encode json response from internal NFM-P object model" }, "findP2mpLspsResponse": { "title": "findP2mpLspsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for Tunnel.findP2mpLsps to encode json response from internal NFM-P object model" }, "findControlInstancesResponse": { "title": "findControlInstancesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for AbstractVirtualSite.findControlInstances to encode json response from internal NFM-P object model" }, "CommonManagedEntityConfigurationInformation": { "title": "CommonManagedEntityConfigurationInformation", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } } }, "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" }, "retrievePccRuleResponse": { "title": "retrievePccRuleResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for SubscriberPccRuleEntry.retrievePccRule to encode json response from internal NFM-P object model" }, "DriverUpgradeInfo": { "title": "DriverUpgradeInfo", "required": [ "objectClassName", "upgradePathDefaultAction", "sysObjectIdDefaultAction", "oldDescriptorPointer", "newDescriptorPointer", "supportedFromDrivers", "supportedToDrivers", "additionalProperties" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "upgradePathDefaultAction": { "type": "string" }, "sysObjectIdDefaultAction": { "type": "string" }, "oldDescriptorPointer": { "type": "string" }, "newDescriptorPointer": { "type": "string" }, "supportedFromDrivers": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/DriverInfo" }, "description": "" }, "supportedToDrivers": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/DriverInfo" }, "description": "" }, "additionalProperties": { "type": "object", "additionalProperties": { "type": "object" } } }, "description": "Model containing the method level model for struct DriverUpgradeInfo. to decode json data to internal NFM-P object model" }, "getInfoResponse": { "title": "getInfoResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/SoftwareFolderManager" }, { "description": "Managed object abstract class" } ] } }, "description": "Model containing the method level model for SoftwareFolderManager.getInfo to encode json response from internal NFM-P object model" }, "retrieveSAPHosts": { "title": "retrieveSAPHosts", "required": [ "additionalStateInfo", "timeout", "retrieveQoSOvr", "retrieveSlaacAddr", "retrieveBgpPeerInfo" ], "type": "object", "properties": { "aInCrdtCtrlOperValues": { "type": "boolean", "default": false }, "aInEncapValue": { "type": "integer", "format": "int64" }, "aInHostIpAddr": { "type": "string" }, "aInHostMacAddr": { "type": "string" }, "aInSiteId": { "type": "string" }, "aInServiceId": { "type": "integer", "format": "int64" }, "aInPortId": { "type": "integer", "format": "int64" }, "additionalStateInfo": { "type": "boolean", "description": "Specifies if retrieval of connectivity info and lease stateis also desired." }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns.", "format": "int64" }, "retrieveQoSOvr": { "type": "boolean", "description": "Specifies if Sub SLAAC QoS Override should be retrieved,the default is \"true\".It won't be retrieved if ESM System preferences \"retrieveQoSOvr\" is false. default:true" }, "retrieveSlaacAddr": { "type": "boolean", "description": "Specifies if retrieval of subscriber SLAAC host addresses is also desired.This is an optional input parameter. The default value is true.The SLAAC Host Address retrieval will be performed only on \"retrieveSlaacAddr\" is true for the method and\"retrieveSlaacHostAddr\" is true for the ResidentialSubscriberManager. default:true" }, "retrieveBgpPeerInfo": { "type": "boolean", "description": "Specifies if Sub SLAAC BGP Peer Info should be retrieved,the default is \"true\".It won't be retrieved if ESM System preferences \"retrieveBgpPeerInfo\" is false. default:true" } }, "description": "Model containing the method level model for SubscriberHost.retrieveSAPHosts to decode json data to internal NFM-P object model" }, "getRouteDistinguisherValuesResponse": { "title": "getRouteDistinguisherValuesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for ServiceSite.getRouteDistinguisherValues to encode json response from internal NFM-P object model" }, "importFromIgpAdminDomain": { "title": "importFromIgpAdminDomain", "required": [ "igpProtocols", "igpAdminDomain" ], "type": "object", "properties": { "igpProtocols": { "type": "array", "items": { "type": "string" }, "description": "The IGP protocols." }, "igpAdminDomain": { "type": "string", "description": "The IGP admin domain pointer." } }, "description": "Model containing the method level model for IgpTopologyModel.importFromIgpAdminDomain to decode json data to internal NFM-P object model" }, "findFaultListResponse": { "title": "findFaultListResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "object" }, "description": "The response object." } }, "description": "Model containing the method level model for FaultManager.findFaultList to encode json response from internal NFM-P object model" }, "TokenAttribute": { "title": "TokenAttribute", "required": [ "access_token", "refresh_token" ], "type": "object", "properties": { "loginContext": { "$ref": "#/components/schemas/LoginContextInterface" }, "expire_in": { "type": "integer", "description": "The Bearer token expiry time in seconds. Ex: 3600, a value in second.\n Represents the number of second from the token issue date before expiration", "format": "int64" }, "access_token": { "type": "string", "description": "Bearer token to use to access the system resource. ex: 5P0Hyj97uQCvt0jySow1JlGIpsBW7yGx3Fq2gRR8vr4=", "readOnly": true, "example": "String" }, "refresh_token": { "type": "string", "description": "ex: ZmM2ODQ0YmEtYzBiNi00ODNiLWE3ZTUtM2M1Nzg3MTY4ZTc4MTQ1ODU5NTg1MzAwMw==", "readOnly": true, "example": "String" }, "token_type": { "type": "string" } }, "description": "The mandatory attributes of Bearer token" }, "findAlarmsStatusesForOfnResponse": { "title": "findAlarmsStatusesForOfnResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/AlarmStatusesStruct" }, { "description": "Model containing the method level model for struct AlarmStatusesStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for FaultManager.findAlarmsStatusesForOfn to encode json response from internal NFM-P object model" }, "findPMSessionsVPRNSites": { "title": "findPMSessionsVPRNSites", "required": [ "filter", "serviceId" ], "type": "object", "properties": { "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "serviceId": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for TestManager.findPMSessionsVPRNSites to decode json data to internal NFM-P object model" }, "setGwAdminState": { "title": "setGwAdminState", "required": [ "siteId", "sigNodeType", "networkTechType", "nodeIndex", "adminState" ], "type": "object", "properties": { "siteId": { "type": "string" }, "sigNodeType": { "type": "string" }, "networkTechType": { "type": "string", "description": "default:lte" }, "nodeIndex": { "type": "integer", "format": "int32" }, "adminState": { "type": "string" }, "clientId": { "type": "string", "description": "Non documentable API" } }, "description": "Model containing the method level model for CMMInstance.setGwAdminState to decode json data to internal NFM-P object model" }, "upgrade": { "title": "upgrade", "required": [ "networkElements", "isSynchronised", "clientId", "upgradeState" ], "type": "object", "properties": { "networkElements": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "isSynchronised": { "type": "boolean", "description": "Identifies if the call to execute the script should wait until all scripts have been executed.True to wait, false otherwise." }, "clientId": { "type": "string", "description": "Identifies the client Id that is requesting the execution(used for sending an event to the specific client when execution is complete)." }, "upgradeState": { "type": "integer", "description": "Identifies the SU Stage to perform.", "format": "int32" } }, "description": "Model containing the method level model for MMESoftwareFolderDescriptor.upgrade to decode json data to internal NFM-P object model" }, "FirewallHostRtrvStruct": { "title": "FirewallHostRtrvStruct", "required": [ "objectClassName", "siteId", "residentialSubIdent", "ipAddrPrefix", "prefixLength", "macAddress", "firewallPolicy" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "residentialSubIdent": { "type": "string" }, "ipAddrPrefix": { "type": "string" }, "prefixLength": { "type": "integer", "format": "int32" }, "macAddress": { "type": "string" }, "firewallPolicy": { "type": "string" } }, "description": "Model containing the method level model for struct FirewallHostRtrvStruct. to decode json data to internal NFM-P object model" }, "findAvailableCtpsPerNodeResponse": { "title": "findAvailableCtpsPerNodeResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionTerminationPointInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for ConnectionTerminationPoint.findAvailableCtpsPerNode to encode json response from internal NFM-P object model" }, "validateQueryResponse": { "title": "validateQueryResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "object", "additionalProperties": { "type": "object" }, "description": "The response object." } }, "description": "Model containing the method level model for WlanGwQbtTunnel.validateQuery to encode json response from internal NFM-P object model" }, "getConnectorsResponse": { "title": "getConnectorsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "object" }, "description": "The response object." } }, "description": "Model containing the method level model for CompositeService.getConnectors to encode json response from internal NFM-P object model" }, "configureAtomicList": { "title": "configureAtomicList", "required": [ "listClassName", "configInfoList" ], "type": "object", "properties": { "listClassName": { "type": "string", "description": "Classname of the atomic list to configure." }, "configInfoList": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" }, "description": "List of configInfo." } }, "description": "Model containing the method level model for ProcessingBase.configureAtomicList to decode json data to internal NFM-P object model" }, "retrievePppSessions": { "title": "retrievePppSessions", "required": [ "pppSessionRetrievalStruct", "retrieveManagedRoutes", "retrieveQoSOvr", "retrieveAcclpEncap", "retrieveBgpPeerInfo", "retrieveBgpPeerV6Info" ], "type": "object", "properties": { "aInCircuitId": { "type": "string" }, "aInRemoteId": { "type": "string" }, "pppSessionRetrievalStruct": { "allOf": [ { "$ref": "#/components/schemas/PppSessionRetrievalStruct" }, { "description": "Model containing the method level model for struct PppSessionRetrievalStruct. to decode json data to internal NFM-P object model" } ] }, "retrieveManagedRoutes": { "type": "boolean", "description": "Specifies if Managed Routes should be retrieved,the default is \"true\".The Managed Routes won't be retrieved if Service preferences \"retrieveManagedRoutes\" isfalse. default:true" }, "retrieveQoSOvr": { "type": "boolean", "description": "Specifies if QoS Override should be retrieved,the default is \"true\".The QoS Override won't be retrieved if Service preferences \"retrieveQoSOvr\" is false. default:true" }, "retrieveAcclpEncap": { "type": "boolean", "description": "Specifies if Access Loop Encapsulation should be retrieved,the default is \"true\".The Access Loop Encapsulation won't be retrieved if Service preferences \"retrieveAcclpEncap\" is false. default:true" }, "retrieveBgpPeerInfo": { "type": "boolean", "description": "Specifies if IPv4 BGP Peer Info should be retrieved,the default is \"true\".The BGP Peer Info won't be retrieved if System Preferences \"retrieveBgpPeerInfo\" isfalse. default:true" }, "retrieveBgpPeerV6Info": { "type": "boolean", "description": "Specifies if IPv6 BGP Peer Info should be retrieved,the default is \"true\".The BGP Peer Info won't be retrieved if System Preferences \"retrieveBgpPeerV6Info\" isfalse. default:true" } }, "description": "Model containing the method level model for PPPSession.retrievePppSessions to decode json data to internal NFM-P object model" }, "findPolicyDistributeGroupsResponse": { "title": "findPolicyDistributeGroupsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for PolicyDistributeGroupManager.findPolicyDistributeGroups to encode json response from internal NFM-P object model" }, "createEthernetTunnelEndpointResponse": { "title": "createEthernetTunnelEndpointResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for EthernetTunnel.createEthernetTunnelEndpoint to encode json response from internal NFM-P object model" }, "clearSubscriberHostDhcp6LeaseStateResponse": { "title": "clearSubscriberHostDhcp6LeaseStateResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for ResidentialSubscriberInstance.clearSubscriberHostDhcp6LeaseState to encode json response from internal NFM-P object model" }, "purgeStaleEntriesOnHsmResponse": { "title": "purgeStaleEntriesOnHsmResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for HSMConfig.purgeStaleEntriesOnHsm to encode json response from internal NFM-P object model" }, "findApplicableOperationsResponse": { "title": "findApplicableOperationsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for GNESoftwareFolderDescriptor.findApplicableOperations to encode json response from internal NFM-P object model" }, "configureMultipleInstancesResponse": { "title": "configureMultipleInstancesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for RoutingInstanceSite.configureMultipleInstances to encode json response from internal NFM-P object model" }, "retrieveVRtrChannels": { "title": "retrieveVRtrChannels", "required": [ "timeout", "filter" ], "type": "object", "properties": { "aInRtrId": { "type": "string" }, "aInVRtrId": { "type": "integer", "format": "int64" }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns.", "format": "int64" }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for IngrPathMgmtOperationalChannelSvc.retrieveVRtrChannels to decode json data to internal NFM-P object model" }, "createTransitService": { "title": "createTransitService", "type": "object", "properties": { "aInCustomerFdn": { "type": "string" }, "aInDataServiceOuterEncap": { "type": "integer", "format": "int32" }, "aInDataServiceInnerEncap": { "type": "integer", "format": "int32" }, "aInControlServiceTemplateFdn": { "type": "string" } }, "description": "Model containing the method level model for Ring.createTransitService to decode json data to internal NFM-P object model" }, "findNumberOfAssociationResponse": { "title": "findNumberOfAssociationResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int32" } }, "description": "Model containing the method level model for ProxyArpNdMacList.findNumberOfAssociation to encode json response from internal NFM-P object model" }, "findServiceReadyCtpsPerNode": { "title": "findServiceReadyCtpsPerNode", "required": [ "nodeId", "ctpFilter", "serviceType" ], "type": "object", "properties": { "nodeId": { "type": "string" }, "ctpFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "serviceType": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for PhysicalInterfaceCtp.findServiceReadyCtpsPerNode to decode json data to internal NFM-P object model" }, "distributeV2Response": { "title": "distributeV2Response", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for PolicyDefinition.distributeV2 to encode json response from internal NFM-P object model" }, "findPathWithJoin": { "title": "findPathWithJoin", "required": [ "filter", "fields", "sortFields", "pageNumber", "pageSize" ], "type": "object", "properties": { "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "fields": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Fields to fetch" }, "sortFields": { "type": "array", "items": { "type": "string" }, "description": "Sorting fields" }, "pageNumber": { "type": "integer", "description": "Page number", "format": "int32" }, "pageSize": { "type": "integer", "description": "The number of entries to return", "format": "int32" } }, "description": "Model containing the method level model for LspPathOptimizationPolicy.findPathWithJoin to decode json data to internal NFM-P object model" }, "createSpokeConnectorResponse": { "title": "createSpokeConnectorResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for CompositeService.createSpokeConnector to encode json response from internal NFM-P object model" }, "findCustomPortsResponse": { "title": "findCustomPortsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for OpticalPortSpecifics.findCustomPorts to encode json response from internal NFM-P object model" }, "updateUserObjectLifecycleStates": { "title": "updateUserObjectLifecycleStates", "required": [ "distinguishedName", "anInOLCState" ], "type": "object", "properties": { "distinguishedName": { "type": "string", "description": "Distinguished Name of object being configured." }, "anInOLCState": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for GenericObject.updateUserObjectLifecycleStates to decode json data to internal NFM-P object model" }, "requestClearMsapsResponse": { "title": "requestClearMsapsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for Policy.requestClearMsaps to encode json response from internal NFM-P object model" }, "retrieveWlanGwBd": { "title": "retrieveWlanGwBd", "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInTimeout": { "type": "integer", "format": "int64" }, "aInBridgeId": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for WlanGwBridgeDomain.retrieveWlanGwBd to decode json data to internal NFM-P object model" }, "findByIpAddressFilterResponse": { "title": "findByIpAddressFilterResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/VirtualInterfaceInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for VirtualInterface.findByIpAddressFilter to encode json response from internal NFM-P object model" }, "NetworkElementInfo": { "title": "NetworkElementInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "gnbDuId": { "type": "integer", "format": "int64" }, "svlanStatsAdminState": { "type": "integer", "format": "int32" }, "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "administrativeState": { "type": "integer", "format": "int32" }, "mgmtIpAddrType": { "type": "integer", "format": "int32" }, "ipAddress": { "type": "string" }, "systemAddressType": { "type": "integer", "format": "int32" }, "systemAddress": { "type": "string" }, "mprSiteName": { "type": "string" }, "outOfBandAddress": { "type": "string" }, "chassisMgmtEthRed": { "type": "integer", "format": "int32" }, "chassisMgmtEthRedRevertTime": { "type": "integer", "format": "int32" }, "inBandSystemAddress": { "type": "string" }, "inBandL3ManagementIfAddrType": { "type": "integer", "format": "int32" }, "inBandL3ManagementIf": { "type": "string" }, "isL3MgmtItfEnabled": { "type": "boolean", "default": false }, "location": { "type": "string" }, "resyncState": { "type": "integer", "format": "int32" }, "resyncRecoverOnStartup": { "type": "integer", "format": "int32" }, "sysMgmtIfWriteMode": { "type": "integer", "format": "int32" }, "primaryRoutePreference": { "type": "integer", "format": "int32" }, "secondaryRoutePreference": { "type": "integer", "format": "int32" }, "activeManagementIp": { "type": "integer", "format": "int32" }, "isMgmtIpAutoRevertive": { "type": "boolean", "default": false }, "mgmtIpRule": { "type": "integer", "format": "int32" }, "snmpStreamEnable": { "type": "boolean", "default": false }, "productType": { "type": "integer", "format": "int32" }, "versionType": { "type": "integer", "format": "int32" }, "redundantSynchronizationMode": { "type": "integer", "format": "int32" }, "persistentSnmpIndices": { "type": "integer", "format": "int32" }, "l4LoadBalancing": { "type": "boolean", "default": false }, "lsrIpLoadBalancing": { "type": "integer", "format": "int32" }, "ipLoadBalancing": { "type": "integer", "format": "int32" }, "ecmpLoadBalancingHashPoly": { "type": "integer", "format": "int32" }, "lagLoadBalancingHashPoly": { "type": "integer", "format": "int32" }, "atmOamLoopbackLocationId": { "type": "string" }, "atmOamLoopbackPeriod": { "type": "integer", "format": "int32" }, "atmOamRetryUp": { "type": "integer", "format": "int32" }, "atmOamRetryDown": { "type": "integer", "format": "int32" }, "isGenericNode": { "type": "boolean", "default": false }, "vplsServiceMode": { "type": "integer", "format": "int32" }, "sbiPrimaryDnsAddrType": { "type": "integer", "format": "int32" }, "sbiPrimaryDns": { "type": "string" }, "sbiSecondaryDnsAddrType": { "type": "integer", "format": "int32" }, "sbiSecondaryDns": { "type": "string" }, "sbiTertiaryDnsAddrType": { "type": "integer", "format": "int32" }, "sbiTertiaryDns": { "type": "string" }, "sbiDnsDomain": { "type": "string" }, "liSeparateAdmin": { "type": "integer", "format": "int32" }, "liLocalSaveAdmin": { "type": "integer", "format": "int32" }, "elementManagerUrl": { "type": "string" }, "ltmtCrossLaunchAddressType": { "type": "integer", "format": "int32" }, "ltmtCrossLaunchAddress": { "type": "string" }, "elementManagerCmd": { "type": "string" }, "externalEms": { "type": "string" }, "eventNotificationPolicyPointer": { "type": "string" }, "equipmentPointer": { "type": "string" }, "softwareUpgradeTransitionStatesPointer": { "type": "string" }, "mrbtsSoftwareUpgradeTransitionStatesPointer": { "type": "string" }, "resourceGroupId": { "type": "integer", "format": "int32" }, "latitudeInDegrees": { "type": "number" }, "longitudeInDegrees": { "type": "number" }, "physicalImpedance": { "type": "integer", "format": "int32" }, "inFlowClassificationMode": { "type": "integer", "format": "int32" }, "inFlowRowStatus": { "type": "integer", "format": "int32" }, "pbbSrcBVplsMacAddr": { "type": "string" }, "pbbLeafSrcBVplsMacAddr": { "type": "string" }, "macNotifInterval": { "type": "integer", "format": "int32" }, "macNotifCount": { "type": "integer", "format": "int32" }, "vendorSpecificIcmpExtensions": { "type": "integer", "format": "int32" }, "customProperty1": { "type": "string" }, "customProperty2": { "type": "string" }, "customProperty3": { "type": "string" }, "mhfCreation": { "type": "integer", "format": "int32" }, "mhfIdPermission": { "type": "integer", "format": "int32" }, "maintDomainLevel": { "type": "integer", "format": "int32" }, "mipLtrPriority": { "type": "integer", "format": "int32" }, "enableDmmVersionInterOp": { "type": "boolean", "default": false }, "feederPort": { "type": "string" }, "qinqUntaggedSap": { "type": "boolean", "default": false }, "alarmAdminStatus": { "type": "integer", "format": "int32" }, "maxClearedAlarms": { "type": "integer", "format": "int32" }, "radiusCoAPort": { "type": "integer", "format": "int32" }, "accessIngressAggrRate": { "type": "integer", "format": "int32" }, "networkIngressAggrRate": { "type": "integer", "format": "int32" }, "systemIngressUnshapedSapCir": { "type": "integer", "format": "int32" }, "isVirtualNoServicePort": { "type": "boolean", "default": false }, "noServicePort": { "type": "string" }, "virtualNoServicePort": { "type": "string" }, "isVirtualMirrorPort": { "type": "boolean", "default": false }, "mirrorPort": { "type": "string" }, "virtualMirrorPort": { "type": "string" }, "isVirtualTestHeadPort": { "type": "boolean", "default": false }, "testHeadPort": { "type": "string" }, "virtualTestHeadPort": { "type": "string" }, "isVirtualP2mpBudPort": { "type": "boolean", "default": false }, "p2mpBudPort": { "type": "string" }, "virtualP2mpBudPort": { "type": "string" }, "isMacSwapPortAssigned": { "type": "boolean", "default": false }, "sysBfdFlapInterval": { "type": "integer", "format": "int32" }, "mpBwObjectPointer": { "type": "string" }, "todPpsMessageType": { "type": "integer", "format": "int32" }, "todPpsOutput": { "type": "integer", "format": "int32" }, "locationId": { "type": "integer", "format": "int32" }, "subLocationId": { "type": "integer", "format": "int32" }, "ntpStatus": { "type": "integer", "format": "int32" }, "useWredSlopes": { "type": "integer", "format": "int32" }, "mcEnhLoadBal": { "type": "integer", "format": "int32" }, "natDetScriptLocation": { "type": "string" }, "isAOSStackable": { "type": "boolean", "default": false }, "subSysNextHopLimit": { "type": "integer", "format": "int64" }, "svcIdLagHashing": { "type": "integer", "format": "int32" }, "consoleAlarmInput": { "type": "boolean", "default": false }, "secActiveSessionHiWtrMrk": { "type": "integer", "format": "int64" }, "secActiveSessionLoWtrMrk": { "type": "integer", "format": "int64" }, "commandMode": { "type": "integer", "format": "int32" }, "dhcp6AdvertiseMessage": { "type": "integer", "format": "int64" }, "svcBgpAutoRDEnabled": { "type": "boolean", "default": false }, "svcBgpAutoRDType1IpAddrType": { "type": "integer", "format": "int32" }, "svcBgpAutoRDType1IpAddr": { "type": "string" }, "svcBgpAutoRDType1CommValStart": { "type": "integer", "format": "int64" }, "svcBgpAutoRDType1CommValEnd": { "type": "integer", "format": "int64" }, "systemSptAggrRate": { "type": "integer", "format": "int64" }, "enableFips1402": { "type": "boolean", "default": false }, "l2tpNonMcTunnelStart": { "type": "integer", "format": "int64" }, "l2tpNonMcTunnelEnd": { "type": "integer", "format": "int64" }, "oesCfCache": { "type": "integer", "format": "int32" }, "sysDynamicIP": { "type": "string" }, "markerSrcMacAddr": { "type": "string" }, "selectiveFIB": { "type": "boolean", "default": false }, "enforceUniqueIfIndex": { "type": "boolean", "default": false }, "extChassisAccess": { "type": "boolean", "default": false }, "virtualRouterName": { "type": "string" }, "oesCtlCommsAddressType": { "type": "integer", "format": "int32" }, "oesCtlCommsAddress": { "type": "string" }, "oesCtlCommsTimeout": { "type": "integer", "format": "int32" }, "oesCtlCommsRetryLimit": { "type": "integer", "format": "int32" }, "swReposPointer": { "type": "string" }, "fpeSdpIdRngStart": { "type": "integer", "format": "int64" }, "fpeSdpIdRngEnd": { "type": "integer", "format": "int64" }, "equipmentHWPointer": { "type": "string" }, "contact": { "type": "string" }, "sysName": { "type": "string" }, "supportsNge": { "type": "boolean", "default": false }, "currentServingOms": { "type": "string" }, "nrbtsId": { "type": "integer", "format": "int64" }, "associatedPeerNodePointer": { "type": "string" }, "geoSitePointer": { "type": "string" }, "svcSysFdbTableSize": { "type": "integer", "format": "int64" }, "allowQinQEncapNwIf": { "type": "boolean", "default": false }, "sbiSystemProfile": { "type": "integer", "format": "int32" }, "encryptConfig": { "type": "boolean", "default": false }, "encryptionKey": { "type": "string" }, "password": { "type": "string" }, "routerTargetAsNumber": { "type": "integer", "format": "int64" }, "mdAutoIdQoSRangeStart": { "type": "integer", "format": "int64" }, "mdAutoIdQoSRangeEnd": { "type": "integer", "format": "int64" }, "mdAutoIdFltrRangeStart": { "type": "integer", "format": "int64" }, "mdAutoIdFltrRangeEnd": { "type": "integer", "format": "int64" }, "vcStackMacAddress": { "type": "string" }, "svcChainMacPrefix": { "type": "string" }, "svcSysVpnGreSrcIpAddrType": { "type": "integer", "format": "int32" }, "svcSysVpnGreSrcIpAddr": { "type": "string" }, "vcStackNumMacAddresses": { "type": "integer", "format": "int32" }, "l2tpLoadBalancing": { "type": "integer", "format": "int32" }, "cpmOptimizedMode": { "type": "integer", "format": "int32" }, "mplsTunnelMode": { "type": "integer", "format": "int32" }, "allowCpuFragmentation": { "type": "boolean", "default": false }, "allowIcmpRedirect": { "type": "boolean", "default": false }, "mplsLabelStackStatsCount": { "type": "integer", "format": "int32" }, "forwardIpOverIpv6": { "type": "boolean", "default": false }, "forwardIpOverGre": { "type": "boolean", "default": false }, "generateDiscoveryTraps": { "type": "boolean", "default": false }, "ospfDynamicHostnames": { "type": "boolean", "default": false }, "fpCamAllocAdminV6Multicast": { "type": "integer", "format": "int64" }, "sysSwFabSfmLossThresh": { "type": "integer", "format": "int32" }, "ftpFileTransfer": { "type": "boolean", "default": false }, "scpFileTransfer": { "type": "boolean", "default": false }, "ipv6ExtensionHeader": { "type": "integer", "format": "int32" }, "packetByteOffsetQoS": { "type": "boolean", "default": false }, "vplsHighAdminState": { "type": "integer", "format": "int32" }, "wredAdminState": { "type": "boolean", "default": false }, "colorClassification": { "type": "integer", "format": "int32" }, "overrides": { "type": "object", "additionalProperties": { "type": "string" } }, "lockOlcState": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for Interface NetworkElementInfo. to decode json data to internal NFM-P object model" }, "requestClearCallTraceIpoeTraceResponse": { "title": "requestClearCallTraceIpoeTraceResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for CallTraceConfig.requestClearCallTraceIpoeTrace to encode json response from internal NFM-P object model" }, "nextHopExtResponse": { "title": "nextHopExtResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ShortestPathGraph" }, "description": "The response object." } }, "description": "Model containing the method level model for TopologyManager.nextHopExt to encode json response from internal NFM-P object model" }, "getHistoryBuffer": { "title": "getHistoryBuffer", "required": [ "supervisionGroupName", "startTime" ], "type": "object", "properties": { "supervisionGroupName": { "type": "string", "description": "If null, the history of all supervision groupsin the summary view is returned." }, "startTime": { "type": "integer", "description": "If not null, return history of all monitoredgroups starting in the specified time.", "format": "int64" } }, "description": "Model containing the method level model for SupervisionGroup.getHistoryBuffer to decode json data to internal NFM-P object model" }, "isConnectionReversedResponse": { "title": "isConnectionReversedResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "boolean", "description": "The response object." } }, "description": "Model containing the method level model for PointToPointConnection.isConnectionReversed to encode json response from internal NFM-P object model" }, "getDependencyResponse": { "title": "getDependencyResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for Policy.getDependency to encode json response from internal NFM-P object model" }, "createDataServicePathSearchResponse": { "title": "createDataServicePathSearchResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for Ring.createDataServicePathSearch to encode json response from internal NFM-P object model" }, "ServiceSiteStruct": { "title": "ServiceSiteStruct", "required": [ "objectClassName", "service", "siteList" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "service": { "allOf": [ { "$ref": "#/components/schemas/ServiceUnion" }, { "description": "Model containing the method level model for struct ServiceUnion. to decode json data to internal NFM-P object model" } ] }, "siteList": { "type": "array", "items": { "$ref": "#/components/schemas/SiteUnion" }, "description": "" } }, "description": "Model containing the method level model for struct ServiceSiteStruct. to decode json data to internal NFM-P object model" }, "setDistributionModeToSyncWithGlobalResponse": { "title": "setDistributionModeToSyncWithGlobalResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int32" } }, "description": "Model containing the method level model for PolicyDefinition.setDistributionModeToSyncWithGlobal to encode json response from internal NFM-P object model" }, "defineFibEntries": { "title": "defineFibEntries", "required": [ "configs", "removeFilter", "shouldComplete" ], "type": "object", "properties": { "configs": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" }, "description": "" }, "removeFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "shouldComplete": { "type": "boolean" } }, "description": "Model containing the method level model for FibEntry.defineFibEntries to decode json data to internal NFM-P object model" }, "NavigateToOppositeObj": { "title": "NavigateToOppositeObj", "required": [ "filter" ], "type": "object", "properties": { "ObjectName": { "type": "string" }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for ServiceManager.NavigateToOppositeObj to decode json data to internal NFM-P object model" }, "setGwtsAdminState": { "title": "setGwtsAdminState", "required": [ "siteId", "gwtsName", "adminState" ], "type": "object", "properties": { "siteId": { "type": "string" }, "gwtsName": { "type": "string" }, "adminState": { "type": "string" }, "clientId": { "type": "string", "description": "Non documentable API" } }, "description": "Model containing the method level model for CMMInstance.setGwtsAdminState to decode json data to internal NFM-P object model" }, "triggerResync": { "title": "triggerResync", "required": [ "instanceName", "resyncSelf", "resyncChildren" ], "type": "object", "properties": { "instanceName": { "type": "string", "description": "The name of the instance to be resynched." }, "resyncSelf": { "type": "boolean", "description": "Specifies if the object has to be resynched." }, "resyncChildren": { "type": "boolean", "description": "Specifies if children need to be resynched." } }, "description": "Model containing the method level model for GenericObject.triggerResync to decode json data to internal NFM-P object model" }, "retrieveDynSvcDataTriggers": { "title": "retrieveDynSvcDataTriggers", "required": [ "retrieveDynSvcDataTriggersStruct", "timeout" ], "type": "object", "properties": { "retrieveDynSvcDataTriggersStruct": { "allOf": [ { "$ref": "#/components/schemas/RetrieveDynSvcDataTriggersStruct" }, { "description": "Model containing the method level model for struct RetrieveDynSvcDataTriggersStruct. to decode json data to internal NFM-P object model" } ] }, "timeout": { "type": "integer", "description": "(Optional) The number of milliseconds to wait beforereceiving the results. If the results are notreceived in the given time, the method returns. default:0", "format": "int64" } }, "description": "Model containing the method level model for DynSvcDataTrigger.retrieveDynSvcDataTriggers to decode json data to internal NFM-P object model" }, "findEntitiesForOcsAlarmProfileResponse": { "title": "findEntitiesForOcsAlarmProfileResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for OcsAlarmProfile.findEntitiesForOcsAlarmProfile to encode json response from internal NFM-P object model" }, "GroupEntriesStruct": { "title": "GroupEntriesStruct", "required": [ "objectClassName", "filterType", "applicationType", "entryLocation", "siteId", "filterId" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "filterType": { "type": "string" }, "applicationType": { "type": "string" }, "entryLocation": { "type": "string" }, "siteId": { "type": "string" }, "filterId": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct GroupEntriesStruct. to decode json data to internal NFM-P object model" }, "ImportStruct": { "title": "ImportStruct", "required": [ "objectClassName", "importFrom", "importPaths", "igpProtocols", "isIsLevel", "objectPtr", "fromMonitoredIps", "fromLsps" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "importFrom": { "type": "string" }, "importPaths": { "type": "array", "items": { "type": "string" }, "description": "" }, "igpProtocols": { "type": "array", "items": { "type": "string" }, "description": "" }, "isIsLevel": { "type": "string" }, "objectPtr": { "type": "string" }, "fromMonitoredIps": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "fromLsps": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" } }, "description": "Model containing the method level model for struct ImportStruct. to decode json data to internal NFM-P object model" }, "findBaseCardsWithIsabbResponse": { "title": "findBaseCardsWithIsabbResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CardInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for WlanGwIsaGroup.findBaseCardsWithIsabb to encode json response from internal NFM-P object model" }, "findReferencedSapsResponse": { "title": "findReferencedSapsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for MultiChassisRingNode.findReferencedSaps to encode json response from internal NFM-P object model" }, "startPollingWithResultResponse": { "title": "startPollingWithResultResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for RANRadioMeasureManager.startPollingWithResult to encode json response from internal NFM-P object model" }, "searchMonitoredObjectResponse": { "title": "searchMonitoredObjectResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for SupervisionManager.searchMonitoredObject to encode json response from internal NFM-P object model" }, "SonetChannelInfo": { "title": "SonetChannelInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "administrativeState": { "type": "integer", "format": "int32" }, "oesShelfId": { "type": "integer", "format": "int32" }, "phyShelfClass": { "type": "integer", "format": "int32" }, "phyShelfType": { "type": "integer", "format": "int32" }, "lockOlcState": { "type": "boolean", "default": false }, "portId": { "type": "integer", "format": "int64" }, "description": { "type": "string" }, "mode": { "type": "integer", "format": "int32" }, "isl2UplinkMode": { "type": "boolean", "default": false }, "macAddress": { "type": "string" }, "encapType": { "type": "integer", "format": "int32" }, "holdTimeUp": { "type": "integer", "format": "int32" }, "holdTimeDown": { "type": "integer", "format": "int32" }, "mtuValue": { "type": "integer", "format": "int32" }, "speed": { "type": "integer", "format": "int32" }, "accountingPolicyObjectPointer": { "type": "string" }, "collectStats": { "type": "boolean", "default": false }, "etherAccountingPolicyObjectPointer": { "type": "string" }, "etherCollectStats": { "type": "boolean", "default": false }, "ethAccessAccountingPolicyObjectPointer": { "type": "string" }, "ethAccessCollectStats": { "type": "boolean", "default": false }, "networkQueueObjectPointer": { "type": "string" }, "loadBalanceAlgorithm": { "type": "integer", "format": "int32" }, "portSchedulerPolicyObjectPointer": { "type": "string" }, "portEgrHsmdaSchedulerPolicy": { "type": "string" }, "uniProfilePointer": { "type": "string" }, "portIngrNamedPoolPlcy": { "type": "string" }, "portEgrNamedPoolPlcy": { "type": "string" }, "portIngrPoolPercentageRate": { "type": "integer", "format": "int32" }, "portEgrPoolPercentageRate": { "type": "integer", "format": "int32" }, "vlanAutoBind": { "type": "boolean", "default": false }, "l2ProfilePointer": { "type": "string" }, "holdTimeUnits": { "type": "integer", "format": "int32" }, "linkTrap": { "type": "integer", "format": "int32" }, "userLabel": { "type": "string" }, "mptCombinerImplemented": { "type": "integer", "format": "int64" }, "numOfDot1qSapUsingVCP": { "type": "integer", "format": "int32" }, "isVCPUpdatedForDot1qSap": { "type": "boolean", "default": false }, "isVCPSapPort": { "type": "boolean", "default": false }, "unpPortType": { "type": "integer", "format": "int32" }, "portChannelType": { "type": "integer", "format": "int32" }, "displayedLocalChannelId": { "type": "string" }, "nodeCardinality": { "type": "integer", "format": "int32" }, "payloadType": { "type": "integer", "format": "int32" }, "scramble": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for Interface SonetChannelInfo. to decode json data to internal NFM-P object model" }, "ClearDynSvcDataTriggerStruct": { "title": "ClearDynSvcDataTriggerStruct", "required": [ "objectClassName", "siteId", "sapId" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "sapId": { "type": "string" } }, "description": "Model containing the method level model for struct ClearDynSvcDataTriggerStruct. to decode json data to internal NFM-P object model" }, "findLocalAddressResponse": { "title": "findLocalAddressResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for VirtualAnyCastRP.findLocalAddress to encode json response from internal NFM-P object model" }, "executeScriptResponse": { "title": "executeScriptResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for ScriptManager.executeScript to encode json response from internal NFM-P object model" }, "pushDownPeerSyncSymmetricalConfig": { "title": "pushDownPeerSyncSymmetricalConfig", "required": [ "distinguishedName", "configInfo" ], "type": "object", "properties": { "distinguishedName": { "type": "string", "description": "Distinguished Name of object being configured." }, "configInfo": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" }, { "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for AbstractMultiChassisPeer.pushDownPeerSyncSymmetricalConfig to decode json data to internal NFM-P object model" }, "getCorrelatedAlarmsForOfnResponse": { "title": "getCorrelatedAlarmsForOfnResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AlarmInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for FaultManager.getCorrelatedAlarmsForOfn to encode json response from internal NFM-P object model" }, "preFixProblemResponse": { "title": "preFixProblemResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/PreFixData" }, { "description": "Model containing the method level model for struct PreFixData. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for RcaManager.preFixProblem to encode json response from internal NFM-P object model" }, "BasicKPIs": { "title": "BasicKPIs", "required": [ "objectClassName", "numberOfAcknowledgedAlarms", "numberOfNewAcknowledgedAlarms", "numberOfUnacknowledgedAlarms", "numberOfNewUnacknowledgedAlarms", "numberOfFailedObjects", "numberOfNewFailedObjects", "numberOfFailedOamTests", "numberOfNewFailedOamTests", "numberOfObjects", "numberOfUnacknowledgedCriticalAlarms" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "numberOfAcknowledgedAlarms": { "type": "integer", "format": "int32" }, "numberOfNewAcknowledgedAlarms": { "type": "integer", "format": "int32" }, "numberOfUnacknowledgedAlarms": { "type": "integer", "format": "int32" }, "numberOfNewUnacknowledgedAlarms": { "type": "integer", "format": "int32" }, "numberOfFailedObjects": { "type": "integer", "format": "int32" }, "numberOfNewFailedObjects": { "type": "integer", "format": "int32" }, "numberOfFailedOamTests": { "type": "integer", "format": "int32" }, "numberOfNewFailedOamTests": { "type": "integer", "format": "int32" }, "numberOfObjects": { "type": "integer", "format": "int32" }, "numberOfUnacknowledgedCriticalAlarms": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for struct BasicKPIs. to decode json data to internal NFM-P object model" }, "retrieveL2AwareNatSubscriberPoliciesResponse": { "title": "retrieveL2AwareNatSubscriberPoliciesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for L2AwareNatSubscriberPolicies.retrieveL2AwareNatSubscriberPolicies to encode json response from internal NFM-P object model" }, "Path": { "title": "Path", "required": [ "displayedName", "application", "connectionId", "operationalState", "administrativeState", "domain", "fromCtp", "fromNodeId", "fromNodeName", "toCtp", "toNodeId", "toNodeName", "pathId", "description", "sourceNodeIdAddrType", "sourceNodeId", "sourceNodeMisconfigured", "destinationNodeIdAddrType", "destinationNodeId", "destinationNodeMisconfigured", "pathMtu", "actualPathMtu", "loadFactor", "forwardingClasses", "type", "numberOfHops", "actualNumberOfHops", "numberOfTunnels", "actualNumberOfTunnels", "destinationIpAddress", "tunnelId", "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties" ], "type": "object", "properties": { "displayedName": { "type": "string", "description": "252]", "example": " maximum: 252" }, "application": { "type": "integer", "format": "int32", "readOnly": true }, "connectionId": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "operationalState": { "type": "integer", "format": "int32", "readOnly": true }, "administrativeState": { "type": "integer", "format": "int32" }, "domain": { "type": "integer", "format": "int32", "readOnly": true }, "fromCtp": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "fromNodeId": { "type": "string", "description": "50]", "readOnly": true, "example": " maximum: 50" }, "fromNodeName": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "toCtp": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "toNodeId": { "type": "string", "description": "50]", "readOnly": true, "example": " maximum: 50" }, "toNodeName": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "pathId": { "type": "integer", "format": "int64" }, "description": { "type": "string", "description": "500]", "example": " maximum: 500" }, "sourceNodeIdAddrType": { "type": "integer", "format": "int32", "readOnly": true }, "sourceNodeId": { "type": "string" }, "sourceNodeMisconfigured": { "type": "boolean", "readOnly": true }, "destinationNodeIdAddrType": { "type": "integer", "format": "int32", "readOnly": true }, "destinationNodeId": { "type": "string" }, "destinationNodeMisconfigured": { "type": "boolean", "readOnly": true }, "pathMtu": { "type": "integer", "description": "[0,9194]", "format": "int32" }, "actualPathMtu": { "type": "integer", "format": "int32", "readOnly": true }, "loadFactor": { "type": "number", "readOnly": true }, "forwardingClasses": { "type": "integer", "format": "int64" }, "type": { "type": "integer", "format": "int32", "readOnly": true }, "numberOfHops": { "type": "integer", "format": "int32", "readOnly": true }, "actualNumberOfHops": { "type": "integer", "format": "int32", "readOnly": true }, "numberOfTunnels": { "type": "integer", "format": "int32", "readOnly": true }, "actualNumberOfTunnels": { "type": "integer", "format": "int32", "readOnly": true }, "destinationIpAddress": { "type": "string", "description": "50]", "readOnly": true, "example": " maximum: 50" }, "tunnelId": { "type": "integer", "format": "int64", "readOnly": true }, "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "actionMask": { "type": "integer", "format": "int32" }, "selfAlarmed": { "type": "boolean", "default": false }, "name": { "type": "string" } }, "description": "Managed object abstract class" }, "findFlexiNodesResponse": { "title": "findFlexiNodesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for FlexiPMPolicy.findFlexiNodes to encode json response from internal NFM-P object model" }, "extShelfScheduleUpgrade": { "title": "extShelfScheduleUpgrade", "required": [ "schedule", "extShelves" ], "type": "object", "properties": { "schedule": { "type": "string" }, "extShelves": { "type": "array", "items": { "$ref": "#/components/schemas/ExtensionShelfUpgradeManagerInfo" }, "description": "" } }, "description": "Model containing the method level model for SoftwareFolderDescriptor.extShelfScheduleUpgrade to decode json data to internal NFM-P object model" }, "clearCcrtReplayStatisticsResponse": { "title": "clearCcrtReplayStatisticsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for DiameterAppPolicy.clearCcrtReplayStatistics to encode json response from internal NFM-P object model" }, "executeScriptFlowResponse": { "title": "executeScriptFlowResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/ScriptFlowExecutionResult" }, { "description": "Model containing the method level model for struct ScriptFlowExecutionResult. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for ScriptManager.executeScriptFlow to encode json response from internal NFM-P object model" }, "getChannelUsageListResponse": { "title": "getChannelUsageListResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for OpticalLink.getChannelUsageList to encode json response from internal NFM-P object model" }, "executeCLITargetScript": { "title": "executeCLITargetScript", "required": [ "isSynchronized", "clientId", "configInfo" ], "type": "object", "properties": { "isSynchronized": { "type": "boolean", "description": "Identifies if the call to execute the script should wait until the script has been executed. True to wait, false otherwise." }, "clientId": { "type": "string", "description": "Identifies the client ID that is requesting the execution (used for sending an event to the specific client when execution is complete)." }, "configInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" }, "description": "The configuration info for the targets when executing (runtime parameters)." } }, "description": "Model containing the method level model for TargetScript.executeCLITargetScript to decode json data to internal NFM-P object model" }, "nextHopExt": { "title": "nextHopExt", "required": [ "igpAdminDomain", "protocols", "sources", "destType", "dest", "destLen" ], "type": "object", "properties": { "igpAdminDomain": { "type": "string", "description": "The IGP Admin Domain ({{topology.AutonomousSystem}}) to perform the next hop query in." }, "protocols": { "type": "array", "items": { "type": "string" }, "description": "The set of protocols to consider." }, "sources": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/SourceParam" }, "description": "The set of source routers from which to calculate the nexthop." }, "destType": { "type": "string", "description": "The address type of the destination. Currently only ipv4 issupported." }, "dest": { "type": "string", "description": "The destination address of the managed route. The format ofthe destination is based on the destType property." }, "destLen": { "type": "integer", "description": "The length of the destination address. Its valid valuesdepend on the destType.", "format": "int32" } }, "description": "Model containing the method level model for TopologyManager.nextHopExt to decode json data to internal NFM-P object model" }, "ClearDhcpStickyLeasesStruct": { "title": "ClearDhcpStickyLeasesStruct", "required": [ "objectClassName", "siteId", "serviceId", "dhcpSvrName", "hostName", "hostNamePrefix" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "serviceId": { "type": "integer", "format": "int64" }, "dhcpSvrName": { "type": "string" }, "hostName": { "type": "string", "description": "default: yes:" }, "hostNamePrefix": { "type": "string", "description": "default: yes:" } }, "description": "Model containing the method level model for struct ClearDhcpStickyLeasesStruct. to decode json data to internal NFM-P object model" }, "MldHostBaseInfoStruct": { "title": "MldHostBaseInfoStruct", "required": [ "objectClassName", "ipAddressType", "siteId", "routerId", "ipAddress", "macAddress", "sessionId", "serviceId" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "ipAddressType": { "type": "string" }, "siteId": { "type": "string" }, "routerId": { "type": "integer", "format": "int64" }, "ipAddress": { "type": "string" }, "macAddress": { "type": "string" }, "sessionId": { "type": "integer", "format": "int64" }, "serviceId": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct MldHostBaseInfoStruct. to decode json data to internal NFM-P object model" }, "cancelExecutionResponse": { "title": "cancelExecutionResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for ScriptManager.cancelExecution to encode json response from internal NFM-P object model" }, "findNetworkElementsInGroupResponse": { "title": "findNetworkElementsInGroupResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkElementInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for Group.findNetworkElementsInGroup to encode json response from internal NFM-P object model" }, "findNEsResponse": { "title": "findNEsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for StatsPollerPolicy.findNEs to encode json response from internal NFM-P object model" }, "updateUserObjectLifecycleStatesAndLocks": { "title": "updateUserObjectLifecycleStatesAndLocks", "required": [ "distinguishedName", "anInOLCState", "anInLockOLCState" ], "type": "object", "properties": { "distinguishedName": { "type": "string", "description": "Distinguished Name of object being configured." }, "anInOLCState": { "type": "integer", "description": "The target OLC State.", "format": "int32" }, "anInLockOLCState": { "type": "boolean", "description": "The target Lock OLC State." } }, "description": "Model containing the method level model for GenericObject.updateUserObjectLifecycleStatesAndLocks to decode json data to internal NFM-P object model" }, "validateSession": { "title": "validateSession", "required": [ "sessionFdn", "areEngineeringChecksToBeExecuted" ], "type": "object", "properties": { "sessionFdn": { "type": "string", "description": "The session to validate." }, "areEngineeringChecksToBeExecuted": { "type": "boolean", "description": "This parameter indicates whether the engineering have to be executed or not" } }, "description": "Model containing the method level model for Session.validateSession to decode json data to internal NFM-P object model" }, "getOpticalPortListResponse": { "title": "getOpticalPortListResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for OpticalPort.getOpticalPortList to encode json response from internal NFM-P object model" }, "countInstance": { "title": "countInstance", "required": [ "fullClassName", "filter" ], "type": "object", "properties": { "fullClassName": { "type": "string", "description": "The full name of the object." }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for GenericObject.countInstance to decode json data to internal NFM-P object model" }, "requestClearOamPmDmmRawStatsResponse": { "title": "requestClearOamPmDmmRawStatsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for CfmDmmSession.requestClearOamPmDmmRawStats to encode json response from internal NFM-P object model" }, "retrieveSubIdStrTimestampResponse": { "title": "retrieveSubIdStrTimestampResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int64" } }, "description": "Model containing the method level model for ClassicLsnHost.retrieveSubIdStrTimestamp to encode json response from internal NFM-P object model" }, "findFilesResponse": { "title": "findFilesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for LogDefinition.findFiles to encode json response from internal NFM-P object model" }, "retrieveL2TPSessionsResponse": { "title": "retrieveL2TPSessionsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for L2TPSession.retrieveL2TPSessions to encode json response from internal NFM-P object model" }, "AlarmHistoryDatabase": { "title": "AlarmHistoryDatabase", "required": [ "maxDailySize", "administrativeState", "logOnChange", "logOnDeletion", "currentPartitionId", "currentPartitionSize", "lastLogTime", "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties" ], "type": "object", "properties": { "maxDailySize": { "type": "integer", "description": "Indicates the maximum number of alarms logged in a single partition.Alarm history objects are kept in 31 partitions.Every 24 hours at midnight UTC or when the number of alarm history objectsin a partition reaches the maxDailySize (whichever comes first),the oldest partition is deleted and a new partition is created for new alarm history objects.", "format": "int64" }, "administrativeState": { "type": "integer", "format": "int32" }, "logOnChange": { "type": "boolean" }, "logOnDeletion": { "type": "boolean" }, "currentPartitionId": { "type": "integer", "description": "Indicates which partition new alarm history object are associated with.", "format": "int32", "readOnly": true }, "currentPartitionSize": { "type": "integer", "description": "Indicates the number of alarm history objects in the current partition.", "format": "int32", "readOnly": true }, "lastLogTime": { "type": "integer", "description": "Indicates the last time an alarm history object was created.", "format": "int64", "readOnly": true }, "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "actionMask": { "type": "integer", "format": "int32" }, "selfAlarmed": { "type": "boolean", "default": false }, "name": { "type": "string" } }, "description": "Managed object abstract class" }, "requestClearMessageBufferResponse": { "title": "requestClearMessageBufferResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for RadiusServerPolicy.requestClearMessageBuffer to encode json response from internal NFM-P object model" }, "retrieveSubscriberHostsResponse": { "title": "retrieveSubscriberHostsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for SubscriberHost.retrieveSubscriberHosts to encode json response from internal NFM-P object model" }, "findCtp": { "title": "findCtp", "required": [ "portObjectPointer", "ctpFilter" ], "type": "object", "properties": { "portObjectPointer": { "type": "string" }, "ctpFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for ConnectionTerminationPoint.findCtp to decode json data to internal NFM-P object model" }, "updateMultipleSubscrHosts": { "title": "updateMultipleSubscrHosts", "required": [ "configs", "timeout" ], "type": "object", "properties": { "configs": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" }, "description": "List of configuration objects with desired values to configure thesubscriber hosts.The configuration objects must also have the subscrIdent, siteId,ipAddressType and ipAddress been set in the config list.The macAddress value should be specified with hyphens as separators between the octets, for example, 00-80-21-AB-CD-EF.For non-pppoe hosts, pppoeSessionId should be set to 0. If you are not using a second site, pleasedo not use the secondSiteId property.If the method is being used to configure multiple hosts then each host must have a separate block withinressubscr.SubscriberHostConfiguration tags." }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns.", "format": "int64" } }, "description": "Model containing the method level model for SubscriberHostConfiguration.updateMultipleSubscrHosts to decode json data to internal NFM-P object model" }, "requestClearOamPmLmmRawStatsResponse": { "title": "requestClearOamPmLmmRawStatsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for CfmLmmSession.requestClearOamPmLmmRawStats to encode json response from internal NFM-P object model" }, "retrieveQualityTimingResponse": { "title": "retrieveQualityTimingResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "description": "The response object." } }, "description": "Model containing the method level model for SiteSync.retrieveQualityTiming to encode json response from internal NFM-P object model" }, "buildHigherRateOdu": { "title": "buildHigherRateOdu", "type": "object", "properties": { "aInLoOduId": { "type": "integer", "format": "int32" }, "aInTimeSlots": { "type": "string" }, "aInRate": { "type": "string" } }, "description": "Model containing the method level model for OdukPtf.buildHigherRateOdu to decode json data to internal NFM-P object model" }, "findMcRingProtectedSapsOnRingResponse": { "title": "findMcRingProtectedSapsOnRingResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for L2AccessInterface.findMcRingProtectedSapsOnRing to encode json response from internal NFM-P object model" }, "syncGroups": { "title": "syncGroups", "type": "object", "properties": { "aInDomainId": { "type": "integer", "format": "int64" }, "aInMCNWId": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for Group.syncGroups to decode json data to internal NFM-P object model" }, "findCtpsForPathEndpoint": { "title": "findCtpsForPathEndpoint", "required": [ "siteIdSet", "ctpFilter" ], "type": "object", "properties": { "siteIdSet": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "ctpFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for PathEndpoint.findCtpsForPathEndpoint to decode json data to internal NFM-P object model" }, "findSlaProfileStringSuggestionsResponse": { "title": "findSlaProfileStringSuggestionsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for SubscriberHost.findSlaProfileStringSuggestions to encode json response from internal NFM-P object model" }, "updateReadyForDownload": { "title": "updateReadyForDownload", "type": "object", "properties": { "aInReadyToDownloadImages": { "type": "string" }, "aInSet": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for OpticalNeProperties.updateReadyForDownload to decode json data to internal NFM-P object model" }, "getFlowsResponse": { "title": "getFlowsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "object" }, "description": "The response object." } }, "description": "Model containing the method level model for DataCenter.getFlows to encode json response from internal NFM-P object model" }, "retrieveResidentialSubscriber": { "title": "retrieveResidentialSubscriber", "required": [ "subscrIdent", "siteId", "timeout", "shallowRetrieval" ], "type": "object", "properties": { "subscrIdent": { "type": "string", "description": "Unique identification of subscriber instance." }, "siteId": { "type": "string", "description": "The site ID of the NE to query." }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait before receiving the results. If no results arereceived in the given time, the method returns. default:0", "format": "int64" }, "shallowRetrieval": { "type": "boolean", "description": "If it is true, not all of the properties are retrieved for quick responseThis is an optional input parameter. The default value is false. default:false" } }, "description": "Model containing the method level model for ResidentialSubscriberInstance.retrieveResidentialSubscriber to decode json data to internal NFM-P object model" }, "retrieveIPoESessionRadiusClassesResponse": { "title": "retrieveIPoESessionRadiusClassesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for IPoESessionRadiusClassAttribute.retrieveIPoESessionRadiusClasses to encode json response from internal NFM-P object model" }, "createServiceResponse": { "title": "createServiceResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for CompositeService.createService to encode json response from internal NFM-P object model" }, "PowerModule": { "title": "PowerModule", "required": [ "displayedName", "shelfId", "hwIndex", "siteId", "siteName", "manufacturer", "serialNumber", "manufacturerBoardNumber", "manufactureDate", "equipmentCategory", "hwName", "cleiCode", "equipmentState", "containingEquipmentState", "compositeEquipmentState", "operationalState", "administrativeState", "isEquipped", "baseMacAddress", "hardwareFailureReason", "isEquipmentInserted", "manufacturingAssemblyNo", "manufacturingDeviations", "isTempSensorAvailable", "hardwareClass", "backgroundDiagnosticsState", "backgroundDiagnosticsFaultReason", "manufacturingVariant", "hwFirmwareRevisionStatus", "oesShelfId", "phyShelfClass", "phyShelfType", "olcState", "lockOlcState", "powerModuleHwIndex", "powerModuleId", "powerShelfId", "phyShelfNumber", "assignedPMType", "supportedPMTypes", "equippedPMType", "pmAvailableWattage", "pmOutputStatus", "inputFeedStatus", "zoneId", "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties" ], "type": "object", "properties": { "displayedName": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "shelfId": { "type": "integer", "format": "int32", "readOnly": true }, "hwIndex": { "type": "integer", "format": "int64", "readOnly": true }, "siteId": { "type": "string", "description": "64]", "readOnly": true, "example": " maximum: 64" }, "siteName": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "manufacturer": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "serialNumber": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "manufacturerBoardNumber": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "manufactureDate": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "equipmentCategory": { "type": "integer", "format": "int32", "readOnly": true }, "hwName": { "type": "string", "description": "[0,32]", "readOnly": true, "example": " maximum: 32" }, "cleiCode": { "type": "string", "description": "[0,16]", "readOnly": true, "example": " maximum: 16" }, "equipmentState": { "type": "integer", "format": "int32", "readOnly": true }, "containingEquipmentState": { "type": "integer", "format": "int32", "readOnly": true }, "compositeEquipmentState": { "type": "integer", "format": "int32", "readOnly": true }, "operationalState": { "type": "integer", "format": "int32", "readOnly": true }, "administrativeState": { "type": "integer", "format": "int32" }, "isEquipped": { "type": "boolean", "readOnly": true }, "baseMacAddress": { "type": "string", "readOnly": true }, "hardwareFailureReason": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "isEquipmentInserted": { "type": "boolean", "readOnly": true }, "manufacturingAssemblyNo": { "type": "string", "readOnly": true }, "manufacturingDeviations": { "type": "string", "readOnly": true }, "isTempSensorAvailable": { "type": "boolean", "readOnly": true }, "hardwareClass": { "type": "integer", "format": "int32", "readOnly": true }, "backgroundDiagnosticsState": { "type": "integer", "format": "int32", "readOnly": true }, "backgroundDiagnosticsFaultReason": { "type": "string", "readOnly": true }, "manufacturingVariant": { "type": "string", "readOnly": true }, "hwFirmwareRevisionStatus": { "type": "integer", "format": "int32", "readOnly": true }, "oesShelfId": { "type": "integer", "format": "int32" }, "phyShelfClass": { "type": "integer", "format": "int32" }, "phyShelfType": { "type": "integer", "format": "int32" }, "olcState": { "type": "integer", "description": "Object Life Cycle can be set using {{generic.GenericObject.updateUserObjectLifecycleStates()}}.", "format": "int32", "readOnly": true }, "lockOlcState": { "type": "boolean", "description": "This is used to lock the OLC State while in OLC Maintenance State only." }, "powerModuleHwIndex": { "type": "integer", "description": "Relative power Module identifier.", "format": "int64" }, "powerModuleId": { "type": "integer", "format": "int32", "readOnly": true }, "powerShelfId": { "type": "integer", "format": "int32", "readOnly": true }, "phyShelfNumber": { "type": "integer", "description": "[1,32]", "format": "int32", "readOnly": true }, "assignedPMType": { "type": "integer", "format": "int64" }, "supportedPMTypes": { "type": "integer", "format": "int64", "readOnly": true }, "equippedPMType": { "type": "integer", "format": "int64", "readOnly": true }, "pmAvailableWattage": { "type": "integer", "format": "int32", "readOnly": true }, "pmOutputStatus": { "type": "integer", "format": "int32", "readOnly": true }, "inputFeedStatus": { "type": "integer", "format": "int64", "readOnly": true }, "zoneId": { "type": "integer", "description": "[0,32]", "format": "int32", "readOnly": true }, "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "actionMask": { "type": "integer", "format": "int32" }, "selfAlarmed": { "type": "boolean", "default": false }, "name": { "type": "string" } }, "description": "Managed object abstract class" }, "bgpPerNextHopSummaryResponse": { "title": "bgpPerNextHopSummaryResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/PagingResult" }, { "description": "Model containing the method level model for struct PagingResult. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for BgpImpactAnalysisTimeRange.bgpPerNextHopSummary to encode json response from internal NFM-P object model" }, "retrieveCallTraceJobsResponse": { "title": "retrieveCallTraceJobsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for CallTraceJob.retrieveCallTraceJobs to encode json response from internal NFM-P object model" }, "DeploymentPolicy": { "title": "DeploymentPolicy", "required": [ "deploymentMode", "autoSaveConfigScheme", "autoSaveConfigTreshold", "scheduledSaveConfigScheme", "scheduledSaveConfigFrequency", "retryScheme", "retryFrequency", "retryThreshold", "saveConfigDetails", "saveConfigInterval", "saveConfigScheduling", "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties" ], "type": "object", "properties": { "deploymentMode": { "type": "integer", "description": "If set to snmp, NFM-P server deploys configuration changes to the node, elsethe changes are saved in NFM-P database only.", "format": "int32" }, "autoSaveConfigScheme": { "type": "integer", "description": "Specifies when the NFM-P server initiates a configuration save on the network element.", "format": "int32" }, "autoSaveConfigTreshold": { "type": "integer", "description": "Specifies the number of deployments, after which the NFM-P server, performs a configuration save.[0,10000]", "format": "int32" }, "scheduledSaveConfigScheme": { "type": "integer", "description": "Schedules the initiation of node config saves at regular intervals, depending on orregardless of deployment activity.", "format": "int32" }, "scheduledSaveConfigFrequency": { "type": "integer", "description": "Specifies the interval for the ScheduleSaveConfigScheme parameter.", "format": "int32" }, "retryScheme": { "type": "integer", "description": "Specifies the conditions under which the NFM-P server attempts to redeploy aconfiguration change after a deployment failure.", "format": "int32" }, "retryFrequency": { "type": "integer", "description": "Works in conjunction with the retryScheme parameter to specify how often the 5620NFM-P server attempts to redeploy after a deployment failure.", "format": "int32" }, "retryThreshold": { "type": "integer", "description": "Works in conjunction with the retryScheme parameter to specify how many timesthe NFM-P server attempts to redeploy after a deployment failure.[0,10000]", "format": "int32" }, "saveConfigDetails": { "type": "boolean", "description": "If enabled, causes the node to save all node parameters in the configuration file,including those with default values." }, "saveConfigInterval": { "type": "integer", "description": "Specifies the minimum time interval between device configuration saves.If multiple save requests for the same NE occur during the interval,the first requestis processed, but the remaining requests are each delayed by saveConfigInterval.The delay can be repeated the number of times specified by saveConfigSchedulingif one or more additional save requests occur before the saveConfigInterval period elapses.The maximum possible delay between the second request andthe last request is saveConfigInterval x saveConfigScheduling..", "format": "int32" }, "saveConfigScheduling": { "type": "integer", "description": "Specifies the maximum number of times that a configuration save is delayed when multiple saverequests are sent to an NE. The maximum possible delay between two save config requestsis the saveConfigScheduling value multiplied by the saveConfigInterval value.The maximum possible delay occurs when the NFM-P requests at least oneconfiguration save during consecutive saveConfigInterval periods.[1,10]", "format": "int32" }, "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "actionMask": { "type": "integer", "format": "int32" }, "selfAlarmed": { "type": "boolean", "default": false }, "name": { "type": "string" } }, "description": "Managed object abstract class" }, "findAvailableNetworkCtpsPerNodeResponse": { "title": "findAvailableNetworkCtpsPerNodeResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionTerminationPointInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for ConnectionTerminationPoint.findAvailableNetworkCtpsPerNode to encode json response from internal NFM-P object model" }, "configureInstanceWithResultResponse": { "title": "configureInstanceWithResultResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, { "description": "Model containing the method level model for struct CommonManagedEntityInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for GenericObject.configureInstanceWithResult to encode json response from internal NFM-P object model" }, "findApplicablePorts": { "title": "findApplicablePorts", "type": "object", "properties": { "aInApsGroupConfigInfo": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" }, { "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } ] }, "aInPortType": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for ApsGroup.findApplicablePorts to decode json data to internal NFM-P object model" }, "GroupInfo": { "title": "GroupInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "groupName": { "type": "string" }, "groupDescription": { "type": "string" }, "groupOrderType": { "type": "integer", "format": "int32" }, "groupMode": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for Interface GroupInfo. to decode json data to internal NFM-P object model" }, "reAssignUser": { "title": "reAssignUser", "required": [ "newUser", "infoList" ], "type": "object", "properties": { "newUser": { "type": "string" }, "infoList": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "" } }, "description": "Model containing the method level model for TSecurityManager.reAssignUser to decode json data to internal NFM-P object model" }, "GroupBindingInfo": { "title": "GroupBindingInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "memberObjectPointer": { "type": "string" } }, "description": "Model containing the method level model for Interface GroupBindingInfo. to decode json data to internal NFM-P object model" }, "findGLSPs": { "title": "findGLSPs", "required": [ "lspPathFilter", "lspFilter" ], "type": "object", "properties": { "lspPathFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "lspFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for ProvisionedPath.findGLSPs to decode json data to internal NFM-P object model" }, "retrieveBgpPrefixList": { "title": "retrieveBgpPrefixList", "required": [ "bgpAs", "bgpPrefixFilter" ], "type": "object", "properties": { "bgpAs": { "type": "string", "description": "The BGP AS ({{topology.BgpAutonomousSystem}}) to retrieve the prefixes." }, "bgpPrefixFilter": { "type": "string", "description": "The Filter ({{topology.BgpPrefixListFilter}}) to be applied for the retrieval." } }, "description": "Model containing the method level model for TopologyManager.retrieveBgpPrefixList to decode json data to internal NFM-P object model" }, "findCtpFilteredResponse": { "title": "findCtpFilteredResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionTerminationPointInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for ConnectionTerminationPoint.findCtpFiltered to encode json response from internal NFM-P object model" }, "createElement": { "title": "createElement", "required": [ "autoConfigureMissingControlServices" ], "type": "object", "properties": { "aInElementList": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" }, "description": "" }, "autoConfigureMissingControlServices": { "type": "boolean", "description": "This parameter is applicable only if the ring element type is aos. If set to true, the VLAN service sites and the access interfaces NNIbindings are automatically configured ports used as path endpoints. default:false" } }, "description": "Model containing the method level model for Ring.createElement to decode json data to internal NFM-P object model" }, "HostTrackedSubscrRtrvStruct": { "title": "HostTrackedSubscrRtrvStruct", "required": [ "objectClassName", "hostTrkPlcyName", "siteId", "timeOut" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "hostTrkPlcyName": { "type": "string" }, "siteId": { "type": "string" }, "timeOut": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct HostTrackedSubscrRtrvStruct. to decode json data to internal NFM-P object model" }, "requestClearProxyNdDynResponse": { "title": "requestClearProxyNdDynResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for Site.requestClearProxyNdDyn to encode json response from internal NFM-P object model" }, "retrievePccRulesPerSubscrHostResponse": { "title": "retrievePccRulesPerSubscrHostResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for SubscriberPccRuleEntry.retrievePccRulesPerSubscrHost to encode json response from internal NFM-P object model" }, "retrieveCallTraceFileResponse": { "title": "retrieveCallTraceFileResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for CallTraceFile.retrieveCallTraceFile to encode json response from internal NFM-P object model" }, "requestClearProxyNdDupsResponse": { "title": "requestClearProxyNdDupsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for Site.requestClearProxyNdDups to encode json response from internal NFM-P object model" }, "updateMultipleSubscrHostsResponse": { "title": "updateMultipleSubscrHostsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for SubscriberHostConfiguration.updateMultipleSubscrHosts to encode json response from internal NFM-P object model" }, "findVrrpInstancesResponse": { "title": "findVrrpInstancesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for Policy.findVrrpInstances to encode json response from internal NFM-P object model" }, "ClearDhcp6LeaseStateConfiguration": { "title": "ClearDhcp6LeaseStateConfiguration", "required": [ "objectClassName", "siteId", "serviceId", "subscrIdent", "ipv6Address", "ipv6AddressPrefixLength" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "serviceId": { "type": "integer", "format": "int64" }, "subscrIdent": { "type": "string" }, "ipv6Address": { "type": "string" }, "ipv6AddressPrefixLength": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for struct ClearDhcp6LeaseStateConfiguration. to decode json data to internal NFM-P object model" }, "retrieveScriptSnippetsResponse": { "title": "retrieveScriptSnippetsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for DynSvcNeConfig.retrieveScriptSnippets to encode json response from internal NFM-P object model" }, "retrieveEnbLinkStatusResponse": { "title": "retrieveEnbLinkStatusResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for MmeEpsPeerSummary.retrieveEnbLinkStatus to encode json response from internal NFM-P object model" }, "findUserMvrSaps": { "title": "findUserMvrSaps", "required": [ "vplsServiceId", "filter" ], "type": "object", "properties": { "vplsServiceId": { "type": "integer", "format": "int64" }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for MldSiteMvr.findUserMvrSaps to decode json data to internal NFM-P object model" }, "updateExclude": { "title": "updateExclude", "required": [ "sessionFdn", "excluded", "neWorkOrders" ], "type": "object", "properties": { "sessionFdn": { "type": "string", "description": "The session." }, "excluded": { "type": "boolean", "description": "True to exclude; false to include." }, "neWorkOrders": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The set of NE work orders to exclude. The NE work orders must be in the given session." } }, "description": "Model containing the method level model for Session.updateExclude to decode json data to internal NFM-P object model" }, "retrieveClearRequestResponse": { "title": "retrieveClearRequestResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/ClearRequest" }, { "description": "Managed object abstract class" } ] } }, "description": "Model containing the method level model for ClearCommandManager.retrieveClearRequest to encode json response from internal NFM-P object model" }, "retrieveMsapResponse": { "title": "retrieveMsapResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, { "description": "Model containing the method level model for struct CommonManagedEntityInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for MSap.retrieveMsap to encode json response from internal NFM-P object model" }, "findCtpsForTunnelPathEndpointResponse": { "title": "findCtpsForTunnelPathEndpointResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionTerminationPointInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for EthernetTunnelPathEndpoint.findCtpsForTunnelPathEndpoint to encode json response from internal NFM-P object model" }, "createScpConnectorResponse": { "title": "createScpConnectorResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for CompositeService.createScpConnector to encode json response from internal NFM-P object model" }, "findGlobalResponse": { "title": "findGlobalResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for PolicyDefinition.findGlobal to encode json response from internal NFM-P object model" }, "getTargetScriptResultResponse": { "title": "getTargetScriptResultResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedContainmentEntityInformation" }, { "description": "Model containing the method level model for struct CommonManagedContainmentEntityInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for TargetScriptResult.getTargetScriptResult to encode json response from internal NFM-P object model" }, "shortestPathFirstGraphExtResponse": { "title": "shortestPathFirstGraphExtResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/ShortestPathGraph" }, { "description": "Model containing the method level model for struct ShortestPathGraph. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for TopologyManager.shortestPathFirstGraphExt to encode json response from internal NFM-P object model" }, "getBodyOfTargetScriptResultResponse": { "title": "getBodyOfTargetScriptResultResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for ScriptManager.getBodyOfTargetScriptResult to encode json response from internal NFM-P object model" }, "ScpConnectorConfigInfo": { "title": "ScpConnectorConfigInfo", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap", "containmentInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } }, "displayedName": { "type": "string" }, "description": { "type": "string" }, "firstSvcPointer": { "type": "string" }, "secondSvcPointer": { "type": "string" }, "firstSitePointer": { "type": "string" }, "secondSitePointer": { "type": "string" }, "scpConnectorId": { "type": "integer", "format": "int64" }, "firstScpPointer": { "type": "string" }, "secondScpPointer": { "type": "string" } }, "description": "Model containing the method level model for Interface ConfigInfo ScpConnectorConfigInfo. to decode json data to internal NFM-P object model" }, "filteredFindResponse": { "title": "filteredFindResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "object" }, "description": "The response object." } }, "description": "Model containing the method level model for GenericObject.filteredFind to encode json response from internal NFM-P object model" }, "validateQuery": { "title": "validateQuery", "required": [ "siteId", "tunnelServiceId" ], "type": "object", "properties": { "siteId": { "type": "string", "description": "Site ID to be validated against sites managed by NFM-P." }, "tunnelServiceId": { "type": "integer", "description": "Optional parameter. Service ID to be validated against services in NFM-P.Valid values are -1 for the Base Routing Instance, or a validVPRN Service ID. default:0", "format": "int64" } }, "description": "Model containing the method level model for WlanGwQbtTunnel.validateQuery to decode json data to internal NFM-P object model" }, "isDbRedundantResponse": { "title": "isDbRedundantResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "boolean", "description": "The response object." } }, "description": "Model containing the method level model for DatabaseManager.isDbRedundant to encode json response from internal NFM-P object model" }, "findMcfrBundlesResponse": { "title": "findMcfrBundlesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for McfrEgressQosProfile.findMcfrBundles to encode json response from internal NFM-P object model" }, "retrieveSubSlaacHostRadiusClassesResponse": { "title": "retrieveSubSlaacHostRadiusClassesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for SubSlaacHostRadiusClassAttribute.retrieveSubSlaacHostRadiusClasses to encode json response from internal NFM-P object model" }, "preFixProblem": { "title": "preFixProblem", "required": [ "fdn" ], "type": "object", "properties": { "aInPreFixData": { "allOf": [ { "$ref": "#/components/schemas/PreFixData" }, { "description": "Model containing the method level model for struct PreFixData. to decode json data to internal NFM-P object model" } ] }, "fdn": { "type": "string", "description": "The Fdn of Problem Object." } }, "description": "Model containing the method level model for RcaManager.preFixProblem to decode json data to internal NFM-P object model" }, "findInstances": { "title": "findInstances", "required": [ "filter" ], "type": "object", "properties": { "aInBackUpAddress": { "type": "string" }, "aInBackupAddressType": { "type": "integer", "format": "int32" }, "aInVrId": { "type": "integer", "format": "int64" }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for VrrpVirtualRouter.findInstances to decode json data to internal NFM-P object model" }, "retrieveDbInfoTransitPrefixAddress": { "title": "retrieveDbInfoTransitPrefixAddress", "required": [ "timeout", "siteId", "isaGrpPartIndex", "transitPlcyId", "subName" ], "type": "object", "properties": { "timeout": { "type": "integer", "description": "The number of milliseconds to wait beforereceiving the results. If the results arenot received in the given time, the method returns.", "format": "int64" }, "siteId": { "type": "string", "description": "Network Element site IP address." }, "isaGrpPartIndex": { "type": "integer", "description": "The ISA-AA Group Partition Index.", "format": "int64" }, "transitPlcyId": { "type": "integer", "description": "Transit policy Id.", "format": "int64" }, "subName": { "type": "string", "description": "Transit subscriber name." } }, "description": "Model containing the method level model for DbInfoTransitPrefixAddress.retrieveDbInfoTransitPrefixAddress to decode json data to internal NFM-P object model" }, "requestClearMsapResponse": { "title": "requestClearMsapResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for MSap.requestClearMsap to encode json response from internal NFM-P object model" }, "retrieveHostLockoutInfoResponse": { "title": "retrieveHostLockoutInfoResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for HostLockoutInfo.retrieveHostLockoutInfo to encode json response from internal NFM-P object model" }, "findObjectsAffectingOfnResponse": { "title": "findObjectsAffectingOfnResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for FaultManager.findObjectsAffectingOfn to encode json response from internal NFM-P object model" }, "addWorkOrder": { "title": "addWorkOrder", "required": [ "sessionFdn", "workOrderFdn", "failAllOnError", "autoLoad" ], "type": "object", "properties": { "sessionFdn": { "type": "string", "description": "The session to add work orders to." }, "workOrderFdn": { "type": "string", "description": "The work order to add to the session." }, "failAllOnError": { "type": "boolean", "description": "If set to true, it indicates that the complete operation will fail if any of the given NEwork orders contained in the work order cannot be added to the session. If set to false,the failed NE work orders will be skipped and valid ones will be added." }, "autoLoad": { "type": "boolean", "description": "Set if the NE work order contents should automatically be loaded in memory and analyzed." } }, "description": "Model containing the method level model for Session.addWorkOrder to decode json data to internal NFM-P object model" }, "VirtualRouterIpAddressInfo": { "title": "VirtualRouterIpAddressInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "index": { "type": "integer", "format": "int32" }, "ipAddressType": { "type": "integer", "format": "int32" }, "ipAddress": { "type": "string" }, "bcastAddrFormat": { "type": "integer", "format": "int32" }, "prefixLength": { "type": "integer", "format": "int32" }, "igpInhibit": { "type": "boolean", "default": false }, "isEui64Address": { "type": "boolean", "default": false }, "gwAddressType": { "type": "integer", "format": "int32" }, "gwIpAddress": { "type": "string" }, "remoteAddressType": { "type": "integer", "format": "int32" }, "remoteIpAddress": { "type": "string" }, "ifName": { "type": "string" }, "ipAddrPreferred": { "type": "boolean", "default": false }, "subscrHostRoutePopulate": { "type": "boolean", "default": false }, "trackSrrpInstance": { "type": "integer", "format": "int64" }, "holdUpTime": { "type": "integer", "format": "int64" }, "cgaModifier": { "type": "string" }, "isSubscriberPrefix": { "type": "boolean", "default": false }, "subscriberPrefixType": { "type": "integer", "format": "int64" }, "customProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "vrfName": { "type": "string" }, "primaryPreference": { "type": "integer", "format": "int64" }, "greTermination": { "type": "boolean", "default": false }, "templateVersionPointer": { "type": "string" }, "creationOrigin": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for Interface VirtualRouterIpAddressInfo. to decode json data to internal NFM-P object model" }, "deleteTrails": { "title": "deleteTrails", "type": "object", "properties": { "aInTrailFdnList": { "type": "array", "items": { "type": "string" }, "description": "" }, "aInMultiDelete": { "type": "string" } }, "description": "Model containing the method level model for Trail.deleteTrails to decode json data to internal NFM-P object model" }, "clearDhcpServerStickyLeasesResponse": { "title": "clearDhcpServerStickyLeasesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for LocalDhcpServer.clearDhcpServerStickyLeases to encode json response from internal NFM-P object model" }, "DetailedError": { "title": "DetailedError", "required": [ "objectClassName", "errorCode", "message" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "errorCode": { "type": "string" }, "message": { "type": "string" } }, "description": "Model containing the method level model for struct DetailedError. to decode json data to internal NFM-P object model" }, "findAdminGroupsResponse": { "title": "findAdminGroupsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for AdminGroupPolicy.findAdminGroups to encode json response from internal NFM-P object model" }, "deleteServices": { "title": "deleteServices", "type": "object", "properties": { "aInMultiDelete": { "type": "string" }, "aInServicesFdnList": { "type": "array", "items": { "type": "string" }, "description": "" } }, "description": "Model containing the method level model for TransportService.deleteServices to decode json data to internal NFM-P object model" }, "findSdpBindingsResponse": { "title": "findSdpBindingsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for Policy.findSdpBindings to encode json response from internal NFM-P object model" }, "clearSapResponse": { "title": "clearSapResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/RequestHandleStruct" }, "description": "The response object." } }, "description": "Model containing the method level model for ResidentialSubscriberManager.clearSap to encode json response from internal NFM-P object model" }, "findLspsResponse": { "title": "findLspsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for AdminGroupPolicy.findLsps to encode json response from internal NFM-P object model" }, "findMcRingProtectedSapsResponse": { "title": "findMcRingProtectedSapsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for L2AccessInterface.findMcRingProtectedSaps to encode json response from internal NFM-P object model" }, "release": { "title": "release", "required": [ "sessionFdn", "neWorkOrders" ], "type": "object", "properties": { "sessionFdn": { "type": "string", "description": "The session." }, "neWorkOrders": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The set of NE work orders to release. The NE work orders must be in the given session." } }, "description": "Model containing the method level model for Session.release to decode json data to internal NFM-P object model" }, "RetrGtpSessionStruct": { "title": "RetrGtpSessionStruct", "required": [ "objectClassName", "siteId", "imsi", "apnNetwId", "timeout" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "imsi": { "type": "string" }, "apnNetwId": { "type": "string" }, "timeout": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct RetrGtpSessionStruct. to decode json data to internal NFM-P object model" }, "findAvailableAccessCtpsPerNode": { "title": "findAvailableAccessCtpsPerNode", "required": [ "nodeId", "ctpFilter" ], "type": "object", "properties": { "nodeId": { "type": "string" }, "ctpFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for ConnectionTerminationPoint.findAvailableAccessCtpsPerNode to decode json data to internal NFM-P object model" }, "triggerCollect": { "title": "triggerCollect", "required": [ "instanceNames", "currentDataClasses" ], "type": "object", "properties": { "instanceNames": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The object instances (FDNs) to collect statistics on." }, "currentDataClasses": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The statistics 'current data' classes to collect for." } }, "description": "Model containing the method level model for ResidentialSubscriberManager.triggerCollect to decode json data to internal NFM-P object model" }, "copyMoveSapsResponse": { "title": "copyMoveSapsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/SingleSapCopyMoveResultStruct" }, "description": "The response object." } }, "description": "Model containing the method level model for L2AccessInterface.copyMoveSaps to encode json response from internal NFM-P object model" }, "requestClearHostIgmpHostTracking": { "title": "requestClearHostIgmpHostTracking", "required": [ "clearHostStruct" ], "type": "object", "properties": { "aInOnlyStats": { "type": "boolean", "default": false }, "clearHostStruct": { "allOf": [ { "$ref": "#/components/schemas/ClearHostStruct" }, { "description": "Model containing the method level model for struct ClearHostStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for ResidentialSubscriberInstance.requestClearHostIgmpHostTracking to decode json data to internal NFM-P object model" }, "retrieveCcrtReplay": { "title": "retrieveCcrtReplay", "required": [ "timeout" ], "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInCcrtReplayId": { "type": "integer", "format": "int64" }, "aInAppPolicyName": { "type": "string" }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait before receiving the results.The method returns if no results are received in the given time.This is an optional input parameter. The default value is 5 minutes (300000). default:300000", "format": "int64" } }, "description": "Model containing the method level model for DiameterSeCcrtReplay.retrieveCcrtReplay to decode json data to internal NFM-P object model" }, "addTriggerFilterResponse": { "title": "addTriggerFilterResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for SupervisionGroup.addTriggerFilter to encode json response from internal NFM-P object model" }, "copyMoveSapsWithSapListResponse": { "title": "copyMoveSapsWithSapListResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/SingleSapCopyMoveResultStruct" }, "description": "The response object." } }, "description": "Model containing the method level model for L2AccessInterface.copyMoveSapsWithSapList to encode json response from internal NFM-P object model" }, "requestClearCpmFilterQueueResponse": { "title": "requestClearCpmFilterQueueResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for CpmFilterQueue.requestClearCpmFilterQueue to encode json response from internal NFM-P object model" }, "requestClearDynSvcDataTriggerResponse": { "title": "requestClearDynSvcDataTriggerResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for DynSvcDataTrigger.requestClearDynSvcDataTrigger to encode json response from internal NFM-P object model" }, "filteredDelete": { "title": "filteredDelete", "required": [ "fullClassName", "filter" ], "type": "object", "properties": { "fullClassName": { "type": "string", "description": "Package qualified class namein dot separated format. EXAMPLE:svc.Servicertr.NetworkInterface." }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for GenericObject.filteredDelete to decode json data to internal NFM-P object model" }, "ComparisonFilter": { "title": "ComparisonFilter", "required": [ "objectClassName", "classesToProcess", "includedDiffTypes", "includedProperties", "flapProperties", "includeOnlyDiffs", "isClassSpecificFilterConfigured" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "classesToProcess": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "includedDiffTypes": { "type": "object", "additionalProperties": {} }, "includedProperties": { "type": "object", "additionalProperties": {} }, "flapProperties": { "type": "object", "additionalProperties": {} }, "includeOnlyDiffs": { "type": "boolean" }, "isClassSpecificFilterConfigured": { "type": "boolean" } }, "description": "Model containing the method level model for struct ComparisonFilter. to decode json data to internal NFM-P object model" }, "ExtensionShelfUpgradeManagerInfo": { "title": "ExtensionShelfUpgradeManagerInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "siteId": { "type": "string" }, "shelfId": { "type": "integer", "format": "int32" }, "oesShelfId": { "type": "integer", "format": "int32" }, "phyShelfClass": { "type": "integer", "format": "int32" }, "policyType": { "type": "integer", "format": "int32" }, "softwareUpgradePolicyId": { "type": "integer", "format": "int32" }, "scheduleType": { "type": "integer", "format": "int32" }, "softwareImage": { "type": "string" }, "softwareRepository": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "description": { "type": "string" } }, "description": "Model containing the method level model for Interface ExtensionShelfUpgradeManagerInfo. to decode json data to internal NFM-P object model" }, "retrievePtpPortRecoveredClockHistoryResponse": { "title": "retrievePtpPortRecoveredClockHistoryResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for PtpPortRecoveredClockHistory.retrievePtpPortRecoveredClockHistory to encode json response from internal NFM-P object model" }, "TunnelConfigInfo": { "title": "TunnelConfigInfo", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap", "containmentInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } }, "administrativeState": { "type": "integer", "format": "int32" }, "pathId": { "type": "integer", "format": "int64" }, "displayedName": { "type": "string" }, "description": { "type": "string" }, "sourceNodeId": { "type": "string" }, "destinationNodeId": { "type": "string" }, "pathMtu": { "type": "integer", "format": "int32" }, "forwardingClasses": { "type": "integer", "format": "int64" }, "priority": { "type": "integer", "format": "int64" }, "provisionedPathId": { "type": "integer", "format": "int64" }, "tunnelInstance": { "type": "integer", "format": "int32" }, "ingressLabelSwitchRouterId": { "type": "integer", "format": "int64" }, "egressLabelSwitchRouterId": { "type": "integer", "format": "int64" }, "lspId": { "type": "integer", "format": "int32" }, "hopIdToAddressList": { "type": "array", "items": { "type": "string" }, "description": "" }, "customProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "isSIDConfiguredOnHops": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for Interface ConfigInfo TunnelConfigInfo. to decode json data to internal NFM-P object model" }, "findSyncTimeSources": { "title": "findSyncTimeSources", "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for SiteSync.findSyncTimeSources to decode json data to internal NFM-P object model" }, "deleteSubSvcComponentsResponse": { "title": "deleteSubSvcComponentsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "boolean", "description": "The response object." } }, "description": "Model containing the method level model for ResidentialSubscriberManager.deleteSubSvcComponents to encode json response from internal NFM-P object model" }, "retrieveSubscriberQosOverridesResponse": { "title": "retrieveSubscriberQosOverridesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for SubscriberQosOverride.retrieveSubscriberQosOverrides to encode json response from internal NFM-P object model" }, "discoverVnfResponse": { "title": "discoverVnfResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "boolean", "description": "The response object." } }, "description": "Model containing the method level model for VNFManager.discoverVnf to encode json response from internal NFM-P object model" }, "DslLineInfoRetrievalStruct": { "title": "DslLineInfoRetrievalStruct", "required": [ "objectClassName", "siteId", "ancpString", "parentFullName", "timeout" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "ancpString": { "type": "string" }, "parentFullName": { "type": "string" }, "timeout": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct DslLineInfoRetrievalStruct. to decode json data to internal NFM-P object model" }, "alterUrgencyOfFaultList": { "title": "alterUrgencyOfFaultList", "required": [ "faultObjectNameSet", "urgency" ], "type": "object", "properties": { "faultObjectNameSet": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Set of alarm full names for which the urgency is to be updated." }, "urgency": { "type": "integer", "description": "New urgency.", "format": "int32" } }, "description": "Model containing the method level model for FaultManager.alterUrgencyOfFaultList to decode json data to internal NFM-P object model" }, "DynSvcInfoRetrievalStruct": { "title": "DynSvcInfoRetrievalStruct", "required": [ "objectClassName", "siteId", "timeout" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "timeout": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct DynSvcInfoRetrievalStruct. to decode json data to internal NFM-P object model" }, "SapCopyMoveStruct": { "title": "SapCopyMoveStruct", "required": [ "objectClassName", "sourcePortFdn", "destinationPortFdn", "isMoving", "outerEncapShiftOffset", "innerEncapShiftOffset", "targetType" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "sourcePortFdn": { "type": "string" }, "destinationPortFdn": { "type": "string" }, "isMoving": { "type": "boolean" }, "outerEncapShiftOffset": { "type": "integer", "format": "int32" }, "innerEncapShiftOffset": { "type": "integer", "format": "int32" }, "targetType": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for struct SapCopyMoveStruct. to decode json data to internal NFM-P object model" }, "executeScriptFlow": { "title": "executeScriptFlow", "required": [ "isSynchronized", "clientId", "systemInvokationId", "scriptName", "targetScriptConfig" ], "type": "object", "properties": { "isSynchronized": { "type": "boolean", "description": "Identifies if the call to execute the script should wait until all scripts have been executed. True to wait, false otherwise." }, "clientId": { "type": "string", "description": "Identifies the client ID that is requesting the execution (used for sending an event to the specific client when execution is complete)." }, "systemInvokationId": { "type": "integer", "description": "Identifies the client request ID that is uniquely identifying this particular request within the client.The client is responsible to generate a unique ID for each request.This value will be set on the script execution events that are created as a result of executing this request.", "format": "int64" }, "scriptName": { "type": "string", "description": "Identifies the script to execute (version is not needed as latest version is executed).This is the fully distinguished name (FDN) of the script to be executed.Alternatively the unique name of the script can be used (scriptName of AbstractScript)." }, "targetScriptConfig": { "allOf": [ { "$ref": "#/components/schemas/TargetScriptConfigInfo" }, { "description": "Model containing the method level model for Interface ConfigInfo TargetScriptConfigInfo. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for ScriptManager.executeScriptFlow to decode json data to internal NFM-P object model" }, "SingleSapCopyMoveResultStruct": { "title": "SingleSapCopyMoveResultStruct", "required": [ "objectClassName", "sourceObjectFdn", "destinationObjectFdn", "extraInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "sourceObjectFdn": { "type": "string" }, "destinationObjectFdn": { "type": "string" }, "extraInfo": { "type": "string" } }, "description": "Model containing the method level model for struct SingleSapCopyMoveResultStruct. to decode json data to internal NFM-P object model" }, "findMultipleInstancesResponse": { "title": "findMultipleInstancesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "object" }, "description": "The response object." } }, "description": "Model containing the method level model for GenericObject.findMultipleInstances to encode json response from internal NFM-P object model" }, "getStatusResponse": { "title": "getStatusResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/AuditStatus" }, { "description": "Model containing the method level model for struct AuditStatus. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for AuditManager.getStatus to encode json response from internal NFM-P object model" }, "ClearCallTraceIpoeTraceStruct": { "title": "ClearCallTraceIpoeTraceStruct", "required": [ "objectClassName", "siteId", "traceName" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "traceName": { "type": "string" } }, "description": "Model containing the method level model for struct ClearCallTraceIpoeTraceStruct. to decode json data to internal NFM-P object model" }, "configureTopologyGroup": { "title": "configureTopologyGroup", "required": [ "parentGroupName", "parentViewName", "topologyGroupInfo" ], "type": "object", "properties": { "parentGroupName": { "type": "string" }, "parentViewName": { "type": "string" }, "topologyGroupInfo": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" }, { "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for TopologyGroupManager.configureTopologyGroup to decode json data to internal NFM-P object model" }, "getVlanConnProfSAPs": { "title": "getVlanConnProfSAPs", "type": "object", "properties": { "aInConnectionProfile": { "type": "integer", "format": "int64" }, "aInServiceType": { "type": "integer", "format": "int32" }, "aInFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for VlanConnProfPolicy.getVlanConnProfSAPs to decode json data to internal NFM-P object model" }, "retrieveReservedResourcesResponse": { "title": "retrieveReservedResourcesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for SvcResourceReservation.retrieveReservedResources to encode json response from internal NFM-P object model" }, "findAlarmsStatusesForOfnsResponse": { "title": "findAlarmsStatusesForOfnsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AlarmStatusesStruct" }, "description": "The response object." } }, "description": "Model containing the method level model for FaultManager.findAlarmsStatusesForOfns to encode json response from internal NFM-P object model" }, "ServiceComponentsCreateConfiguration": { "title": "ServiceComponentsCreateConfiguration", "required": [ "objectClassName", "serviceCompSelectionId", "neSystemAddress", "vlanPerSub", "esm", "templates", "services", "downstreamLineRate", "upstreamLineRate", "ingressAclNames", "egressAclNames", "ingressIpv6AclNames", "egressIpv6AclNames", "allRates" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "serviceCompSelectionId": { "type": "string" }, "neSystemAddress": { "type": "string" }, "vlanPerSub": { "type": "boolean" }, "esm": { "type": "boolean" }, "templates": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TemplateIdPair" } }, "services": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceSelectionInfo" }, "description": "" }, "downstreamLineRate": { "type": "integer", "format": "int32" }, "upstreamLineRate": { "type": "integer", "format": "int32" }, "ingressAclNames": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TemplateIdPair" } }, "egressAclNames": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TemplateIdPair" } }, "ingressIpv6AclNames": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TemplateIdPair" } }, "egressIpv6AclNames": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TemplateIdPair" } }, "allRates": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" } } }, "description": "Model containing the method level model for struct ServiceComponentsCreateConfiguration. to decode json data to internal NFM-P object model" }, "configureAinsModeResponse": { "title": "configureAinsModeResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for TransportService.configureAinsMode to encode json response from internal NFM-P object model" }, "findRouteNextHopPolicyTemplatesResponse": { "title": "findRouteNextHopPolicyTemplatesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for AdminGroupPolicy.findRouteNextHopPolicyTemplates to encode json response from internal NFM-P object model" }, "requestClearSubVlanStats": { "title": "requestClearSubVlanStats", "required": [ "siteId", "portName", "vlanId" ], "type": "object", "properties": { "siteId": { "type": "string", "description": "Specifies Site ID of the Subscriber VLAN Statistics to be cleared.This is mandatory parameter." }, "portName": { "type": "string", "description": "Specifies port of the Subscriber VLAN Statistics to be cleared.This is mandatory parameter." }, "vlanId": { "type": "integer", "description": "Specifies VLAN ID the Subscriber VLAN Statistics to be cleared.This value is equal to the outer encapsulation value on the Service Access Point.If set to -1, all Subscriber VLAN Statistics on the specified port will be cleared. default:-1", "format": "int32" } }, "description": "Model containing the method level model for PwPort.requestClearSubVlanStats to decode json data to internal NFM-P object model" }, "findFirmwareApplicableNesResponse": { "title": "findFirmwareApplicableNesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "object" }, "description": "The response object." } }, "description": "Model containing the method level model for FirmwareFolderDescriptor.findFirmwareApplicableNes to encode json response from internal NFM-P object model" }, "createTopologyGroupBindingForObject": { "title": "createTopologyGroupBindingForObject", "required": [ "parentGroupFullName", "objectFullName", "label" ], "type": "object", "properties": { "xCoordinate": { "type": "integer", "format": "int32" }, "yCoordinate": { "type": "integer", "format": "int32" }, "parentGroupFullName": { "type": "string" }, "objectFullName": { "type": "string" }, "label": { "type": "string" } }, "description": "Model containing the method level model for TopologyGroupManager.createTopologyGroupBindingForObject to decode json data to internal NFM-P object model" }, "findServiceAccessPointsResponse": { "title": "findServiceAccessPointsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for Policy.findServiceAccessPoints to encode json response from internal NFM-P object model" }, "BidirBulkCreationResult": { "title": "BidirBulkCreationResult", "required": [ "objectClassName", "success", "noMatch", "multipleMatch" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "success": { "type": "integer", "format": "int32" }, "noMatch": { "type": "integer", "format": "int32" }, "multipleMatch": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for struct BidirBulkCreationResult. to decode json data to internal NFM-P object model" }, "configureSecondaryShapersResponse": { "title": "configureSecondaryShapersResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "object" }, "description": "The response object." } }, "description": "Model containing the method level model for HsmdaEgressSecondaryShaper.configureSecondaryShapers to encode json response from internal NFM-P object model" }, "SizeConstraintPolicy": { "title": "SizeConstraintPolicy", "required": [ "policyId", "description", "rowThreshold", "rowsToDelete", "thresholdPolicy", "constraintViolated", "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties" ], "type": "object", "properties": { "policyId": { "type": "integer", "description": "[1,", "format": "int64" }, "description": { "type": "string", "description": "[0,80]", "example": " maximum: 80" }, "rowThreshold": { "type": "integer", "description": "[10,2147483647]", "format": "int64" }, "rowsToDelete": { "type": "integer", "description": "[1,2147483647]", "format": "int64" }, "thresholdPolicy": { "type": "integer", "format": "int32" }, "constraintViolated": { "type": "boolean", "readOnly": true }, "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "actionMask": { "type": "integer", "format": "int32" }, "selfAlarmed": { "type": "boolean", "default": false }, "name": { "type": "string" } }, "description": "Managed object abstract class" }, "RetrievingSessionStruct": { "title": "RetrievingSessionStruct", "required": [ "objectClassName", "siteId", "svcId", "sapId", "innerEncap", "outerEncap", "sessionsMac", "sessionsId", "timeout" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "svcId": { "type": "integer", "format": "int64" }, "sapId": { "type": "string" }, "innerEncap": { "type": "integer", "format": "int64" }, "outerEncap": { "type": "integer", "format": "int64" }, "sessionsMac": { "type": "string" }, "sessionsId": { "type": "integer", "format": "int64" }, "timeout": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct RetrievingSessionStruct. to decode json data to internal NFM-P object model" }, "findWithWorkOrderScan": { "title": "findWithWorkOrderScan", "required": [ "fullClassName", "filter", "joinConditions", "capabillities", "fields", "sortFields", "pageNumber", "pageSize", "excludedSubClasses" ], "type": "object", "properties": { "fullClassName": { "type": "string", "description": "Package qualified class name in dot separated format. EXAMPLE:service.Service,rtr.NetworkInterface" }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "joinConditions": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/RestFilter" }, "description": "Joins fields of two classes together.For use with Filter.setFilterClass." }, "capabillities": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "capability id(s)." }, "fields": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "table fields" }, "sortFields": { "type": "array", "items": { "type": "string" }, "description": "sorting fields" }, "pageNumber": { "type": "integer", "description": "page number", "format": "int32" }, "pageSize": { "type": "integer", "description": "page size", "format": "int32" }, "excludedSubClasses": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "excluded subclasses" } }, "description": "Model containing the method level model for ActivationManager.findWithWorkOrderScan to decode json data to internal NFM-P object model" }, "findMultipleInstancesShallowResponse": { "title": "findMultipleInstancesShallowResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "object" }, "description": "The response object." } }, "description": "Model containing the method level model for GenericObject.findMultipleInstancesShallow to encode json response from internal NFM-P object model" }, "syncMembersResponse": { "title": "syncMembersResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for PolicySyncGroup.syncMembers to encode json response from internal NFM-P object model" }, "retrieveWlanGwUeCallTraceJobs": { "title": "retrieveWlanGwUeCallTraceJobs", "required": [ "retrieveCallTraceStruct", "ieeeAddress", "timeout" ], "type": "object", "properties": { "retrieveCallTraceStruct": { "allOf": [ { "$ref": "#/components/schemas/RetrieveCallTraceStruct" }, { "description": "Model containing the method level model for struct RetrieveCallTraceStruct. to decode json data to internal NFM-P object model" } ] }, "ieeeAddress": { "type": "string", "description": "Specifies the IEEE address of WLAN GW UE. It is an optional parameter.{P}IEEE address and ID within the RetrieveCallTraceStruct are mutually exclusive. default:" }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns. default:300000", "format": "int64" } }, "description": "Model containing the method level model for CallTraceJob.retrieveWlanGwUeCallTraceJobs to decode json data to internal NFM-P object model" }, "bgpImpactAnalysisDetailsResponse": { "title": "bgpImpactAnalysisDetailsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/PagingResult" }, { "description": "Model containing the method level model for struct PagingResult. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for BgpImpactAnalysisTimeRange.bgpImpactAnalysisDetails to encode json response from internal NFM-P object model" }, "findUnDiscoveredNodesResponse": { "title": "findUnDiscoveredNodesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for TopologyDiscoveryRule.findUnDiscoveredNodes to encode json response from internal NFM-P object model" }, "VcnCrossConnectInfo": { "title": "VcnCrossConnectInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "administrativeState": { "type": "integer", "format": "int32" }, "connId": { "type": "integer", "format": "int64" }, "biDirectional": { "type": "boolean", "default": false }, "connectionType": { "type": "integer", "format": "int32" }, "portAPointer": { "type": "string" }, "portZPointer": { "type": "string" }, "ctpAPointer": { "type": "string" }, "ctpZPointer": { "type": "string" }, "protectionState": { "type": "integer", "format": "int32" }, "protectionLevel": { "type": "integer", "format": "int32" }, "modifyFlag": { "type": "boolean", "default": false }, "isRidingOnConnGroup": { "type": "boolean", "default": false }, "xcId": { "type": "integer", "format": "int64" }, "xcName": { "type": "string" }, "siteId": { "type": "string" }, "siteName": { "type": "string" }, "rate": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for Interface VcnCrossConnectInfo. to decode json data to internal NFM-P object model" }, "ClearCallTraceIpoeSessionStruct": { "title": "ClearCallTraceIpoeSessionStruct", "required": [ "objectClassName", "siteId", "sapFdn", "macAddress", "circuitId", "remoteId" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "sapFdn": { "type": "string" }, "macAddress": { "type": "string" }, "circuitId": { "type": "string" }, "remoteId": { "type": "string" } }, "description": "Model containing the method level model for struct ClearCallTraceIpoeSessionStruct. to decode json data to internal NFM-P object model" }, "evalLeaseStatePerSapIdResponse": { "title": "evalLeaseStatePerSapIdResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/EvalLeaseStatePerSapReturnStruct" }, { "description": "Model containing the method level model for struct EvalLeaseStatePerSapReturnStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for SubscriberHostConfiguration.evalLeaseStatePerSapId to encode json response from internal NFM-P object model" }, "resyncDeclinedAddressesResponse": { "title": "resyncDeclinedAddressesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for AddressPool.resyncDeclinedAddresses to encode json response from internal NFM-P object model" }, "findNetworkElementsAssignableToGroupResponse": { "title": "findNetworkElementsAssignableToGroupResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkElementInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for Group.findNetworkElementsAssignableToGroup to encode json response from internal NFM-P object model" }, "triggerResyncResponse": { "title": "triggerResyncResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int32" } }, "description": "Model containing the method level model for GenericObject.triggerResync to encode json response from internal NFM-P object model" }, "requestPolicyAccountStatsClear": { "title": "requestPolicyAccountStatsClear", "type": "object", "properties": { "aInAcctType": { "type": "integer", "format": "int32" }, "aInAcctIndex": { "type": "integer", "format": "int32" }, "aInClearAll": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for NetworkInterface.requestPolicyAccountStatsClear to decode json data to internal NFM-P object model" }, "TimeStampDto": { "title": "TimeStampDto", "type": "object", "properties": { "includeFormatted": { "type": "boolean", "description": "boolean", "default": false, "example": true } }, "description": "TimeStamp Request DTO" }, "requestClearCpmIpFilterResponse": { "title": "requestClearCpmIpFilterResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for CpmIpFilterEntryBase.requestClearCpmIpFilter to encode json response from internal NFM-P object model" }, "ResidentialSubscriberRetrievalStruct": { "title": "ResidentialSubscriberRetrievalStruct", "required": [ "objectClassName", "siteId", "subscriberIdentification", "includeChildren" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "subscriberIdentification": { "type": "string" }, "includeChildren": { "type": "boolean" } }, "description": "Model containing the method level model for struct ResidentialSubscriberRetrievalStruct. to decode json data to internal NFM-P object model" }, "executeCompareCheckpointResponse": { "title": "executeCompareCheckpointResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for RollbackNEInfo.executeCompareCheckpoint to encode json response from internal NFM-P object model" }, "configureIghMemberResponse": { "title": "configureIghMemberResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for InterfaceGroupHandler.configureIghMember to encode json response from internal NFM-P object model" }, "findSitesForResponse": { "title": "findSitesForResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for VirtualRouterIpAddress.findSitesFor to encode json response from internal NFM-P object model" }, "configureIPSecSecuredVPNResponse": { "title": "configureIPSecSecuredVPNResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for IPSecSecuredVpnManager.configureIPSecSecuredVPN to encode json response from internal NFM-P object model" }, "getCachedHistory": { "title": "getCachedHistory", "required": [ "supervisionGroupName", "startTime" ], "type": "object", "properties": { "supervisionGroupName": { "type": "string", "description": "Supervision Group name.If null, the history of all supervision groupsin the summary view is returned." }, "startTime": { "type": "integer", "description": "If not null, return history of monitoredgroup(s) starting at or after that time.", "format": "int64" } }, "description": "Model containing the method level model for SummaryView.getCachedHistory to decode json data to internal NFM-P object model" }, "findCardsResponse": { "title": "findCardsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for SystemResourceProfilePolicy.findCards to encode json response from internal NFM-P object model" }, "RouteResult": { "title": "RouteResult", "required": [ "objectClassName", "errorCode", "type", "errorMessage", "vertices", "detailedErrors" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "errorCode": { "type": "string" }, "type": { "type": "string" }, "errorMessage": { "type": "string" }, "vertices": { "type": "array", "items": { "$ref": "#/components/schemas/Vertex" }, "description": "" }, "detailedErrors": { "type": "array", "items": { "$ref": "#/components/schemas/DetailedError" }, "description": "" } }, "description": "Model containing the method level model for struct RouteResult. to decode json data to internal NFM-P object model" }, "createCrossConnect": { "title": "createCrossConnect", "type": "object", "properties": { "aInDirection": { "type": "string" }, "aInLineSideLoOdukChannel": { "type": "string" }, "aInOdu1PtfChnanel": { "type": "string" } }, "description": "Model containing the method level model for Odu1PtfChannel.createCrossConnect to decode json data to internal NFM-P object model" }, "findAssociatedISitesResponse": { "title": "findAssociatedISitesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for AbstractVpls.findAssociatedISites to encode json response from internal NFM-P object model" }, "retrieveSubSapError": { "title": "retrieveSubSapError", "required": [ "timeout" ], "type": "object", "properties": { "aInSapPortId": { "type": "integer", "format": "int64" }, "aInReportedTimeMinutes": { "type": "integer", "format": "int32" }, "aInReportedTimeSeconds": { "type": "integer", "format": "int32" }, "aInReportedTimeHours": { "type": "integer", "format": "int32" }, "aInReportedTimeDay": { "type": "integer", "format": "int32" }, "aInReportedTimeMonth": { "type": "integer", "format": "int32" }, "aInReportedTimeYear": { "type": "integer", "format": "int32" }, "aInSapIndex": { "type": "integer", "format": "int64" }, "aInSiteId": { "type": "string" }, "aInInnerEncapValue": { "type": "integer", "format": "int64" }, "aInOuterEncapValue": { "type": "integer", "format": "int64" }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait before receiving the results.The method returns if no results are received in the given time.This is an optional input parameter. The default value is 5 minutes (300000). default:300000", "format": "int64" } }, "description": "Model containing the method level model for SubscrSapError.retrieveSubSapError to decode json data to internal NFM-P object model" }, "findSyncESitesResponse": { "title": "findSyncESitesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for SyncEDomain.findSyncESites to encode json response from internal NFM-P object model" }, "getAllGroupInterfacesResponse": { "title": "getAllGroupInterfacesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/GroupInterfaceInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for DhcpFilter.getAllGroupInterfaces to encode json response from internal NFM-P object model" }, "findPathWithJoinResponse": { "title": "findPathWithJoinResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/PagingResult" }, { "description": "Model containing the method level model for struct PagingResult. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for LspPathOptimizationPolicy.findPathWithJoin to encode json response from internal NFM-P object model" }, "setConfigurationModeToReleasedResponse": { "title": "setConfigurationModeToReleasedResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int32" } }, "description": "Model containing the method level model for PolicyDefinition.setConfigurationModeToReleased to encode json response from internal NFM-P object model" }, "retrieveLocalUserDatabasesResponse": { "title": "retrieveLocalUserDatabasesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for LocalUserDb.retrieveLocalUserDatabases to encode json response from internal NFM-P object model" }, "findAllServicePathsResponse": { "title": "findAllServicePathsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/ServicePathInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for TransportService.findAllServicePaths to encode json response from internal NFM-P object model" }, "clearFaultsOnObject": { "title": "clearFaultsOnObject", "required": [ "baseInstanceFullName", "faultFilter" ], "type": "object", "properties": { "baseInstanceFullName": { "type": "string", "description": "Full name of the affected object on which the alarms should be cleared." }, "faultFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for FaultManager.clearFaultsOnObject to decode json data to internal NFM-P object model" }, "findFateSharedInterfaces": { "title": "findFateSharedInterfaces", "required": [ "anInfilter", "fields", "sortFields", "pageNumber", "pageSize" ], "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInserviceId": { "type": "integer", "format": "int64" }, "aInInterfaceDN": { "type": "string" }, "anInfilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "fields": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Fields to fetch" }, "sortFields": { "type": "array", "items": { "type": "string" }, "description": "Sorting fields" }, "pageNumber": { "type": "integer", "description": "Page number", "format": "int32" }, "pageSize": { "type": "integer", "description": "The number of entries to return", "format": "int32" } }, "description": "Model containing the method level model for SpokeSdpBindingInterface.findFateSharedInterfaces to decode json data to internal NFM-P object model" }, "findMcRingProtectedSapsOnRing": { "title": "findMcRingProtectedSapsOnRing", "required": [ "ringFdn", "sapFilter" ], "type": "object", "properties": { "ringFdn": { "type": "string" }, "sapFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for L2AccessInterface.findMcRingProtectedSapsOnRing to decode json data to internal NFM-P object model" }, "clearFib": { "title": "clearFib", "required": [ "siteId", "shelfId", "slotId", "daughterCardSlotId" ], "type": "object", "properties": { "siteId": { "type": "string" }, "shelfId": { "type": "integer", "format": "int64" }, "slotId": { "type": "integer", "format": "int32" }, "daughterCardSlotId": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for MdaStaticMacFdb.clearFib to decode json data to internal NFM-P object model" }, "findResponse": { "title": "findResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for RadiusServerItem.find to encode json response from internal NFM-P object model" }, "retrieveWlanGwUeCountResponse": { "title": "retrieveWlanGwUeCountResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int64" } }, "description": "Model containing the method level model for WlanGwQbtUe.retrieveWlanGwUeCount to encode json response from internal NFM-P object model" }, "removeGroupsResponse": { "title": "removeGroupsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for SummaryView.removeGroups to encode json response from internal NFM-P object model" }, "listGroupsResponse": { "title": "listGroupsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for SummaryView.listGroups to encode json response from internal NFM-P object model" }, "findValidTerminationPointsForTrail": { "title": "findValidTerminationPointsForTrail", "type": "object", "properties": { "aInTrailInfo": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" }, { "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } ] }, "aInTrailSiteInfo": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" }, { "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for TrailSite.findValidTerminationPointsForTrail to decode json data to internal NFM-P object model" }, "retrieveHostSharedPccRuleIngressPolicyResponse": { "title": "retrieveHostSharedPccRuleIngressPolicyResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, { "description": "Model containing the method level model for struct CommonManagedEntityInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for Policy.retrieveHostSharedPccRuleIngressPolicy to encode json response from internal NFM-P object model" }, "ClearHostStruct": { "title": "ClearHostStruct", "required": [ "objectClassName", "siteId", "ipAddress", "sapId", "subscrIdent" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "ipAddress": { "type": "string" }, "sapId": { "type": "string" }, "subscrIdent": { "type": "string" } }, "description": "Model containing the method level model for struct ClearHostStruct. to decode json data to internal NFM-P object model" }, "testConnectionToHsmResponse": { "title": "testConnectionToHsmResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "boolean", "description": "The response object." } }, "description": "Model containing the method level model for HSMConfig.testConnectionToHsm to encode json response from internal NFM-P object model" }, "findInstanceContainedPeersResponse": { "title": "findInstanceContainedPeersResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for AbstractMultiChassisPeer.findInstanceContainedPeers to encode json response from internal NFM-P object model" }, "findAssociatedSamUserGroupsResponse": { "title": "findAssociatedSamUserGroupsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for ServiceCreationSpanRule.findAssociatedSamUserGroups to encode json response from internal NFM-P object model" }, "restoreServiceForThroughputTestResponse": { "title": "restoreServiceForThroughputTestResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for Epipe.restoreServiceForThroughputTest to encode json response from internal NFM-P object model" }, "acknowledgeFaultList": { "title": "acknowledgeFaultList", "required": [ "faultObjectNameSet", "alteredSeverity", "urgency", "text", "doMarkAsAcknowledged", "doDelete" ], "type": "object", "properties": { "faultObjectNameSet": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Set of alarm full names to be acknowledged." }, "alteredSeverity": { "type": "string", "description": "New severity, unspecified severity leaves the severity unchanged." }, "urgency": { "type": "string", "description": "New urgency, unspecified urgency leaves the urgency unchanged." }, "text": { "type": "string", "description": "Text of the alarm note added as part of the acknowledgment." }, "doMarkAsAcknowledged": { "type": "boolean", "description": "Indicates whether to acknowledge the alarm or not." }, "doDelete": { "type": "boolean", "description": "Indicates whether to delete the alarm or not." } }, "description": "Model containing the method level model for FaultManager.acknowledgeFaultList to decode json data to internal NFM-P object model" }, "executeMultiCliResponse": { "title": "executeMultiCliResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for NetworkElement.executeMultiCli to encode json response from internal NFM-P object model" }, "retrieveAddrPools": { "title": "retrieveAddrPools", "required": [ "retrieveIpAddrs" ], "type": "object", "properties": { "aInBrgId": { "type": "string" }, "aInPoolName": { "type": "string" }, "aInSiteId": { "type": "string" }, "aInTimeout": { "type": "integer", "format": "int64" }, "retrieveIpAddrs": { "type": "boolean", "description": "Specifies to retrieve Standby IP addresses of the pool or not. Default is FALSE.This is optional parameter. default:false" } }, "description": "Model containing the method level model for SubBrgAddressPool.retrieveAddrPools to decode json data to internal NFM-P object model" }, "retrieveSubUnknownErrorResponse": { "title": "retrieveSubUnknownErrorResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for SubscrUnknownError.retrieveSubUnknownError to encode json response from internal NFM-P object model" }, "findCtpsOnMultiplePortsWithFilterResponse": { "title": "findCtpsOnMultiplePortsWithFilterResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionTerminationPointInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for ConnectionTerminationPoint.findCtpsOnMultiplePortsWithFilter to encode json response from internal NFM-P object model" }, "findGroupBindingsResponse": { "title": "findGroupBindingsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/GroupBindingInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for Group.findGroupBindings to encode json response from internal NFM-P object model" }, "igpShortestPathFirstGraphSetResponse": { "title": "igpShortestPathFirstGraphSetResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ShortestPathGraph" }, "description": "The response object." } }, "description": "Model containing the method level model for TopologyManager.igpShortestPathFirstGraphSet to encode json response from internal NFM-P object model" }, "executeFromListResponse": { "title": "executeFromListResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int64" } }, "description": "Model containing the method level model for LspPathOptimizationPolicy.executeFromList to encode json response from internal NFM-P object model" }, "getServerVersionResponse": { "title": "getServerVersionResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for TSecurityManager.getServerVersion to encode json response from internal NFM-P object model" }, "findPMSessionsVPRNSitesResponse": { "title": "findPMSessionsVPRNSitesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for TestManager.findPMSessionsVPRNSites to encode json response from internal NFM-P object model" }, "scheduleActivate": { "title": "scheduleActivate", "required": [ "schedule", "networkElements" ], "type": "object", "properties": { "schedule": { "type": "string" }, "networkElements": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" } }, "description": "Model containing the method level model for RANSoftwareFolderDescriptor.scheduleActivate to decode json data to internal NFM-P object model" }, "applyStaticPortMapRequestsResponse": { "title": "applyStaticPortMapRequestsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/StaticPortMapRequestConfigInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for StaticPortMapRequest.applyStaticPortMapRequests to encode json response from internal NFM-P object model" }, "executeTargetScripts": { "title": "executeTargetScripts", "required": [ "isSynchronized", "clientId", "listOfTargetScriptConfigInfo" ], "type": "object", "properties": { "isSynchronized": { "type": "boolean", "description": "Identifies if the call to execute the script should wait until all scripts have been executed. True to wait, false otherwise." }, "clientId": { "type": "string", "description": "Identifies the client ID that is requesting the execution (used for sending an event to the specific client when execution is complete)." }, "listOfTargetScriptConfigInfo": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" }, "description": "The configuration info for the targets when executing (runtime parameters)." } }, "description": "Model containing the method level model for ScriptManager.executeTargetScripts to decode json data to internal NFM-P object model" }, "getHopsCount": { "title": "getHopsCount", "required": [ "svcMgrId", "pathType", "reverseDirection" ], "type": "object", "properties": { "svcMgrId": { "type": "integer", "description": "Service manager Id.", "format": "int64" }, "pathType": { "type": "integer", "description": "Path type - unprotected(1) working(2) protected(3).", "format": "int32" }, "reverseDirection": { "type": "boolean", "description": "If 'false' the hops count done in direction from A to Z.If 'true' the hops count done in reverse direction (from Z to A)." } }, "description": "Model containing the method level model for TransportService.getHopsCount to decode json data to internal NFM-P object model" }, "retrieveSubSvc": { "title": "retrieveSubSvc", "type": "object", "properties": { "aInEncapValue": { "type": "integer", "format": "int64" }, "aInAddrType": { "type": "string" }, "aInAddress": { "type": "string" }, "aInPppoeSessionId": { "type": "integer", "format": "int64" }, "aInSiteId": { "type": "string" }, "aInServiceId": { "type": "integer", "format": "int64" }, "aInMacAddr": { "type": "string" }, "aInPortId": { "type": "integer", "format": "int64" }, "aInSubId": { "type": "string" } }, "description": "Model containing the method level model for SubscriberService.retrieveSubSvc to decode json data to internal NFM-P object model" }, "impactAnalysisDetails": { "title": "impactAnalysisDetails", "required": [ "objectType", "reason", "filter", "fields", "sortFields", "pageNumber", "pageSize" ], "type": "object", "properties": { "objectType": { "type": "integer", "format": "int32" }, "reason": { "type": "integer", "format": "int32" }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "fields": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Sorting fields" }, "sortFields": { "type": "array", "items": { "type": "string" }, "description": "Sorting fields" }, "pageNumber": { "type": "integer", "description": "Page number", "format": "int32" }, "pageSize": { "type": "integer", "description": "The number of entries to return", "format": "int32" } }, "description": "Model containing the method level model for AbstractImpactAnalysisTimeRange.impactAnalysisDetails to decode json data to internal NFM-P object model" }, "getIncrementalRequestIDResponse": { "title": "getIncrementalRequestIDResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int64" } }, "description": "Model containing the method level model for GenericObject.getIncrementalRequestID to encode json response from internal NFM-P object model" }, "executeResponse": { "title": "executeResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for XmlApiConfigTemplate.execute to encode json response from internal NFM-P object model" }, "prepareThroughputTestResponse": { "title": "prepareThroughputTestResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for CompositeService.prepareThroughputTest to encode json response from internal NFM-P object model" }, "importImageResponse": { "title": "importImageResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "boolean", "description": "The response object." } }, "description": "Model containing the method level model for SoftwareFolderManager.importImage to encode json response from internal NFM-P object model" }, "updateDataServicesResponse": { "title": "updateDataServicesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int32" } }, "description": "Model containing the method level model for Ring.updateDataServices to encode json response from internal NFM-P object model" }, "retrieveIsaPoolSubnetsResponse": { "title": "retrieveIsaPoolSubnetsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for IsaPoolSubnet.retrieveIsaPoolSubnets to encode json response from internal NFM-P object model" }, "addIPoECallTraceJobResponse": { "title": "addIPoECallTraceJobResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for CallTraceConfig.addIPoECallTraceJob to encode json response from internal NFM-P object model" }, "requestClearEfmOamEventLogsResponse": { "title": "requestClearEfmOamEventLogsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for PortCrossConnectSubPort.requestClearEfmOamEventLogs to encode json response from internal NFM-P object model" }, "retrieveChannels": { "title": "retrieveChannels", "required": [ "shelfId", "slotId", "daughterCardSlotId", "timeout", "filter" ], "type": "object", "properties": { "aInRtrId": { "type": "string" }, "shelfId": { "type": "integer", "description": "ShelfId of the MDA.", "format": "int32" }, "slotId": { "type": "integer", "description": "Slot number of the MDA.", "format": "int32" }, "daughterCardSlotId": { "type": "integer", "description": "Daughter card slot of the MDA.", "format": "int32" }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns.", "format": "int64" }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for IngrPathMgmtOperationalChannelMda.retrieveChannels to decode json data to internal NFM-P object model" }, "createCrossConnectResponse": { "title": "createCrossConnectResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for CompositeService.createCrossConnect to encode json response from internal NFM-P object model" }, "moveSapToAnotherServiceResponse": { "title": "moveSapToAnotherServiceResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for AccessInterface.moveSapToAnotherService to encode json response from internal NFM-P object model" }, "RoutedVplsConnectorConfigInfo": { "title": "RoutedVplsConnectorConfigInfo", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap", "containmentInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } }, "displayedName": { "type": "string" }, "description": { "type": "string" }, "firstSvcPointer": { "type": "string" }, "secondSvcPointer": { "type": "string" }, "firstSitePointer": { "type": "string" }, "secondSitePointer": { "type": "string" }, "accessInterfacePointer": { "type": "string" }, "vplsSitePointer": { "type": "string" } }, "description": "Model containing the method level model for Interface ConfigInfo RoutedVplsConnectorConfigInfo. to decode json data to internal NFM-P object model" }, "findInterfaces": { "title": "findInterfaces", "required": [ "filter" ], "type": "object", "properties": { "aInClassName": { "type": "string" }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for SharedRiskLinkGroup.findInterfaces to decode json data to internal NFM-P object model" }, "findSyncTagsResponse": { "title": "findSyncTagsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for PeerSynchronizationProtocol.findSyncTags to encode json response from internal NFM-P object model" }, "retrieveL2AwHosts": { "title": "retrieveL2AwHosts", "required": [ "timeout" ], "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInResidentialSubIdent": { "type": "string" }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait before receiving the results.This is an optional input parameter. The default value is 5 minutes (300000). default:300000", "format": "int64" } }, "description": "Model containing the method level model for L2AwHosts.retrieveL2AwHosts to decode json data to internal NFM-P object model" }, "PropertyDiff": { "title": "PropertyDiff", "required": [ "objectClassName", "diffType", "name", "baseValue", "compareToValue", "baseValueUnset", "compareToValueUnset" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "diffType": { "type": "string" }, "name": { "type": "string" }, "baseValue": { "type": "object" }, "compareToValue": { "type": "object" }, "baseValueUnset": { "type": "boolean" }, "compareToValueUnset": { "type": "boolean" } }, "description": "Model containing the method level model for struct PropertyDiff. to decode json data to internal NFM-P object model" }, "SoftwareFolderManager": { "title": "SoftwareFolderManager", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "actionMask": { "type": "integer", "format": "int32" }, "selfAlarmed": { "type": "boolean", "default": false }, "name": { "type": "string" } }, "description": "Managed object abstract class" }, "IGHMemCreateInfo": { "title": "IGHMemCreateInfo", "required": [ "objectClassName", "parentDN", "portPointer" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "parentDN": { "type": "string" }, "portPointer": { "type": "string" } }, "description": "Model containing the method level model for struct IGHMemCreateInfo. to decode json data to internal NFM-P object model" }, "retrieveLsnBlockAllocationsResponse": { "title": "retrieveLsnBlockAllocationsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for LsnBlockAllocation.retrieveLsnBlockAllocations to encode json response from internal NFM-P object model" }, "DaughterCardInfo": { "title": "DaughterCardInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "mcastSource": { "type": "boolean", "default": false }, "mcastGroup": { "type": "integer", "format": "int32" }, "mcastAlarm": { "type": "boolean", "default": false }, "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "administrativeState": { "type": "integer", "format": "int32" }, "oesShelfId": { "type": "integer", "format": "int32" }, "phyShelfClass": { "type": "integer", "format": "int32" }, "phyShelfType": { "type": "integer", "format": "int32" }, "lockOlcState": { "type": "boolean", "default": false }, "slotId": { "type": "integer", "format": "int32" }, "specificType": { "type": "integer", "format": "int32" }, "cardStatus": { "type": "integer", "format": "int32" }, "daughterCardSlotId": { "type": "integer", "format": "int32" }, "isXiomMda": { "type": "boolean", "default": false }, "networkQueueObjectPointer": { "type": "string" }, "inMCM": { "type": "boolean", "default": false }, "mdaIngrNamedPoolPolicy": { "type": "string" }, "mdaEgrNamedPoolPolicy": { "type": "string" }, "mdaEgrHsmdaPoolPolicyPointer": { "type": "string" }, "mdaEgrHsmdaThrshlowBurstMultiplier": { "type": "integer", "format": "int32" }, "mdaEgrHsmdaThrshHighBurstIncrease": { "type": "integer", "format": "int32" }, "ingrPathMgmtBwPolicyPointer": { "type": "string" }, "primaryPathLimit": { "type": "integer", "format": "int32" }, "secondaryPathLimit": { "type": "integer", "format": "int32" }, "ancillaryPathLimit": { "type": "integer", "format": "int32" }, "ingrPathMgmtAdminState": { "type": "integer", "format": "int32" }, "syncE": { "type": "boolean", "default": false }, "atmMode": { "type": "integer", "format": "int32" }, "networkFabricProfilePointer": { "type": "string" }, "networkSecurityQueuePolicyPointer": { "type": "string" }, "accessSecurityQueuePolicyPointer": { "type": "string" }, "accessFabricProfilePointer": { "type": "string" }, "voiceCompanding": { "type": "integer", "format": "int32" }, "voiceSigType": { "type": "integer", "format": "int32" }, "mdaMode": { "type": "integer", "format": "int32" }, "vcbApplication": { "type": "integer", "format": "int32" }, "fabricStats": { "type": "boolean", "default": false }, "tunnelGroup": { "type": "integer", "format": "int32" }, "tunnelGroupPointer": { "type": "string" }, "addDropQueuePolicyPointer": { "type": "string" }, "ringNwQosPolicyPointer": { "type": "string" }, "powerPriorityLevel": { "type": "integer", "format": "int32" }, "poePowerSupplyMode": { "type": "integer", "format": "int32" }, "mdaFailOnError": { "type": "integer", "format": "int64" }, "mdaResetOnRecoverableError": { "type": "boolean", "default": false }, "mdaEgrXplErrThreshold": { "type": "integer", "format": "int64" }, "mdaEgrXplErrWindow": { "type": "integer", "format": "int32" }, "mdaIngrXplErrThreshold": { "type": "integer", "format": "int64" }, "mdaIngrXplErrWindow": { "type": "integer", "format": "int32" }, "mdaTuAis": { "type": "boolean", "default": false }, "mdaSptAggrRate": { "type": "integer", "format": "int64" }, "accessShaperPolicyPointer": { "type": "string" } }, "description": "Model containing the method level model for Interface DaughterCardInfo. to decode json data to internal NFM-P object model" }, "constrainedShortestPathFirstGraphExt": { "title": "constrainedShortestPathFirstGraphExt", "required": [ "igpAdminDomain", "protocol", "source", "destType", "dest", "destLen", "constraints" ], "type": "object", "properties": { "igpAdminDomain": { "type": "string", "description": "The IGP Admin Domain ({{topology.AutonomousSystem}}) to perform the CSPF in." }, "protocol": { "type": "string", "description": "The protocol to run CSPF on. Only OSPF and ISIS aresupported." }, "source": { "type": "string", "description": "The source address. The format ofthe source is based on the sourceType property." }, "destType": { "type": "string", "description": "The address type of the destination. Currently only ipv4 issupported." }, "dest": { "type": "string", "description": "The destination address. The format ofthe destination is based on the destType property." }, "destLen": { "type": "integer", "description": "The length of the destination address. Its valid valuesdepend on the destType.", "format": "int32" }, "constraints": { "allOf": [ { "$ref": "#/components/schemas/Constraints" }, { "description": "Model containing the method level model for struct Constraints. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for TopologyManager.constrainedShortestPathFirstGraphExt to decode json data to internal NFM-P object model" }, "StaticPortMappingInfo": { "title": "StaticPortMappingInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "type": { "type": "integer", "format": "int32" }, "subIdent": { "type": "string" }, "routerId": { "type": "integer", "format": "int32" }, "nodeId": { "type": "string" }, "b4AddressType": { "type": "integer", "format": "int32" }, "ipv6B4Address": { "type": "string" }, "ipAddress": { "type": "string" }, "protocol": { "type": "integer", "format": "int32" }, "port": { "type": "integer", "format": "int32" }, "natPolicy": { "type": "string" } }, "description": "Model containing the method level model for Interface StaticPortMappingInfo. to decode json data to internal NFM-P object model" }, "findInstanceApsBundlesResponse": { "title": "findInstanceApsBundlesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for MultiChassisApsInterface.findInstanceApsBundles to encode json response from internal NFM-P object model" }, "configureDomainSitesResponse": { "title": "configureDomainSitesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "boolean", "description": "The response object." } }, "description": "Model containing the method level model for Domain.configureDomainSites to encode json response from internal NFM-P object model" }, "AuditStatus": { "title": "AuditStatus", "required": [ "objectClassName", "status", "errorCode", "noOfProblems", "auditFdn", "targetFdn", "lastAudited" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "status": { "type": "string" }, "errorCode": { "type": "string" }, "noOfProblems": { "type": "integer", "format": "int32" }, "auditFdn": { "type": "string" }, "targetFdn": { "type": "string" }, "lastAudited": { "type": "string" } }, "description": "Model containing the method level model for struct AuditStatus. to decode json data to internal NFM-P object model" }, "activate": { "title": "activate", "required": [ "sessionFdn", "neWorkOrders" ], "type": "object", "properties": { "sessionFdn": { "type": "string", "description": "The session to validate." }, "neWorkOrders": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The set of NE work orders to validate. The NE work orders must be in the given session." } }, "description": "Model containing the method level model for Session.activate to decode json data to internal NFM-P object model" }, "retrieveScriptSnippetRootObjectsResponse": { "title": "retrieveScriptSnippetRootObjectsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for DynSvcSnippetInfo.retrieveScriptSnippetRootObjects to encode json response from internal NFM-P object model" }, "RtrvHostSharedPccRuleIngPolicyStruct": { "title": "RtrvHostSharedPccRuleIngPolicyStruct", "required": [ "objectClassName", "siteId", "policyId", "retrieveEntryOption", "startEntry", "entryCount" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "policyId": { "type": "integer", "format": "int64" }, "retrieveEntryOption": { "type": "boolean" }, "startEntry": { "type": "integer", "format": "int32" }, "entryCount": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for struct RtrvHostSharedPccRuleIngPolicyStruct. to decode json data to internal NFM-P object model" }, "retrieveTransitSubscribers": { "title": "retrieveTransitSubscribers", "required": [ "timeout", "dbInfoTransitSubscriberRetrievalInfoList" ], "type": "object", "properties": { "timeout": { "type": "integer", "description": "The number of milliseconds to wait beforereceiving the results. If the results arenot received in the given time, the method returns.", "format": "int64" }, "dbInfoTransitSubscriberRetrievalInfoList": { "type": "array", "items": { "$ref": "#/components/schemas/DbInfoTransitSubscriberRetrievalStruct" }, "description": "" } }, "description": "Model containing the method level model for DbInfoTransitSubscriberManager.retrieveTransitSubscribers to decode json data to internal NFM-P object model" }, "retrievePPPoASessions": { "title": "retrievePPPoASessions", "required": [ "retrievingSessionStruct", "retrieveManagedRoutes", "retrieveQoSOvr", "retrieveAcclpEncap", "retrieveBgpPeerInfo", "retrieveBgpPeerV6Info" ], "type": "object", "properties": { "aInCircuitId": { "type": "string" }, "aInRemoteId": { "type": "string" }, "retrievingSessionStruct": { "allOf": [ { "$ref": "#/components/schemas/RetrievingSessionStruct" }, { "description": "Model containing the method level model for struct RetrievingSessionStruct. to decode json data to internal NFM-P object model" } ] }, "retrieveManagedRoutes": { "type": "boolean", "description": "Specifies if Managed Routes should be retrieved,the default is \"true\".The Managed Routes won't be retrieved if Service preferences \"retrieveManagedRoutes\" isfalse. default:true" }, "retrieveQoSOvr": { "type": "boolean", "description": "Specifies if QoS Override should be retrieved,the default is \"true\".The QoS Override won't be retrieved if Service preferences \"retrieveQoSOvr\" is false. default:true" }, "retrieveAcclpEncap": { "type": "boolean", "description": "Specifies if Access Loop Encapsulation should be retrieved,the default is \"true\".The Access Loop Encapsulation won't be retrieved if Service preferences \"retrieveAcclpEncap\" is false. default:true" }, "retrieveBgpPeerInfo": { "type": "boolean", "description": "Specifies if Ipv4 BGP Peer Info should be retrieved,the default is \"true\".The BGP Peer Info won't be retrieved if System Preferences \"retrieveBgpPeerInfo\" isfalse. default:true" }, "retrieveBgpPeerV6Info": { "type": "boolean", "description": "Specifies if Ipv6 BGP Peer Info should be retrieved,the default is \"true\".The BGP Peer Info won't be retrieved if System Preferences \"retrieveBgpPeerV6Info\" isfalse. default:true" } }, "description": "Model containing the method level model for PPPoASession.retrievePPPoASessions to decode json data to internal NFM-P object model" }, "SubHostBaseInfoStruct": { "title": "SubHostBaseInfoStruct", "required": [ "objectClassName", "hostOrigin", "ipAddressType", "siteId", "svcId", "subIdent", "portId", "pppSessionIndex", "ipAddress", "macAddress" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "hostOrigin": { "type": "array", "items": { "type": "string" }, "description": "" }, "ipAddressType": { "type": "string" }, "siteId": { "type": "string" }, "svcId": { "type": "integer", "format": "int64" }, "subIdent": { "type": "string" }, "portId": { "type": "integer", "format": "int64" }, "pppSessionIndex": { "type": "integer", "format": "int64" }, "ipAddress": { "type": "string" }, "macAddress": { "type": "string" } }, "description": "Model containing the method level model for struct SubHostBaseInfoStruct. to decode json data to internal NFM-P object model" }, "findLocalAddress": { "title": "findLocalAddress", "required": [ "virtualAnyCastRPFullName", "filter" ], "type": "object", "properties": { "virtualAnyCastRPFullName": { "type": "string" }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for VirtualAnyCastRP.findLocalAddress to decode json data to internal NFM-P object model" }, "requestClearMeshSdpBfdSessionResponse": { "title": "requestClearMeshSdpBfdSessionResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for MeshSdpBinding.requestClearMeshSdpBfdSession to encode json response from internal NFM-P object model" }, "removePcmResponse": { "title": "removePcmResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/PowerConnectionModules" }, { "description": "Managed object abstract class" } ] } }, "description": "Model containing the method level model for PCMTray.removePcm to encode json response from internal NFM-P object model" }, "findReassemblyPortsResponse": { "title": "findReassemblyPortsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for IPPacketReassemblySpecifics.findReassemblyPorts to encode json response from internal NFM-P object model" }, "restoreCompSvcForThroughputTestResponse": { "title": "restoreCompSvcForThroughputTestResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for CompositeService.restoreCompSvcForThroughputTest to encode json response from internal NFM-P object model" }, "clearTestResultsResponse": { "title": "clearTestResultsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for Y1564TestHeadProfile.clearTestResults to encode json response from internal NFM-P object model" }, "findServiceReadyCtpsPerNodeResponse": { "title": "findServiceReadyCtpsPerNodeResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionTerminationPointInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for PhysicalInterfaceCtp.findServiceReadyCtpsPerNode to encode json response from internal NFM-P object model" }, "CompareResult": { "title": "CompareResult", "required": [ "objectClassName", "compareBase", "compareTo", "objectDiffs" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "compareBase": { "type": "string" }, "compareTo": { "type": "string" }, "objectDiffs": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectDiff" }, "description": "" } }, "description": "Model containing the method level model for struct CompareResult. to decode json data to internal NFM-P object model" }, "requestClearProxyArpDupsResponse": { "title": "requestClearProxyArpDupsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for Site.requestClearProxyArpDups to encode json response from internal NFM-P object model" }, "findOpticalLinksResponse": { "title": "findOpticalLinksResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/OpticalLinkInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for PointToPointConnection.findOpticalLinks to encode json response from internal NFM-P object model" }, "adhocExecuteAndWait": { "title": "adhocExecuteAndWait", "required": [ "testedObject", "test", "timeout", "keepTest" ], "type": "object", "properties": { "testedObject": { "type": "string", "description": "The object under test or system Address of your node." }, "test": { "allOf": [ { "$ref": "#/components/schemas/TestConfigInfo" }, { "description": "Model containing the method level model for Interface ConfigInfo TestConfigInfo. to decode json data to internal NFM-P object model" } ] }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns.", "format": "int64" }, "keepTest": { "type": "boolean", "description": "Setting this parameter to false means that anytest created for the purposes of executionwill be deleted after the results are receivedfrom the network." } }, "description": "Model containing the method level model for Test.adhocExecuteAndWait to decode json data to internal NFM-P object model" }, "VtsConnectionInfo": { "title": "VtsConnectionInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "administrativeState": { "type": "integer", "format": "int32" }, "connId": { "type": "integer", "format": "int64" }, "biDirectional": { "type": "boolean", "default": false }, "connectionType": { "type": "integer", "format": "int32" }, "portAPointer": { "type": "string" }, "portZPointer": { "type": "string" }, "ctpAPointer": { "type": "string" }, "ctpZPointer": { "type": "string" }, "protectionState": { "type": "integer", "format": "int32" }, "protectionLevel": { "type": "integer", "format": "int32" }, "modifyFlag": { "type": "boolean", "default": false }, "isRidingOnConnGroup": { "type": "boolean", "default": false }, "xcId": { "type": "integer", "format": "int64" }, "xcName": { "type": "string" }, "siteId": { "type": "string" }, "siteName": { "type": "string" }, "shelfId": { "type": "integer", "format": "int32" }, "slotId": { "type": "integer", "format": "int64" }, "srcVtsNumber": { "type": "integer", "format": "int32" }, "destVtsNumber": { "type": "integer", "format": "int32" }, "vtsNumber": { "type": "integer", "format": "int32" }, "vtsLine": { "type": "integer", "format": "int32" }, "vtsConnSrcIfIndex": { "type": "integer", "format": "int64" }, "vtsConnSrcVts": { "type": "integer", "format": "int64" }, "vtsConnDestIfIndex": { "type": "integer", "format": "int64" }, "vtsConnDestVts": { "type": "integer", "format": "int64" }, "destCardSlotId": { "type": "integer", "format": "int32" }, "vtsConnSrcPortId": { "type": "string" }, "vtsConnDestPortId": { "type": "string" }, "vtsConnName": { "type": "string" }, "vtsCommittedInfoRate": { "type": "integer", "format": "int32" }, "vtsCommittedBurstRate": { "type": "integer", "format": "int32" }, "vtsExcessInfoRate": { "type": "integer", "format": "int32" }, "vtsExcessBurstRate": { "type": "integer", "format": "int32" }, "showInGUI": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for Interface VtsConnectionInfo. to decode json data to internal NFM-P object model" }, "ClearIpoeSessionStruct": { "title": "ClearIpoeSessionStruct", "required": [ "objectClassName", "siteId", "svcId", "sapId", "interfaceName", "macAddress", "circuitId", "remoteId", "interDestId", "ipAddress", "portName", "subscriberName", "sapSessionId" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "svcId": { "type": "integer", "format": "int64" }, "sapId": { "type": "string" }, "interfaceName": { "type": "string" }, "macAddress": { "type": "string" }, "circuitId": { "type": "string" }, "remoteId": { "type": "string" }, "interDestId": { "type": "string" }, "ipAddress": { "type": "string" }, "portName": { "type": "string" }, "subscriberName": { "type": "string" }, "sapSessionId": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct ClearIpoeSessionStruct. to decode json data to internal NFM-P object model" }, "reload": { "title": "reload", "required": [ "networkElements", "isIssu" ], "type": "object", "properties": { "networkElements": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "isIssu": { "type": "boolean" } }, "description": "Model containing the method level model for OmniSoftwareFolderDescriptor.reload to decode json data to internal NFM-P object model" }, "getPollerManagerResponse": { "title": "getPollerManagerResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/PollerManager" }, { "description": "Managed object abstract class" } ] } }, "description": "Model containing the method level model for PollerManager.getPollerManager to encode json response from internal NFM-P object model" }, "getTimeRangeEntryAssignmentsResponse": { "title": "getTimeRangeEntryAssignmentsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for TimeRangeEntryAssignment.getTimeRangeEntryAssignments to encode json response from internal NFM-P object model" }, "findNsgUbrsInGroupResponse": { "title": "findNsgUbrsInGroupResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for NsgUbrGroup.findNsgUbrsInGroup to encode json response from internal NFM-P object model" }, "resetPeerSyncProtocolsResponse": { "title": "resetPeerSyncProtocolsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for AbstractMultiChassisPeer.resetPeerSyncProtocols to encode json response from internal NFM-P object model" }, "retrievePPPoESessionsResponse": { "title": "retrievePPPoESessionsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for PPPoESession.retrievePPPoESessions to encode json response from internal NFM-P object model" }, "IncrementalContext": { "title": "IncrementalContext", "required": [ "objectClassName", "jmsClientId", "handlerName", "appDefinedContext" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "jmsClientId": { "type": "string" }, "handlerName": { "type": "string" }, "appDefinedContext": { "type": "object" } }, "description": "Model containing the method level model for struct IncrementalContext. to decode json data to internal NFM-P object model" }, "configureTopologyGroupResponse": { "title": "configureTopologyGroupResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for TopologyGroupManager.configureTopologyGroup to encode json response from internal NFM-P object model" }, "retrieveAdaptiveClockHistoryResponse": { "title": "retrieveAdaptiveClockHistoryResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for AdaptiveClockHistory.retrieveAdaptiveClockHistory to encode json response from internal NFM-P object model" }, "findSyncTimeSourcesResponse": { "title": "findSyncTimeSourcesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/PagingResult" }, { "description": "Model containing the method level model for struct PagingResult. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for SiteSync.findSyncTimeSources to encode json response from internal NFM-P object model" }, "SpecificData": { "title": "SpecificData", "required": [ "objectClassName", "xpath", "unset", "simpleValue", "listValue", "indexedListValue" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "xpath": { "type": "string" }, "unset": { "type": "string" }, "simpleValue": { "type": "string" }, "listValue": { "type": "array", "items": { "type": "string" }, "description": "" }, "indexedListValue": { "type": "array", "items": { "$ref": "#/components/schemas/IndexedValue" }, "description": "" } }, "description": "Model containing the method level model for struct SpecificData. to decode json data to internal NFM-P object model" }, "getIfsForUtilizationRangeResponse": { "title": "getIfsForUtilizationRangeResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/IfUtilizationDetail" }, "description": "The response object." } }, "description": "Model containing the method level model for CpamStatisticManager.getIfsForUtilizationRange to encode json response from internal NFM-P object model" }, "PollerManager": { "title": "PollerManager", "required": [ "pollingSyncTime", "basePollingInterval", "snmpStreamingAdminState", "ftpResyncAdminState", "topologyScanInterval", "targetName", "peerTargetName", "trapDestinationIpv4AddressType", "trapDestinationIpAddress", "trapDestinationIpAddressType", "trapDestinationIpv6Address", "trapDestinationPort", "trapLogId", "trapDestinationIpv4AddressSecondType", "trapDestinationIpAddressSecond", "trapDestinationIpAddressSecondType", "trapDestinationIpv6AddressSecond", "trapDestinationPortSecond", "trapLogIdSecond", "administrativeState", "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties" ], "type": "object", "properties": { "pollingSyncTime": { "type": "integer", "description": "Specifies the polling synchronizationstart time from which the polling intervals are calculated based ona 24-hour clock. When the server restarts, the next appropriate collection interval iscalculated and polling restarts for all enabled MIBs. The default is 00:00.Time is specified in milliseconds from 00:00 UTC.", "format": "int64" }, "basePollingInterval": { "type": "integer", "description": "Specifies how often MIB elements of discovered andmanaged devices are polled for changes to their MIBs. When changes are detected,the NFM-P rereads the MIB element and updates the database.", "format": "int32" }, "snmpStreamingAdminState": { "type": "integer", "description": "When up NFM-P tries to use SNMP Streaming instead of UDP-based SNMP.", "format": "int32" }, "ftpResyncAdminState": { "type": "integer", "description": "When up NFM-P tries to resync nodes by requesting dump of NE config through FTP.The config output is parsed and populated in NFM-P.Normal resync is performed, if node does not support this functionality.", "format": "int32" }, "topologyScanInterval": { "type": "integer", "description": "How often to scan IP ranges in discovery rules.", "format": "int32" }, "targetName": { "type": "string", "description": "[0,50]", "example": " maximum: 50" }, "peerTargetName": { "type": "string", "description": "[0,50]", "example": " maximum: 50" }, "trapDestinationIpv4AddressType": { "type": "integer", "format": "int32" }, "trapDestinationIpAddress": { "type": "string" }, "trapDestinationIpAddressType": { "type": "integer", "format": "int32" }, "trapDestinationIpv6Address": { "type": "string", "readOnly": true }, "trapDestinationPort": { "type": "integer", "description": "[1,65535]", "format": "int32" }, "trapLogId": { "type": "integer", "description": "[1,98]", "format": "int32" }, "trapDestinationIpv4AddressSecondType": { "type": "integer", "format": "int32" }, "trapDestinationIpAddressSecond": { "type": "string" }, "trapDestinationIpAddressSecondType": { "type": "integer", "format": "int32" }, "trapDestinationIpv6AddressSecond": { "type": "string", "readOnly": true }, "trapDestinationPortSecond": { "type": "integer", "description": "[1,65535]", "format": "int32" }, "trapLogIdSecond": { "type": "integer", "description": "[1,98]", "format": "int32" }, "administrativeState": { "type": "integer", "format": "int32" }, "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "actionMask": { "type": "integer", "format": "int32" }, "selfAlarmed": { "type": "boolean", "default": false }, "name": { "type": "string" } }, "description": "Managed object abstract class" }, "alterUrgencyOfFaultsOnObject": { "title": "alterUrgencyOfFaultsOnObject", "required": [ "baseInstanceFullName", "faultFilter", "urgency" ], "type": "object", "properties": { "baseInstanceFullName": { "type": "string", "description": "Full name of the affected object for which alarms against it are to have their urgency updated." }, "faultFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "urgency": { "type": "integer", "description": "New urgency.", "format": "int32" } }, "description": "Model containing the method level model for FaultManager.alterUrgencyOfFaultsOnObject to decode json data to internal NFM-P object model" }, "ScriptFlowExecutionResult": { "title": "ScriptFlowExecutionResult", "required": [ "objectClassName", "resultInfo", "resultBody" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "resultInfo": { "allOf": [ { "$ref": "#/components/schemas/TargetScriptResult" }, { "description": "Managed object abstract class" } ] }, "resultBody": { "type": "string" } }, "description": "Model containing the method level model for struct ScriptFlowExecutionResult. to decode json data to internal NFM-P object model" }, "configureKeyGroupWlanGwBindingsResponse": { "title": "configureKeyGroupWlanGwBindingsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "boolean", "description": "The response object." } }, "description": "Model containing the method level model for KeyGroup.configureKeyGroupWlanGwBindings to encode json response from internal NFM-P object model" }, "RegisterFindToFileDto": { "title": "RegisterFindToFileDto", "required": [ "fullClassName", "fileName" ], "type": "object", "properties": { "fullClassName": { "type": "array", "items": { "type": "string" }, "description": "list" }, "fileName": { "type": "string", "description": "string", "example": "myFile.xml" }, "compress": { "type": "boolean", "description": "boolean", "default": false, "example": true }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "synchronous": { "type": "boolean", "description": "boolean", "default": false, "example": false }, "resultFilter": { "allOf": [ { "$ref": "#/components/schemas/RestResultFilterDto" }, { "description": "Result filter class" } ] }, "timeStamp": { "type": "boolean", "description": "boolean", "default": false, "example": true }, "timeout": { "type": "integer", "description": "long", "format": "int64", "example": 1000 } }, "description": "RestRegister Find to file model" }, "RetrieveDynSvcDataTriggersStruct": { "title": "RetrieveDynSvcDataTriggersStruct", "required": [ "objectClassName", "siteId", "portName", "outerEncapValue", "innerEncapValue" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "portName": { "type": "string" }, "outerEncapValue": { "type": "integer", "format": "int64" }, "innerEncapValue": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct RetrieveDynSvcDataTriggersStruct. to decode json data to internal NFM-P object model" }, "igpShortestPathFirstGraphExtResponse": { "title": "igpShortestPathFirstGraphExtResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/ShortestPathGraph" }, { "description": "Model containing the method level model for struct ShortestPathGraph. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for TopologyManager.igpShortestPathFirstGraphExt to encode json response from internal NFM-P object model" }, "Edge": { "title": "Edge", "required": [ "objectClassName", "fdn" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "fdn": { "type": "string" } }, "description": "Model containing the method level model for struct Edge. to decode json data to internal NFM-P object model" }, "findGatewayInterfacesWithRiBindingResponse": { "title": "findGatewayInterfacesWithRiBindingResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "boolean", "description": "The response object." } }, "description": "Model containing the method level model for GatewayInterface.findGatewayInterfacesWithRiBinding to encode json response from internal NFM-P object model" }, "findScriptsResponse": { "title": "findScriptsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for GenericNeProfile.findScripts to encode json response from internal NFM-P object model" }, "renum": { "title": "renum", "type": "object", "properties": { "aInNewEntryFullName": { "type": "string" }, "aInOldEntryFullName": { "type": "string" } }, "description": "Model containing the method level model for SecurityPolicyEntryDefinition.renum to decode json data to internal NFM-P object model" }, "retrieveVRFRoutesResponse": { "title": "retrieveVRFRoutesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for Site.retrieveVRFRoutes to encode json response from internal NFM-P object model" }, "retrieveCallTraceJobs": { "title": "retrieveCallTraceJobs", "required": [ "retrieveCallTraceStruct", "traceName", "sapFdn", "macAddress", "circuitId", "remoteId", "timeout" ], "type": "object", "properties": { "retrieveCallTraceStruct": { "allOf": [ { "$ref": "#/components/schemas/RetrieveCallTraceStruct" }, { "description": "Model containing the method level model for struct RetrieveCallTraceStruct. to decode json data to internal NFM-P object model" } ] }, "traceName": { "type": "string", "description": "Specifies the trace name. Its optional parameter. default:" }, "sapFdn": { "type": "string", "description": "Specifies the FDN of SAP.Its optional parameter. default:" }, "macAddress": { "type": "string", "description": "Specifies the MAC address of IPoE Session. Its optional parameter. default:" }, "circuitId": { "type": "string", "description": "Specifies the circuit ID of IPoE Session. Its optional parameter. default:" }, "remoteId": { "type": "string", "description": "Specifies the remote ID of IPoE Session. Its optional parameter. default:" }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns. default:300000", "format": "int64" } }, "description": "Model containing the method level model for CallTraceJob.retrieveCallTraceJobs to decode json data to internal NFM-P object model" }, "findTrailsResponse": { "title": "findTrailsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/TrailInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for AbstractPath.findTrails to encode json response from internal NFM-P object model" }, "evalLeaseStatePerSapResponse": { "title": "evalLeaseStatePerSapResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/EvalLeaseStatePerSapReturnStruct" }, { "description": "Model containing the method level model for struct EvalLeaseStatePerSapReturnStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for SubscriberHostConfiguration.evalLeaseStatePerSap to encode json response from internal NFM-P object model" }, "impactAnalysisDetailsResponse": { "title": "impactAnalysisDetailsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/PagingResult" }, { "description": "Model containing the method level model for struct PagingResult. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for AbstractImpactAnalysisTimeRange.impactAnalysisDetails to encode json response from internal NFM-P object model" }, "findEgressMcastGroupsResponse": { "title": "findEgressMcastGroupsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for FilterDefinition.findEgressMcastGroups to encode json response from internal NFM-P object model" }, "findCtpsForTunnelPathEndpoint": { "title": "findCtpsForTunnelPathEndpoint", "required": [ "nodeId", "ctpFilter" ], "type": "object", "properties": { "nodeId": { "type": "string" }, "ctpFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for EthernetTunnelPathEndpoint.findCtpsForTunnelPathEndpoint to decode json data to internal NFM-P object model" }, "createScriptVersionResponse": { "title": "createScriptVersionResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedContainmentEntityInformation" }, { "description": "Model containing the method level model for struct CommonManagedContainmentEntityInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for AbstractScript.createScriptVersion to encode json response from internal NFM-P object model" }, "L3AccessInterfaceConfigInfo": { "title": "L3AccessInterfaceConfigInfo", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap", "containmentInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "urpfcheckState": { "type": "integer", "format": "int32" }, "urpfcheckMode": { "type": "integer", "format": "int32" }, "urpfcheckStateIpv6": { "type": "integer", "format": "int32" }, "urpfcheckModeIpv6": { "type": "integer", "format": "int32" }, "diconX": { "type": "integer", "format": "int32" }, "diconY": { "type": "integer", "format": "int32" }, "dcpuProtectionPolicyPointer": { "type": "string" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } }, "displayedName": { "type": "string" }, "description": { "type": "string" }, "encapType": { "type": "integer", "format": "int32" }, "administrativeState": { "type": "integer", "format": "int32" }, "portPointer": { "type": "string" }, "innerEncapValue": { "type": "integer", "format": "int32" }, "outerEncapValue": { "type": "integer", "format": "int32" }, "reassembly": { "type": "boolean", "default": false }, "ingressPolicyObjectPointer": { "type": "string" }, "egressPolicyObjectPointer": { "type": "string" }, "aggregation": { "type": "integer", "format": "int32" }, "ingressSchedulerObjectPointer": { "type": "string" }, "egressSchedulerObjectPointer": { "type": "string" }, "aggregationSchedulerObjectPointer": { "type": "string" }, "ingressFilterPointer": { "type": "string" }, "ingressMatchQinqDot1pBits": { "type": "integer", "format": "int32" }, "egressQinqMarkTopBitsOnly": { "type": "boolean", "default": false }, "egressFilterPointer": { "type": "string" }, "ingressIpv6FilterPointer": { "type": "string" }, "egressIpv6FilterPointer": { "type": "string" }, "accountingPolicyObjectPointer": { "type": "string" }, "accountingOn": { "type": "boolean", "default": false }, "ingressPolicerAccountingOn": { "type": "boolean", "default": false }, "egressQueueAccountingOn": { "type": "boolean", "default": false }, "sharedQueueOn": { "type": "boolean", "default": false }, "hsmdaEgrSecondaryShaper": { "type": "string" }, "hsmdaEgrQosPackByteOffOvrd": { "type": "integer", "format": "int32" }, "egressAggRateLimit": { "type": "integer", "format": "int64" }, "ingressAggRateLimit": { "type": "integer", "format": "int32" }, "egressAggCIR": { "type": "integer", "format": "int32" }, "ingressAggCIR": { "type": "integer", "format": "int32" }, "egressSchedulerMode": { "type": "integer", "format": "int32" }, "ingressSchedulerMode": { "type": "integer", "format": "int32" }, "egressFrameBaseAccounting": { "type": "boolean", "default": false }, "dosProtection": { "type": "string" }, "ingressPolicerPolicyPointer": { "type": "string" }, "egressPolicerPolicyPointer": { "type": "string" }, "sapEgressStatsPktsMode": { "type": "boolean", "default": false }, "sapIngressCounterMode": { "type": "integer", "format": "int32" }, "sapIngressCounterType": { "type": "integer", "format": "int32" }, "sapEgressStatsEnable": { "type": "boolean", "default": false }, "sapIngressStatsEnable": { "type": "boolean", "default": false }, "transitIpPolicyPointer": { "type": "string" }, "transitPrefixPolicyPointer": { "type": "string" }, "hsmdaEgrQosWrrPlcyOvrd": { "type": "string" }, "ingressQueueGroupName": { "type": "string" }, "ingressRedirectListQueueGroup": { "type": "string" }, "egressRedirectListQueueGroup": { "type": "string" }, "ingressInstanceId": { "type": "integer", "format": "int64" }, "egressPortQueueGroupPointer": { "type": "string" }, "egressPortQueueGroupName": { "type": "string" }, "egressPortQueueInstanceId": { "type": "integer", "format": "int64" }, "aarpPointer": { "type": "string" }, "aarpServRefType": { "type": "integer", "format": "int32" }, "egressAggRateLUB": { "type": "boolean", "default": false }, "egressAggRateLimitEnabled": { "type": "boolean", "default": false }, "egressAggRateLimitCIR": { "type": "integer", "format": "int32" }, "egressAggRateLimitPIR": { "type": "integer", "format": "int32" }, "macLearnOptions": { "type": "integer", "format": "int64" }, "egressShaperGrpPointer": { "type": "string" }, "ingressShaperGrpPointer": { "type": "string" }, "sapIngressAggregateShaperRate": { "type": "integer", "format": "int32" }, "sapEgressAggregateShaperRate": { "type": "integer", "format": "int32" }, "hsEgrSecondaryShaper": { "type": "string" }, "egressRemarkingPolicyObjectPointer": { "type": "string" }, "egressRemarkPolicyObjectPointer": { "type": "string" }, "egressVlanQosPolicyObjectPointer": { "type": "string" }, "mprvlanId": { "type": "integer", "format": "int32" }, "pmonPolicy": { "type": "string" }, "lockOlcState": { "type": "boolean", "default": false }, "templateVersionPointer": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "sapIngressAggregateShaperRateCIR": { "type": "integer", "format": "int32" }, "sapIngressAggregateShaperRatePIR": { "type": "integer", "format": "int32" }, "physicalAddress": { "type": "string" }, "interfaceClass": { "type": "integer", "format": "int32" }, "unnumberedReferenceType": { "type": "integer", "format": "int32" }, "unnumberedReference": { "type": "string" }, "directedBroadcast": { "type": "boolean", "default": false }, "isTrusted": { "type": "integer", "format": "int32" }, "loopbackEnabled": { "type": "boolean", "default": false }, "l3InterfaceDescription": { "type": "string" }, "l3InterfaceAdministrativeState": { "type": "integer", "format": "int32" }, "shcvSource": { "type": "integer", "format": "int32" }, "shcvAction": { "type": "integer", "format": "int32" }, "shcvInterval": { "type": "integer", "format": "int32" }, "shcvRetryTimeout": { "type": "integer", "format": "int32" }, "shcvRetryCount": { "type": "integer", "format": "int32" }, "usesMultipointShared": { "type": "integer", "format": "int32" }, "todSuitePointer": { "type": "string" }, "unnumberedInterfaceName": { "type": "string" }, "unnumberedIpAddress": { "type": "string" }, "ipMtu": { "type": "integer", "format": "int64" }, "localDhcpServerPointer": { "type": "string" }, "localDhcpServerName": { "type": "string" }, "aaApplicationProfile": { "type": "string" }, "callingStationId": { "type": "string" }, "aaGrpId": { "type": "integer", "format": "int32" }, "aaPartId": { "type": "integer", "format": "int32" }, "l3dosProtection": { "type": "string" }, "macMonitoring": { "type": "boolean", "default": false }, "ipMonitoring": { "type": "boolean", "default": false }, "cpmProtEthCfmMonitorFlags": { "type": "integer", "format": "int64" }, "vplsName": { "type": "string" }, "vplsEgressQosPolicyPointer": { "type": "string" }, "vplsIngressIPv4FilterPointer": { "type": "string" }, "vplsIngressIPv6FilterPointer": { "type": "string" }, "vplsEgressIPv4FilterPointer": { "type": "string" }, "vplsEgressIPv6FilterPointer": { "type": "string" }, "localDhcp6ServerPointer": { "type": "string" }, "monitorOperGroupName": { "type": "string" }, "monitorOperGroupPtr": { "type": "string" }, "qosRouteLookupIpv4": { "type": "integer", "format": "int32" }, "qosRouteLookupIpv6": { "type": "integer", "format": "int32" }, "sasIngressPolicyObjectPointer": { "type": "string" }, "sapIngressAggregateMeterRate": { "type": "integer", "format": "int64" }, "sapIngressAggregateMeterBurst": { "type": "integer", "format": "int32" }, "sapIngressWithAggregateMeter": { "type": "integer", "format": "int32" }, "sapIngressAggregateMeterCIR": { "type": "integer", "format": "int64" }, "sapIngressAggregateMeterCBS": { "type": "integer", "format": "int32" }, "sapEgressAggregateMeterBurst": { "type": "integer", "format": "int32" }, "sapEgressAggregateMeterEnableStats": { "type": "integer", "format": "int32" }, "sapEgressAggregateMeterRate": { "type": "integer", "format": "int32" }, "sasEgressPolicyObjectPointer": { "type": "string" }, "radiusProxyServerPointer": { "type": "string" }, "globalIfIndex": { "type": "integer", "format": "int32" }, "hostLockoutPolicyPointer": { "type": "string" }, "enableIngressStats": { "type": "boolean", "default": false }, "lagLinkMapProfilePointer": { "type": "string" }, "ingressFlowspec": { "type": "boolean", "default": false }, "ingressIPv6Flowspec": { "type": "boolean", "default": false }, "staticTnlRedNHAddrType": { "type": "integer", "format": "int32" }, "staticTnlRedNHAddr": { "type": "string" }, "dynamicTnlRedNHAddrType": { "type": "integer", "format": "int32" }, "dynamicTnlRedNHAddr": { "type": "string" }, "enableMacAccountingStats": { "type": "boolean", "default": false }, "aluIfL4LoadBalancing": { "type": "integer", "format": "int32" }, "ifTeIdLoadBalancing": { "type": "boolean", "default": false }, "egrIpLoadBalancing": { "type": "integer", "format": "int32" }, "spiLoadBalancing": { "type": "boolean", "default": false }, "ipv6FlowLabelHashing": { "type": "boolean", "default": false }, "securityPolicyBypass": { "type": "boolean", "default": false }, "zonePointer": { "type": "string" }, "zoneId": { "type": "integer", "format": "int64" }, "policyAccountingTemplatePointer": { "type": "string" }, "sharedRiskLinkGroupPointers": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "adminGroupInclude": { "type": "integer", "format": "int64" }, "shcvPolicyIPv4Pointer": { "type": "string" }, "ipv6Allowed": { "type": "boolean", "default": false }, "vasIfType": { "type": "integer", "format": "int32" }, "ipv6NeighborLimit": { "type": "integer", "format": "int32" }, "ipv6NeighborLogOnly": { "type": "boolean", "default": false }, "ipv6NeighborThreshold": { "type": "integer", "format": "int32" }, "bandwidth": { "type": "integer", "format": "int64" }, "bandwidthHi": { "type": "integer", "format": "int64" }, "ignoreSapPortState": { "type": "integer", "format": "int32" }, "schedulerPolicyObjectPointer": { "type": "string" }, "arpLearnUnsolicited": { "type": "boolean", "default": false }, "arpPopulateHostRoute": { "type": "boolean", "default": false }, "arpRouteTag": { "type": "string" }, "neighbhorPopulateHostRoute": { "type": "boolean", "default": false }, "neighbhorRouteTag": { "type": "string" }, "arpProactiveRefresh": { "type": "boolean", "default": false }, "neighborLearnUnsolicited": { "type": "integer", "format": "int32" }, "neighborProactiveRefresh": { "type": "integer", "format": "int32" }, "enableTableClassification": { "type": "boolean", "default": false }, "enableTableClassificationForRvpls": { "type": "boolean", "default": false }, "routedOverrideQosPolicyPointer": { "type": "string" }, "forwardIPv4Packets": { "type": "boolean", "default": false }, "arpLearnDynamic": { "type": "boolean", "default": false }, "ndLearnDynamic": { "type": "boolean", "default": false }, "floodGarpAndUnknownReq": { "type": "boolean", "default": false }, "ipCriteriaOverrideTag": { "type": "integer", "format": "int64" }, "ipv6CriteriaOverrideTag": { "type": "integer", "format": "int64" }, "ingrDestinationClassLookup": { "type": "boolean", "default": false }, "overrides": { "type": "object", "additionalProperties": { "type": "string" } } }, "description": "Model containing the method level model for Interface ConfigInfo L3AccessInterfaceConfigInfo. to decode json data to internal NFM-P object model" }, "RestResultFilterDto": { "title": "RestResultFilterDto", "required": [ "attributes" ], "type": "object", "properties": { "recursive": { "type": "boolean", "default": false }, "attributes": { "type": "array", "items": { "type": "string" }, "description": "List [String]" }, "fullClassName": { "type": "string", "description": "string", "example": "netw.NetworkElement" }, "childrenFilters": { "type": "array", "items": { "$ref": "#/components/schemas/RestResultFilterDto" }, "description": "List [ResultFilter]" } }, "description": "Result filter class" }, "TestConfigInfo": { "title": "TestConfigInfo", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap", "containmentInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } }, "id": { "type": "integer", "format": "int64" }, "displayedName": { "type": "string" }, "description": { "type": "string" }, "administrativeState": { "type": "integer", "format": "int32" }, "nePersistent": { "type": "boolean", "default": false }, "neSchedulable": { "type": "boolean", "default": false }, "accountingFiles": { "type": "boolean", "default": false }, "continuousExec": { "type": "boolean", "default": false }, "testResultStorage": { "type": "integer", "format": "int32" }, "probeHistory": { "type": "integer", "format": "int32" }, "publishTopic": { "type": "boolean", "default": false }, "applicationId": { "type": "string" } }, "description": "Model containing the method level model for Interface ConfigInfo TestConfigInfo. to decode json data to internal NFM-P object model" }, "removeTests": { "title": "removeTests", "required": [ "testGroupRole", "test" ], "type": "object", "properties": { "testGroupRole": { "type": "string", "description": "The test group from which to remove these test." }, "test": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "A set of test pointers to remove." } }, "description": "Model containing the method level model for TestSuite.removeTests to decode json data to internal NFM-P object model" }, "executeViewCheckPoint": { "title": "executeViewCheckPoint", "required": [ "isSynchronized", "clientId", "neId", "rollbackIndex" ], "type": "object", "properties": { "isSynchronized": { "type": "boolean", "description": "Wait until executed command finished. True to wait, false otherwise." }, "clientId": { "type": "string", "description": "Identifies the client Id that is requesting the execution (used for sending an event to the specific client when execution is complete)." }, "neId": { "type": "string" }, "rollbackIndex": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for RollbackNEInfo.executeViewCheckPoint to decode json data to internal NFM-P object model" }, "alterUrgencyOfFault": { "title": "alterUrgencyOfFault", "required": [ "faultObjectFullName", "urgency" ], "type": "object", "properties": { "faultObjectFullName": { "type": "string", "description": "Alarm full name for which the urgency is to be updated." }, "urgency": { "type": "integer", "description": "New urgency.", "format": "int32" } }, "description": "Model containing the method level model for FaultManager.alterUrgencyOfFault to decode json data to internal NFM-P object model" }, "getLogRecordsResponse": { "title": "getLogRecordsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for AlarmHistoryDatabase.getLogRecords to encode json response from internal NFM-P object model" }, "findAvailableNetworkCtpsPerNode": { "title": "findAvailableNetworkCtpsPerNode", "required": [ "nodeId", "ctpFilter" ], "type": "object", "properties": { "nodeId": { "type": "string" }, "ctpFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for ConnectionTerminationPoint.findAvailableNetworkCtpsPerNode to decode json data to internal NFM-P object model" }, "findCtpsForPathEndpointResponse": { "title": "findCtpsForPathEndpointResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionTerminationPointInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for PathEndpoint.findCtpsForPathEndpoint to encode json response from internal NFM-P object model" }, "oneTimeValidate": { "title": "oneTimeValidate", "required": [ "testedEntity", "testPolicy" ], "type": "object", "properties": { "testedEntity": { "type": "string" }, "testPolicy": { "type": "string" } }, "description": "Model containing the method level model for TestManager.oneTimeValidate to decode json data to internal NFM-P object model" }, "retrieveIgmpHosts": { "title": "retrieveIgmpHosts", "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInSubId": { "type": "string" }, "aInMCacPolicyPointer": { "type": "string" } }, "description": "Model containing the method level model for IgmpHost.retrieveIgmpHosts to decode json data to internal NFM-P object model" }, "retrieveNatPortForwarding": { "title": "retrieveNatPortForwarding", "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInTimeout": { "type": "integer", "format": "int64" }, "aInType": { "type": "string" }, "aInL2AwareSubId": { "type": "string" }, "aInB4AddressType": { "type": "string" }, "aInIpv6B4Address": { "type": "string" }, "aInOriginRetrieve": { "type": "string" }, "aInRouterId": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for StaticPortMapping.retrieveNatPortForwarding to decode json data to internal NFM-P object model" }, "retrieveResSubscrMldHostsResponse": { "title": "retrieveResSubscrMldHostsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for MldHost.retrieveResSubscrMldHosts to encode json response from internal NFM-P object model" }, "findReleasedResponse": { "title": "findReleasedResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, { "description": "Model containing the method level model for struct CommonManagedEntityInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for PolicyDefinition.findReleased to encode json response from internal NFM-P object model" }, "DbLinkInfo": { "title": "DbLinkInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "aendTeLinkEndpointId": { "type": "string" }, "zendTeLinkEndpointId": { "type": "string" }, "zendShelfPointer": { "type": "string" }, "zendPortPointer": { "type": "string" }, "zendCpNodeId": { "type": "string" }, "zendDataBearerId": { "type": "string" }, "aendUserLabel": { "type": "string" }, "aendSitePointer": { "type": "string" }, "aendShelfPointer": { "type": "string" }, "aendPortPointer": { "type": "string" }, "aendCpNodeId": { "type": "string" }, "aendDataBearerId": { "type": "string" }, "zendUserLabel": { "type": "string" }, "zendSitePointer": { "type": "string" }, "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "administrativeState": { "type": "integer", "format": "int32" }, "connId": { "type": "integer", "format": "int64" }, "biDirectional": { "type": "boolean", "default": false }, "connectionType": { "type": "integer", "format": "int32" }, "portAPointer": { "type": "string" }, "portZPointer": { "type": "string" }, "ctpAPointer": { "type": "string" }, "ctpZPointer": { "type": "string" }, "protectionState": { "type": "integer", "format": "int32" }, "protectionLevel": { "type": "integer", "format": "int32" }, "modifyFlag": { "type": "boolean", "default": false }, "isRidingOnConnGroup": { "type": "boolean", "default": false }, "domainId": { "type": "integer", "format": "int64" }, "configuredConnectivityType": { "type": "integer", "format": "int32" }, "allowInBand": { "type": "integer", "format": "int32" }, "waitToRevert": { "type": "integer", "format": "int32" }, "tcMonitor": { "type": "integer", "format": "int32" }, "msSignalDegraded": { "type": "integer", "format": "int32" }, "linkAdministrativeState": { "type": "integer", "format": "int32" }, "teLinkPointer": { "type": "string" }, "useDefaultsForOduTrail": { "type": "boolean", "default": false }, "wavekeyAssignMode": { "type": "integer", "format": "int32" }, "pathSearchOption": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for Interface DbLinkInfo. to decode json data to internal NFM-P object model" }, "generateFromSample": { "title": "generateFromSample", "required": [ "templateConfiguration", "sampleId", "parameters" ], "type": "object", "properties": { "templateConfiguration": { "allOf": [ { "$ref": "#/components/schemas/XmlApiConfigTemplateConfigInfo" }, { "description": "Model containing the method level model for Interface ConfigInfo XmlApiConfigTemplateConfigInfo. to decode json data to internal NFM-P object model" } ] }, "sampleId": { "type": "string", "description": "The name of the sample." }, "parameters": { "type": "object", "additionalProperties": { "type": "object" }, "description": "The parameters used to generate template from the sample.These parameters are optional and are specific to each sample." } }, "description": "Model containing the method level model for XmlApiConfigTemplate.generateFromSample to decode json data to internal NFM-P object model" }, "RetrievePccRuleStruct": { "title": "RetrievePccRuleStruct", "required": [ "objectClassName", "siteId", "subPccRuleName", "subPccRuleKey", "subPCCRuleFlowId" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "subPccRuleName": { "type": "string", "description": "default: yes:" }, "subPccRuleKey": { "type": "integer", "description": "default: yes:0", "format": "int64" }, "subPCCRuleFlowId": { "type": "integer", "description": "default: yes:0", "format": "int64" } }, "description": "Model containing the method level model for struct RetrievePccRuleStruct. to decode json data to internal NFM-P object model" }, "renumIds": { "title": "renumIds", "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInAaGroupId": { "type": "integer", "format": "int32" }, "aInAaPartId": { "type": "integer", "format": "int32" }, "aInStartId": { "type": "integer", "format": "int32" }, "aInEndId": { "type": "integer", "format": "int32" }, "aInFactor": { "type": "string" }, "aInFactorValue": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for ApplicationFilter.renumIds to decode json data to internal NFM-P object model" }, "getSearchSuggestionCacheResponse": { "title": "getSearchSuggestionCacheResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "object", "additionalProperties": {}, "description": "The response object." } }, "description": "Model containing the method level model for NetworkElement.getSearchSuggestionCache to encode json response from internal NFM-P object model" }, "resyncToUpdateOperStatus": { "title": "resyncToUpdateOperStatus", "required": [ "siteId", "groupId", "urlFilterName" ], "type": "object", "properties": { "siteId": { "type": "string", "description": "Network Element site IP address." }, "groupId": { "type": "integer", "description": "The ISA-AA Group Index.", "format": "int64" }, "urlFilterName": { "type": "string", "description": "AA URL Filter name." } }, "description": "Model containing the method level model for AAUrlFilter.resyncToUpdateOperStatus to decode json data to internal NFM-P object model" }, "invokeResyncAaSpokeSdpBindingInfo": { "title": "invokeResyncAaSpokeSdpBindingInfo", "required": [ "siteId", "isaGrpPartIndex" ], "type": "object", "properties": { "siteId": { "type": "string", "description": "Network Element site IP address." }, "isaGrpPartIndex": { "type": "integer", "description": "The ISA-AA Group Partition Index.", "format": "int64" } }, "description": "Model containing the method level model for AaSpokeSdpBindingInfo.invokeResyncAaSpokeSdpBindingInfo to decode json data to internal NFM-P object model" }, "findPSSsResponse": { "title": "findPSSsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for OpticsPMPolicy.findPSSs to encode json response from internal NFM-P object model" }, "retrieveAddrPoolsResponse": { "title": "retrieveAddrPoolsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for SubBrgAddressPool.retrieveAddrPools to encode json response from internal NFM-P object model" }, "retrieveReservedResources": { "title": "retrieveReservedResources", "required": [ "anInClassName", "anInfilter" ], "type": "object", "properties": { "anInClassName": { "type": "string", "description": "The class name which can be service.SvcResourceReservation or service.ReservedRouteTarget" }, "anInfilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for SvcResourceReservation.retrieveReservedResources to decode json data to internal NFM-P object model" }, "getAlarmsWithFilter": { "title": "getAlarmsWithFilter", "required": [ "supervisionGroupName", "filter" ], "type": "object", "properties": { "supervisionGroupName": { "type": "string", "description": "Supervision Group name." }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for SummaryView.getAlarmsWithFilter to decode json data to internal NFM-P object model" }, "removePowerModuleResponse": { "title": "removePowerModuleResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/PowerModule" }, { "description": "Managed object abstract class" } ] } }, "description": "Model containing the method level model for PowerModule.removePowerModule to encode json response from internal NFM-P object model" }, "getTransitServiceResponse": { "title": "getTransitServiceResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, { "description": "Model containing the method level model for struct CommonManagedEntityInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for VlanUplink.getTransitService to encode json response from internal NFM-P object model" }, "getMonitoredObjectsSummaries": { "title": "getMonitoredObjectsSummaries", "required": [ "supervisionGroupName", "getProblemObjectsOnly", "startTime" ], "type": "object", "properties": { "supervisionGroupName": { "type": "string", "description": "Supervision Group name." }, "getProblemObjectsOnly": { "type": "boolean", "description": "If true, the method will return only objectswith non-zero KPIs (e.g. alarms, failed etc.)" }, "startTime": { "type": "integer", "description": "Get counts of alarms and failed tests on themonitored objects since this time.", "format": "int64" } }, "description": "Model containing the method level model for SummaryView.getMonitoredObjectsSummaries to decode json data to internal NFM-P object model" }, "getCpTopology": { "title": "getCpTopology", "required": [ "checkpointId", "asNumber", "asName", "protocol", "fullClassName" ], "type": "object", "properties": { "checkpointId": { "type": "integer", "description": "Checkpoint ID.", "format": "int64" }, "asNumber": { "type": "integer", "description": "The IGP administrative domain number of the CP.", "format": "int64" }, "asName": { "type": "string", "description": "The IGP administrative domain name of the CP." }, "protocol": { "type": "string", "description": "The protocol that the CP belongs to. Only OSPF and ISIS aresupported." }, "fullClassName": { "type": "string", "description": "Package qualified class name in dot separated formatEXAMPLE: topology.Router, topology.OspfLink." } }, "description": "Model containing the method level model for Checkpoint.getCpTopology to decode json data to internal NFM-P object model" }, "findValidAunCtpsForNewVcnXcResponse": { "title": "findValidAunCtpsForNewVcnXcResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for VcnCrossConnect.findValidAunCtpsForNewVcnXc to encode json response from internal NFM-P object model" }, "removePowerSupplyResponse": { "title": "removePowerSupplyResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/PowerSupply" }, { "description": "Managed object abstract class" } ] } }, "description": "Model containing the method level model for PowerSupplyTray.removePowerSupply to encode json response from internal NFM-P object model" }, "retrieveWlanGwTunnelsResponse": { "title": "retrieveWlanGwTunnelsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for WlanGwQbtTunnel.retrieveWlanGwTunnels to encode json response from internal NFM-P object model" }, "executeAndWaitResponse": { "title": "executeAndWaitResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/TestResult" }, { "description": "Model containing the method level model for struct TestResult. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for Test.executeAndWait to encode json response from internal NFM-P object model" }, "configureKeyGroupPwBindingsResponse": { "title": "configureKeyGroupPwBindingsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "boolean", "description": "The response object." } }, "description": "Model containing the method level model for KeyGroup.configureKeyGroupPwBindings to encode json response from internal NFM-P object model" }, "LoginContextInterface": { "title": "LoginContextInterface", "type": "object", "properties": { "group": { "type": "string" }, "user": { "type": "string" }, "clientId": { "type": "string" }, "clientIPAddress": { "type": "string" }, "securityString": { "type": "string" }, "hashed": { "type": "boolean", "default": false }, "loginTime": { "type": "integer", "format": "int64" }, "clientType": { "type": "integer", "format": "int32" }, "topic": { "type": "string" }, "sessionId": { "type": "string" }, "singleSignOnId": { "type": "string" }, "ssoRestToken": { "type": "string" }, "isSaneUser": { "type": "boolean", "default": false }, "state": { "type": "integer", "format": "int32" } } }, "forceSwitchover": { "title": "forceSwitchover", "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInInterfaceId": { "type": "integer", "format": "int64" }, "aInServiceId": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for WlanGwRedundancyConfig.forceSwitchover to decode json data to internal NFM-P object model" }, "rediscoverTunnelDestinationResponse": { "title": "rediscoverTunnelDestinationResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for AbstractTunnel.rediscoverTunnelDestination to encode json response from internal NFM-P object model" }, "igpShortestPathFirstGraphSet": { "title": "igpShortestPathFirstGraphSet", "required": [ "igpAdminDomain", "sourceType", "source", "sourceLen", "destType", "dest", "destLen" ], "type": "object", "properties": { "igpAdminDomain": { "type": "string", "description": "The IGP Admin Domain ({{topology.AutonomousSystem}}) to perform the SPF in." }, "sourceType": { "type": "string", "description": "The address type of the source. Currently ipv4 and ipv6 aresupported." }, "source": { "type": "string", "description": "The source address of the managed route. The format ofthe source is based on the sourceType property." }, "sourceLen": { "type": "integer", "description": "The length of the source address. Its valid values dependon the sourceType.", "format": "int32" }, "destType": { "type": "string", "description": "The address type of the destination. Currently only ipv4 issupported." }, "dest": { "type": "string", "description": "The destination address of the managed route. The format ofthe destination is based on the destType property." }, "destLen": { "type": "integer", "description": "The length of the destination address. Its valid valuesdepend on the destType.", "format": "int32" } }, "description": "Model containing the method level model for TopologyManager.igpShortestPathFirstGraphSet to decode json data to internal NFM-P object model" }, "queryLsnSubscribersResponse": { "title": "queryLsnSubscribersResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for AbstractLsnSubscriber.queryLsnSubscribers to encode json response from internal NFM-P object model" }, "requestSavePythonScript": { "title": "requestSavePythonScript", "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInpythonProtectFileUrl": { "type": "string" }, "aInpythonProtectDestFileUrl": { "type": "string" }, "aInpythonProtectType": { "type": "string" }, "aInpythonProtectKey": { "type": "string" } }, "description": "Model containing the method level model for NetworkElement.requestSavePythonScript to decode json data to internal NFM-P object model" }, "constructServiceTemplate": { "title": "constructServiceTemplate", "type": "object", "properties": { "aInServiceFdn": { "type": "string" }, "aInSetSubscriber": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for TemplateService.constructServiceTemplate to decode json data to internal NFM-P object model" }, "countInstanceResponse": { "title": "countInstanceResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int32" } }, "description": "Model containing the method level model for GenericObject.countInstance to encode json response from internal NFM-P object model" }, "configureInstance": { "title": "configureInstance", "required": [ "distinguishedName", "configInfo" ], "type": "object", "properties": { "distinguishedName": { "type": "string", "description": "Distinguished Name of object being configured." }, "configInfo": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" }, { "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for GenericObject.configureInstance to decode json data to internal NFM-P object model" }, "editNote": { "title": "editNote", "required": [ "alarmNoteObjectPointer", "text", "reasonForChange", "textualExplanation" ], "type": "object", "properties": { "alarmNoteObjectPointer": { "type": "string", "description": "Full name of the alarm note." }, "text": { "type": "string", "description": "Edited text." }, "reasonForChange": { "type": "integer", "description": "Reason for change, please refer to {{fm.AlarmNoteRevisionObject.reasonForChange}} for details.", "format": "int32" }, "textualExplanation": { "type": "string", "description": "Textual explanation for the change." } }, "description": "Model containing the method level model for FaultManager.editNote to decode json data to internal NFM-P object model" }, "executeOamTestContextResponse": { "title": "executeOamTestContextResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for TestManager.executeOamTestContext to encode json response from internal NFM-P object model" }, "createSubSvcComponentsResponse": { "title": "createSubSvcComponentsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for ResidentialSubscriberManager.createSubSvcComponents to encode json response from internal NFM-P object model" }, "getNeTraceStatusObjectsByGroupResponse": { "title": "getNeTraceStatusObjectsByGroupResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for SummaryView.getNeTraceStatusObjectsByGroup to encode json response from internal NFM-P object model" }, "isPremiumPkgEnabledResponse": { "title": "isPremiumPkgEnabledResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "boolean", "description": "The response object." } }, "description": "Model containing the method level model for AnalyticsManager.isPremiumPkgEnabled to encode json response from internal NFM-P object model" }, "GroupInterfaceInfo": { "title": "GroupInterfaceInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "urpfcheckState": { "type": "integer", "format": "int32" }, "urpfcheckMode": { "type": "integer", "format": "int32" }, "urpfcheckStateIpv6": { "type": "integer", "format": "int32" }, "urpfcheckModeIpv6": { "type": "integer", "format": "int32" }, "ipv6Dhcp6PDManagedRouteNH": { "type": "integer", "format": "int32" }, "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "description": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "administrativeState": { "type": "integer", "format": "int32" }, "reassembly": { "type": "boolean", "default": false }, "templateVersionPointer": { "type": "string" }, "physicalAddress": { "type": "string" }, "shcvSource": { "type": "integer", "format": "int32" }, "shcvAction": { "type": "integer", "format": "int32" }, "shcvInterval": { "type": "integer", "format": "int32" }, "shcvRetryTimeout": { "type": "integer", "format": "int32" }, "shcvRetryCount": { "type": "integer", "format": "int32" }, "shcvFamily": { "type": "integer", "format": "int32" }, "arpPopulate": { "type": "integer", "format": "int32" }, "redundantInterfacePointer": { "type": "string" }, "operationalStateWhileEmpty": { "type": "boolean", "default": false }, "redundantInterfaceName": { "type": "string" }, "lns": { "type": "integer", "format": "int32" }, "ipv6Allowed": { "type": "boolean", "default": false }, "qosRouteLookupIpv4": { "type": "integer", "format": "int32" }, "qosRouteLookupIpv6": { "type": "integer", "format": "int32" }, "srrpRoutingEnabled": { "type": "boolean", "default": false }, "srrpRoutingHoldTime": { "type": "number" }, "ipoeBridgedModeEnabled": { "type": "boolean", "default": false }, "wppEnabled": { "type": "boolean", "default": false }, "specificType": { "type": "integer", "format": "int32" }, "enableIngressStats": { "type": "boolean", "default": false }, "ipMtu": { "type": "integer", "format": "int64" }, "allowMultipleWANAddresses": { "type": "boolean", "default": false }, "overrideSlaac": { "type": "boolean", "default": false }, "diamAppPolicy": { "type": "string" }, "pdManagedRoute": { "type": "boolean", "default": false }, "policyAccountingTemplatePointer": { "type": "string" }, "suppressAaSub": { "type": "integer", "format": "int32" }, "diamAuthPolicy": { "type": "string" }, "shcvPolicyPointer": { "type": "string" }, "shcvPolicyIPv4Pointer": { "type": "string" }, "shcvPolicyIPv6Pointer": { "type": "string" }, "dhcpV6FilterPointer": { "type": "string" }, "dhcpV6SnpgAdminState": { "type": "integer", "format": "int32" }, "dhcpV6UserIdent": { "type": "integer", "format": "int32" }, "autoReplyOptions": { "type": "integer", "format": "int64" }, "dataTriggerAdminState": { "type": "integer", "format": "int32" }, "ignoreSapPortState": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for Interface GroupInterfaceInfo. to decode json data to internal NFM-P object model" }, "executeTargetScriptResponse": { "title": "executeTargetScriptResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedContainmentEntityInformation" }, { "description": "Model containing the method level model for struct CommonManagedContainmentEntityInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for TargetScript.executeTargetScript to encode json response from internal NFM-P object model" }, "RtrvHostSharedPccRuleEgrPolicyStruct": { "title": "RtrvHostSharedPccRuleEgrPolicyStruct", "required": [ "objectClassName", "siteId", "policyId", "retrieveEntryOption", "startEntry", "entryCount" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "policyId": { "type": "integer", "format": "int64" }, "retrieveEntryOption": { "type": "boolean" }, "startEntry": { "type": "integer", "format": "int32" }, "entryCount": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for struct RtrvHostSharedPccRuleEgrPolicyStruct. to decode json data to internal NFM-P object model" }, "executeCLIScriptResponse": { "title": "executeCLIScriptResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for ScriptManager.executeCLIScript to encode json response from internal NFM-P object model" }, "retrieveVpnBgpRouteProfilesAssociatedWithService": { "title": "retrieveVpnBgpRouteProfilesAssociatedWithService", "required": [ "servicePointer", "filter", "fields", "sortFields", "pageNumber", "pageSize" ], "type": "object", "properties": { "servicePointer": { "type": "string", "description": "The service FDN to search for" }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "fields": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Sorting fields" }, "sortFields": { "type": "array", "items": { "type": "string" }, "description": "Sorting fields" }, "pageNumber": { "type": "integer", "description": "Page number", "format": "int32" }, "pageSize": { "type": "integer", "description": "The number of entries to return", "format": "int32" } }, "description": "Model containing the method level model for RouteProfileManager.retrieveVpnBgpRouteProfilesAssociatedWithService to decode json data to internal NFM-P object model" }, "ObjectsOnLinkStruct": { "title": "ObjectsOnLinkStruct", "required": [ "objectClassName", "time", "returnCode", "result" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "time": { "type": "integer", "format": "int64" }, "returnCode": { "type": "integer", "format": "int32" }, "result": { "allOf": [ { "$ref": "#/components/schemas/PagingResult" }, { "description": "Model containing the method level model for struct PagingResult. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for struct ObjectsOnLinkStruct. to decode json data to internal NFM-P object model" }, "findAllNetworkElementsHavingPDNGatewaysResponse": { "title": "findAllNetworkElementsHavingPDNGatewaysResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for PDNGateway.findAllNetworkElementsHavingPDNGateways to encode json response from internal NFM-P object model" }, "retrieveMldHosts": { "title": "retrieveMldHosts", "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInSubId": { "type": "string" }, "aInMCacPolicyPointer": { "type": "string" } }, "description": "Model containing the method level model for MldHost.retrieveMldHosts to decode json data to internal NFM-P object model" }, "retrieveStickyLeases": { "title": "retrieveStickyLeases", "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInRoutingInstance": { "type": "string" }, "aInDhcpServerName": { "type": "string" }, "aInLeaseHostName": { "type": "string" }, "aInLeaseHostNamePrefix": { "type": "string" }, "aInTimeout": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for StickyLeaseData.retrieveStickyLeases to decode json data to internal NFM-P object model" }, "syncToResponse": { "title": "syncToResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for PolicyDefinition.syncTo to encode json response from internal NFM-P object model" }, "retrieveIpMappingsResponse": { "title": "retrieveIpMappingsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for SvcChainIpMapping.retrieveIpMappings to encode json response from internal NFM-P object model" }, "discoverOverlayPath": { "title": "discoverOverlayPath", "required": [ "adminDomainFDN", "srcVPortFDN", "dstVPortName", "srcPort", "dstPort", "protocol", "transProtocol", "isActiveFlow" ], "type": "object", "properties": { "adminDomainFDN": { "type": "string", "description": "Admin Domain FDN" }, "srcVPortFDN": { "type": "string", "description": "Source Virtual Port FDN" }, "dstVPortName": { "type": "string", "description": "Destination Virtual port FDN." }, "srcPort": { "type": "integer", "description": "Application Source Port", "format": "int32" }, "dstPort": { "type": "integer", "description": "Application Destination Port", "format": "int32" }, "protocol": { "type": "integer", "description": "Underlay protocol Type(BGP=4,ISIS=2,OSPF=1)", "format": "int32" }, "transProtocol": { "type": "integer", "description": "Transport Protocol Number", "format": "int32" }, "isActiveFlow": { "type": "boolean", "description": "Overlay Path Discovery for Active Flow" } }, "description": "Model containing the method level model for DataCenter.discoverOverlayPath to decode json data to internal NFM-P object model" }, "setAggregateAdminState": { "title": "setAggregateAdminState", "required": [ "siteId", "adminState" ], "type": "object", "properties": { "siteId": { "type": "string" }, "adminState": { "type": "string" }, "clientId": { "type": "string", "description": "Non documentable API" } }, "description": "Model containing the method level model for CMMInstance.setAggregateAdminState to decode json data to internal NFM-P object model" }, "convertOldTemplates": { "title": "convertOldTemplates", "required": [ "oldTemplatePointers", "templateConfiguration", "updateExistingServices", "updateExistingSites" ], "type": "object", "properties": { "oldTemplatePointers": { "type": "array", "items": { "type": "string" }, "description": "The old templates that has to be converted.Must be instance of class 'template.Template'." }, "templateConfiguration": { "allOf": [ { "$ref": "#/components/schemas/XmlApiConfigTemplateConfigInfo" }, { "description": "Model containing the method level model for Interface ConfigInfo XmlApiConfigTemplateConfigInfo. to decode json data to internal NFM-P object model" } ] }, "updateExistingServices": { "type": "boolean", "description": "All services created from the old service template will be updated." }, "updateExistingSites": { "type": "boolean", "description": "The service sites of all services created from the old service template will be updated." } }, "description": "Model containing the method level model for XmlApiConfigTemplate.convertOldTemplates to decode json data to internal NFM-P object model" }, "getIfUtilizationStats": { "title": "getIfUtilizationStats", "required": [ "endRangeSet", "timestamp", "asFdn", "isCalBasedOnIntSpeed" ], "type": "object", "properties": { "endRangeSet": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The set of utilization ending ranges." }, "timestamp": { "type": "integer", "format": "int64" }, "asFdn": { "type": "string" }, "isCalBasedOnIntSpeed": { "type": "boolean" } }, "description": "Model containing the method level model for CpamStatisticManager.getIfUtilizationStats to decode json data to internal NFM-P object model" }, "findLspPathsResponse": { "title": "findLspPathsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for AdminGroupPolicy.findLspPaths to encode json response from internal NFM-P object model" }, "setDistributionModeToLocalEditOnlyResponse": { "title": "setDistributionModeToLocalEditOnlyResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int32" } }, "description": "Model containing the method level model for PolicyDefinition.setDistributionModeToLocalEditOnly to encode json response from internal NFM-P object model" }, "getInfoWithMonitoredObjectsResponse": { "title": "getInfoWithMonitoredObjectsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, { "description": "Model containing the method level model for struct CommonManagedEntityInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for SupervisionGroup.getInfoWithMonitoredObjects to encode json response from internal NFM-P object model" }, "TrailInfo": { "title": "TrailInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "administrativeState": { "type": "integer", "format": "int32" }, "connId": { "type": "integer", "format": "int64" }, "biDirectional": { "type": "boolean", "default": false }, "connectionType": { "type": "integer", "format": "int32" }, "portAPointer": { "type": "string" }, "portZPointer": { "type": "string" }, "ctpAPointer": { "type": "string" }, "ctpZPointer": { "type": "string" }, "protectionState": { "type": "integer", "format": "int32" }, "protectionLevel": { "type": "integer", "format": "int32" }, "modifyFlag": { "type": "boolean", "default": false }, "isRidingOnConnGroup": { "type": "boolean", "default": false }, "trailId": { "type": "integer", "format": "int32" }, "showInGUI": { "type": "boolean", "default": false }, "rate": { "type": "integer", "format": "int32" }, "protection": { "type": "integer", "format": "int32" }, "isModified": { "type": "boolean", "default": false }, "forceXcCreate": { "type": "boolean", "default": false }, "subscriberPointer": { "type": "string" }, "subscriberId": { "type": "integer", "format": "int64" }, "subscriberName": { "type": "string" }, "modifyProtectionPreference": { "type": "integer", "format": "int32" }, "managementDomains": { "type": "integer", "format": "int32" }, "connectionMode": { "type": "integer", "format": "int32" }, "protectionPathSearchType": { "type": "integer", "format": "int32" }, "asapProfileSetting": { "type": "boolean", "default": false }, "waveKey1AZ": { "type": "integer", "format": "int32" }, "waveKey2AZ": { "type": "integer", "format": "int32" }, "waveKey1ZA": { "type": "integer", "format": "int32" }, "waveKey2ZA": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for Interface TrailInfo. to decode json data to internal NFM-P object model" }, "updateUserObjectLifecycleStatesAndLocksResponse": { "title": "updateUserObjectLifecycleStatesAndLocksResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int32" } }, "description": "Model containing the method level model for GenericObject.updateUserObjectLifecycleStatesAndLocks to encode json response from internal NFM-P object model" }, "executeCLITargetScriptResponse": { "title": "executeCLITargetScriptResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedContainmentEntityInformation" }, { "description": "Model containing the method level model for struct CommonManagedContainmentEntityInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for TargetScript.executeCLITargetScript to encode json response from internal NFM-P object model" }, "executeSystemScripts": { "title": "executeSystemScripts", "required": [ "isSynchronized", "clientId", "scriptClassName", "scriptName", "listOfSystemScriptTargetConfigInfo" ], "type": "object", "properties": { "isSynchronized": { "type": "boolean", "description": "Identifies if the call to execute the script should wait until all scripts have been executed. True to wait, false otherwise." }, "clientId": { "type": "string", "description": "Identifies the client Id that is requesting the execution (used for sending an event to the specific client when execution is complete)." }, "scriptClassName": { "type": "string", "description": "Identifies the script class name to execute." }, "scriptName": { "type": "string", "description": "Identifies the script to execute (version is not needed as versions are not supported for system scripts)." }, "listOfSystemScriptTargetConfigInfo": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" }, "description": "The configuration info for the targets when executing." } }, "description": "Model containing the method level model for ScriptManager.executeSystemScripts to decode json data to internal NFM-P object model" }, "retrieveL2AwareBlockAllocations": { "title": "retrieveL2AwareBlockAllocations", "required": [ "timeout" ], "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInResidentialSubIdent": { "type": "string" }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait before receiving the results.This is an optional input parameter. The default value is 5 minutes (300000). default:300000", "format": "int64" } }, "description": "Model containing the method level model for L2AwareBlockAllocation.retrieveL2AwareBlockAllocations to decode json data to internal NFM-P object model" }, "findActualPathResponse": { "title": "findActualPathResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/Path" }, { "description": "Managed object abstract class" } ] } }, "description": "Model containing the method level model for Tunnel.findActualPath to encode json response from internal NFM-P object model" }, "configInfo": { "title": "configInfo", "required": [ "fullClassName", "properties" ], "type": "object", "properties": { "children": { "type": "array", "items": { "$ref": "#/components/schemas/configInfo" }, "description": "Optional grandchildren to be configured. ex: { \"fullClassName\":\"packageName.className\",\"properties\": {attribute1\": \"value1\",\"attribute2\":\"value2\",\"attributeN\": \"valueN}}" }, "fullClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "properties": { "type": "object", "additionalProperties": { "type": "object" }, "description": "The desired values to be configured for the child object. ex: {\"property1\":\"value1\", \"property2\":\"value2\", ..... ,\"propertyN\":\"valueN\"}" } }, "description": "Model containing the Data model for RestfulConfigurationInfo" }, "createDeviceResponse": { "title": "createDeviceResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for DiscoveredDevice.createDevice to encode json response from internal NFM-P object model" }, "retrieveIgmpGroupIfSapGrpResponse": { "title": "retrieveIgmpGroupIfSapGrpResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for GroupInterfaceSapGroup.retrieveIgmpGroupIfSapGrp to encode json response from internal NFM-P object model" }, "retrieveProfiledBgpEventsFilterResponse": { "title": "retrieveProfiledBgpEventsFilterResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/PagingResult" }, { "description": "Model containing the method level model for struct PagingResult. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for TopologyManager.retrieveProfiledBgpEventsFilter to encode json response from internal NFM-P object model" }, "updateUserObjectLifecycleStatesAndSchedulesResponse": { "title": "updateUserObjectLifecycleStatesAndSchedulesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int64" } }, "description": "Model containing the method level model for GenericObject.updateUserObjectLifecycleStatesAndSchedules to encode json response from internal NFM-P object model" }, "deleteSubSvcComponents": { "title": "deleteSubSvcComponents", "required": [ "neSystemAddress", "fdns" ], "type": "object", "properties": { "neSystemAddress": { "type": "string", "description": "System address of the NE to remove the profileor policy from (i.e. where the sub resides).The value \"0.0.0.0\" requests the removal of theprofiles policies from ALL nodes in the network(i.e. globally)." }, "fdns": { "type": "array", "items": { "type": "string" }, "description": "FDNs of the profiles policies to be deleted." } }, "description": "Model containing the method level model for ResidentialSubscriberManager.deleteSubSvcComponents to decode json data to internal NFM-P object model" }, "IPSecSecuredVpnConfigInfo": { "title": "IPSecSecuredVpnConfigInfo", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap", "containmentInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } }, "id": { "type": "integer", "format": "int64" }, "displayedName": { "type": "string" }, "description": { "type": "string" }, "serviceType": { "type": "integer", "format": "int32" }, "corporateServiceId": { "type": "integer", "format": "int64" }, "corporateServicePointer": { "type": "string" }, "privateServicePointer": { "type": "string" }, "corporateToSecureServiceConnector": { "type": "integer", "format": "int32" }, "ipsecSecurityPolicy": { "type": "boolean", "default": false }, "replayWindow": { "type": "integer", "format": "int32" }, "keying": { "type": "integer", "format": "int32" }, "ikePolicyPointer": { "type": "string" }, "preSharedKey": { "type": "string" }, "tunnelTemplatePointer": { "type": "string" }, "ipsecTransformPointer": { "type": "string" }, "autoEstablish": { "type": "boolean", "default": false }, "createCompositeService": { "type": "boolean", "default": false }, "keyTypeOptionInbound": { "type": "integer", "format": "int32" }, "encryptionKeyInbound": { "type": "string" }, "authenticationKeyInbound": { "type": "string" }, "spiInbound": { "type": "integer", "format": "int32" }, "keyTypeOptionOutbound": { "type": "integer", "format": "int32" }, "encryptionKeyOutbound": { "type": "string" }, "authenticationKeyOutbound": { "type": "string" }, "spiOutbound": { "type": "integer", "format": "int32" }, "subscrAuthPolicyPointer": { "type": "string" }, "ikePolicyPointerSoftClient": { "type": "string" }, "certTrustAnchorPointer": { "type": "string" }, "certFile": { "type": "string" }, "keyFile": { "type": "string" }, "localIdType": { "type": "integer", "format": "int32" }, "localIdValue": { "type": "string" } }, "description": "Model containing the method level model for Interface ConfigInfo IPSecSecuredVpnConfigInfo. to decode json data to internal NFM-P object model" }, "PreviewHopInfo": { "title": "PreviewHopInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "hopId": { "type": "integer", "format": "int32" }, "hopOrder": { "type": "integer", "format": "int32" }, "traversalType": { "type": "integer", "format": "int32" }, "direction": { "type": "integer", "format": "int32" }, "portPointer": { "type": "string" }, "ctpPointer": { "type": "string" }, "portType": { "type": "integer", "format": "int32" }, "isLogical": { "type": "boolean", "default": false }, "description": { "type": "string" }, "rate": { "type": "integer", "format": "int32" }, "channel": { "type": "integer", "format": "int32" }, "siteId": { "type": "string" }, "siteName": { "type": "string" }, "alarmProfilePointer": { "type": "string" }, "connectionPointer": { "type": "string" }, "linkPointer": { "type": "string" } }, "description": "Model containing the method level model for Interface PreviewHopInfo. to decode json data to internal NFM-P object model" }, "addTestedEntities": { "title": "addTestedEntities", "required": [ "testedEntities", "generateTests" ], "type": "object", "properties": { "testedEntities": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "A set of tested entity pointers to add." }, "generateTests": { "type": "boolean", "description": "Whether to generate tests for each tested entity that is added.If 'true' the tests for newly added tested entities will be generated." } }, "description": "Model containing the method level model for TestSuite.addTestedEntities to decode json data to internal NFM-P object model" }, "executeTargetScriptsWithParameters": { "title": "executeTargetScriptsWithParameters", "required": [ "isSynchronized", "clientId", "targetScriptFullNameList" ], "type": "object", "properties": { "isSynchronized": { "type": "boolean", "description": "Identifies if the call to execute the script should wait until all scripts have been executed. True to wait, false otherwise." }, "clientId": { "type": "string", "description": "Identifies the client ID that is requesting the execution (used for sending an event to the specific client when execution is complete)." }, "targetScriptFullNameList": { "type": "array", "items": { "type": "string" }, "description": "Identifies the list of target scripts to execute." } }, "description": "Model containing the method level model for ScriptManager.executeTargetScriptsWithParameters to decode json data to internal NFM-P object model" }, "findInactivePrimaryStaticRoutesResponse": { "title": "findInactivePrimaryStaticRoutesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/PagingResult" }, { "description": "Model containing the method level model for struct PagingResult. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for AutonomousSystem.findInactivePrimaryStaticRoutes to encode json response from internal NFM-P object model" }, "requestClearIsaSvcChainVasFilter": { "title": "requestClearIsaSvcChainVasFilter", "required": [ "siteId", "policyName" ], "type": "object", "properties": { "siteId": { "type": "string", "description": "Specifies the NE.This is a required input parameter." }, "policyName": { "type": "string", "description": "Specifies the Service Chaining VAS Filter Policy name.This is a required input parameter." } }, "description": "Model containing the method level model for SvcChainVasFilterPolicy.requestClearIsaSvcChainVasFilter to decode json data to internal NFM-P object model" }, "configScriptVersionResponse": { "title": "configScriptVersionResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedContainmentEntityInformation" }, { "description": "Model containing the method level model for struct CommonManagedContainmentEntityInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for AbstractScript.configScriptVersion to encode json response from internal NFM-P object model" }, "RdRtPairing": { "title": "RdRtPairing", "required": [ "objectClassName", "rdString", "rtString" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "rdString": { "type": "string" }, "rtString": { "type": "string" } }, "description": "Model containing the method level model for struct RdRtPairing. to decode json data to internal NFM-P object model" }, "resolveTargetResponse": { "title": "resolveTargetResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for TestManager.resolveTarget to encode json response from internal NFM-P object model" }, "TimeRangeEntryAssignmentSearchConfig": { "title": "TimeRangeEntryAssignmentSearchConfig", "required": [ "objectClassName", "timeOfDayEntryType", "assignedObjPointer", "startDate", "endDate" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "timeOfDayEntryType": { "type": "string" }, "assignedObjPointer": { "type": "string" }, "startDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct TimeRangeEntryAssignmentSearchConfig. to decode json data to internal NFM-P object model" }, "requestClearMeshSdpBfdStatsResponse": { "title": "requestClearMeshSdpBfdStatsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for MeshSdpBinding.requestClearMeshSdpBfdStats to encode json response from internal NFM-P object model" }, "retrieveOFFlowTableCounts": { "title": "retrieveOFFlowTableCounts", "required": [ "siteId", "dataPathId", "flowTableId" ], "type": "object", "properties": { "siteId": { "type": "string" }, "dataPathId": { "type": "string" }, "flowTableId": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for OFFlowTableCounts.retrieveOFFlowTableCounts to decode json data to internal NFM-P object model" }, "retrieveVRtrChannelsResponse": { "title": "retrieveVRtrChannelsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for IngrPathMgmtOperationalChannelSvc.retrieveVRtrChannels to encode json response from internal NFM-P object model" }, "multipleFilteredFind": { "title": "multipleFilteredFind", "required": [ "searchCriteria", "capabillities" ], "type": "object", "properties": { "searchCriteria": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/InstanceSearchCriteria" }, "description": "The search criteria to applied to retrieve the set of objects." }, "capabillities": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Capability ID(s)." } }, "description": "Model containing the method level model for GenericObject.multipleFilteredFind to decode json data to internal NFM-P object model" }, "TdmFacilityProtectionGroupInfo": { "title": "TdmFacilityProtectionGroupInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "groupId": { "type": "integer", "format": "int64" }, "groupType": { "type": "integer", "format": "int32" }, "siteName": { "type": "string" }, "siteId": { "type": "string" }, "protectionMode": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "direction": { "type": "integer", "format": "int32" }, "cardSubType": { "type": "integer", "format": "int32" }, "revertMode": { "type": "integer", "format": "int32" }, "extraTraffic": { "type": "integer", "format": "int32" }, "waitToRestore": { "type": "integer", "format": "int32" }, "holdOffTimer": { "type": "integer", "format": "int32" }, "requestFor": { "type": "integer", "format": "int32" }, "members": { "type": "string" }, "apsAction": { "type": "integer", "format": "int32" }, "xcDirection": { "type": "integer", "format": "int32" }, "apsGroupMethod": { "type": "integer", "format": "int32" }, "apsPingMethod": { "type": "integer", "format": "int32" }, "apsSdEnable": { "type": "boolean", "default": false }, "clientPortIfIndex": { "type": "integer", "format": "int64" }, "clientPortIfIndexLo": { "type": "integer", "format": "int64" }, "workingPortIfIndex": { "type": "integer", "format": "int64" }, "workingPortIfIndexLo": { "type": "integer", "format": "int64" }, "protectionPortIfIndex": { "type": "integer", "format": "int64" }, "protectionPortIfIndexLo": { "type": "integer", "format": "int64" }, "clientPort": { "type": "string" }, "workingPort": { "type": "string" }, "protectionPort": { "type": "string" }, "clientCtp": { "type": "string" }, "workingCtp": { "type": "string" }, "protectionCtp": { "type": "string" }, "protectionSwitch": { "type": "integer", "format": "int32" }, "clientFacilityPointer": { "type": "string" }, "workingFacilityPointer": { "type": "string" }, "protectionFacilityPointer": { "type": "string" }, "onDeleteAction": { "type": "integer", "format": "int32" }, "tdmProtId": { "type": "integer", "format": "int64" }, "rate": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for Interface TdmFacilityProtectionGroupInfo. to decode json data to internal NFM-P object model" }, "getAllConnectionProfileResponse": { "title": "getAllConnectionProfileResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/ConnProfPolicyInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for Interface.getAllConnectionProfile to encode json response from internal NFM-P object model" }, "getHistoryBufferResponse": { "title": "getHistoryBufferResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for SupervisionGroup.getHistoryBuffer to encode json response from internal NFM-P object model" }, "DbInfoTransitSubscriberResultStruct": { "title": "DbInfoTransitSubscriberResultStruct", "required": [ "objectClassName", "status", "details" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "status": { "type": "string" }, "details": { "type": "object" } }, "description": "Model containing the method level model for struct DbInfoTransitSubscriberResultStruct. to decode json data to internal NFM-P object model" }, "findNoteForAlarmInstance": { "title": "findNoteForAlarmInstance", "required": [ "alarmInstancePointer", "filter" ], "type": "object", "properties": { "alarmInstancePointer": { "type": "string", "description": "Full name of the alarm." }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for FaultManager.findNoteForAlarmInstance to decode json data to internal NFM-P object model" }, "GlobalTPLspConfigInfo": { "title": "GlobalTPLspConfigInfo", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap", "containmentInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } }, "globalTPLspId": { "type": "integer", "format": "int64" }, "lspIdAutoAssigned": { "type": "boolean", "default": false }, "displayedName": { "type": "string" }, "ipAddressType": { "type": "integer", "format": "int32" }, "tpLspNameA": { "type": "string" }, "tpLspNameB": { "type": "string" }, "pathIdA": { "type": "integer", "format": "int64" }, "sourceNodeIdA": { "type": "string" }, "pathIdB": { "type": "integer", "format": "int64" }, "sourceNodeIdB": { "type": "string" }, "sourceNodePointerA": { "type": "string" }, "sourceNodePointerB": { "type": "string" }, "fromNodeIdA": { "type": "string" }, "toNodeIdA": { "type": "string" }, "destinationGlobalIdA": { "type": "integer", "format": "int64" }, "destinationTunnelNumberA": { "type": "integer", "format": "int64" }, "fromNodeIdB": { "type": "string" }, "toNodeIdB": { "type": "string" }, "destinationGlobalIdB": { "type": "integer", "format": "int64" }, "destinationTunnelNumberB": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for Interface ConfigInfo GlobalTPLspConfigInfo. to decode json data to internal NFM-P object model" }, "retrieveIgmpGroupIfSapGrpSrc": { "title": "retrieveIgmpGroupIfSapGrpSrc", "type": "object", "properties": { "aInFwdServiceId": { "type": "integer", "format": "int64" }, "aInGrpIfindex": { "type": "integer", "format": "int64" }, "aInEncapVal": { "type": "integer", "format": "int64" }, "aInGroupAddress": { "type": "string" }, "aInSiteId": { "type": "string" }, "aInRouterId": { "type": "integer", "format": "int32" }, "aInPortId": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for GroupInterfaceSapGroupSource.retrieveIgmpGroupIfSapGrpSrc to decode json data to internal NFM-P object model" }, "getVrfTargetsResponse": { "title": "getVrfTargetsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for ServiceSite.getVrfTargets to encode json response from internal NFM-P object model" }, "QoSRetrievalStruct": { "title": "QoSRetrievalStruct", "required": [ "objectClassName", "siteId", "routerId", "remoteAddress", "localAddress", "retailServiceId", "getTunnel", "timeout" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "routerId": { "type": "integer", "format": "int64" }, "remoteAddress": { "type": "string" }, "localAddress": { "type": "string" }, "retailServiceId": { "type": "integer", "format": "int64" }, "getTunnel": { "type": "boolean" }, "timeout": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct QoSRetrievalStruct. to decode json data to internal NFM-P object model" }, "L2TPTunnelRetrievalStruct": { "title": "L2TPTunnelRetrievalStruct", "required": [ "objectClassName", "siteId", "subscriberId", "timeout" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "subscriberId": { "type": "string" }, "timeout": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct L2TPTunnelRetrievalStruct. to decode json data to internal NFM-P object model" }, "RemoveWlanGwUeTraceInfoStruct": { "title": "RemoveWlanGwUeTraceInfoStruct", "required": [ "objectClassName", "siteId", "ieeeAddress" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "ieeeAddress": { "type": "string" } }, "description": "Model containing the method level model for struct RemoveWlanGwUeTraceInfoStruct. to decode json data to internal NFM-P object model" }, "findNetworkInterfacesResponse": { "title": "findNetworkInterfacesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for MplsLspExpMap.findNetworkInterfaces to encode json response from internal NFM-P object model" }, "getStatsMibEntryPolicyResponse": { "title": "getStatsMibEntryPolicyResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/PollerPolicy" }, { "description": "Managed object abstract class" } ] } }, "description": "Model containing the method level model for PollerManager.getStatsMibEntryPolicy to encode json response from internal NFM-P object model" }, "CommonManagedEntityInformation": { "title": "CommonManagedEntityInformation", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" } }, "description": "Model containing the method level model for struct CommonManagedEntityInformation. to decode json data to internal NFM-P object model" }, "MCMCard": { "title": "MCMCard", "required": [ "displayedName", "shelfId", "hwIndex", "siteId", "siteName", "manufacturer", "serialNumber", "manufacturerBoardNumber", "manufactureDate", "equipmentCategory", "hwName", "cleiCode", "equipmentState", "containingEquipmentState", "compositeEquipmentState", "operationalState", "administrativeState", "isEquipped", "baseMacAddress", "hardwareFailureReason", "isEquipmentInserted", "manufacturingAssemblyNo", "manufacturingDeviations", "isTempSensorAvailable", "hardwareClass", "backgroundDiagnosticsState", "backgroundDiagnosticsFaultReason", "manufacturingVariant", "hwFirmwareRevisionStatus", "oesShelfId", "phyShelfClass", "phyShelfType", "olcState", "lockOlcState", "slotId", "specificType", "clockSource", "numberOfPorts", "maxPorts", "slotName", "shelfType", "numberOfDaughterCardSlots", "numberOfInstalledDaughterCards", "numberOfXiomCardSlots", "cardStatus", "numberOfEquippedXioms", "licenseConsumed", "licensedProduct", "platformType", "mcmSlotId", "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties" ], "type": "object", "properties": { "displayedName": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "shelfId": { "type": "integer", "format": "int32", "readOnly": true }, "hwIndex": { "type": "integer", "format": "int64", "readOnly": true }, "siteId": { "type": "string", "description": "64]", "readOnly": true, "example": " maximum: 64" }, "siteName": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "manufacturer": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "serialNumber": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "manufacturerBoardNumber": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "manufactureDate": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "equipmentCategory": { "type": "integer", "format": "int32", "readOnly": true }, "hwName": { "type": "string", "description": "[0,32]", "readOnly": true, "example": " maximum: 32" }, "cleiCode": { "type": "string", "description": "[0,16]", "readOnly": true, "example": " maximum: 16" }, "equipmentState": { "type": "integer", "format": "int32", "readOnly": true }, "containingEquipmentState": { "type": "integer", "format": "int32", "readOnly": true }, "compositeEquipmentState": { "type": "integer", "format": "int32", "readOnly": true }, "operationalState": { "type": "integer", "format": "int32", "readOnly": true }, "administrativeState": { "type": "integer", "format": "int32" }, "isEquipped": { "type": "boolean", "readOnly": true }, "baseMacAddress": { "type": "string", "readOnly": true }, "hardwareFailureReason": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "isEquipmentInserted": { "type": "boolean", "readOnly": true }, "manufacturingAssemblyNo": { "type": "string", "readOnly": true }, "manufacturingDeviations": { "type": "string", "readOnly": true }, "isTempSensorAvailable": { "type": "boolean", "readOnly": true }, "hardwareClass": { "type": "integer", "format": "int32", "readOnly": true }, "backgroundDiagnosticsState": { "type": "integer", "format": "int32", "readOnly": true }, "backgroundDiagnosticsFaultReason": { "type": "string", "readOnly": true }, "manufacturingVariant": { "type": "string", "readOnly": true }, "hwFirmwareRevisionStatus": { "type": "integer", "format": "int32", "readOnly": true }, "oesShelfId": { "type": "integer", "format": "int32" }, "phyShelfClass": { "type": "integer", "format": "int32" }, "phyShelfType": { "type": "integer", "format": "int32" }, "olcState": { "type": "integer", "description": "Object Life Cycle can be set using {{generic.GenericObject.updateUserObjectLifecycleStates()}}.", "format": "int32", "readOnly": true }, "lockOlcState": { "type": "boolean", "description": "This is used to lock the OLC State while in OLC Maintenance State only." }, "slotId": { "type": "integer", "description": "[1,", "format": "int32" }, "specificType": { "type": "integer", "format": "int32" }, "clockSource": { "type": "string", "description": "80]", "readOnly": true, "example": " maximum: 80" }, "numberOfPorts": { "type": "integer", "description": "The number of ports on this card only (does not includenumber of ports on daughter cards).For example: if this card is an IOCard (which does not have any ports on it)this value will be 0 regardless of the configured daughter card(s).", "format": "int32", "readOnly": true }, "maxPorts": { "type": "integer", "description": "The maximum number of ports on this card only (does not includemaximum number of ports on daughter cards).For example: if this card is an IOCard (which does not have any ports on it)this value will be 0 regardless of the configured daughter card(s).", "format": "int32", "readOnly": true }, "slotName": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "shelfType": { "type": "integer", "format": "int32", "readOnly": true }, "numberOfDaughterCardSlots": { "type": "integer", "format": "int32", "readOnly": true }, "numberOfInstalledDaughterCards": { "type": "integer", "format": "int32", "readOnly": true }, "numberOfXiomCardSlots": { "type": "integer", "format": "int32", "readOnly": true }, "cardStatus": { "type": "integer", "description": "[1,", "format": "int32" }, "numberOfEquippedXioms": { "type": "integer", "format": "int32", "readOnly": true }, "licenseConsumed": { "type": "number", "description": "The value specifies the number of license points consumed.", "readOnly": true }, "licensedProduct": { "type": "string", "description": "The value specifies the license product.252]", "readOnly": true, "example": " maximum: 252" }, "platformType": { "type": "integer", "format": "int32", "readOnly": true }, "mcmSlotId": { "type": "integer", "format": "int32" }, "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "actionMask": { "type": "integer", "format": "int32" }, "selfAlarmed": { "type": "boolean", "default": false }, "name": { "type": "string" } }, "description": "Managed object abstract class" }, "findCtpsOnMultiplePorts": { "title": "findCtpsOnMultiplePorts", "required": [ "portObjectPointers", "ctpFilter" ], "type": "object", "properties": { "portObjectPointers": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "ctpFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for ConnectionTerminationPoint.findCtpsOnMultiplePorts to decode json data to internal NFM-P object model" }, "ClearDhcpLeaseStruct": { "title": "ClearDhcpLeaseStruct", "required": [ "objectClassName", "siteId", "serviceId", "dhcpSvrName", "ipAddress", "prefix", "state" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "serviceId": { "type": "integer", "format": "int64" }, "dhcpSvrName": { "type": "string" }, "ipAddress": { "type": "string" }, "prefix": { "type": "integer", "format": "int64" }, "state": { "type": "string" } }, "description": "Model containing the method level model for struct ClearDhcpLeaseStruct. to decode json data to internal NFM-P object model" }, "findInactiveSecondaryStaticRoutes": { "title": "findInactiveSecondaryStaticRoutes", "required": [ "fields", "sortFields", "pageNumber", "pageSize" ], "type": "object", "properties": { "fields": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Sorting fields" }, "sortFields": { "type": "array", "items": { "type": "string" }, "description": "Sorting fields" }, "pageNumber": { "type": "integer", "description": "Page number", "format": "int32" }, "pageSize": { "type": "integer", "description": "The number of entries to return", "format": "int32" } }, "description": "Model containing the method level model for AutonomousSystem.findInactiveSecondaryStaticRoutes to decode json data to internal NFM-P object model" }, "findBwUsageResponse": { "title": "findBwUsageResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CacBWAttribute" }, "description": "The response object." } }, "description": "Model containing the method level model for AbstractPhysicalLink.findBwUsage to encode json response from internal NFM-P object model" }, "getDependencyCountResponse": { "title": "getDependencyCountResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int32" } }, "description": "Model containing the method level model for PortCrossConnect.getDependencyCount to encode json response from internal NFM-P object model" }, "deleteAllENBsResponse": { "title": "deleteAllENBsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for TCE.deleteAllENBs to encode json response from internal NFM-P object model" }, "findGmplsLoopbackInterfaceAddressesResponse": { "title": "findGmplsLoopbackInterfaceAddressesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for NetworkInterface.findGmplsLoopbackInterfaceAddresses to encode json response from internal NFM-P object model" }, "findNoteForAlarmInstanceResponse": { "title": "findNoteForAlarmInstanceResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/AlarmNoteObjectInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for FaultManager.findNoteForAlarmInstance to encode json response from internal NFM-P object model" }, "findAssociatedServicesResponse": { "title": "findAssociatedServicesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/TransportServiceInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for PointToPointConnection.findAssociatedServices to encode json response from internal NFM-P object model" }, "importImage": { "title": "importImage", "required": [ "imageFileNames", "imageLocation", "imageType", "md5Map", "versionString", "gneType" ], "type": "object", "properties": { "imageFileNames": { "type": "array", "items": { "type": "string" }, "description": "List of file names to be imported. If empty, all the files in the directory referred to by \"imageLocation\" parametershall be picked up.{blockquote}{pre}Example 1:<imageFileNames> <string>myfile.ext< string>< imageFileNames>{BR}Example 2:<imageFileNames> <string>myfile1.ext< string> <string>myfile2.ext< string> <string>myfile3.ext< string>< imageFileNames>{ pre}{ blockquote}" }, "imageLocation": { "type": "string", "description": "Relative name of the directory containing all the image files (relative to the local directory server_install_dir nms nodeSoftware ).Descriptor file must be included for RAN based images." }, "imageType": { "type": "string", "description": "Type of image - srBased, aosBased, mprBased, mmeBased, etc." }, "md5Map": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of file names and their md5 checksums. Used for validation, if not empty.{blockquote}{pre}Example:<md5Map> <item> <key>myfile.ext< key> <value>123456789< value> < item>< md5Map>{ pre}{ blockquote}" }, "versionString": { "type": "string", "description": "Image version." }, "gneType": { "type": "string", "description": "Used for generic nodes, this parameter contains the Generic Ne Profile fullname, used to determine GNE types that can be upgraded, using this image." } }, "description": "Model containing the method level model for SoftwareFolderManager.importImage to decode json data to internal NFM-P object model" }, "findAllStaticRoutesResponse": { "title": "findAllStaticRoutesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/PagingResult" }, { "description": "Model containing the method level model for struct PagingResult. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for AutonomousSystem.findAllStaticRoutes to encode json response from internal NFM-P object model" }, "findSbtsNodesResponse": { "title": "findSbtsNodesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for SbtsPMPolicy.findSbtsNodes to encode json response from internal NFM-P object model" }, "findSrrpInstancesResponse": { "title": "findSrrpInstancesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for Policy.findSrrpInstances to encode json response from internal NFM-P object model" }, "retrieveEthernetSessionsResponse": { "title": "retrieveEthernetSessionsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for GroupProfile.retrieveEthernetSessions to encode json response from internal NFM-P object model" }, "retrieveMsap": { "title": "retrieveMsap", "required": [ "subscrIdent", "nodeId", "portName", "outerEncapValue", "innerEncapValue", "isActive", "timeout", "shallowRetrieval" ], "type": "object", "properties": { "subscrIdent": { "type": "string", "description": "The subscriber ID used to determine the MSAP’s service IDin the event the MSAP cannot be found in the NFM-P database" }, "nodeId": { "type": "string", "description": "The site ID of the NE to query." }, "portName": { "type": "string", "description": "The port of the MSAP on which the subscriber is located.The string should be set to a value in the ‘Port x y z’ format." }, "outerEncapValue": { "type": "integer", "description": "The outer encapsulation of the MSAP on which the subscriber is located.", "format": "int32" }, "innerEncapValue": { "type": "integer", "description": "The inner encapsulation of the MSAP on which the subscriber is located", "format": "int32" }, "isActive": { "type": "boolean", "description": "The value \"false\" means that the MSAP exists in NFM-P database but not on NE. default:true" }, "timeout": { "type": "integer", "description": "(Optional)The number of milliseconds to wait before receiving the results.If no results are received in the given time, the method returns. default:0", "format": "int64" }, "shallowRetrieval": { "type": "boolean", "description": "(Optional)If it is true, not all of the properties are retrieved for quick response default:false" } }, "description": "Model containing the method level model for MSap.retrieveMsap to decode json data to internal NFM-P object model" }, "findPortsResponse": { "title": "findPortsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for Remark.findPorts to encode json response from internal NFM-P object model" }, "configure": { "title": "configure", "required": [ "siteId", "routerIdOrZero", "configInfo" ], "type": "object", "properties": { "siteId": { "type": "string" }, "routerIdOrZero": { "type": "integer", "format": "int64" }, "configInfo": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" }, { "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for Crossconnect.configure to decode json data to internal NFM-P object model" }, "amfDirectedUELoadBalance": { "title": "amfDirectedUELoadBalance", "required": [ "siteId", "amfDirectedUelbProfileName", "amfUelbAction" ], "type": "object", "properties": { "siteId": { "type": "string" }, "amfDirectedUelbProfileName": { "type": "string" }, "amfUelbAction": { "type": "string" }, "requestId": { "type": "string", "description": "Non documentable API" } }, "description": "Model containing the method level model for CMMInstance.amfDirectedUELoadBalance to decode json data to internal NFM-P object model" }, "pingAndGetResultResponse": { "title": "pingAndGetResultResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int32" } }, "description": "Model containing the method level model for NodeDiscoveryControl.pingAndGetResult to encode json response from internal NFM-P object model" }, "retrieveEpsPeers": { "title": "retrieveEpsPeers", "required": [ "siteId", "epsType", "terminationName", "adminState", "operationalState", "linkAlarm" ], "type": "object", "properties": { "siteId": { "type": "string" }, "epsType": { "type": "string" }, "terminationName": { "type": "string" }, "adminState": { "type": "string" }, "operationalState": { "type": "string" }, "linkAlarm": { "type": "boolean" } }, "description": "Model containing the method level model for MmeEpsPeerSummary.retrieveEpsPeers to decode json data to internal NFM-P object model" }, "retrieveVplsChannelsResponse": { "title": "retrieveVplsChannelsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for IngrPathMgmtOperationalChannelSvc.retrieveVplsChannels to encode json response from internal NFM-P object model" }, "getStandbyDbStatusResponse": { "title": "getStandbyDbStatusResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int32" } }, "description": "Model containing the method level model for DatabaseManager.getStandbyDbStatus to encode json response from internal NFM-P object model" }, "dhcpStickyLeaseActionResponse": { "title": "dhcpStickyLeaseActionResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for AbstractAddressPool.dhcpStickyLeaseAction to encode json response from internal NFM-P object model" }, "executeTargetScript": { "title": "executeTargetScript", "required": [ "isSynchronized", "clientId", "configInfo" ], "type": "object", "properties": { "isSynchronized": { "type": "boolean", "description": "Identifies if the call to execute the script should wait until the script has been executed. True to wait, false otherwise." }, "clientId": { "type": "string", "description": "Identifies the client Id that is requesting the execution (used for sending an event to the specific client when execution is complete)." }, "configInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" }, "description": "The configuration info for the targets when executing (runtime parameters)." } }, "description": "Model containing the method level model for TargetScript.executeTargetScript to decode json data to internal NFM-P object model" }, "findSampleProfileResponse": { "title": "findSampleProfileResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for Ipv6FilterEntry.findSampleProfile to encode json response from internal NFM-P object model" }, "URLDecoderResult": { "title": "URLDecoderResult", "type": "object", "properties": { "decodedString": { "type": "string" }, "iteration": { "type": "integer", "format": "int32" } }, "description": "URL Decoder Result to model" }, "retrieveStaticIsids": { "title": "retrieveStaticIsids", "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInInterfaceDN": { "type": "string" }, "aInFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "aInSvcId": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for SpokeSdpBindingStaticIsid.retrieveStaticIsids to decode json data to internal NFM-P object model" }, "retrieveFirewallHosts": { "title": "retrieveFirewallHosts", "required": [ "timeout" ], "type": "object", "properties": { "aInFirewallHostRtrvStruct": { "allOf": [ { "$ref": "#/components/schemas/FirewallHostRtrvStruct" }, { "description": "Model containing the method level model for struct FirewallHostRtrvStruct. to decode json data to internal NFM-P object model" } ] }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait before receiving the results.This is an optional input parameter. The default value is 5 minutes (300000). default:300000", "format": "int64" } }, "description": "Model containing the method level model for FirewallHost.retrieveFirewallHosts to decode json data to internal NFM-P object model" }, "findNsgsInGroupResponse": { "title": "findNsgsInGroupResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for NsgGroup.findNsgsInGroup to encode json response from internal NFM-P object model" }, "PppSessionRetrievalStruct": { "title": "PppSessionRetrievalStruct", "required": [ "objectClassName", "siteId", "serviceId", "pppSessionIndex", "timeout" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "serviceId": { "type": "integer", "format": "int64" }, "pppSessionIndex": { "type": "integer", "format": "int64" }, "timeout": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct PppSessionRetrievalStruct. to decode json data to internal NFM-P object model" }, "configureChildInstance": { "title": "configureChildInstance", "required": [ "distinguishedName", "childConfigInfo" ], "type": "object", "properties": { "distinguishedName": { "type": "string", "description": "Distinguished Name of parent under which object is being configured." }, "childConfigInfo": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" }, { "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for GenericObject.configureChildInstance to decode json data to internal NFM-P object model" }, "findValidTerminatingPortsForServiceControlPlaneResponse": { "title": "findValidTerminatingPortsForServiceControlPlaneResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for ServiceSite.findValidTerminatingPortsForServiceControlPlane to encode json response from internal NFM-P object model" }, "clearSubscriberHostLeaseStateResponse": { "title": "clearSubscriberHostLeaseStateResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for ResidentialSubscriberInstance.clearSubscriberHostLeaseState to encode json response from internal NFM-P object model" }, "retrieveDbInfoTransitPrefixAddressResponse": { "title": "retrieveDbInfoTransitPrefixAddressResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for DbInfoTransitPrefixAddress.retrieveDbInfoTransitPrefixAddress to encode json response from internal NFM-P object model" }, "requestRecoverL2AwBypassResponse": { "title": "requestRecoverL2AwBypassResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for IsaMda.requestRecoverL2AwBypass to encode json response from internal NFM-P object model" }, "AnchorPortInfo": { "title": "AnchorPortInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "administrativeState": { "type": "integer", "format": "int32" }, "oesShelfId": { "type": "integer", "format": "int32" }, "phyShelfClass": { "type": "integer", "format": "int32" }, "phyShelfType": { "type": "integer", "format": "int32" }, "lockOlcState": { "type": "boolean", "default": false }, "portId": { "type": "integer", "format": "int64" }, "description": { "type": "string" }, "mode": { "type": "integer", "format": "int32" }, "isl2UplinkMode": { "type": "boolean", "default": false }, "macAddress": { "type": "string" }, "encapType": { "type": "integer", "format": "int32" }, "holdTimeUp": { "type": "integer", "format": "int32" }, "holdTimeDown": { "type": "integer", "format": "int32" }, "mtuValue": { "type": "integer", "format": "int32" }, "speed": { "type": "integer", "format": "int32" }, "accountingPolicyObjectPointer": { "type": "string" }, "collectStats": { "type": "boolean", "default": false }, "etherAccountingPolicyObjectPointer": { "type": "string" }, "etherCollectStats": { "type": "boolean", "default": false }, "ethAccessAccountingPolicyObjectPointer": { "type": "string" }, "ethAccessCollectStats": { "type": "boolean", "default": false }, "networkQueueObjectPointer": { "type": "string" }, "loadBalanceAlgorithm": { "type": "integer", "format": "int32" }, "portSchedulerPolicyObjectPointer": { "type": "string" }, "portEgrHsmdaSchedulerPolicy": { "type": "string" }, "uniProfilePointer": { "type": "string" }, "portIngrNamedPoolPlcy": { "type": "string" }, "portEgrNamedPoolPlcy": { "type": "string" }, "portIngrPoolPercentageRate": { "type": "integer", "format": "int32" }, "portEgrPoolPercentageRate": { "type": "integer", "format": "int32" }, "vlanAutoBind": { "type": "boolean", "default": false }, "l2ProfilePointer": { "type": "string" }, "holdTimeUnits": { "type": "integer", "format": "int32" }, "linkTrap": { "type": "integer", "format": "int32" }, "userLabel": { "type": "string" }, "mptCombinerImplemented": { "type": "integer", "format": "int64" }, "numOfDot1qSapUsingVCP": { "type": "integer", "format": "int32" }, "isVCPUpdatedForDot1qSap": { "type": "boolean", "default": false }, "isVCPSapPort": { "type": "boolean", "default": false }, "unpPortType": { "type": "integer", "format": "int32" }, "ingressAccessWeight": { "type": "integer", "format": "int32" }, "ingressNetworkWeight": { "type": "integer", "format": "int32" }, "egressAccessWeight": { "type": "integer", "format": "int32" }, "egressNetworkWeight": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for Interface AnchorPortInfo. to decode json data to internal NFM-P object model" }, "generateResponse": { "title": "generateResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, { "description": "Model containing the method level model for struct CommonManagedEntityInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for XmlApiConfigTemplate.generate to encode json response from internal NFM-P object model" }, "getDbStatusResponse": { "title": "getDbStatusResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int32" } }, "description": "Model containing the method level model for DatabaseManager.getDbStatus to encode json response from internal NFM-P object model" }, "scheduleFirmwareUpgrade": { "title": "scheduleFirmwareUpgrade", "required": [ "schedule", "networkElements", "simId" ], "type": "object", "properties": { "schedule": { "type": "string" }, "networkElements": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "simId": { "type": "integer", "description": "default:1", "format": "int32" } }, "description": "Model containing the method level model for FirmwareFolderDescriptor.scheduleFirmwareUpgrade to decode json data to internal NFM-P object model" }, "findUserMvrSapsResponse": { "title": "findUserMvrSapsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for MldSiteMvr.findUserMvrSaps to encode json response from internal NFM-P object model" }, "findActivePrimaryStaticRoutesResponse": { "title": "findActivePrimaryStaticRoutesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/PagingResult" }, { "description": "Model containing the method level model for struct PagingResult. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for AutonomousSystem.findActivePrimaryStaticRoutes to encode json response from internal NFM-P object model" }, "configureMaintenanceModeResponse": { "title": "configureMaintenanceModeResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for TransportService.configureMaintenanceMode to encode json response from internal NFM-P object model" }, "showDhcp6LeasesResponse": { "title": "showDhcp6LeasesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for LocalDhcp6Server.showDhcp6Leases to encode json response from internal NFM-P object model" }, "addNeWorkOrders": { "title": "addNeWorkOrders", "required": [ "sessionFdn", "neWorkOrders", "failAllOnError", "autoLoad" ], "type": "object", "properties": { "sessionFdn": { "type": "string", "description": "The session to validate." }, "neWorkOrders": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The set of NE work orders to add to the session." }, "failAllOnError": { "type": "boolean", "description": "If set to true, it indicates that the complete operation will fail if any of the given NEwork orders cannot be added to the session. If set to false, the failed NE work orders will be skippedand valid ones will be added." }, "autoLoad": { "type": "boolean", "description": "Set if the NE work order contents should automatically be loaded in memory and analyzed." } }, "description": "Model containing the method level model for Session.addNeWorkOrders to decode json data to internal NFM-P object model" }, "triggerNesAuditResponse": { "title": "triggerNesAuditResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for NeAuditManager.triggerNesAudit to encode json response from internal NFM-P object model" }, "retrieveMlpppBundlesResponse": { "title": "retrieveMlpppBundlesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for MlpppBundle.retrieveMlpppBundles to encode json response from internal NFM-P object model" }, "auditLocalPolicyResponse": { "title": "auditLocalPolicyResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/AuditLocalPolicyResultInfo" }, { "description": "Model containing the method level model for struct AuditLocalPolicyResultInfo. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for Manager.auditLocalPolicy to encode json response from internal NFM-P object model" }, "invokeResyncAaSapInfo": { "title": "invokeResyncAaSapInfo", "required": [ "siteId", "isaGrpPartIndex" ], "type": "object", "properties": { "siteId": { "type": "string", "description": "Network Element site IP address." }, "isaGrpPartIndex": { "type": "integer", "description": "The ISA-AA Group Partition Index.", "format": "int64" } }, "description": "Model containing the method level model for AaSapInfo.invokeResyncAaSapInfo to decode json data to internal NFM-P object model" }, "copyMovePolicyEntries": { "title": "copyMovePolicyEntries", "required": [ "selectedPolicyEntries", "policyInfoList", "entryOverride", "globalPolicyDistribute" ], "type": "object", "properties": { "selectedPolicyEntries": { "type": "array", "items": { "type": "string" }, "description": "List of policy entries that need to copied or overridden for a given policy list." }, "policyInfoList": { "type": "array", "items": { "type": "string" }, "description": "List of global policies to which the selected policy Entries will be copied overridden." }, "entryOverride": { "type": "boolean", "description": "Indicates if any existing entries in a given policy can be overridden with selected entries." }, "globalPolicyDistribute": { "type": "boolean", "description": "Indicates if the global policy needs to be distributed post copy operation." } }, "description": "Model containing the method level model for Manager.copyMovePolicyEntries to decode json data to internal NFM-P object model" }, "getMonitoredObjectsSummariesResponse": { "title": "getMonitoredObjectsSummariesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ObjectStateSummary" }, "description": "The response object." } }, "description": "Model containing the method level model for SummaryView.getMonitoredObjectsSummaries to encode json response from internal NFM-P object model" }, "resyncLeasesResponse": { "title": "resyncLeasesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for LocalDhcpServer.resyncLeases to encode json response from internal NFM-P object model" }, "configureAdditionalTextPolicy": { "title": "configureAdditionalTextPolicy", "required": [ "domain", "objectType", "additionalTextAttributeConfigInfo" ], "type": "object", "properties": { "domain": { "type": "string", "description": "The domain of the additional text policy" }, "objectType": { "type": "string", "description": "The object type of the additional text policy" }, "additionalTextAttributeConfigInfo": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" }, "description": "The additional text attribute config info" } }, "description": "Model containing the method level model for AdditionalTextPolicy.configureAdditionalTextPolicy to decode json data to internal NFM-P object model" }, "getLogResponse": { "title": "getLogResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/AlarmHistoryDatabase" }, { "description": "Managed object abstract class" } ] } }, "description": "Model containing the method level model for AlarmHistoryDatabase.getLog to encode json response from internal NFM-P object model" }, "DriverInfo": { "title": "DriverInfo", "required": [ "objectClassName", "product", "version", "resync" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "product": { "type": "string" }, "version": { "type": "string" }, "resync": { "type": "boolean" } }, "description": "Model containing the method level model for struct DriverInfo. to decode json data to internal NFM-P object model" }, "findZoneAssociationsResponse": { "title": "findZoneAssociationsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for FwPolicyDefinition.findZoneAssociations to encode json response from internal NFM-P object model" }, "resyncDeclinedAddresses": { "title": "resyncDeclinedAddresses", "required": [ "timeout" ], "type": "object", "properties": { "aInRtrId": { "type": "string" }, "aInLocalDhcpServerName": { "type": "string" }, "aInAddressPoolName": { "type": "string" }, "aInVirtualRtrId": { "type": "integer", "format": "int64" }, "aInDhcpSvrSubnetAddress": { "type": "string" }, "aInDhcpSvrSubnetPrefixLength": { "type": "integer", "format": "int64" }, "aInDhcpSvrFreeAddress": { "type": "string" }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns.", "format": "int64" } }, "description": "Model containing the method level model for AddressPool.resyncDeclinedAddresses to decode json data to internal NFM-P object model" }, "retrievePppSessionsResponse": { "title": "retrievePppSessionsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for PPPSession.retrievePppSessions to encode json response from internal NFM-P object model" }, "highlightLFANextHopsResponse": { "title": "highlightLFANextHopsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/ShortestPathGraph" }, { "description": "Model containing the method level model for struct ShortestPathGraph. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for TopologyManager.highlightLFANextHops to encode json response from internal NFM-P object model" }, "AlarmStatusesStruct": { "title": "AlarmStatusesStruct", "required": [ "objectClassName", "alarmStatus", "aggregatedAlarmStatus", "hasSelfAlarm" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "alarmStatus": { "type": "string" }, "aggregatedAlarmStatus": { "type": "string" }, "hasSelfAlarm": { "type": "boolean" } }, "description": "Model containing the method level model for struct AlarmStatusesStruct. to decode json data to internal NFM-P object model" }, "reset": { "title": "reset", "required": [ "resetType", "mode", "fwUpgrade" ], "type": "object", "properties": { "resetType": { "type": "string", "description": "This parameter defines which type of reset is to be sent to the card." }, "mode": { "type": "string", "description": "Command Mode - identifies the Command Execution Mode. default:NORM" }, "fwUpgrade": { "type": "string", "description": "This parameter identifies the firmware upgrade option during reboot.{UL}{LI}Yes - Card scope FW image is downloaded from the Main Shelf First Level Controller{BR}to the target card. A cold restart is then instantiated without PortGroup FW image(s) upgrade.{LI}No - Card scope FW image is not downloaded before reboot.{LI}Yes including Port Group - Card scope FW image is downloaded from the Main Shelf First Level Controller{BR}to the target card. A cold restart is then instantiated with all PortGroup FW image(s) upgrade. default:N" } }, "description": "Model containing the method level model for BaseCard.reset to decode json data to internal NFM-P object model" }, "getAlarmsResponse": { "title": "getAlarmsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "object" }, "description": "The response object." } }, "description": "Model containing the method level model for SummaryView.getAlarms to encode json response from internal NFM-P object model" }, "cancelExecution": { "title": "cancelExecution", "required": [ "clientId", "targetScriptResultObjectFullNameListToBeCanceled" ], "type": "object", "properties": { "clientId": { "type": "string", "description": "The client ID of the client that requested the execution of the target script." }, "targetScriptResultObjectFullNameListToBeCanceled": { "type": "array", "items": { "type": "string" }, "description": "The list of target scripts to cancel." } }, "description": "Model containing the method level model for ScriptManager.cancelExecution to decode json data to internal NFM-P object model" }, "IPSecTunnelConfigInfo": { "title": "IPSecTunnelConfigInfo", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap", "containmentInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "pmtuDiscoveryAging": { "type": "integer", "format": "int64" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } }, "serviceIdPointer": { "type": "string" }, "adminState": { "type": "integer", "format": "int32" }, "certTrustAnchorPointer": { "type": "string" }, "gwAddressType": { "type": "integer", "format": "int32" }, "gwIpAddress": { "type": "string" }, "ikePolicyPointer": { "type": "string" }, "preSharedKey": { "type": "string" }, "certFile": { "type": "string" }, "keyFile": { "type": "string" }, "certProfilePointer": { "type": "string" }, "trustAnchorProfilePointer": { "type": "string" }, "defaultResult": { "type": "integer", "format": "int32" }, "primary": { "type": "integer", "format": "int32" }, "secondary": { "type": "integer", "format": "int32" }, "localIdType": { "type": "integer", "format": "int32" }, "localIdValue": { "type": "string" }, "description": { "type": "string" }, "dynamicKeyTransformId1Pointer": { "type": "string" }, "dynamicKeyTransformId2Pointer": { "type": "string" }, "dynamicKeyTransformId3Pointer": { "type": "string" }, "dynamicKeyTransformId4Pointer": { "type": "string" }, "replayWindow": { "type": "integer", "format": "int32" }, "tunnelName": { "type": "string" }, "remoteAddressType": { "type": "integer", "format": "int32" }, "remoteIpAddress": { "type": "string" }, "securityPolicyPointer": { "type": "string" }, "keying": { "type": "integer", "format": "int32" }, "autoEstablish": { "type": "boolean", "default": false }, "bfdDesignate": { "type": "boolean", "default": false }, "bfdEnable": { "type": "boolean", "default": false }, "ipMtu": { "type": "integer", "format": "int64" }, "encapsulatedIpMtu": { "type": "integer", "format": "int64" }, "clearDfBit": { "type": "boolean", "default": false }, "copyDfBit": { "type": "boolean", "default": false }, "icmp6Pkt2Big": { "type": "boolean", "default": false }, "icmp6NumPkt2Big": { "type": "integer", "format": "int64" }, "icmp6Pkt2BigTime": { "type": "integer", "format": "int64" }, "publicTcpMssAdjust": { "type": "integer", "format": "int64" }, "privateTcpMssAdjust": { "type": "integer", "format": "int64" }, "secPlcyStrictMatch": { "type": "boolean", "default": false }, "propogatePMtuV4": { "type": "boolean", "default": false }, "propogatePMtuV6": { "type": "boolean", "default": false }, "icmpFragReq": { "type": "boolean", "default": false }, "icmpFragReqNum": { "type": "integer", "format": "int64" }, "icmpFragReqTime": { "type": "integer", "format": "int32" }, "copyTrafficClass": { "type": "boolean", "default": false }, "creationOrigin": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for Interface ConfigInfo IPSecTunnelConfigInfo. to decode json data to internal NFM-P object model" }, "lightPathTraceResponse": { "title": "lightPathTraceResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "object" }, "description": "The response object." } }, "description": "Model containing the method level model for TransportService.lightPathTrace to encode json response from internal NFM-P object model" }, "RetrievingMlpppBundleStruct": { "title": "RetrievingMlpppBundleStruct", "required": [ "objectClassName", "siteId", "bundleId", "timeout" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "bundleId": { "type": "integer", "format": "int64" }, "timeout": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct RetrievingMlpppBundleStruct. to decode json data to internal NFM-P object model" }, "retrieveLsnBlockAllocations": { "title": "retrieveLsnBlockAllocations", "required": [ "timeout" ], "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInAddr": { "type": "string" }, "aInStartPort": { "type": "integer", "format": "int32" }, "aInRouterId": { "type": "integer", "format": "int32" }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait before receiving the results. If no results arereceived in the given time, the method returns.This is an optional input parameter. The default value is 5 minutes (300000). default:300000", "format": "int64" } }, "description": "Model containing the method level model for LsnBlockAllocation.retrieveLsnBlockAllocations to decode json data to internal NFM-P object model" }, "takeSnapshotResponse": { "title": "takeSnapshotResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int64" } }, "description": "Model containing the method level model for SupervisionManager.takeSnapshot to encode json response from internal NFM-P object model" }, "retrieveWlanGwBdUesPerTunnelResponse": { "title": "retrieveWlanGwBdUesPerTunnelResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for WlanGwBdUe.retrieveWlanGwBdUesPerTunnel to encode json response from internal NFM-P object model" }, "ClearIsaSubnetStruct": { "title": "ClearIsaSubnetStruct", "required": [ "objectClassName", "siteId", "svcId", "subscriberInterfaceName", "ipAddress", "prefix" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "svcId": { "type": "integer", "format": "int64" }, "subscriberInterfaceName": { "type": "string" }, "ipAddress": { "type": "string" }, "prefix": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct ClearIsaSubnetStruct. to decode json data to internal NFM-P object model" }, "findInstancesResponse": { "title": "findInstancesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for VrrpVirtualRouter.findInstances to encode json response from internal NFM-P object model" }, "generateStmDefaults": { "title": "generateStmDefaults", "required": [ "testedEntities", "testedEntityType" ], "type": "object", "properties": { "testedEntities": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "testedEntityType": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for TestManager.generateStmDefaults to decode json data to internal NFM-P object model" }, "PropertyValueEntry": { "title": "PropertyValueEntry", "required": [ "objectClassName", "policyFullName", "parameters" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "policyFullName": { "type": "string" }, "parameters": { "type": "array", "items": { "type": "string" }, "description": "" } }, "description": "Model containing the method level model for struct PropertyValueEntry. to decode json data to internal NFM-P object model" }, "findMembers": { "title": "findMembers", "required": [ "memberType", "filter" ], "type": "object", "properties": { "memberType": { "type": "string" }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for CommunityMember.findMembers to decode json data to internal NFM-P object model" }, "PreFixData": { "title": "PreFixData", "required": [ "objectClassName", "state", "appDefinedContext", "plan", "report" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "state": { "type": "string" }, "appDefinedContext": { "type": "object" }, "plan": { "type": "array", "items": { "type": "string" }, "description": "" }, "report": { "type": "array", "items": { "type": "string" }, "description": "" } }, "description": "Model containing the method level model for struct PreFixData. to decode json data to internal NFM-P object model" }, "DeploymentPolicyConfigInfo": { "title": "DeploymentPolicyConfigInfo", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap", "containmentInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } }, "deploymentMode": { "type": "integer", "format": "int32" }, "autoSaveConfigScheme": { "type": "integer", "format": "int32" }, "autoSaveConfigTreshold": { "type": "integer", "format": "int32" }, "scheduledSaveConfigScheme": { "type": "integer", "format": "int32" }, "scheduledSaveConfigFrequency": { "type": "integer", "format": "int32" }, "retryScheme": { "type": "integer", "format": "int32" }, "retryFrequency": { "type": "integer", "format": "int32" }, "retryThreshold": { "type": "integer", "format": "int32" }, "saveConfigDetails": { "type": "boolean", "default": false }, "saveConfigInterval": { "type": "integer", "format": "int32" }, "saveConfigScheduling": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for Interface ConfigInfo DeploymentPolicyConfigInfo. to decode json data to internal NFM-P object model" }, "retrieveSubSapErrorResponse": { "title": "retrieveSubSapErrorResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for SubscrSapError.retrieveSubSapError to encode json response from internal NFM-P object model" }, "AuditParam": { "title": "AuditParam", "required": [ "objectClassName", "fdn" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "fdn": { "type": "string" } }, "description": "Model containing the method level model for struct AuditParam. to decode json data to internal NFM-P object model" }, "shortestPathFirstGraphExt": { "title": "shortestPathFirstGraphExt", "required": [ "igpAdminDomain", "protocol", "sourceType", "source", "sourceLen", "destType", "dest", "destLen" ], "type": "object", "properties": { "igpAdminDomain": { "type": "string", "description": "The IGP Admin Domain ({{topology.AutonomousSystem}}) to perform the SPF in." }, "protocol": { "type": "string", "description": "The protocol to run SPF on. Currently OSPF, OSPFv3 and ISIS aresupported." }, "sourceType": { "type": "string", "description": "The address type of the source. Currently only ipv4 issupported." }, "source": { "type": "string", "description": "The source address. The format ofthe source is based on the sourceType property." }, "sourceLen": { "type": "integer", "description": "The length of the source address. Its valid values dependon the sourceType.", "format": "int32" }, "destType": { "type": "string", "description": "The address type of the destination. Currently ipv4 and ipv6 aresupported." }, "dest": { "type": "string", "description": "The destination address. The format ofthe destination is based on the destType property." }, "destLen": { "type": "integer", "description": "The length of the destination address. Its valid valuesdepend on the destType.", "format": "int32" } }, "description": "Model containing the method level model for TopologyManager.shortestPathFirstGraphExt to decode json data to internal NFM-P object model" }, "findVcnCrossConnectsResponse": { "title": "findVcnCrossConnectsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/VcnCrossConnectInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for TdmFacilityProtectionGroup.findVcnCrossConnects to encode json response from internal NFM-P object model" }, "importSerialNumbersFromXML": { "title": "importSerialNumbersFromXML", "required": [ "importFileName", "requestId" ], "type": "object", "properties": { "importFileName": { "type": "string" }, "requestId": { "type": "string" } }, "description": "Model containing the method level model for Domain.importSerialNumbersFromXML to decode json data to internal NFM-P object model" }, "configureReplicationLabels": { "title": "configureReplicationLabels", "required": [ "nextHopInstance", "labelStringValue" ], "type": "object", "properties": { "nextHopInstance": { "type": "string", "description": "Specifies the Replication Segment Next Hop under which the labels have to be configured." }, "labelStringValue": { "type": "string", "description": "Specifies the labels separated by space. The value provided will replace the entirelabels currently available to the new values.E.G.: 111 222 333" } }, "description": "Model containing the method level model for ReplicationSegmentPolicyNextHop.configureReplicationLabels to decode json data to internal NFM-P object model" }, "TopologyDiscoveryRuleElement": { "title": "TopologyDiscoveryRuleElement", "required": [ "ipAddressType", "ipAddress", "maskBits", "usage", "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties" ], "type": "object", "properties": { "ipAddressType": { "type": "integer", "format": "int32" }, "ipAddress": { "type": "string", "description": "Mandatory on create." }, "maskBits": { "type": "integer", "description": "Mandatory on create.", "format": "int32" }, "usage": { "type": "integer", "format": "int32" }, "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "actionMask": { "type": "integer", "format": "int32" }, "selfAlarmed": { "type": "boolean", "default": false }, "name": { "type": "string" } }, "description": "Managed object abstract class" }, "RetrievingDhcpLeaseStruct": { "title": "RetrievingDhcpLeaseStruct", "required": [ "objectClassName", "siteId", "svcId", "ciAddr", "chAddr" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "svcId": { "type": "integer", "format": "int64" }, "ciAddr": { "type": "string" }, "chAddr": { "type": "string" } }, "description": "Model containing the method level model for struct RetrievingDhcpLeaseStruct. to decode json data to internal NFM-P object model" }, "getBindingsForTopologyGroupResponse": { "title": "getBindingsForTopologyGroupResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for TopologyGroup.getBindingsForTopologyGroup to encode json response from internal NFM-P object model" }, "findEnodeBsReadyForRadioMeasurementResponse": { "title": "findEnodeBsReadyForRadioMeasurementResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for RANRadioMeasureManager.findEnodeBsReadyForRadioMeasurement to encode json response from internal NFM-P object model" }, "findObjectsRelatedToOfnResponse": { "title": "findObjectsRelatedToOfnResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for FaultManager.findObjectsRelatedToOfn to encode json response from internal NFM-P object model" }, "initiateGroupInsertsResponse": { "title": "initiateGroupInsertsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/GroupEntriesActionResult" }, { "description": "Model containing the method level model for struct GroupEntriesActionResult. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for FilterDefinition.initiateGroupInserts to encode json response from internal NFM-P object model" }, "addWlanGwUeCallTraceJobResponse": { "title": "addWlanGwUeCallTraceJobResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for CallTraceConfig.addWlanGwUeCallTraceJob to encode json response from internal NFM-P object model" }, "RouteKey": { "title": "RouteKey", "required": [ "objectClassName", "sourceType", "destType", "source", "sourceLen", "dest", "destLen" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "sourceType": { "type": "string" }, "destType": { "type": "string" }, "source": { "type": "string" }, "sourceLen": { "type": "integer", "format": "int32" }, "dest": { "type": "string" }, "destLen": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for struct RouteKey. to decode json data to internal NFM-P object model" }, "addTest": { "title": "addTest", "required": [ "testGroupRole", "test" ], "type": "object", "properties": { "testGroupRole": { "type": "string", "description": "The test group to which to add this test." }, "test": { "type": "string", "description": "The pointer to the test to add." } }, "description": "Model containing the method level model for TestSuite.addTest to decode json data to internal NFM-P object model" }, "retrieveSubMacError": { "title": "retrieveSubMacError", "required": [ "timeout" ], "type": "object", "properties": { "aInReportedTimeMinutes": { "type": "integer", "format": "int32" }, "aInReportedTimeSeconds": { "type": "integer", "format": "int32" }, "aInReportedTimeHours": { "type": "integer", "format": "int32" }, "aInReportedTimeDay": { "type": "integer", "format": "int32" }, "aInReportedTimeMonth": { "type": "integer", "format": "int32" }, "aInReportedTimeYear": { "type": "integer", "format": "int32" }, "aInMacIndex": { "type": "integer", "format": "int64" }, "aInSiteId": { "type": "string" }, "aInMacAddress": { "type": "string" }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait before receiving the results.The method returns if no results are received in the given time.This is an optional input parameter. The default value is 5 minutes (300000). default:300000", "format": "int64" } }, "description": "Model containing the method level model for SubscrMacError.retrieveSubMacError to decode json data to internal NFM-P object model" }, "closeSession": { "title": "closeSession", "required": [ "sessionFdn", "shouldDelete" ], "type": "object", "properties": { "sessionFdn": { "type": "string", "description": "The session to start." }, "shouldDelete": { "type": "boolean", "description": "If true, the closed session is deleted. If false, the session is not deleted." } }, "description": "Model containing the method level model for Session.closeSession to decode json data to internal NFM-P object model" }, "retrieveDhcpLeaseStateRadiusClassesResponse": { "title": "retrieveDhcpLeaseStateRadiusClassesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for DhcpLeaseStateRadiusClassAttribute.retrieveDhcpLeaseStateRadiusClasses to encode json response from internal NFM-P object model" }, "TraceInfoStruct": { "title": "TraceInfoStruct", "required": [ "objectClassName", "siteId", "circuitId", "remoteId", "sapFdn", "macAddress", "traceProfileName", "maxJobs", "traceExistingSessions", "traceName" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "circuitId": { "type": "string" }, "remoteId": { "type": "string" }, "sapFdn": { "type": "string" }, "macAddress": { "type": "string" }, "traceProfileName": { "type": "string" }, "maxJobs": { "type": "integer", "format": "int32" }, "traceExistingSessions": { "type": "boolean" }, "traceName": { "type": "string" } }, "description": "Model containing the method level model for struct TraceInfoStruct. to decode json data to internal NFM-P object model" }, "NatPoolHistogram": { "title": "NatPoolHistogram", "required": [ "objectClassName", "natPlHistIndex", "timestamp", "name", "bucketSize", "numBuckets", "tcp", "udp", "icmp" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "vRtrID": { "type": "integer", "format": "int64" }, "natPlHistIndex": { "type": "integer", "format": "int64" }, "timestamp": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "bucketSize": { "type": "integer", "format": "int64" }, "numBuckets": { "type": "integer", "format": "int64" }, "tcp": { "type": "integer", "format": "int64" }, "udp": { "type": "integer", "format": "int64" }, "icmp": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct NatPoolHistogram. to decode json data to internal NFM-P object model" }, "RequestHandleStruct": { "title": "RequestHandleStruct", "required": [ "objectClassName", "requestId", "requestedTime" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "requestId": { "type": "integer", "format": "int64" }, "requestedTime": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" }, "continueExecutingSU": { "title": "continueExecutingSU", "required": [ "siteId", "isSynchronised", "clientId" ], "type": "object", "properties": { "siteId": { "type": "string", "description": "Identifies the siteId of the WMM node to perform the continue on." }, "isSynchronised": { "type": "boolean", "description": "Identifies if the call to execute the script should wait until all scripts have been executed.True to wait, false otherwise." }, "clientId": { "type": "string", "description": "Identifies the client Id that is requesting the execution(used for sending an event to the specific client when execution is complete)." } }, "description": "Model containing the method level model for MMESoftwareFolderDescriptor.continueExecutingSU to decode json data to internal NFM-P object model" }, "ClearDhcpLeaseStateConfiguration": { "title": "ClearDhcpLeaseStateConfiguration", "required": [ "objectClassName", "ipAddress", "serviceId", "siteId", "subscrIdent" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "ipAddress": { "type": "string" }, "serviceId": { "type": "integer", "format": "int64" }, "siteId": { "type": "string" }, "subscrIdent": { "type": "string" } }, "description": "Model containing the method level model for struct ClearDhcpLeaseStateConfiguration. to decode json data to internal NFM-P object model" }, "retrieveAntiSpoofingFiltersResponse": { "title": "retrieveAntiSpoofingFiltersResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for AntiSpoofingFilter.retrieveAntiSpoofingFilters to encode json response from internal NFM-P object model" }, "findVtsConnectionsResponse": { "title": "findVtsConnectionsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/VtsConnectionInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for AbstractPath.findVtsConnections to encode json response from internal NFM-P object model" }, "findRsvpSessionsResponse": { "title": "findRsvpSessionsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for P2MPDynamicLsp.findRsvpSessions to encode json response from internal NFM-P object model" }, "TopologyDiscoveryRuleConfigInfo": { "title": "TopologyDiscoveryRuleConfigInfo", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap", "containmentInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } }, "id": { "type": "integer", "format": "int64" }, "description": { "type": "string" }, "administrativeState": { "type": "integer", "format": "int32" }, "readMediationPolicyId": { "type": "integer", "format": "int32" }, "writeMediationPolicyId": { "type": "integer", "format": "int32" }, "trapMediationPolicyId": { "type": "integer", "format": "int32" }, "securityMediationPolicyId": { "type": "integer", "format": "int32" }, "dualReadMediationPolicyId": { "type": "integer", "format": "int32" }, "dualWriteMediationPolicyId": { "type": "integer", "format": "int32" }, "dualTrapMediationPolicyId": { "type": "integer", "format": "int32" }, "outOfBandPingPolicyId": { "type": "integer", "format": "int32" }, "inBandPingPolicyId": { "type": "integer", "format": "int32" }, "standbyCpmPingPolicyId": { "type": "integer", "format": "int32" }, "statsPollingPolicyId": { "type": "integer", "format": "int32" }, "olcState": { "type": "integer", "format": "int32" }, "revertOlcState": { "type": "boolean", "default": false }, "scanInterval": { "type": "integer", "format": "int32" }, "backupPolicyPointer": { "type": "string" }, "topologyGroupPointer": { "type": "string" }, "ipAddressType": { "type": "integer", "format": "int32" }, "neSelfConfigurationPolicies": { "type": "array", "items": { "type": "string" }, "description": "" }, "defaultExternalEms": { "type": "string" }, "podPointer": { "type": "string" }, "dcInterconnectPointer": { "type": "string" }, "postDiscoveryActionPointer": { "type": "string" }, "discoveryProtocol": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for Interface ConfigInfo TopologyDiscoveryRuleConfigInfo. to decode json data to internal NFM-P object model" }, "findP2PLspResponse": { "title": "findP2PLspResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for BFDTemplate.findP2PLsp to encode json response from internal NFM-P object model" }, "retrieveHostResponse": { "title": "retrieveHostResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for Portal.retrieveHost to encode json response from internal NFM-P object model" }, "fixProblem": { "title": "fixProblem", "required": [ "fdn" ], "type": "object", "properties": { "aInPreFixData": { "allOf": [ { "$ref": "#/components/schemas/PreFixData" }, { "description": "Model containing the method level model for struct PreFixData. to decode json data to internal NFM-P object model" } ] }, "fdn": { "type": "string", "description": "The Fdn of Problem Object." } }, "description": "Model containing the method level model for RcaManager.fixProblem to decode json data to internal NFM-P object model" }, "getIfsForUtilizationRange": { "title": "getIfsForUtilizationRange", "required": [ "statsType", "rangeStart", "rangeEnd", "timestamp", "asFdn", "isCalBasedOnIntSpeed" ], "type": "object", "properties": { "statsType": { "type": "string", "description": "The CPAM stats type, could be IP interface or MPLS interface." }, "rangeStart": { "type": "integer", "description": "The start value of utilization range.", "format": "int32" }, "rangeEnd": { "type": "integer", "description": "The end value of utilization range.", "format": "int32" }, "timestamp": { "type": "integer", "format": "int64" }, "asFdn": { "type": "string" }, "isCalBasedOnIntSpeed": { "type": "boolean" } }, "description": "Model containing the method level model for CpamStatisticManager.getIfsForUtilizationRange to decode json data to internal NFM-P object model" }, "retrieveStaticIsidsResponse": { "title": "retrieveStaticIsidsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for SpokeSdpBindingStaticIsid.retrieveStaticIsids to encode json response from internal NFM-P object model" }, "retrieveSlaProfileInstances": { "title": "retrieveSlaProfileInstances", "required": [ "retrievingSlaProfileInstStruct", "retrieveQoSOvr", "retrieveAcclpEncap" ], "type": "object", "properties": { "retrievingSlaProfileInstStruct": { "allOf": [ { "$ref": "#/components/schemas/RetrievingSlaProfileInstStruct" }, { "description": "Model containing the method level model for struct RetrievingSlaProfileInstStruct. to decode json data to internal NFM-P object model" } ] }, "retrieveQoSOvr": { "type": "boolean", "description": "Specifies if QoS Override should be retrieved,the default is \"true\".The QoS Override won't be retrieved if Service preferences \"retrieveQoSOvr\" is false. default:true" }, "retrieveAcclpEncap": { "type": "boolean", "description": "Specifies if Access Loop Encapsulation should be retrieved,the default is \"true\".The Access Loop Encapsulation won't be retrieved if Service preferences \"retrieveAcclpEncap\" is false. default:true" } }, "description": "Model containing the method level model for SlaProfileInstance.retrieveSlaProfileInstances to decode json data to internal NFM-P object model" }, "addMembers": { "title": "addMembers", "required": [ "action", "globalPolicyFullNames" ], "type": "object", "properties": { "action": { "type": "string" }, "globalPolicyFullNames": { "type": "array", "items": { "type": "string" }, "description": "" } }, "description": "Model containing the method level model for PolicySyncGroup.addMembers to decode json data to internal NFM-P object model" }, "findP2mpLspResponse": { "title": "findP2mpLspResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for LspTemplateMvpn.findP2mpLsp to encode json response from internal NFM-P object model" }, "findProtectedLspsResponse": { "title": "findProtectedLspsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for Session.findProtectedLsps to encode json response from internal NFM-P object model" }, "retrieveResidentialSubscribers": { "title": "retrieveResidentialSubscribers", "required": [ "timeout", "subscriberRetrievalInfoList", "retrieveQoSOvr" ], "type": "object", "properties": { "timeout": { "type": "integer", "description": "The number of milliseconds to wait beforereceiving the results. If the results arenot received in the given time, the method returns.", "format": "int64" }, "subscriberRetrievalInfoList": { "type": "array", "items": { "$ref": "#/components/schemas/ResidentialSubscriberRetrievalStruct" }, "description": "" }, "retrieveQoSOvr": { "type": "boolean", "description": "Specifies if QoS Override should be retrieved,the default is \"true\".The QoS Override won't be retrieved if Service preferences \"retrieveQoSOvr\" is false. default:true" } }, "description": "Model containing the method level model for ResidentialSubscriberManager.retrieveResidentialSubscribers to decode json data to internal NFM-P object model" }, "dumpLog": { "title": "dumpLog", "required": [ "logLevel", "details" ], "type": "object", "properties": { "logLevel": { "type": "integer", "description": "Logging level.", "format": "int32" }, "details": { "type": "integer", "description": "Details level.0: very brief info,1: more details,2: most details", "format": "int32" } }, "description": "Model containing the method level model for SupervisionManager.dumpLog to decode json data to internal NFM-P object model" }, "dumpLogResponse": { "title": "dumpLogResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for SupervisionManager.dumpLog to encode json response from internal NFM-P object model" }, "removeIPoECallTraceJobResponse": { "title": "removeIPoECallTraceJobResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for CallTraceConfig.removeIPoECallTraceJob to encode json response from internal NFM-P object model" }, "retrieveHostSharedFilterResponse": { "title": "retrieveHostSharedFilterResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, { "description": "Model containing the method level model for struct CommonManagedEntityInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for FilterDefinition.retrieveHostSharedFilter to encode json response from internal NFM-P object model" }, "retrieveDynSvcDataTriggersResponse": { "title": "retrieveDynSvcDataTriggersResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for DynSvcDataTrigger.retrieveDynSvcDataTriggers to encode json response from internal NFM-P object model" }, "retrieveL2TPSessions": { "title": "retrieveL2TPSessions", "required": [ "sessionStruct", "shallowRetrieval" ], "type": "object", "properties": { "sessionStruct": { "allOf": [ { "$ref": "#/components/schemas/SessionStruct" }, { "description": "Model containing the method level model for struct SessionStruct. to decode json data to internal NFM-P object model" } ] }, "shallowRetrieval": { "type": "boolean", "description": "If it is true, not all of the properties are retrieved for quick response default:false" } }, "description": "Model containing the method level model for L2TPSession.retrieveL2TPSessions to decode json data to internal NFM-P object model" }, "KPI": { "title": "KPI", "required": [ "objectClassName", "value", "newValue", "isUsedForTrending" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "value": { "type": "integer", "format": "int32" }, "newValue": { "type": "integer", "format": "int32" }, "isUsedForTrending": { "type": "boolean" } }, "description": "Model containing the method level model for struct KPI. to decode json data to internal NFM-P object model" }, "createPsk": { "title": "createPsk", "type": "object", "properties": { "aInPskIndex": { "type": "integer", "format": "int32" }, "aInEncryptionType": { "type": "string" } }, "description": "Model containing the method level model for StaticCAK.createPsk to decode json data to internal NFM-P object model" }, "retrieveIgmpGroupIfSapGrp": { "title": "retrieveIgmpGroupIfSapGrp", "type": "object", "properties": { "aInFwdServiceId": { "type": "integer", "format": "int64" }, "aInGrpIfindex": { "type": "integer", "format": "int64" }, "aInEncapVal": { "type": "integer", "format": "int64" }, "aInSiteId": { "type": "string" }, "aInRouterId": { "type": "integer", "format": "int32" }, "aInPortId": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for GroupInterfaceSapGroup.retrieveIgmpGroupIfSapGrp to decode json data to internal NFM-P object model" }, "findActivePrimaryStaticRoutes": { "title": "findActivePrimaryStaticRoutes", "required": [ "fields", "sortFields", "pageNumber", "pageSize" ], "type": "object", "properties": { "fields": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Sorting fields" }, "sortFields": { "type": "array", "items": { "type": "string" }, "description": "Sorting fields" }, "pageNumber": { "type": "integer", "description": "Page number", "format": "int32" }, "pageSize": { "type": "integer", "description": "The number of entries to return", "format": "int32" } }, "description": "Model containing the method level model for AutonomousSystem.findActivePrimaryStaticRoutes to decode json data to internal NFM-P object model" }, "forcePartnerDownResponse": { "title": "forcePartnerDownResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for AbstractDhcpServerFailover.forcePartnerDown to encode json response from internal NFM-P object model" }, "LsnSubRetrievalStruct": { "title": "LsnSubRetrievalStruct", "required": [ "objectClassName", "subType", "siteId", "routingInstance", "subInsideAddr", "subInsideAddrPfxL", "shouldRetrieveBlkAlloc", "timeout" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "subType": { "type": "string" }, "siteId": { "type": "string" }, "routingInstance": { "type": "string" }, "subInsideAddr": { "type": "string" }, "subInsideAddrPfxL": { "type": "integer", "format": "int64" }, "shouldRetrieveBlkAlloc": { "type": "boolean" }, "timeout": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct LsnSubRetrievalStruct. to decode json data to internal NFM-P object model" }, "ServiceUnion": { "title": "ServiceUnion", "required": [ "objectClassName", "serviceId", "ctdMap" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "serviceId": { "type": "integer", "format": "int32" }, "ctdMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } } }, "description": "Model containing the method level model for struct ServiceUnion. to decode json data to internal NFM-P object model" }, "BgpSummaryResult": { "title": "BgpSummaryResult", "required": [ "objectClassName", "isGlobal", "nextHop", "added", "withdrawn", "flapped", "numNextHop", "community", "localPref", "med", "asPath", "tooManyEvents" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "isGlobal": { "type": "boolean" }, "nextHop": { "type": "string" }, "added": { "type": "integer", "format": "int32" }, "withdrawn": { "type": "integer", "format": "int32" }, "flapped": { "type": "integer", "format": "int32" }, "numNextHop": { "type": "integer", "format": "int32" }, "community": { "type": "integer", "format": "int32" }, "localPref": { "type": "integer", "format": "int32" }, "med": { "type": "integer", "format": "int32" }, "asPath": { "type": "integer", "format": "int32" }, "tooManyEvents": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for struct BgpSummaryResult. to decode json data to internal NFM-P object model" }, "PathConfigInfo": { "title": "PathConfigInfo", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap", "containmentInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } }, "administrativeState": { "type": "integer", "format": "int32" }, "pathId": { "type": "integer", "format": "int64" }, "displayedName": { "type": "string" }, "description": { "type": "string" }, "sourceNodeId": { "type": "string" }, "destinationNodeId": { "type": "string" }, "pathMtu": { "type": "integer", "format": "int32" }, "forwardingClasses": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for Interface ConfigInfo PathConfigInfo. to decode json data to internal NFM-P object model" }, "retrieveDbInfoTransitIpAddress": { "title": "retrieveDbInfoTransitIpAddress", "required": [ "timeout", "siteId", "isaGrpPartIndex", "transitPlcyId", "subName" ], "type": "object", "properties": { "timeout": { "type": "integer", "description": "The number of milliseconds to wait beforereceiving the results. If the results arenot received in the given time, the method returns.", "format": "int64" }, "siteId": { "type": "string", "description": "Network Element site IP address." }, "isaGrpPartIndex": { "type": "integer", "description": "The ISA-AA Group Partition Index.", "format": "int64" }, "transitPlcyId": { "type": "integer", "description": "Transit policy Id.", "format": "int64" }, "subName": { "type": "string", "description": "Transit subscriber name." } }, "description": "Model containing the method level model for DbInfoTransitIpAddress.retrieveDbInfoTransitIpAddress to decode json data to internal NFM-P object model" }, "acknowledgeFault": { "title": "acknowledgeFault", "required": [ "faultObjectFullName", "alteredSeverity", "urgency", "text", "doMarkAsAcknowledged", "doDelete" ], "type": "object", "properties": { "faultObjectFullName": { "type": "string", "description": "Full name of the alarm to be acknowledged." }, "alteredSeverity": { "type": "string", "description": "New severity for the alarm. Unspecified severity leaves the severity unchanged." }, "urgency": { "type": "string", "description": "New urgency for the alarm. Unspecified urgency leaves the urgency unchanged." }, "text": { "type": "string", "description": "Text of the alarm note added as part of the acknowledgment." }, "doMarkAsAcknowledged": { "type": "boolean", "description": "Indicates whether the alarm should be acknowledged or not." }, "doDelete": { "type": "boolean", "description": "Indicates whether the alarm should be deleted or not." } }, "description": "Model containing the method level model for FaultManager.acknowledgeFault to decode json data to internal NFM-P object model" }, "configureKeyGroupSdpBindingsResponse": { "title": "configureKeyGroupSdpBindingsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "boolean", "description": "The response object." } }, "description": "Model containing the method level model for KeyGroup.configureKeyGroupSdpBindings to encode json response from internal NFM-P object model" }, "getServiceDependencyCountResponse": { "title": "getServiceDependencyCountResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int32" } }, "description": "Model containing the method level model for Policy.getServiceDependencyCount to encode json response from internal NFM-P object model" }, "retrievePtpPortRecoveredClockHistory": { "title": "retrievePtpPortRecoveredClockHistory", "required": [ "timeout" ], "type": "object", "properties": { "aInPtpPortName": { "type": "string" }, "aInMasterIndex": { "type": "integer", "format": "int32" }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns.", "format": "int64" } }, "description": "Model containing the method level model for PtpPortRecoveredClockHistory.retrievePtpPortRecoveredClockHistory to decode json data to internal NFM-P object model" }, "requestClearSubVlanStatsResponse": { "title": "requestClearSubVlanStatsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for PwPort.requestClearSubVlanStats to encode json response from internal NFM-P object model" }, "URLToEncode": { "title": "URLToEncode", "type": "object", "properties": { "stringToEncode": { "type": "string", "description": "String", "example": "XATzChm4-macsmgr:ca-a # b % c $ d ! e & *:scak:psk-1" }, "encodingIteration": { "type": "integer", "description": "int", "format": "int32", "example": 1 } }, "description": "URL in path parameters to model" }, "findServicesResponse": { "title": "findServicesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/PagingResult" }, { "description": "Model containing the method level model for struct PagingResult. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for IpPathRecord.findServices to encode json response from internal NFM-P object model" }, "NeAuditParam": { "title": "NeAuditParam", "required": [ "objectClassName", "fdn", "includeReadOnlyAttributes" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "fdn": { "type": "string" }, "includeReadOnlyAttributes": { "type": "boolean" } }, "description": "Model containing the method level model for struct NeAuditParam. to decode json data to internal NFM-P object model" }, "getAllSonetChannelsResponse": { "title": "getAllSonetChannelsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/SonetChannelInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for ConnProfPolicy.getAllSonetChannels to encode json response from internal NFM-P object model" }, "getResultResponse": { "title": "getResultResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for AuditManager.getResult to encode json response from internal NFM-P object model" }, "revertRollbckCheckPt": { "title": "revertRollbckCheckPt", "required": [ "neId", "rollbackIndex" ], "type": "object", "properties": { "neId": { "type": "string" }, "rollbackIndex": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for RollbackNEInfo.revertRollbckCheckPt to decode json data to internal NFM-P object model" }, "findVirtualPortsResponse": { "title": "findVirtualPortsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for AbstractVirtualSite.findVirtualPorts to encode json response from internal NFM-P object model" }, "getCachedHistoryResponse": { "title": "getCachedHistoryResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "object", "additionalProperties": { "type": "object" }, "description": "The response object." } }, "description": "Model containing the method level model for SummaryView.getCachedHistory to encode json response from internal NFM-P object model" }, "retrieveStickyLeasesResponse": { "title": "retrieveStickyLeasesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for StickyLeaseData.retrieveStickyLeases to encode json response from internal NFM-P object model" }, "PowerConnectionModules": { "title": "PowerConnectionModules", "required": [ "displayedName", "shelfId", "hwIndex", "siteId", "siteName", "manufacturer", "serialNumber", "manufacturerBoardNumber", "manufactureDate", "equipmentCategory", "hwName", "cleiCode", "equipmentState", "containingEquipmentState", "compositeEquipmentState", "operationalState", "administrativeState", "isEquipped", "baseMacAddress", "hardwareFailureReason", "isEquipmentInserted", "manufacturingAssemblyNo", "manufacturingDeviations", "isTempSensorAvailable", "hardwareClass", "backgroundDiagnosticsState", "backgroundDiagnosticsFaultReason", "manufacturingVariant", "hwFirmwareRevisionStatus", "oesShelfId", "phyShelfClass", "phyShelfType", "olcState", "lockOlcState", "pcmId", "phyShelfNumber", "zoneId", "pcmInputFeedStatus", "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties" ], "type": "object", "properties": { "displayedName": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "shelfId": { "type": "integer", "format": "int32", "readOnly": true }, "hwIndex": { "type": "integer", "format": "int64", "readOnly": true }, "siteId": { "type": "string", "description": "64]", "readOnly": true, "example": " maximum: 64" }, "siteName": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "manufacturer": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "serialNumber": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "manufacturerBoardNumber": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "manufactureDate": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "equipmentCategory": { "type": "integer", "format": "int32", "readOnly": true }, "hwName": { "type": "string", "description": "[0,32]", "readOnly": true, "example": " maximum: 32" }, "cleiCode": { "type": "string", "description": "[0,16]", "readOnly": true, "example": " maximum: 16" }, "equipmentState": { "type": "integer", "format": "int32", "readOnly": true }, "containingEquipmentState": { "type": "integer", "format": "int32", "readOnly": true }, "compositeEquipmentState": { "type": "integer", "format": "int32", "readOnly": true }, "operationalState": { "type": "integer", "format": "int32", "readOnly": true }, "administrativeState": { "type": "integer", "format": "int32" }, "isEquipped": { "type": "boolean", "readOnly": true }, "baseMacAddress": { "type": "string", "readOnly": true }, "hardwareFailureReason": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "isEquipmentInserted": { "type": "boolean", "readOnly": true }, "manufacturingAssemblyNo": { "type": "string", "readOnly": true }, "manufacturingDeviations": { "type": "string", "readOnly": true }, "isTempSensorAvailable": { "type": "boolean", "readOnly": true }, "hardwareClass": { "type": "integer", "format": "int32", "readOnly": true }, "backgroundDiagnosticsState": { "type": "integer", "format": "int32", "readOnly": true }, "backgroundDiagnosticsFaultReason": { "type": "string", "readOnly": true }, "manufacturingVariant": { "type": "string", "readOnly": true }, "hwFirmwareRevisionStatus": { "type": "integer", "format": "int32", "readOnly": true }, "oesShelfId": { "type": "integer", "format": "int32" }, "phyShelfClass": { "type": "integer", "format": "int32" }, "phyShelfType": { "type": "integer", "format": "int32" }, "olcState": { "type": "integer", "description": "Object Life Cycle can be set using {{generic.GenericObject.updateUserObjectLifecycleStates()}}.", "format": "int32", "readOnly": true }, "lockOlcState": { "type": "boolean", "description": "This is used to lock the OLC State while in OLC Maintenance State only." }, "pcmId": { "type": "integer", "format": "int32" }, "phyShelfNumber": { "type": "integer", "description": "[1,32]", "format": "int32" }, "zoneId": { "type": "integer", "description": "[0,32]", "format": "int32", "readOnly": true }, "pcmInputFeedStatus": { "type": "integer", "format": "int64", "readOnly": true }, "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "actionMask": { "type": "integer", "format": "int32" }, "selfAlarmed": { "type": "boolean", "default": false }, "name": { "type": "string" } }, "description": "Managed object abstract class" }, "executeScript": { "title": "executeScript", "required": [ "isSynchronized", "clientId", "targetScriptFullNameList" ], "type": "object", "properties": { "isSynchronized": { "type": "boolean", "description": "Identifies if the call to execute the script should wait until all scripts have been executed. True to wait, false otherwise." }, "clientId": { "type": "string", "description": "Identifies the client ID that is requesting the execution (used for sending an event to the specific client when execution is complete)." }, "targetScriptFullNameList": { "type": "array", "items": { "type": "string" }, "description": "Identifies the list of target scripts to execute." } }, "description": "Model containing the method level model for ScriptManager.executeScript to decode json data to internal NFM-P object model" }, "executeMultiResponse": { "title": "executeMultiResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for XmlApiConfigTemplate.executeMulti to encode json response from internal NFM-P object model" }, "TargetScriptResult": { "title": "TargetScriptResult", "required": [ "spanObjectPointer", "mtosi_id", "filename", "status", "errorMsg", "systemInvokationId", "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "parentClassName", "managedObjectId", "unsetProperties" ], "type": "object", "properties": { "spanObjectPointer": { "type": "string", "description": "A pointer to the parent spanEnabled object.[0,252]", "readOnly": true, "example": " maximum: 252" }, "mtosi_id": { "type": "integer", "description": "The unique ID for the target script result.[1,", "format": "int64" }, "filename": { "type": "string", "description": "The filename of the file containing the results of the target script.[0,255] Mandatory on create.", "example": " maximum: 255" }, "status": { "type": "integer", "description": "The status of the executed target. Mandatory on create.", "format": "int32" }, "errorMsg": { "type": "string", "description": "Specifies any errors found when executing the target script.[0,4000] Mandatory on create.", "example": " maximum: 4000" }, "systemInvokationId": { "type": "integer", "description": "A unique ID assigned to each individual client invocation of a given script.Currently this property is only set if the script is invoked as part of a cascading flow.The value is system generated and is unique for each NFM-P client (uniqueness within the NFM-P server is not guaranteed).Each script that was invoked as a result of the same cascading flow will have the same ID.Script events also contain this ID. This ID associates every script event with a given cascading flow.", "format": "int64" }, "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "actionMask": { "type": "integer", "format": "int32" }, "selfAlarmed": { "type": "boolean", "default": false }, "name": { "type": "string" } }, "description": "Managed object abstract class" }, "findP2mpLsps": { "title": "findP2mpLsps", "required": [ "s2lPathFilter", "lspFilter" ], "type": "object", "properties": { "s2lPathFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "lspFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for Tunnel.findP2mpLsps to decode json data to internal NFM-P object model" }, "RingAuditResult": { "title": "RingAuditResult", "required": [ "objectClassName", "result", "errors" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "result": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "object" }, "description": "" } }, "description": "Model containing the method level model for struct RingAuditResult. to decode json data to internal NFM-P object model" }, "expandPolicyStatementResponse": { "title": "expandPolicyStatementResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for FromCriteria.expandPolicyStatement to encode json response from internal NFM-P object model" }, "getProxyStatusResponse": { "title": "getProxyStatusResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int32" } }, "description": "Model containing the method level model for DatabaseManager.getProxyStatus to encode json response from internal NFM-P object model" }, "retrieveGtpSessionsResponse": { "title": "retrieveGtpSessionsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for GTPSession.retrieveGtpSessions to encode json response from internal NFM-P object model" }, "retrieveL2tpTunnelsResponse": { "title": "retrieveL2tpTunnelsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for ResidentialSubscriberInstance.retrieveL2tpTunnels to encode json response from internal NFM-P object model" }, "EvalLeaseStatePerSapStruct": { "title": "EvalLeaseStatePerSapStruct", "required": [ "objectClassName", "encapType", "siteId", "svcId", "portId", "innerEncapVal", "outerEncapVal", "combinedEncap" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "encapType": { "type": "string" }, "siteId": { "type": "string" }, "svcId": { "type": "integer", "format": "int64" }, "portId": { "type": "integer", "format": "int64" }, "innerEncapVal": { "type": "integer", "format": "int64" }, "outerEncapVal": { "type": "integer", "format": "int64" }, "combinedEncap": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct EvalLeaseStatePerSapStruct. to decode json data to internal NFM-P object model" }, "executeSystemScriptsResponse": { "title": "executeSystemScriptsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for ScriptManager.executeSystemScripts to encode json response from internal NFM-P object model" }, "findLoopbacksResponse": { "title": "findLoopbacksResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/MdaXconnectLoopbackInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for MdaXconnectMac.findLoopbacks to encode json response from internal NFM-P object model" }, "retrieveIgmpGroupIfSapGrpSrcResponse": { "title": "retrieveIgmpGroupIfSapGrpSrcResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for GroupInterfaceSapGroupSource.retrieveIgmpGroupIfSapGrpSrc to encode json response from internal NFM-P object model" }, "findAvailableAccessCtpsPerNodeResponse": { "title": "findAvailableAccessCtpsPerNodeResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionTerminationPointInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for ConnectionTerminationPoint.findAvailableAccessCtpsPerNode to encode json response from internal NFM-P object model" }, "TemplateAndSpecificData": { "title": "TemplateAndSpecificData", "required": [ "objectClassName", "templateName", "templateRootId", "parentXpath", "updateServiceLink", "specificDataList" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "templateName": { "type": "string" }, "templateRootId": { "type": "string" }, "parentXpath": { "type": "string" }, "updateServiceLink": { "type": "boolean" }, "specificDataList": { "type": "array", "items": { "$ref": "#/components/schemas/SpecificData" }, "description": "" } }, "description": "Model containing the method level model for struct TemplateAndSpecificData. to decode json data to internal NFM-P object model" }, "fallback": { "title": "fallback", "required": [ "sessionFdn", "neWorkOrders" ], "type": "object", "properties": { "sessionFdn": { "type": "string", "description": "The session." }, "neWorkOrders": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The set of NE work orders to fallback. The NE work orders must be in the given session." } }, "description": "Model containing the method level model for Session.fallback to decode json data to internal NFM-P object model" }, "bgpImpactAnalysisDetails": { "title": "bgpImpactAnalysisDetails", "required": [ "reason", "filter", "fields", "sortFields", "pageNumber", "pageSize" ], "type": "object", "properties": { "reason": { "type": "integer", "format": "int32" }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "fields": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Sorting fields" }, "sortFields": { "type": "array", "items": { "type": "string" }, "description": "Sorting fields" }, "pageNumber": { "type": "integer", "description": "Page number", "format": "int32" }, "pageSize": { "type": "integer", "description": "The number of entries to return", "format": "int32" } }, "description": "Model containing the method level model for BgpImpactAnalysisTimeRange.bgpImpactAnalysisDetails to decode json data to internal NFM-P object model" }, "populateToResponse": { "title": "populateToResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for Subscriber.populateTo to encode json response from internal NFM-P object model" }, "createVrrpInstance": { "title": "createVrrpInstance", "type": "object", "properties": { "aInL3InterfaceFullName": { "type": "string" }, "aInVrrpInstance": { "allOf": [ { "$ref": "#/components/schemas/AbstractInstanceConfigInfo" }, { "description": "Model containing the method level model for Interface ConfigInfo AbstractInstanceConfigInfo. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for VrrpVirtualRouter.createVrrpInstance to decode json data to internal NFM-P object model" }, "retrieveServiceBgpInfoResponse": { "title": "retrieveServiceBgpInfoResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/ServiceBgpInfo" }, { "description": "Model containing the method level model for struct ServiceBgpInfo. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for TopologyManager.retrieveServiceBgpInfo to encode json response from internal NFM-P object model" }, "findByIpAddressResponse": { "title": "findByIpAddressResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/VirtualInterface" }, { "description": "Managed object abstract class" } ] } }, "description": "Model containing the method level model for VirtualInterface.findByIpAddress to encode json response from internal NFM-P object model" }, "generateNewVrfTargetResponse": { "title": "generateNewVrfTargetResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for ServiceSite.generateNewVrfTarget to encode json response from internal NFM-P object model" }, "redundancyRollbackSync": { "title": "redundancyRollbackSync", "required": [ "neId", "syncType" ], "type": "object", "properties": { "neId": { "type": "string" }, "syncType": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for RollbackNEInfo.redundancyRollbackSync to decode json data to internal NFM-P object model" }, "retrieveCallTraceTraces": { "title": "retrieveCallTraceTraces", "required": [ "retrieveCallTraceStruct", "traceName", "timeout" ], "type": "object", "properties": { "retrieveCallTraceStruct": { "allOf": [ { "$ref": "#/components/schemas/RetrieveCallTraceStruct" }, { "description": "Model containing the method level model for struct RetrieveCallTraceStruct. to decode json data to internal NFM-P object model" } ] }, "traceName": { "type": "string", "description": "Specifies the trace name. It is optional parameter. traceName and id are mutually exclusive. default:" }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns. default:300000", "format": "int64" } }, "description": "Model containing the method level model for CallTraceTrace.retrieveCallTraceTraces to decode json data to internal NFM-P object model" }, "retrieveDhcpLease": { "title": "retrieveDhcpLease", "required": [ "retrievingDhcpLeaseStruct", "retrieveManagedRoutes", "retrieveQoSOvr", "retrieveBgpPeer", "retrieveAcclpEncap" ], "type": "object", "properties": { "retrievingDhcpLeaseStruct": { "allOf": [ { "$ref": "#/components/schemas/RetrievingDhcpLeaseStruct" }, { "description": "Model containing the method level model for struct RetrievingDhcpLeaseStruct. to decode json data to internal NFM-P object model" } ] }, "retrieveManagedRoutes": { "type": "boolean", "description": "Specifies if Managed Routes should be retrieved,the default is \"true\".The Managed Routes won't be retrieved if Service preferences\"retrieveManagedRoutes\"isfalse. default:true" }, "retrieveQoSOvr": { "type": "boolean", "description": "Specifies if QoS Override should be retrieved,the default is \"true\".The QoS Override won't be retrieved if Service preferences \"retrieveQoSOvr\" isfalse. default:true" }, "retrieveBgpPeer": { "type": "boolean", "description": "Specifies if BGP Peer should be retrieved,the default is \"true\".The BGP Peer won't be retrieved if Service preferences \"BGP Peer Info\" isunchecked. default:true" }, "retrieveAcclpEncap": { "type": "boolean", "description": "Specifies if Access Loop Encapsulation should be retrieved,the default is \"true\".The Access Loop Encapsulation won't be retrieved if Service preferences \"retrieveAcclpEncap\" is false. default:true" } }, "description": "Model containing the method level model for DhcpLeaseState.retrieveDhcpLease to decode json data to internal NFM-P object model" }, "validateNeWorkOrders": { "title": "validateNeWorkOrders", "required": [ "sessionFdn", "neWorkOrders", "areEngineeringChecksToBeExecuted" ], "type": "object", "properties": { "sessionFdn": { "type": "string", "description": "The session to validate." }, "neWorkOrders": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The set of NE work orders to validate. The NE work orders must be in the given session." }, "areEngineeringChecksToBeExecuted": { "type": "boolean", "description": "This parameter indicates whether the engineering have to be executed or not" } }, "description": "Model containing the method level model for Session.validateNeWorkOrders to decode json data to internal NFM-P object model" }, "retrieveProfiledBgpEventsFilter": { "title": "retrieveProfiledBgpEventsFilter", "required": [ "filterInfo", "filter", "fields", "sortFields", "pageNumber", "pageSize" ], "type": "object", "properties": { "filterInfo": { "type": "object", "description": "Pass in type topology.BgpProfileEventRetrievalFilter - To search specifically for BGP prefix events mapping to the profile" }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "fields": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Sorting fields" }, "sortFields": { "type": "array", "items": { "type": "string" }, "description": "Sorting fields" }, "pageNumber": { "type": "integer", "description": "Page number", "format": "int32" }, "pageSize": { "type": "integer", "description": "The number of entries to return", "format": "int32" } }, "description": "Model containing the method level model for TopologyManager.retrieveProfiledBgpEventsFilter to decode json data to internal NFM-P object model" }, "HistoricalImpactAnalysisResult": { "title": "HistoricalImpactAnalysisResult", "required": [ "objectClassName", "reason", "count", "serviceCount" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "reason": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" }, "serviceCount": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for struct HistoricalImpactAnalysisResult. to decode json data to internal NFM-P object model" }, "addGroupsResponse": { "title": "addGroupsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for SummaryView.addGroups to encode json response from internal NFM-P object model" }, "clearDynamicHostResponse": { "title": "clearDynamicHostResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for ResidentialSubscriberManager.clearDynamicHost to encode json response from internal NFM-P object model" }, "VirtualInterface": { "title": "VirtualInterface", "required": [ "displayedName", "domain", "application", "nodeName", "nodeId", "description", "ctpPointer", "terminatedObjectPointer", "terminatedObjectId", "terminatedObjectName", "routerId", "routerName", "portId", "portName", "encapType", "terminatedPortPointer", "terminatedPortClassName", "terminatedPortCombinedEncapValue", "terminatedPortInnerEncapValue", "terminatedPortOuterEncapValue", "isExclusiveTermination", "provisionedMtu", "actualMtu", "mtuMismatch", "terminationParticipationType", "underlyingResourceState", "compositeState", "resourceState", "operationalState", "administrativeState", "portPointer", "innerEncapValue", "outerEncapValue", "portIdentifyingName", "id", "physicalAddress", "interfaceClass", "unnumberedReferenceType", "unnumberedReference", "cflowdType", "numberOfIpAddressLikeCtps", "directedBroadcast", "primaryIPv4Address", "primaryIPv4PrefixLength", "numberOfLoopbackAddresses", "isTrusted", "loopbackEnabled", "pimRPDelayedDownPeriod", "pimRPDelayedUpPeriod", "initDelayEnable", "pimRPDelayedUpTimer", "ipMtu", "ipOperMtu", "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties" ], "type": "object", "properties": { "displayedName": { "type": "string", "description": "[0,255] Mandatory on create.", "example": " maximum: 255" }, "domain": { "type": "integer", "format": "int32", "readOnly": true }, "application": { "type": "integer", "format": "int32", "readOnly": true }, "nodeName": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "nodeId": { "type": "string", "description": "64]", "readOnly": true, "example": " maximum: 64" }, "description": { "type": "string", "description": "[0,80]", "example": " maximum: 80" }, "ctpPointer": { "type": "string", "readOnly": true }, "terminatedObjectPointer": { "type": "string", "readOnly": true }, "terminatedObjectId": { "type": "integer", "format": "int64", "readOnly": true }, "terminatedObjectName": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "routerId": { "type": "integer", "description": "[1,10240]", "format": "int32", "readOnly": true }, "routerName": { "type": "string", "description": "[0,32]", "readOnly": true, "example": " maximum: 32" }, "portId": { "type": "integer", "format": "int64", "readOnly": true }, "portName": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "encapType": { "type": "integer", "format": "int32" }, "terminatedPortPointer": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "terminatedPortClassName": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "terminatedPortCombinedEncapValue": { "type": "integer", "description": "derived from terminatedPortInnerEncapValueand terminatedPortOuterEncapValue", "format": "int64", "readOnly": true }, "terminatedPortInnerEncapValue": { "type": "integer", "description": "combined with terminatedPortOuterEncapValue toproduce terminatedPortCombinedEncapValue", "format": "int32", "readOnly": true }, "terminatedPortOuterEncapValue": { "type": "integer", "description": "combined with terminatedPortInnerEncapValue toproduce terminatedPortCombinedEncapValue", "format": "int32", "readOnly": true }, "isExclusiveTermination": { "type": "boolean", "readOnly": true }, "provisionedMtu": { "type": "integer", "format": "int32", "readOnly": true }, "actualMtu": { "type": "integer", "format": "int32", "readOnly": true }, "mtuMismatch": { "type": "boolean", "description": "The value is set to 'true' when the provisioned MTU value is greaterthan the actual MTU value (provisionedMtu > actualMtu).", "readOnly": true }, "terminationParticipationType": { "type": "integer", "format": "int32", "readOnly": true }, "underlyingResourceState": { "type": "integer", "description": "State of the underlying resource. (An underlying resource is for example a netw.ConnectionTerminationPoint)", "format": "int32", "readOnly": true }, "compositeState": { "type": "integer", "description": "This value is derived from underlyingResourceState and or resourceState attributes.If the underlyingResourceState is not 'OK' and is not 'unspecified' the value of compositeStatewill be set to the same value as underlyingResourceState. Otherwise the value of compositeStatewill be set to the same value as resourceState.", "format": "int32", "readOnly": true }, "resourceState": { "type": "integer", "description": "The value is determined from the combination of administrative and operational states in thefollowing order:1) If the resource is administratively down the value will be 'administartivelyDown'.2) If the resource is operationally down the value will be 'failed'.3) Otherwise the value will be 'OK'.", "format": "int32", "readOnly": true }, "operationalState": { "type": "integer", "format": "int32", "readOnly": true }, "administrativeState": { "type": "integer", "format": "int32" }, "portPointer": { "type": "string", "description": "252]", "example": " maximum: 252" }, "innerEncapValue": { "type": "integer", "description": "Provisioned inner encap value.This value is propagated into: terminatedPortInnerEncapValue.", "format": "int32" }, "outerEncapValue": { "type": "integer", "description": "Provisioned outer encap value.This value is propagated into: terminatedPortOuterEncapValue.", "format": "int32" }, "portIdentifyingName": { "type": "string", "description": "[0,252]", "readOnly": true, "example": " maximum: 252" }, "id": { "type": "integer", "description": "[1,5119]", "format": "int64" }, "physicalAddress": { "type": "string" }, "interfaceClass": { "type": "integer", "format": "int32" }, "unnumberedReferenceType": { "type": "integer", "format": "int32" }, "unnumberedReference": { "type": "string", "description": "[0,32]", "example": " maximum: 32" }, "cflowdType": { "type": "integer", "description": "This attribute is deprecated for 7750 7450 7950 13.0 and above nodes.Please use {{cflowd.CflowdSampling}} instead.", "format": "int32" }, "numberOfIpAddressLikeCtps": { "type": "integer", "format": "int32", "readOnly": true }, "directedBroadcast": { "type": "boolean" }, "primaryIPv4Address": { "type": "string", "description": "50]", "readOnly": true, "example": " maximum: 50" }, "primaryIPv4PrefixLength": { "type": "integer", "format": "int32", "readOnly": true }, "numberOfLoopbackAddresses": { "type": "integer", "format": "int32", "readOnly": true }, "isTrusted": { "type": "integer", "format": "int32" }, "loopbackEnabled": { "type": "boolean" }, "pimRPDelayedDownPeriod": { "type": "integer", "description": "The value of pimRPDelayedDownPeriod specifies the time in secondsthat is used to bring down the IPv4 interface. In other words, the value of pimRPDelayedDownPeriodindicates the hold up time before the interface is going down.[0,1200]", "format": "int64" }, "pimRPDelayedUpPeriod": { "type": "integer", "description": "The value of pimRPDelayedUpPeriod specifies the time in secondsthat is used to bring up the IPv4 interface. In other words, the value of pimRPDelayedUpPeriodindicates the hold down time before the interface is coming up.When interface comes up, it will not become operational untilafter the specified delay.[0,65535]", "format": "int64" }, "initDelayEnable": { "type": "boolean", "description": "When the value initDelayEnable is set to 'false', everytime the system attempts to bring the IPv4 interface operationally up,it will be delayed by the value of pimRPDelayedUpPeriod.When the value initDelayEnable is set to 'true', only the next time the system attempts to bring the interface operationally up,it will be delayed by the value of pimRPDelayedUpPeriod." }, "pimRPDelayedUpTimer": { "type": "integer", "description": "The value of pimRPDelayedUpTimer indicates the time left before theIPv4 interface comes up when pimRPDelayedUpPeriod is configured to anon-zero value. From SR 14.0.R1, the value of pimRPDelayedUpTimer also indicatesthe time left before the IPv4 interface goes down when pimRPDelayedDownPeriod is configured to anon-zero value.[-1,65535]", "format": "int32", "readOnly": true }, "ipMtu": { "type": "integer", "description": "The value of IP MTU is used to reflect the MTU size of this interface in the header of an ICMP MTU exceeded message when a packet is too large to be transmitted on this interface.The default size is calculated by subtracting the DLC header size from the physical MTU size of the interface.The range is 0 or between 512 and 9786. When a value of zero (0) is specified, the value is set to the calculated default size.[0,9786]", "format": "int32" }, "ipOperMtu": { "type": "integer", "description": "The value of the operational IP MTU indicates the operational value of the IP MTU on this interface. It is the minimum of the IP MTU and the MTU of the physical port this interface is bound to.", "format": "int32", "readOnly": true }, "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "actionMask": { "type": "integer", "format": "int32" }, "selfAlarmed": { "type": "boolean", "default": false }, "name": { "type": "string" } }, "description": "Managed object abstract class" }, "evaluatePolicyResponse": { "title": "evaluatePolicyResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for PolicyDefinition.evaluatePolicy to encode json response from internal NFM-P object model" }, "archiveTestResult": { "title": "archiveTestResult", "required": [ "testFdn" ], "type": "object", "properties": { "lTestResultStructObjectId": { "type": "integer", "format": "int64" }, "testFdn": { "type": "string" } }, "description": "Model containing the method level model for TestManager.archiveTestResult to decode json data to internal NFM-P object model" }, "retrieveEsiMappingsResponse": { "title": "retrieveEsiMappingsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for SvcChainEsiMapping.retrieveEsiMappings to encode json response from internal NFM-P object model" }, "findServices": { "title": "findServices", "required": [ "objectType", "filter", "fields", "sortFields", "pageNumber", "pageSize" ], "type": "object", "properties": { "objectType": { "type": "integer", "format": "int32" }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "fields": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Sorting fields" }, "sortFields": { "type": "array", "items": { "type": "string" }, "description": "Sorting fields" }, "pageNumber": { "type": "integer", "description": "Page number", "format": "int32" }, "pageSize": { "type": "integer", "description": "The number of entries to return", "format": "int32" } }, "description": "Model containing the method level model for IpPathRecord.findServices to decode json data to internal NFM-P object model" }, "findPtpPeers": { "title": "findPtpPeers", "type": "object", "properties": { "aInDomain": { "type": "integer", "format": "int64" }, "aInIsUnmonitoredIp": { "type": "boolean", "default": false }, "aInIsUnmonitoredBidirIp": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for IEEEPTPSyncDomain.findPtpPeers to decode json data to internal NFM-P object model" }, "findInactiveSecondaryStaticRoutesResponse": { "title": "findInactiveSecondaryStaticRoutesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/PagingResult" }, { "description": "Model containing the method level model for struct PagingResult. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for AutonomousSystem.findInactiveSecondaryStaticRoutes to encode json response from internal NFM-P object model" }, "retrieveNatPortForwardingResponse": { "title": "retrieveNatPortForwardingResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for StaticPortMapping.retrieveNatPortForwarding to encode json response from internal NFM-P object model" }, "findAssociations": { "title": "findAssociations", "required": [ "filter" ], "type": "object", "properties": { "aInPolicyEntryClass": { "type": "string" }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for FwPolicyDefinition.findAssociations to decode json data to internal NFM-P object model" }, "forcePartnerDown": { "title": "forcePartnerDown", "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInRoutingInstanceName": { "type": "string" }, "aInDHCPServerName": { "type": "string" }, "aInDHCPServerPoolName": { "type": "string" }, "aInTimeout": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for AbstractDhcpServerFailover.forcePartnerDown to decode json data to internal NFM-P object model" }, "L2TPSessionRetrievalStruct": { "title": "L2TPSessionRetrievalStruct", "required": [ "objectClassName", "siteId", "pppSessionIndex", "timeout" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "pppSessionIndex": { "type": "integer", "format": "int64" }, "timeout": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct L2TPSessionRetrievalStruct. to decode json data to internal NFM-P object model" }, "findChannelsResponse": { "title": "findChannelsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/SonetChannelInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for SonetPortSpecifics.findChannels to encode json response from internal NFM-P object model" }, "restore": { "title": "restore", "required": [ "backupFolderDescriptorPointer", "restoreBof", "restoreConfig", "force" ], "type": "object", "properties": { "backupFolderDescriptorPointer": { "type": "string" }, "restoreBof": { "type": "boolean" }, "restoreConfig": { "type": "boolean" }, "force": { "type": "boolean", "description": "default:false" } }, "description": "Model containing the method level model for BackupRestoreManager.restore to decode json data to internal NFM-P object model" }, "retrieveL2AwareNatSubscriberPolicies": { "title": "retrieveL2AwareNatSubscriberPolicies", "required": [ "timeout" ], "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInResidentialSubIdent": { "type": "string" }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait before receiving the results.This is an optional input parameter. The default value is 5 minutes (300000). default:300000", "format": "int64" } }, "description": "Model containing the method level model for L2AwareNatSubscriberPolicies.retrieveL2AwareNatSubscriberPolicies to decode json data to internal NFM-P object model" }, "retrievePPPSessionRadiusClasses": { "title": "retrievePPPSessionRadiusClasses", "required": [ "siteId", "sessionIndex", "timeout" ], "type": "object", "properties": { "siteId": { "type": "string", "description": "Site ID for the PPP Session." }, "sessionIndex": { "type": "integer", "description": "PPP Session ID.", "format": "int64" }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait before receiving the results.This is an optional input parameter. The default value is 5 minutes (300000). default:300000", "format": "int64" } }, "description": "Model containing the method level model for PPPSessionRadiusClassAttribute.retrievePPPSessionRadiusClasses to decode json data to internal NFM-P object model" }, "GlobalPolicyConfigInfo": { "title": "GlobalPolicyConfigInfo", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap", "containmentInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } }, "isSeverityAlterable": { "type": "boolean", "default": false }, "isSeverityManuallyAlterable": { "type": "boolean", "default": false }, "isSeverityManualPromotionEnabled": { "type": "boolean", "default": false }, "isSeverityManualDemotionEnabled": { "type": "boolean", "default": false }, "isSeverityManualClearingEnabled": { "type": "boolean", "default": false }, "isSeverityAutoAlterable": { "type": "boolean", "default": false }, "isSeverityImplicitPromotionEnabled": { "type": "boolean", "default": false }, "isSeverityImplicitDemotionEnabled": { "type": "boolean", "default": false }, "isSeverityEscalationEnabled": { "type": "boolean", "default": false }, "isSeverityDeEscalationEnabled": { "type": "boolean", "default": false }, "freqencyUpdateRule": { "type": "integer", "format": "int32" }, "severityEscalatorWorkerFrequency": { "type": "integer", "format": "int64" }, "isAlarmDeletionEnabled": { "type": "boolean", "default": false }, "manualDeletionRule": { "type": "integer", "format": "int32" }, "implicitDeletionRule": { "type": "integer", "format": "int32" }, "correlatedAlarmDeletionRule": { "type": "integer", "format": "int32" }, "nonClearableImplicitDeletionRule": { "type": "integer", "format": "int32" }, "timerBasedDeletonRule": { "type": "integer", "format": "int32" }, "deletionTimer": { "type": "integer", "format": "int64" }, "deletionWorkerFrequency": { "type": "integer", "format": "int64" }, "optimizeAlarmEventBuffer": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for Interface ConfigInfo GlobalPolicyConfigInfo. to decode json data to internal NFM-P object model" }, "findAssociatedSamUsersResponse": { "title": "findAssociatedSamUsersResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for ServiceCreationSpanRule.findAssociatedSamUsers to encode json response from internal NFM-P object model" }, "lightPathTrace": { "title": "lightPathTrace", "required": [ "portPointer", "channel" ], "type": "object", "properties": { "portPointer": { "type": "string", "description": "Pointer to a physical port" }, "channel": { "type": "string", "description": "ITU channel" } }, "description": "Model containing the method level model for TransportService.lightPathTrace to decode json data to internal NFM-P object model" }, "requestClearSpokeSdpBfdStatsResponse": { "title": "requestClearSpokeSdpBfdStatsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for SpokeSdpBinding.requestClearSpokeSdpBfdStats to encode json response from internal NFM-P object model" }, "findMepsResponse": { "title": "findMepsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for SystemOperGroup.findMeps to encode json response from internal NFM-P object model" }, "findCreatedTunnelsResponse": { "title": "findCreatedTunnelsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for TopologyRule.findCreatedTunnels to encode json response from internal NFM-P object model" }, "findByName": { "title": "findByName", "required": [ "nodeId", "routingInstance", "interfaceName" ], "type": "object", "properties": { "nodeId": { "type": "string" }, "routingInstance": { "type": "integer", "format": "int64" }, "interfaceName": { "type": "string" } }, "description": "Model containing the method level model for VirtualInterface.findByName to decode json data to internal NFM-P object model" }, "executeTargetScriptsResponse": { "title": "executeTargetScriptsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for ScriptManager.executeTargetScripts to encode json response from internal NFM-P object model" }, "GroupState": { "title": "GroupState", "required": [ "objectClassName", "time", "baselineTime", "basicKPIs", "extraKPIs" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "time": { "type": "integer", "format": "int64" }, "baselineTime": { "type": "integer", "format": "int64" }, "basicKPIs": { "allOf": [ { "$ref": "#/components/schemas/BasicKPIs" }, { "description": "Model containing the method level model for struct BasicKPIs. to decode json data to internal NFM-P object model" } ] }, "extraKPIs": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/KPI" } } }, "description": "Model containing the method level model for struct GroupState. to decode json data to internal NFM-P object model" }, "findGlobalPoliciesForDistributionResponse": { "title": "findGlobalPoliciesForDistributionResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/FwPolicyDefinitionInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for FwPolicyDefinition.findGlobalPoliciesForDistribution to encode json response from internal NFM-P object model" }, "checkBulkDistributeWithinCapacityResponse": { "title": "checkBulkDistributeWithinCapacityResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "boolean", "description": "The response object." } }, "description": "Model containing the method level model for Manager.checkBulkDistributeWithinCapacity to encode json response from internal NFM-P object model" }, "findCtpsOnDirectlyTerminatablePortResponse": { "title": "findCtpsOnDirectlyTerminatablePortResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/ConnectionTerminationPoint" }, { "description": "Managed object abstract class" } ] } }, "description": "Model containing the method level model for ConnectionTerminationPoint.findCtpsOnDirectlyTerminatablePort to encode json response from internal NFM-P object model" }, "PowerSupply": { "title": "PowerSupply", "required": [ "displayedName", "shelfId", "hwIndex", "siteId", "siteName", "manufacturer", "serialNumber", "manufacturerBoardNumber", "manufactureDate", "equipmentCategory", "hwName", "cleiCode", "equipmentState", "containingEquipmentState", "compositeEquipmentState", "operationalState", "administrativeState", "isEquipped", "baseMacAddress", "hardwareFailureReason", "isEquipmentInserted", "manufacturingAssemblyNo", "manufacturingDeviations", "isTempSensorAvailable", "hardwareClass", "backgroundDiagnosticsState", "backgroundDiagnosticsFaultReason", "manufacturingVariant", "hwFirmwareRevisionStatus", "oesShelfId", "phyShelfClass", "phyShelfType", "olcState", "lockOlcState", "number", "powerSupplyName", "mfgName", "modelName", "serialNo", "hwVersion", "swVersion", "standbyStatus", "powerSupplyVoltageAlarmState", "acVoltageStatus", "dcVoltageStatus", "temperatureStatus", "powerSupply1Status", "powerSupply2Status", "psTemperatureThreshold", "psTemperatureThresholdInFahrenheit", "powerSupplyInputStatus", "powerSupplyOutputStatus", "peqAvailableWattage", "peqInputPowerMode", "zoneId", "inputFeedStatus", "phyShelfNumber", "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties" ], "type": "object", "properties": { "displayedName": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "shelfId": { "type": "integer", "format": "int32", "readOnly": true }, "hwIndex": { "type": "integer", "format": "int64", "readOnly": true }, "siteId": { "type": "string", "description": "64]", "readOnly": true, "example": " maximum: 64" }, "siteName": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "manufacturer": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "serialNumber": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "manufacturerBoardNumber": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "manufactureDate": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "equipmentCategory": { "type": "integer", "format": "int32", "readOnly": true }, "hwName": { "type": "string", "description": "[0,32]", "readOnly": true, "example": " maximum: 32" }, "cleiCode": { "type": "string", "description": "[0,16]", "readOnly": true, "example": " maximum: 16" }, "equipmentState": { "type": "integer", "format": "int32", "readOnly": true }, "containingEquipmentState": { "type": "integer", "format": "int32", "readOnly": true }, "compositeEquipmentState": { "type": "integer", "format": "int32", "readOnly": true }, "operationalState": { "type": "integer", "format": "int32", "readOnly": true }, "administrativeState": { "type": "integer", "format": "int32" }, "isEquipped": { "type": "boolean", "readOnly": true }, "baseMacAddress": { "type": "string", "readOnly": true }, "hardwareFailureReason": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "isEquipmentInserted": { "type": "boolean", "readOnly": true }, "manufacturingAssemblyNo": { "type": "string", "readOnly": true }, "manufacturingDeviations": { "type": "string", "readOnly": true }, "isTempSensorAvailable": { "type": "boolean", "readOnly": true }, "hardwareClass": { "type": "integer", "format": "int32", "readOnly": true }, "backgroundDiagnosticsState": { "type": "integer", "format": "int32", "readOnly": true }, "backgroundDiagnosticsFaultReason": { "type": "string", "readOnly": true }, "manufacturingVariant": { "type": "string", "readOnly": true }, "hwFirmwareRevisionStatus": { "type": "integer", "format": "int32", "readOnly": true }, "oesShelfId": { "type": "integer", "format": "int32" }, "phyShelfClass": { "type": "integer", "format": "int32" }, "phyShelfType": { "type": "integer", "format": "int32" }, "olcState": { "type": "integer", "description": "Object Life Cycle can be set using {{generic.GenericObject.updateUserObjectLifecycleStates()}}.", "format": "int32", "readOnly": true }, "lockOlcState": { "type": "boolean", "description": "This is used to lock the OLC State while in OLC Maintenance State only." }, "number": { "type": "integer", "description": "Represents the number of a Power Supply. Mandatory on create.", "format": "int32" }, "powerSupplyName": { "type": "string", "description": "Represents the name of a Power Supply.", "readOnly": true }, "mfgName": { "type": "string", "description": "Represents the manufacturer name of a Power Supply.", "readOnly": true }, "modelName": { "type": "string", "description": "Represents the model name of a Power Supply.[0,255]", "readOnly": true, "example": " maximum: 255" }, "serialNo": { "type": "string", "description": "Represents the serial number of a Power Supply.[0,255]", "readOnly": true, "example": " maximum: 255" }, "hwVersion": { "type": "string", "description": "Represents the hardware version of a Power Supply.[0,255]", "readOnly": true, "example": " maximum: 255" }, "swVersion": { "type": "string", "description": "Represents the software version of a Power Supply.[0,255]", "readOnly": true, "example": " maximum: 255" }, "standbyStatus": { "type": "integer", "description": "Represents the Standby Status of a Power Supply.", "format": "int32", "readOnly": true }, "powerSupplyVoltageAlarmState": { "type": "integer", "description": "Represents the Power Supply Voltage Alarm state of a Power Supply.", "format": "int32", "readOnly": true }, "acVoltageStatus": { "type": "integer", "format": "int32", "readOnly": true }, "dcVoltageStatus": { "type": "integer", "format": "int32", "readOnly": true }, "temperatureStatus": { "type": "integer", "format": "int32", "readOnly": true }, "powerSupply1Status": { "type": "integer", "format": "int32", "readOnly": true }, "powerSupply2Status": { "type": "integer", "format": "int32", "readOnly": true }, "psTemperatureThreshold": { "type": "integer", "format": "int32", "readOnly": true }, "psTemperatureThresholdInFahrenheit": { "type": "integer", "format": "int32", "readOnly": true }, "powerSupplyInputStatus": { "type": "integer", "format": "int32", "readOnly": true }, "powerSupplyOutputStatus": { "type": "integer", "format": "int32", "readOnly": true }, "peqAvailableWattage": { "type": "integer", "format": "int32", "readOnly": true }, "peqInputPowerMode": { "type": "integer", "format": "int32" }, "zoneId": { "type": "integer", "description": "[0,32]", "format": "int32", "readOnly": true }, "inputFeedStatus": { "type": "integer", "format": "int64", "readOnly": true }, "phyShelfNumber": { "type": "integer", "description": "[1,32]", "format": "int32" }, "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "actionMask": { "type": "integer", "format": "int32" }, "selfAlarmed": { "type": "boolean", "default": false }, "name": { "type": "string" } }, "description": "Managed object abstract class" }, "configurePSSCardResponse": { "title": "configurePSSCardResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/CardSlot" }, { "description": "Managed object abstract class" } ] } }, "description": "Model containing the method level model for CardSlot.configurePSSCard to encode json response from internal NFM-P object model" }, "moveServices": { "title": "moveServices", "type": "object", "properties": { "aInDestCompositeService": { "type": "string" }, "aInFdns": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" } }, "description": "Model containing the method level model for CompositeService.moveServices to decode json data to internal NFM-P object model" }, "retrieveFirewallHostsResponse": { "title": "retrieveFirewallHostsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for FirewallHost.retrieveFirewallHosts to encode json response from internal NFM-P object model" }, "getReassemblyGroupsResponse": { "title": "getReassemblyGroupsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for NatIsaGroupConf.getReassemblyGroups to encode json response from internal NFM-P object model" }, "turnUpResponse": { "title": "turnUpResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int32" } }, "description": "Model containing the method level model for VirtualInterface.turnUp to encode json response from internal NFM-P object model" }, "SizeConstraintPolicyConfigInfo": { "title": "SizeConstraintPolicyConfigInfo", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap", "containmentInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } }, "policyId": { "type": "integer", "format": "int64" }, "description": { "type": "string" }, "rowThreshold": { "type": "integer", "format": "int64" }, "rowsToDelete": { "type": "integer", "format": "int64" }, "thresholdPolicy": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for Interface ConfigInfo SizeConstraintPolicyConfigInfo. to decode json data to internal NFM-P object model" }, "HopInfo": { "title": "HopInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "hopId": { "type": "integer", "format": "int32" }, "hopOrder": { "type": "integer", "format": "int32" }, "traversalType": { "type": "integer", "format": "int32" }, "direction": { "type": "integer", "format": "int32" }, "portPointer": { "type": "string" }, "ctpPointer": { "type": "string" }, "portType": { "type": "integer", "format": "int32" }, "isLogical": { "type": "boolean", "default": false }, "description": { "type": "string" }, "rate": { "type": "integer", "format": "int32" }, "channel": { "type": "integer", "format": "int32" }, "siteId": { "type": "string" }, "siteName": { "type": "string" }, "alarmProfilePointer": { "type": "string" }, "showInGUI": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for Interface HopInfo. to decode json data to internal NFM-P object model" }, "retrieveWorkOrderXMLResponse": { "title": "retrieveWorkOrderXMLResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for AbstractWorkOrder.retrieveWorkOrderXML to encode json response from internal NFM-P object model" }, "generateNewVrfTarget": { "title": "generateNewVrfTarget", "required": [ "neId", "vrfTargetFormat" ], "type": "object", "properties": { "neId": { "type": "string", "description": "The Network Element ID. This value must be a valid NE ID and cannot be null nor empty." }, "vrfTargetFormat": { "type": "string", "description": "The VRF Target Format, asBased (2) or ipAddressBased(3).At this time only asBased(2) is supported." } }, "description": "Model containing the method level model for ServiceSite.generateNewVrfTarget to decode json data to internal NFM-P object model" }, "retrieveVplsChannels": { "title": "retrieveVplsChannels", "required": [ "svcId", "timeout", "filter" ], "type": "object", "properties": { "aInRtrId": { "type": "string" }, "svcId": { "type": "integer", "description": "The service ID of the VPLS service.", "format": "int64" }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns.", "format": "int64" }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for IngrPathMgmtOperationalChannelSvc.retrieveVplsChannels to decode json data to internal NFM-P object model" }, "TransportServiceInfo": { "title": "TransportServiceInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "id": { "type": "integer", "format": "int64" }, "description": { "type": "string" }, "serviceId": { "type": "integer", "format": "int64" }, "templatePointer": { "type": "string" }, "subscriberPointer": { "type": "string" }, "groupPointer": { "type": "string" }, "administrativeState": { "type": "integer", "format": "int32" }, "tier": { "type": "integer", "format": "int32" }, "globalServiceName": { "type": "string" }, "globalServiceComments": { "type": "string" }, "svcPriority": { "type": "integer", "format": "int32" }, "enableAppPerfReporting": { "type": "boolean", "default": false }, "ipDetailCount": { "type": "integer", "format": "int32" }, "reportCustName": { "type": "string" }, "nsdManaged": { "type": "boolean", "default": false }, "lockOlcState": { "type": "boolean", "default": false }, "templateVersionPointer": { "type": "string" }, "svcType": { "type": "integer", "format": "int32" }, "rate": { "type": "integer", "format": "int32" }, "protection": { "type": "integer", "format": "int32" }, "protectionLevel": { "type": "integer", "format": "int32" }, "direction": { "type": "integer", "format": "int32" }, "wavekeyAssignMode": { "type": "integer", "format": "int32" }, "waveKeyingPreference": { "type": "integer", "format": "int32" }, "isServicePathCreated": { "type": "boolean", "default": false }, "discrepancyFlag": { "type": "boolean", "default": false }, "discrepancy": { "type": "string" }, "forceXcCreate": { "type": "boolean", "default": false }, "spectralWidth": { "type": "integer", "format": "int32" }, "isModified": { "type": "boolean", "default": false }, "modifyProtectionPreference": { "type": "integer", "format": "int32" }, "isServicePathModified": { "type": "boolean", "default": false }, "pathSearchOption": { "type": "integer", "format": "int32" }, "protectionPathSearchType": { "type": "integer", "format": "int32" }, "revertMode": { "type": "integer", "format": "int32" }, "apsDirection": { "type": "integer", "format": "int32" }, "managementDomains": { "type": "integer", "format": "int32" }, "connectionMode": { "type": "integer", "format": "int32" }, "apsSdEnable": { "type": "boolean", "default": false }, "lineBurstIntervalForSD": { "type": "integer", "format": "int32" }, "lineBurstThresholdForSD": { "type": "integer", "format": "int32" }, "clientBurstIntervalForSD": { "type": "integer", "format": "int32" }, "clientBurstThresholdForSD": { "type": "integer", "format": "int32" }, "asapProfileSetting": { "type": "boolean", "default": false }, "waveKey1AZ": { "type": "integer", "format": "int32" }, "waveKey2AZ": { "type": "integer", "format": "int32" }, "waveKey1ZA": { "type": "integer", "format": "int32" }, "waveKey2ZA": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for Interface TransportServiceInfo. to decode json data to internal NFM-P object model" }, "UtilizationResult": { "title": "UtilizationResult", "required": [ "objectClassName", "utilizationRangeEnd", "percentageOfInterfaces", "numOfInterfaces" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "utilizationRangeEnd": { "type": "integer", "format": "int32" }, "percentageOfInterfaces": { "type": "integer", "format": "int32" }, "numOfInterfaces": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct UtilizationResult. to decode json data to internal NFM-P object model" }, "invokeSbtssCatchup": { "title": "invokeSbtssCatchup", "required": [ "networkElements", "forceOnPMPolicyDown" ], "type": "object", "properties": { "networkElements": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "forceOnPMPolicyDown": { "type": "boolean", "description": "default:false" } }, "description": "Model containing the method level model for SbtsPMPolicy.invokeSbtssCatchup to decode json data to internal NFM-P object model" }, "shutDownResponse": { "title": "shutDownResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int32" } }, "description": "Model containing the method level model for VirtualInterface.shutDown to encode json response from internal NFM-P object model" }, "getIfUtilizationStatsResponse": { "title": "getIfUtilizationStatsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "object", "additionalProperties": { "type": "object" }, "description": "The response object." } }, "description": "Model containing the method level model for CpamStatisticManager.getIfUtilizationStats to encode json response from internal NFM-P object model" }, "AuditLocalPolicyResultInfo": { "title": "AuditLocalPolicyResultInfo", "required": [ "objectClassName", "comparingPolicyEntityResultMap", "comparedPolicyEntityResultMap" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "comparingPolicyEntityResultMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AuditLocalPolicyEntityResultInfo" } }, "comparedPolicyEntityResultMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AuditLocalPolicyEntityResultInfo" } } }, "description": "Model containing the method level model for struct AuditLocalPolicyResultInfo. to decode json data to internal NFM-P object model" }, "importFwImageResponse": { "title": "importFwImageResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "boolean", "description": "The response object." } }, "description": "Model containing the method level model for SoftwareFolderManager.importFwImage to encode json response from internal NFM-P object model" }, "retrieveVRFStaticRoutes": { "title": "retrieveVRFStaticRoutes", "type": "object", "properties": { "aInSiteFdn": { "type": "string" }, "aInSvcFdn": { "type": "string" }, "aInTag": { "type": "string" } }, "description": "Model containing the method level model for StaticRoute.retrieveVRFStaticRoutes to decode json data to internal NFM-P object model" }, "convertOldTemplatesResponse": { "title": "convertOldTemplatesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for XmlApiConfigTemplate.convertOldTemplates to encode json response from internal NFM-P object model" }, "executeCLITargetScripts": { "title": "executeCLITargetScripts", "required": [ "isSynchronized", "clientId", "listOfTargetScriptConfigInfo" ], "type": "object", "properties": { "isSynchronized": { "type": "boolean", "description": "Identifies if the call to execute the script should wait until all scripts have been executed. True to wait, false otherwise." }, "clientId": { "type": "string", "description": "Identifies the client ID that is requesting the execution (used for sending an event to the specific client when execution is complete)." }, "listOfTargetScriptConfigInfo": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" }, "description": "The configuration info for the targets when executing (runtime parameters)." } }, "description": "Model containing the method level model for ScriptManager.executeCLITargetScripts to decode json data to internal NFM-P object model" }, "importPoliciesResponse": { "title": "importPoliciesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ImportGlobalPolicyResultInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for Manager.importPolicies to encode json response from internal NFM-P object model" }, "updateUserObjectLifecycleStatesAndLocksAndSchedules": { "title": "updateUserObjectLifecycleStatesAndLocksAndSchedules", "required": [ "distinguishedName", "anInFlipTimeSelected", "anInCurrentOLCState", "anInCurrentLockOLCState" ], "type": "object", "properties": { "distinguishedName": { "type": "string", "description": "Distinguished Name of object being configured." }, "anInFlipTimeSelected": { "type": "integer", "description": "The time in milliseconds that OLC State will be flipped.", "format": "int64" }, "anInCurrentOLCState": { "type": "integer", "description": "The target OLC State to set before the schedule.", "format": "int32" }, "anInCurrentLockOLCState": { "type": "boolean", "description": "The target Lock OLC State to set before the schedule." } }, "description": "Model containing the method level model for GenericObject.updateUserObjectLifecycleStatesAndLocksAndSchedules to decode json data to internal NFM-P object model" }, "retrieveIgmpHostsResponse": { "title": "retrieveIgmpHostsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for IgmpHost.retrieveIgmpHosts to encode json response from internal NFM-P object model" }, "constrainedShortestPathFirstGraphExtResponse": { "title": "constrainedShortestPathFirstGraphExtResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/ShortestPathGraph" }, { "description": "Model containing the method level model for struct ShortestPathGraph. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for TopologyManager.constrainedShortestPathFirstGraphExt to encode json response from internal NFM-P object model" }, "findSyncTimeLinksResponse": { "title": "findSyncTimeLinksResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/PagingResult" }, { "description": "Model containing the method level model for struct PagingResult. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for SiteSync.findSyncTimeLinks to encode json response from internal NFM-P object model" }, "VirtualRouterIpAddressConfigInfo": { "title": "VirtualRouterIpAddressConfigInfo", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap", "containmentInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } }, "index": { "type": "integer", "format": "int32" }, "ipAddressType": { "type": "integer", "format": "int32" }, "ipAddress": { "type": "string" }, "bcastAddrFormat": { "type": "integer", "format": "int32" }, "prefixLength": { "type": "integer", "format": "int32" }, "igpInhibit": { "type": "boolean", "default": false }, "isEui64Address": { "type": "boolean", "default": false }, "gwAddressType": { "type": "integer", "format": "int32" }, "gwIpAddress": { "type": "string" }, "remoteAddressType": { "type": "integer", "format": "int32" }, "remoteIpAddress": { "type": "string" }, "ifName": { "type": "string" }, "ipAddrPreferred": { "type": "boolean", "default": false }, "subscrHostRoutePopulate": { "type": "boolean", "default": false }, "trackSrrpInstance": { "type": "integer", "format": "int64" }, "holdUpTime": { "type": "integer", "format": "int64" }, "cgaModifier": { "type": "string" }, "isSubscriberPrefix": { "type": "boolean", "default": false }, "subscriberPrefixType": { "type": "integer", "format": "int64" }, "customProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "vrfName": { "type": "string" }, "primaryPreference": { "type": "integer", "format": "int64" }, "greTermination": { "type": "boolean", "default": false }, "templateVersionPointer": { "type": "string" }, "creationOrigin": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for Interface ConfigInfo VirtualRouterIpAddressConfigInfo. to decode json data to internal NFM-P object model" }, "InstanceSearchCriteria": { "title": "InstanceSearchCriteria", "required": [ "objectClassName", "instanceFullName", "filter", "scopeType", "scopeDepth" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "instanceFullName": { "type": "string" }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "scopeType": { "type": "integer", "format": "int32" }, "scopeDepth": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for struct InstanceSearchCriteria. to decode json data to internal NFM-P object model" }, "configureIpAddressesResponse": { "title": "configureIpAddressesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/VirtualRouterIpAddressInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for VirtualInterface.configureIpAddresses to encode json response from internal NFM-P object model" }, "updateSubSvcComponentsDynAclResponse": { "title": "updateSubSvcComponentsDynAclResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for ResidentialSubscriberManager.updateSubSvcComponentsDynAcl to encode json response from internal NFM-P object model" }, "ThroughputTestStruct": { "title": "ThroughputTestStruct", "required": [ "objectClassName", "srcSapBeingReplaced", "srcPortForTesting", "dstSapBeingReplaced", "dstPortForTesting", "dstPortLoopback", "dstPortLoopbackTime", "loopbackSwapMacAddr", "loopbackPersist", "loopbackSapPointer", "loopbackDstMacAddress", "loopbackSrcMacAddress", "srcSdpBindingPointer", "testServiceId" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "srcSapBeingReplaced": { "type": "string" }, "srcPortForTesting": { "type": "string" }, "dstSapBeingReplaced": { "type": "string" }, "dstPortForTesting": { "type": "string" }, "dstPortLoopback": { "type": "integer", "format": "int32" }, "dstPortLoopbackTime": { "type": "integer", "format": "int64" }, "loopbackSwapMacAddr": { "type": "boolean" }, "loopbackPersist": { "type": "boolean" }, "loopbackSapPointer": { "type": "string" }, "loopbackDstMacAddress": { "type": "string" }, "loopbackSrcMacAddress": { "type": "string" }, "srcSdpBindingPointer": { "type": "string" }, "testServiceId": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct ThroughputTestStruct. to decode json data to internal NFM-P object model" }, "retrieveArpHostRadiusClassesResponse": { "title": "retrieveArpHostRadiusClassesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for ArpHostRadiusClassAttribute.retrieveArpHostRadiusClasses to encode json response from internal NFM-P object model" }, "TemplateService": { "title": "TemplateService", "required": [ "displayedName", "templateId", "templateType", "subscriberId", "subscriberName", "templateDescription", "templatedClass", "attrDescriptions", "invalidReference", "bindingCount", "scriptPointer", "bindUnmarkedTemplates", "description", "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties" ], "type": "object", "properties": { "displayedName": { "type": "string", "description": "[0,32]", "example": " maximum: 32" }, "templateId": { "type": "integer", "description": "Unique - used for naming[1,2147483647]", "format": "int64" }, "templateType": { "type": "integer", "format": "int32", "readOnly": true }, "subscriberId": { "type": "integer", "description": "If other than 0, a template is associated justwith this subscriber - used for limiting choicesof templates at provisioning time", "format": "int32" }, "subscriberName": { "type": "string", "description": "255]", "readOnly": true, "example": " maximum: 255" }, "templateDescription": { "type": "string", "description": "[0,80]", "example": " maximum: 80" }, "templatedClass": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "attrDescriptions": { "type": "object", "additionalProperties": { "type": "string" } }, "invalidReference": { "type": "boolean", "description": "Used to raise an alarm when some object this templaterefers to gets deleted", "readOnly": true }, "bindingCount": { "type": "integer", "description": "Gets incremented decremented every time this templateis associated disassociated to from another one.[0,", "format": "int32", "readOnly": true }, "scriptPointer": { "type": "string", "description": "Pointer to the XML API Configuration template (script.XmlApiConfigTemplate) instancethis template was converted to.If the value is empty this template was never converted to new XML API Based script.", "readOnly": true }, "bindUnmarkedTemplates": { "type": "boolean" }, "description": { "type": "string", "description": "[0,80]", "example": " maximum: 80" }, "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "actionMask": { "type": "integer", "format": "int32" }, "selfAlarmed": { "type": "boolean", "default": false }, "name": { "type": "string" } }, "description": "Managed object abstract class" }, "configureIPSecSecuredVPN": { "title": "configureIPSecSecuredVPN", "required": [ "ipsecSecuredCtdInfo", "privateService", "publicServices", "l3IpSecPairs" ], "type": "object", "properties": { "ipsecSecuredCtdInfo": { "allOf": [ { "$ref": "#/components/schemas/IPSecSecuredVpnConfigInfo" }, { "description": "Model containing the method level model for Interface ConfigInfo IPSecSecuredVpnConfigInfo. to decode json data to internal NFM-P object model" } ] }, "privateService": { "allOf": [ { "$ref": "#/components/schemas/ServiceSiteStruct" }, { "description": "Model containing the method level model for struct ServiceSiteStruct. to decode json data to internal NFM-P object model" } ] }, "publicServices": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceSiteStruct" }, "description": "" }, "l3IpSecPairs": { "type": "array", "items": { "$ref": "#/components/schemas/Pair" }, "description": "" } }, "description": "Model containing the method level model for IPSecSecuredVpnManager.configureIPSecSecuredVPN to decode json data to internal NFM-P object model" }, "TargetParameterConfigInfo": { "title": "TargetParameterConfigInfo", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap", "containmentInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } }, "parameterName": { "type": "string" }, "value": { "type": "string" }, "checkBoxValueDefined": { "type": "boolean", "default": false }, "unset": { "type": "boolean", "default": false }, "runtime": { "type": "boolean", "default": false }, "paramType": { "type": "integer", "format": "int32" }, "mode": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for Interface ConfigInfo TargetParameterConfigInfo. to decode json data to internal NFM-P object model" }, "copyMoveSaps": { "title": "copyMoveSaps", "required": [ "copyMoveStruct", "sourceSapFilter" ], "type": "object", "properties": { "copyMoveStruct": { "allOf": [ { "$ref": "#/components/schemas/SapCopyMoveStruct" }, { "description": "Model containing the method level model for struct SapCopyMoveStruct. to decode json data to internal NFM-P object model" } ] }, "sourceSapFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for L2AccessInterface.copyMoveSaps to decode json data to internal NFM-P object model" }, "findReferencedStaticHostsResponse": { "title": "findReferencedStaticHostsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for MultiChassisRingNode.findReferencedStaticHosts to encode json response from internal NFM-P object model" }, "retrieveDhcpLeaseResponse": { "title": "retrieveDhcpLeaseResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for DhcpLeaseState.retrieveDhcpLease to encode json response from internal NFM-P object model" }, "RegisterSasLogToFileDto": { "title": "RegisterSasLogToFileDto", "required": [ "fullClassName", "dirName" ], "type": "object", "properties": { "fullClassName": { "type": "array", "items": { "type": "string" }, "description": "list" }, "dirName": { "type": "string", "description": "string", "example": "/myDir" }, "compress": { "type": "boolean", "description": "boolean", "default": false, "example": true }, "resultFilter": { "allOf": [ { "$ref": "#/components/schemas/RestResultFilterDto" }, { "description": "Result filter class" } ] } }, "description": "RestRegister SAS Log to file model" }, "RegisterFindDto": { "title": "RegisterFindDto", "required": [ "fullClassName" ], "type": "object", "properties": { "fullClassName": { "type": "string", "description": "string", "example": "netw.NetworkElement" }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "resultFilter": { "allOf": [ { "$ref": "#/components/schemas/RestResultFilterDto" }, { "description": "Result filter class" } ] } }, "description": "Find" }, "retrieveRootObjectsResponse": { "title": "retrieveRootObjectsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for DynSvcNeConfig.retrieveRootObjects to encode json response from internal NFM-P object model" }, "alterSeverityOfFault": { "title": "alterSeverityOfFault", "required": [ "faultObjectFullName", "severity" ], "type": "object", "properties": { "faultObjectFullName": { "type": "string", "description": "Full name of the alarm to have its severity updated." }, "severity": { "type": "integer", "description": "New severity.", "format": "int32" } }, "description": "Model containing the method level model for FaultManager.alterSeverityOfFault to decode json data to internal NFM-P object model" }, "searchMonitoredObject": { "title": "searchMonitoredObject", "required": [ "className", "filter" ], "type": "object", "properties": { "className": { "type": "string", "description": "The class name for the search." }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for SupervisionManager.searchMonitoredObject to decode json data to internal NFM-P object model" }, "TestResult": { "title": "TestResult", "required": [ "scheduled", "resultStatus", "testSuiteTestRole", "testGroupRole", "execTrigger", "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects", "structObjectId", "parentObjectId", "fromNodeId", "timeCaptured", "nmUser", "nmUserName", "resultsCompleted", "delayedTestExecution", "sla", "saa", "continuous", "neTestOwner", "neTestIndex", "neTestRunIndex", "testId", "reason", "ignoreResults", "test", "testPolicy", "testDefinition", "testSuite", "testSuiteId", "testSuiteResult", "testPolicyResult", "testDefinitionResult", "testSuiteTestedEntity", "testedEntityResult", "testedObject", "baseObject", "tsExecutionId", "scheduledTime", "timedout", "skipReason", "ignoreResult" ], "type": "object", "properties": { "scheduled": { "type": "string", "description": "default: yes:notScheduled" }, "resultStatus": { "type": "string" }, "testSuiteTestRole": { "type": "string" }, "testGroupRole": { "type": "string" }, "execTrigger": { "type": "string", "description": "default: yes:nmTriggered" }, "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "structObjectId": { "type": "integer", "format": "int64" }, "parentObjectId": { "type": "integer", "format": "int64" }, "fromNodeId": { "type": "string" }, "timeCaptured": { "type": "integer", "format": "int64" }, "nmUser": { "type": "string", "description": "default: yes:" }, "nmUserName": { "type": "string", "description": "default: yes:" }, "resultsCompleted": { "type": "boolean", "description": "default: yes:false" }, "delayedTestExecution": { "type": "boolean", "description": "default: yes:false" }, "sla": { "type": "boolean", "description": "default: yes:false" }, "saa": { "type": "boolean", "description": "default: yes:false" }, "continuous": { "type": "boolean", "description": "default: yes:false" }, "neTestOwner": { "type": "string" }, "neTestIndex": { "type": "string" }, "neTestRunIndex": { "type": "integer", "format": "int64" }, "testId": { "type": "integer", "format": "int64" }, "reason": { "type": "string" }, "ignoreResults": { "type": "boolean", "description": "default: yes:false" }, "test": { "type": "string" }, "testPolicy": { "type": "string" }, "testDefinition": { "type": "string" }, "testSuite": { "type": "string" }, "testSuiteId": { "type": "integer", "format": "int64" }, "testSuiteResult": { "type": "string" }, "testPolicyResult": { "type": "string" }, "testDefinitionResult": { "type": "string" }, "testSuiteTestedEntity": { "type": "string" }, "testedEntityResult": { "type": "string" }, "testedObject": { "type": "string" }, "baseObject": { "type": "string" }, "tsExecutionId": { "type": "integer", "format": "int64" }, "scheduledTime": { "type": "integer", "description": "default: yes:0", "format": "int64" }, "timedout": { "type": "boolean", "description": "default: yes:false" }, "skipReason": { "type": "string", "description": "default: yes:" }, "ignoreResult": { "type": "boolean", "description": "default: yes:false" } }, "description": "Model containing the method level model for struct TestResult. to decode json data to internal NFM-P object model" }, "associateHandlerScriptResponse": { "title": "associateHandlerScriptResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, { "description": "Model containing the method level model for struct CommonManagedEntityInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for ControlScript.associateHandlerScript to encode json response from internal NFM-P object model" }, "retrieveSubSvcResponse": { "title": "retrieveSubSvcResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for SubscriberService.retrieveSubSvc to encode json response from internal NFM-P object model" }, "PowerShelf": { "title": "PowerShelf", "required": [ "displayedName", "shelfId", "hwIndex", "siteId", "siteName", "manufacturer", "serialNumber", "manufacturerBoardNumber", "manufactureDate", "equipmentCategory", "hwName", "cleiCode", "equipmentState", "containingEquipmentState", "compositeEquipmentState", "operationalState", "administrativeState", "isEquipped", "baseMacAddress", "hardwareFailureReason", "isEquipmentInserted", "manufacturingAssemblyNo", "manufacturingDeviations", "isTempSensorAvailable", "hardwareClass", "backgroundDiagnosticsState", "backgroundDiagnosticsFaultReason", "manufacturingVariant", "hwFirmwareRevisionStatus", "oesShelfId", "phyShelfClass", "phyShelfType", "olcState", "lockOlcState", "powerShelfHwIndex", "powerShelfId", "phyShelfNumber", "description", "assignedType", "equippedType", "supportedTypes", "powerShelfInputPowerMode", "powerShelfOutputStatus", "zoneId", "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties" ], "type": "object", "properties": { "displayedName": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "shelfId": { "type": "integer", "format": "int32", "readOnly": true }, "hwIndex": { "type": "integer", "format": "int64", "readOnly": true }, "siteId": { "type": "string", "description": "64]", "readOnly": true, "example": " maximum: 64" }, "siteName": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "manufacturer": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "serialNumber": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "manufacturerBoardNumber": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "manufactureDate": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "equipmentCategory": { "type": "integer", "format": "int32", "readOnly": true }, "hwName": { "type": "string", "description": "[0,32]", "readOnly": true, "example": " maximum: 32" }, "cleiCode": { "type": "string", "description": "[0,16]", "readOnly": true, "example": " maximum: 16" }, "equipmentState": { "type": "integer", "format": "int32", "readOnly": true }, "containingEquipmentState": { "type": "integer", "format": "int32", "readOnly": true }, "compositeEquipmentState": { "type": "integer", "format": "int32", "readOnly": true }, "operationalState": { "type": "integer", "format": "int32", "readOnly": true }, "administrativeState": { "type": "integer", "format": "int32" }, "isEquipped": { "type": "boolean", "readOnly": true }, "baseMacAddress": { "type": "string", "readOnly": true }, "hardwareFailureReason": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "isEquipmentInserted": { "type": "boolean", "readOnly": true }, "manufacturingAssemblyNo": { "type": "string", "readOnly": true }, "manufacturingDeviations": { "type": "string", "readOnly": true }, "isTempSensorAvailable": { "type": "boolean", "readOnly": true }, "hardwareClass": { "type": "integer", "format": "int32", "readOnly": true }, "backgroundDiagnosticsState": { "type": "integer", "format": "int32", "readOnly": true }, "backgroundDiagnosticsFaultReason": { "type": "string", "readOnly": true }, "manufacturingVariant": { "type": "string", "readOnly": true }, "hwFirmwareRevisionStatus": { "type": "integer", "format": "int32", "readOnly": true }, "oesShelfId": { "type": "integer", "format": "int32" }, "phyShelfClass": { "type": "integer", "format": "int32" }, "phyShelfType": { "type": "integer", "format": "int32" }, "olcState": { "type": "integer", "description": "Object Life Cycle can be set using {{generic.GenericObject.updateUserObjectLifecycleStates()}}.", "format": "int32", "readOnly": true }, "lockOlcState": { "type": "boolean", "description": "This is used to lock the OLC State while in OLC Maintenance State only." }, "powerShelfHwIndex": { "type": "integer", "description": "Relative power shelf identifier.", "format": "int64" }, "powerShelfId": { "type": "integer", "format": "int32", "readOnly": true }, "phyShelfNumber": { "type": "integer", "description": "[1,32]", "format": "int32", "readOnly": true }, "description": { "type": "string", "description": "[0,255]", "example": " maximum: 255" }, "assignedType": { "type": "integer", "format": "int64" }, "equippedType": { "type": "integer", "format": "int64", "readOnly": true }, "supportedTypes": { "type": "integer", "format": "int64", "readOnly": true }, "powerShelfInputPowerMode": { "type": "integer", "format": "int32", "readOnly": true }, "powerShelfOutputStatus": { "type": "integer", "format": "int32", "readOnly": true }, "zoneId": { "type": "integer", "description": "[0,32]", "format": "int32", "readOnly": true }, "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "actionMask": { "type": "integer", "format": "int32" }, "selfAlarmed": { "type": "boolean", "default": false }, "name": { "type": "string" } }, "description": "Managed object abstract class" }, "findOchCrossConnectsResponse": { "title": "findOchCrossConnectsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for OchCrossConnect.findOchCrossConnects to encode json response from internal NFM-P object model" }, "getVirtualPortsForVnodeResponse": { "title": "getVirtualPortsForVnodeResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for VirtualNode.getVirtualPortsForVnode to encode json response from internal NFM-P object model" }, "findServiceIpInterfacesResponse": { "title": "findServiceIpInterfacesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for Policy.findServiceIpInterfaces to encode json response from internal NFM-P object model" }, "findApplicableNesResponse": { "title": "findApplicableNesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "object" }, "description": "The response object." } }, "description": "Model containing the method level model for GNESoftwareFolderDescriptor.findApplicableNes to encode json response from internal NFM-P object model" }, "highlightLFANextHops": { "title": "highlightLFANextHops", "required": [ "igpAdminDomain", "protocol", "sourceType", "source", "sourceLen", "destType", "dest", "destLen" ], "type": "object", "properties": { "igpAdminDomain": { "type": "string", "description": "The IGP Admin Domain ({{topology.AutonomousSystem}}) to perform the LFA in." }, "protocol": { "type": "string", "description": "The protocol to run LFA on. Currently OSPF, OSPFv3 and ISIS aresupported." }, "sourceType": { "type": "string", "description": "The address type of the source. Currently only ipv4 issupported." }, "source": { "type": "string", "description": "The source address. The format ofthe source is based on the sourceType property." }, "sourceLen": { "type": "integer", "description": "The length of the source address. Its valid values dependon the sourceType.", "format": "int32" }, "destType": { "type": "string", "description": "The address type of the destination. Currently ipv4 and ipv6 aresupported." }, "dest": { "type": "string", "description": "The destination address. The format ofthe destination is based on the destType property." }, "destLen": { "type": "integer", "description": "The length of the destination address. Its valid valuesdepend on the destType.", "format": "int32" } }, "description": "Model containing the method level model for TopologyManager.highlightLFANextHops to decode json data to internal NFM-P object model" }, "defineFibEntry": { "title": "defineFibEntry", "required": [ "macAddress", "terminatedObject", "shouldComplete", "type" ], "type": "object", "properties": { "macAddress": { "type": "string" }, "terminatedObject": { "type": "string" }, "shouldComplete": { "type": "boolean" }, "type": { "type": "string" } }, "description": "Model containing the method level model for FibEntry.defineFibEntry to decode json data to internal NFM-P object model" }, "distributeResponse": { "title": "distributeResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for PolicyDefinition.distribute to encode json response from internal NFM-P object model" }, "removePowerShelfResponse": { "title": "removePowerShelfResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/PowerShelf" }, { "description": "Managed object abstract class" } ] } }, "description": "Model containing the method level model for PowerShelf.removePowerShelf to encode json response from internal NFM-P object model" }, "RetrievingLacMlpppBundleStruct": { "title": "RetrievingLacMlpppBundleStruct", "required": [ "objectClassName", "siteId", "routerId", "bundleId", "timeout" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "routerId": { "type": "integer", "format": "int64" }, "bundleId": { "type": "integer", "format": "int64" }, "timeout": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct RetrievingLacMlpppBundleStruct. to decode json data to internal NFM-P object model" }, "MldSapStruct": { "title": "MldSapStruct", "required": [ "objectClassName", "encapType", "siteId", "svcId", "fwdSvcId", "grpIfIndex", "portName", "combinedEncap", "innerEncapVal", "outerEncapVal" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "encapType": { "type": "string" }, "siteId": { "type": "string" }, "svcId": { "type": "integer", "format": "int64" }, "fwdSvcId": { "type": "integer", "format": "int64" }, "grpIfIndex": { "type": "integer", "format": "int64" }, "portName": { "type": "string" }, "combinedEncap": { "type": "integer", "format": "int64" }, "innerEncapVal": { "type": "integer", "format": "int64" }, "outerEncapVal": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct MldSapStruct. to decode json data to internal NFM-P object model" }, "retrieveAaEsmHosts": { "title": "retrieveAaEsmHosts", "type": "object", "properties": { "aInHostInfoRtrvStruct": { "allOf": [ { "$ref": "#/components/schemas/AaEsmHostRtrvStruct" }, { "description": "Model containing the method level model for struct AaEsmHostRtrvStruct. to decode json data to internal NFM-P object model" } ] }, "aInTimeout": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for AaEsmHostInfo.retrieveAaEsmHosts to decode json data to internal NFM-P object model" }, "RestRegisterLogToFileDto": { "title": "RestRegisterLogToFileDto", "required": [ "fullClassName", "dirName" ], "type": "object", "properties": { "fullClassName": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "list" }, "dirName": { "type": "string", "description": "string", "example": "/myDir" }, "compress": { "type": "boolean", "description": "boolean", "default": false, "example": true }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "resultFilter": { "allOf": [ { "$ref": "#/components/schemas/RestResultFilterDto" }, { "description": "Result filter class" } ] } }, "description": "RestRegister Log To File model" }, "TunnelAndPathResult": { "title": "TunnelAndPathResult", "required": [ "objectClassName", "pathDn", "tunnelDn" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "pathDn": { "type": "string" }, "tunnelDn": { "type": "string" } }, "description": "Model containing the method level model for struct TunnelAndPathResult. to decode json data to internal NFM-P object model" }, "getServiceSegmentsResponse": { "title": "getServiceSegmentsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "object" }, "description": "The response object." } }, "description": "Model containing the method level model for Service.getServiceSegments to encode json response from internal NFM-P object model" }, "discoverTrail": { "title": "discoverTrail", "type": "object", "properties": { "aInConnType": { "type": "integer", "format": "int32" }, "aInFdnList": { "type": "array", "items": { "type": "string" }, "description": "" } }, "description": "Model containing the method level model for Trail.discoverTrail to decode json data to internal NFM-P object model" }, "clearCcrtReplaySessionResponse": { "title": "clearCcrtReplaySessionResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for DiameterAppPolicy.clearCcrtReplaySession to encode json response from internal NFM-P object model" }, "findP2pLspResponse1": { "title": "findP2pLspResponse1", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for LspTemplateMvpn.findP2pLsp to encode json response from internal NFM-P object model" }, "createMulticastNetwork": { "title": "createMulticastNetwork", "required": [ "nwId", "description" ], "type": "object", "properties": { "nwId": { "type": "integer", "format": "int64" }, "description": { "type": "string" } }, "description": "Model containing the method level model for MulticastNetwork.createMulticastNetwork to decode json data to internal NFM-P object model" }, "retrieveBgpEventTopNContributersResponse": { "title": "retrieveBgpEventTopNContributersResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/AbstractBgpEventContributerResultStruct" }, "description": "The response object." } }, "description": "Model containing the method level model for BgpAutonomousSystem.retrieveBgpEventTopNContributers to encode json response from internal NFM-P object model" }, "findDiscoveredNodesResponse": { "title": "findDiscoveredNodesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/NetworkElementInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for TopologyDiscoveryRule.findDiscoveredNodes to encode json response from internal NFM-P object model" }, "MdaXconnectLoopbackInfo": { "title": "MdaXconnectLoopbackInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "mdaXconnectLoopbackId": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "mdaXconnectLoopbackBandwidth": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for Interface MdaXconnectLoopbackInfo. to decode json data to internal NFM-P object model" }, "drain": { "title": "drain", "type": "object", "properties": { "aInGroupName": { "type": "string" }, "aInTunnelNameList": { "type": "array", "items": { "type": "string" }, "description": "" }, "aInAction": { "type": "integer", "format": "int32" }, "aInSiteId": { "type": "string" }, "aInRouterId": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for TunnelProfile.drain to decode json data to internal NFM-P object model" }, "configureCertificateManagementAuthParameters": { "title": "configureCertificateManagementAuthParameters", "required": [ "preSharedKey", "refNum" ], "type": "object", "properties": { "preSharedKey": { "type": "string" }, "refNum": { "type": "string" } }, "description": "Model containing the method level model for AbstractMRBTS.configureCertificateManagementAuthParameters to decode json data to internal NFM-P object model" }, "checkConfig": { "title": "checkConfig", "required": [ "fdn", "fdnPolicy" ], "type": "object", "properties": { "aInContext": { "allOf": [ { "$ref": "#/components/schemas/Context" }, { "description": "Model containing the method level model for struct Context. to decode json data to internal NFM-P object model" } ] }, "fdn": { "type": "string", "description": "The source of the managed object which validate will be started." }, "fdnPolicy": { "type": "string", "description": "The FDN of Audit policy which it will be used, it can null." } }, "description": "Model containing the method level model for RcaManager.checkConfig to decode json data to internal NFM-P object model" }, "syncToLocalWithResyncResponse": { "title": "syncToLocalWithResyncResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for PolicyDefinition.syncToLocalWithResync to encode json response from internal NFM-P object model" }, "FwPolicyDefinitionInfo": { "title": "FwPolicyDefinitionInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "description": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "templateObject": { "type": "string" }, "policyMode": { "type": "integer", "format": "int32" }, "configurationAction": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for Interface FwPolicyDefinitionInfo. to decode json data to internal NFM-P object model" }, "findOdukCrossConnectsResponse": { "title": "findOdukCrossConnectsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/LoOdukCrossConnectInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for AbstractPath.findOdukCrossConnects to encode json response from internal NFM-P object model" }, "findSubscribersResponse": { "title": "findSubscribersResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for AbstractTunnel.findSubscribers to encode json response from internal NFM-P object model" }, "findAllStaticRoutes": { "title": "findAllStaticRoutes", "required": [ "fields", "sortFields", "pageNumber", "pageSize" ], "type": "object", "properties": { "fields": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Sorting fields" }, "sortFields": { "type": "array", "items": { "type": "string" }, "description": "Sorting fields" }, "pageNumber": { "type": "integer", "description": "Page number", "format": "int32" }, "pageSize": { "type": "integer", "description": "The number of entries to return", "format": "int32" } }, "description": "Model containing the method level model for AutonomousSystem.findAllStaticRoutes to decode json data to internal NFM-P object model" }, "updateUserObjectLifecycleStatesAndSchedules": { "title": "updateUserObjectLifecycleStatesAndSchedules", "required": [ "distinguishedName", "anInFlipTimeSelected", "anInCurrentOLCState" ], "type": "object", "properties": { "distinguishedName": { "type": "string", "description": "Distinguished Name of object being configured." }, "anInFlipTimeSelected": { "type": "integer", "description": "The time in milliseconds that OLC State will be flipped.", "format": "int64" }, "anInCurrentOLCState": { "type": "integer", "description": "The target OLC State to set before the schedule.", "format": "int32" } }, "description": "Model containing the method level model for GenericObject.updateUserObjectLifecycleStatesAndSchedules to decode json data to internal NFM-P object model" }, "TargetScriptConfigInfo": { "title": "TargetScriptConfigInfo", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap", "containmentInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } }, "mtosi_id": { "type": "integer", "format": "int64" }, "targetName": { "type": "string" }, "targetObjectFullName": { "type": "string" }, "description": { "type": "string" }, "versionFullName": { "type": "string" }, "mtosi_version": { "type": "integer", "format": "int32" }, "scriptDisplayName": { "type": "string" }, "versionMode": { "type": "integer", "format": "int32" }, "executionDate": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "creationTime": { "type": "integer", "format": "int64" }, "numberOfExecutions": { "type": "integer", "format": "int64" }, "numberOfSavedResults": { "type": "integer", "format": "int32" }, "lastExecutedUser": { "type": "string" } }, "description": "Model containing the method level model for Interface ConfigInfo TargetScriptConfigInfo. to decode json data to internal NFM-P object model" }, "ringAuditCheckResponse": { "title": "ringAuditCheckResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RingAuditResult" }, { "description": "Model containing the method level model for struct RingAuditResult. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for Ring.ringAuditCheck to encode json response from internal NFM-P object model" }, "previewResponse": { "title": "previewResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for TargetScript.preview to encode json response from internal NFM-P object model" }, "configureDiscoveryRuleResponse": { "title": "configureDiscoveryRuleResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/TopologyDiscoveryRule" }, { "description": "Managed object abstract class" } ] } }, "description": "Model containing the method level model for Topology.configureDiscoveryRule to encode json response from internal NFM-P object model" }, "createDefaultTestHeadProfileResponse": { "title": "createDefaultTestHeadProfileResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for L2AccessInterface.createDefaultTestHeadProfile to encode json response from internal NFM-P object model" }, "SpokeConnectorConfigInfo": { "title": "SpokeConnectorConfigInfo", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap", "containmentInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } }, "displayedName": { "type": "string" }, "description": { "type": "string" }, "firstSvcPointer": { "type": "string" }, "secondSvcPointer": { "type": "string" }, "firstSitePointer": { "type": "string" }, "secondSitePointer": { "type": "string" }, "vcId": { "type": "integer", "format": "int64" }, "autoSelectTunnel": { "type": "boolean", "default": false }, "tunnelSelectionProfile": { "type": "string" }, "transportPreference": { "type": "integer", "format": "int32" }, "firstTunnelPointer": { "type": "string" }, "firstL3AccessInterfacePointer": { "type": "string" }, "secondL3AccessInterfacePointer": { "type": "string" }, "secondTunnelPointer": { "type": "string" }, "firstSdpBindingPointer": { "type": "string" }, "secondSdpBindingPointer": { "type": "string" } }, "description": "Model containing the method level model for Interface ConfigInfo SpokeConnectorConfigInfo. to decode json data to internal NFM-P object model" }, "aldUpgrade": { "title": "aldUpgrade", "required": [ "aldElements", "requestId" ], "type": "object", "properties": { "aldElements": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "requestId": { "type": "string" } }, "description": "Model containing the method level model for RANAldSoftwareFolderDescriptor.aldUpgrade to decode json data to internal NFM-P object model" }, "previewPolicyListResponse": { "title": "previewPolicyListResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/FetchGlobalPolicyInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for Manager.previewPolicyList to encode json response from internal NFM-P object model" }, "AreaConfigInfo": { "title": "AreaConfigInfo", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap", "containmentInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } }, "areaId": { "type": "string" }, "areaName": { "type": "string" }, "areaDescription": { "type": "string" } }, "description": "Model containing the method level model for Interface ConfigInfo AreaConfigInfo. to decode json data to internal NFM-P object model" }, "retrieveEsiMappings": { "title": "retrieveEsiMappings", "required": [ "evpnId", "esi" ], "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInTimeout": { "type": "integer", "format": "int64" }, "evpnId": { "type": "integer", "description": "Specifies EVPN ID. This is mandatory parameter.", "format": "int64" }, "esi": { "type": "string", "description": "Specifies ESI Mapping IP Address. This is optional parameter. default:" } }, "description": "Model containing the method level model for SvcChainEsiMapping.retrieveEsiMappings to decode json data to internal NFM-P object model" }, "addWorkOrderResponse": { "title": "addWorkOrderResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for Session.addWorkOrder to encode json response from internal NFM-P object model" }, "retrieveHostTrackedSubscribersResponse": { "title": "retrieveHostTrackedSubscribersResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for HostTrackedSubscriber.retrieveHostTrackedSubscribers to encode json response from internal NFM-P object model" }, "createElementResponse": { "title": "createElementResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for Ring.createElement to encode json response from internal NFM-P object model" }, "resyncAllWavekeys": { "title": "resyncAllWavekeys", "type": "object", "properties": { "aInSiteIdList": { "type": "array", "items": { "type": "string" }, "description": "" }, "aInIfIndexList": { "type": "array", "items": { "type": "string" }, "description": "" } }, "description": "Model containing the method level model for OpticalPortSpecifics.resyncAllWavekeys to decode json data to internal NFM-P object model" }, "findTunnelGroupEndpointMembers": { "title": "findTunnelGroupEndpointMembers", "required": [ "tunnelGroupEndpointMemberFilter", "tunnelGroupEndpointFilter" ], "type": "object", "properties": { "tunnelGroupEndpointMemberFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "tunnelGroupEndpointFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for GmplsLsp.findTunnelGroupEndpointMembers to decode json data to internal NFM-P object model" }, "findAssociatedObjectsResponse": { "title": "findAssociatedObjectsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for FlexibleAlgorithmDefinition.findAssociatedObjects to encode json response from internal NFM-P object model" }, "bindAu": { "title": "bindAu", "type": "object", "properties": { "aInBindRate": { "type": "integer", "format": "int32" }, "aInVcId": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for OCStmSpecifics.bindAu to decode json data to internal NFM-P object model" }, "bgpPerNextHopEventAnalysisResponse": { "title": "bgpPerNextHopEventAnalysisResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/BgpSummaryResult" }, "description": "The response object." } }, "description": "Model containing the method level model for BgpImpactAnalysisTimeRange.bgpPerNextHopEventAnalysis to encode json response from internal NFM-P object model" }, "requestClearHostIgmpHostTrackingResponse": { "title": "requestClearHostIgmpHostTrackingResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for ResidentialSubscriberInstance.requestClearHostIgmpHostTracking to encode json response from internal NFM-P object model" }, "ServiceSelectionInfo": { "title": "ServiceSelectionInfo", "required": [ "objectClassName", "name", "application", "params" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "name": { "type": "string" }, "application": { "type": "string" }, "params": { "type": "object", "additionalProperties": { "type": "string" } } }, "description": "Model containing the method level model for struct ServiceSelectionInfo. to decode json data to internal NFM-P object model" }, "findClientTrailsResponse": { "title": "findClientTrailsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/TrailInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for OpticalLink.findClientTrails to encode json response from internal NFM-P object model" }, "retrieveCcrtReplayResponse": { "title": "retrieveCcrtReplayResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for DiameterSeCcrtReplay.retrieveCcrtReplay to encode json response from internal NFM-P object model" }, "discoverDevicesResponse": { "title": "discoverDevicesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for RmdConfig.discoverDevices to encode json response from internal NFM-P object model" }, "WlanGwUeTraceInfoStruct": { "title": "WlanGwUeTraceInfoStruct", "required": [ "objectClassName", "siteId", "ieeeAddress", "traceProfileName" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "ieeeAddress": { "type": "string" }, "traceProfileName": { "type": "string" } }, "description": "Model containing the method level model for struct WlanGwUeTraceInfoStruct. to decode json data to internal NFM-P object model" }, "retrieveIPoESessionRadiusClasses": { "title": "retrieveIPoESessionRadiusClasses", "required": [ "siteId", "sessionIndex", "timeout" ], "type": "object", "properties": { "siteId": { "type": "string", "description": "Site ID for the IPoE Session." }, "sessionIndex": { "type": "integer", "description": "IPoE Session ID.", "format": "int64" }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait before receiving the results.This is an optional input parameter. The default value is 5 minutes (300000). default:300000", "format": "int64" } }, "description": "Model containing the method level model for IPoESessionRadiusClassAttribute.retrieveIPoESessionRadiusClasses to decode json data to internal NFM-P object model" }, "findNonMembers": { "title": "findNonMembers", "required": [ "filter" ], "type": "object", "properties": { "aInObjectClassName": { "type": "string" }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for GroupManager.findNonMembers to decode json data to internal NFM-P object model" }, "findFateSharedInterfacesResponse": { "title": "findFateSharedInterfacesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/PagingResult" }, { "description": "Model containing the method level model for struct PagingResult. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for SpokeSdpBindingInterface.findFateSharedInterfaces to encode json response from internal NFM-P object model" }, "retrieveWlanGwTunnelCountResponse": { "title": "retrieveWlanGwTunnelCountResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int64" } }, "description": "Model containing the method level model for WlanGwQbtTunnel.retrieveWlanGwTunnelCount to encode json response from internal NFM-P object model" }, "findServiceSitesResponse": { "title": "findServiceSitesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for Tunnel.findServiceSites to encode json response from internal NFM-P object model" }, "Port": { "title": "Port", "required": [ "displayedName", "shelfId", "hwIndex", "siteId", "siteName", "manufacturer", "serialNumber", "manufacturerBoardNumber", "manufactureDate", "equipmentCategory", "hwName", "cleiCode", "equipmentState", "containingEquipmentState", "compositeEquipmentState", "operationalState", "administrativeState", "isEquipped", "baseMacAddress", "hardwareFailureReason", "isEquipmentInserted", "manufacturingAssemblyNo", "manufacturingDeviations", "isTempSensorAvailable", "hardwareClass", "backgroundDiagnosticsState", "backgroundDiagnosticsFaultReason", "manufacturingVariant", "hwFirmwareRevisionStatus", "oesShelfId", "phyShelfClass", "phyShelfType", "olcState", "lockOlcState", "snmpPortId", "portId", "portCategory", "portClass", "specificType", "specificCardType", "description", "mode", "hasUserAssignedMac", "isl2UplinkMode", "macAddress", "hwMacAddress", "encapType", "holdTimeUp", "holdTimeDown", "upProtocols", "isLinkUp", "state", "previousState", "isTerminatable", "isConnectionTerminated", "hasConnections", "mtuValue", "operationalMTU", "neSpecificMtu", "speed", "actualSpeed", "accountingPolicyCapable", "accountingPolicyId", "accountingPolicyName", "accountingPolicyObjectPointer", "collectStats", "etherAccountingPolicyObjectPointer", "etherCollectStats", "ethAccessAccountingPolicyObjectPointer", "ethAccessCollectStats", "networkQueuePolicyName", "networkQueueObjectPointer", "networkQueuePolicyCapable", "portName", "numberOfPossibleChannels", "isPortChannelALeaf", "parentSnmpPortId", "currentNumberOfChannels", "intervalNumber", "mirrorStatus", "loadBalanceAlgorithm", "portSchedulerPolicyObjectPointer", "portEgrHsmdaSchedulerPolicy", "uniProfilePointer", "portIngrNamedPoolPlcy", "portEgrNamedPoolPlcy", "portIngrPoolPercentageRate", "portEgrPoolPercentageRate", "vlanAutoBind", "portUsage", "portUsageType", "ubtSpeed", "ubtListBits", "l2ProfilePointer", "memberOfIGH", "holdTimeUnits", "linkTrap", "userLabel", "mptSubrackPointer", "mptCombiner", "mptCombinerImplemented", "iomType", "portStateFPNumber", "portStateMacChipNumber", "portStateLicensed", "portRsFecOperMode", "unpPortType", "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties" ], "type": "object", "properties": { "displayedName": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "shelfId": { "type": "integer", "format": "int32", "readOnly": true }, "hwIndex": { "type": "integer", "format": "int64", "readOnly": true }, "siteId": { "type": "string", "description": "64]", "readOnly": true, "example": " maximum: 64" }, "siteName": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "manufacturer": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "serialNumber": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "manufacturerBoardNumber": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "manufactureDate": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "equipmentCategory": { "type": "integer", "format": "int32", "readOnly": true }, "hwName": { "type": "string", "description": "[0,32]", "readOnly": true, "example": " maximum: 32" }, "cleiCode": { "type": "string", "description": "[0,16]", "readOnly": true, "example": " maximum: 16" }, "equipmentState": { "type": "integer", "format": "int32", "readOnly": true }, "containingEquipmentState": { "type": "integer", "format": "int32", "readOnly": true }, "compositeEquipmentState": { "type": "integer", "format": "int32", "readOnly": true }, "operationalState": { "type": "integer", "format": "int32", "readOnly": true }, "administrativeState": { "type": "integer", "format": "int32" }, "isEquipped": { "type": "boolean", "readOnly": true }, "baseMacAddress": { "type": "string", "readOnly": true }, "hardwareFailureReason": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "isEquipmentInserted": { "type": "boolean", "readOnly": true }, "manufacturingAssemblyNo": { "type": "string", "readOnly": true }, "manufacturingDeviations": { "type": "string", "readOnly": true }, "isTempSensorAvailable": { "type": "boolean", "readOnly": true }, "hardwareClass": { "type": "integer", "format": "int32", "readOnly": true }, "backgroundDiagnosticsState": { "type": "integer", "format": "int32", "readOnly": true }, "backgroundDiagnosticsFaultReason": { "type": "string", "readOnly": true }, "manufacturingVariant": { "type": "string", "readOnly": true }, "hwFirmwareRevisionStatus": { "type": "integer", "format": "int32", "readOnly": true }, "oesShelfId": { "type": "integer", "format": "int32" }, "phyShelfClass": { "type": "integer", "format": "int32" }, "phyShelfType": { "type": "integer", "format": "int32" }, "olcState": { "type": "integer", "description": "Object Life Cycle can be set using {{generic.GenericObject.updateUserObjectLifecycleStates()}}.", "format": "int32", "readOnly": true }, "lockOlcState": { "type": "boolean", "description": "This is used to lock the OLC State while in OLC Maintenance State only." }, "snmpPortId": { "type": "integer", "format": "int64", "readOnly": true }, "portId": { "type": "integer", "format": "int64" }, "portCategory": { "type": "integer", "format": "int32", "readOnly": true }, "portClass": { "type": "integer", "format": "int32", "readOnly": true }, "specificType": { "type": "integer", "format": "int32", "readOnly": true }, "specificCardType": { "type": "integer", "format": "int32", "readOnly": true }, "description": { "type": "string", "description": "[0,256]", "example": " maximum: 256" }, "mode": { "type": "integer", "format": "int32" }, "hasUserAssignedMac": { "type": "boolean", "readOnly": true }, "isl2UplinkMode": { "type": "boolean" }, "macAddress": { "type": "string" }, "hwMacAddress": { "type": "string", "readOnly": true }, "encapType": { "type": "integer", "format": "int32" }, "holdTimeUp": { "type": "integer", "description": "[0,36000]", "format": "int32" }, "holdTimeDown": { "type": "integer", "description": "[0,36000]", "format": "int32" }, "upProtocols": { "type": "integer", "format": "int64", "readOnly": true }, "isLinkUp": { "type": "boolean", "readOnly": true }, "state": { "type": "integer", "format": "int32", "readOnly": true }, "previousState": { "type": "integer", "format": "int32", "readOnly": true }, "isTerminatable": { "type": "boolean", "readOnly": true }, "isConnectionTerminated": { "type": "boolean", "readOnly": true }, "hasConnections": { "type": "boolean", "readOnly": true }, "mtuValue": { "type": "integer", "format": "int32" }, "operationalMTU": { "type": "integer", "format": "int32", "readOnly": true }, "neSpecificMtu": { "type": "integer", "description": "The MTU of the port as reported by the network element.Various vendors may configure the MTU differently. For example on Cisco IOS IOS-XE theport MTU is configured as protocol MTU, it means that MTU 1500 can fit a protocol payload of 1500 bytes.Whereas on Cisco IOS-XR to fit 1500 bytes of payload data the MTU must be configured as 1514.This attribute is read-only and its purpose is to indicate the NE specific MTU value that may be usedfor troubleshooting.The normalized MTU value for the port is specified by the mtuValue property.", "format": "int32", "readOnly": true }, "speed": { "type": "integer", "format": "int32" }, "actualSpeed": { "type": "integer", "format": "int64", "readOnly": true }, "accountingPolicyCapable": { "type": "boolean", "readOnly": true }, "accountingPolicyId": { "type": "integer", "format": "int64", "readOnly": true }, "accountingPolicyName": { "type": "string", "description": "80]", "readOnly": true, "example": " maximum: 80" }, "accountingPolicyObjectPointer": { "type": "string" }, "collectStats": { "type": "boolean" }, "etherAccountingPolicyObjectPointer": { "type": "string" }, "etherCollectStats": { "type": "boolean" }, "ethAccessAccountingPolicyObjectPointer": { "type": "string", "description": "The value of ethAccessAccountingPolicyObjectPointer specifies theTIMETRA-LOG-MIB::tmnxLogApPolicyId that identifies the policy entry inTIMETRA-LOG-MIB::tmnxLogApTable which is associated with this ethernetaccess port queue for the purpose of collecting physical layerethernet access port queue statistics." }, "ethAccessCollectStats": { "type": "boolean", "description": "The value of ethAccessCollectStats specifies whether or notthe collection of physical layer ethernet accounting and statisticaldata for the ethernet access port queue is enabled" }, "networkQueuePolicyName": { "type": "string", "description": "[1,32]", "readOnly": true, "example": " maximum: 32" }, "networkQueueObjectPointer": { "type": "string" }, "networkQueuePolicyCapable": { "type": "boolean", "readOnly": true }, "portName": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "numberOfPossibleChannels": { "type": "integer", "format": "int64", "readOnly": true }, "isPortChannelALeaf": { "type": "integer", "format": "int32", "readOnly": true }, "parentSnmpPortId": { "type": "integer", "format": "int64", "readOnly": true }, "currentNumberOfChannels": { "type": "integer", "format": "int32", "readOnly": true }, "intervalNumber": { "type": "integer", "description": "Stats interval number to retrieve when doing a manual resync.", "format": "int32", "readOnly": true }, "mirrorStatus": { "type": "integer", "format": "int64", "readOnly": true }, "loadBalanceAlgorithm": { "type": "integer", "description": "Specifies the load balancing algorithm to be used on this port.", "format": "int32" }, "portSchedulerPolicyObjectPointer": { "type": "string", "description": "Specifies the port scheduler policy used by this port" }, "portEgrHsmdaSchedulerPolicy": { "type": "string", "description": "Specifies the hsmda scheduler policy used by this port" }, "uniProfilePointer": { "type": "string", "description": "Pointer to the UNI Profile Policy object." }, "portIngrNamedPoolPlcy": { "type": "string" }, "portEgrNamedPoolPlcy": { "type": "string" }, "portIngrPoolPercentageRate": { "type": "integer", "description": "[0,1000]", "format": "int32" }, "portEgrPoolPercentageRate": { "type": "integer", "description": "[0,1000]", "format": "int32" }, "vlanAutoBind": { "type": "boolean" }, "portUsage": { "type": "integer", "format": "int32", "readOnly": true }, "portUsageType": { "type": "integer", "format": "int32", "readOnly": true }, "ubtSpeed": { "type": "integer", "format": "int32", "readOnly": true }, "ubtListBits": { "type": "integer", "format": "int32", "readOnly": true }, "l2ProfilePointer": { "type": "string", "description": "Pointer to the L2 Profile Policy object." }, "memberOfIGH": { "type": "string", "description": "ECMP fate sharing group membership", "readOnly": true }, "holdTimeUnits": { "type": "integer", "format": "int32" }, "linkTrap": { "type": "integer", "format": "int32" }, "userLabel": { "type": "string", "description": "20]", "example": " maximum: 20" }, "mptSubrackPointer": { "type": "string", "description": "specifies where the MPT is connected to on the subrack", "readOnly": true }, "mptCombiner": { "type": "integer", "description": "Enable Disable Combiner(SD)function on MPT.", "format": "int64", "readOnly": true }, "mptCombinerImplemented": { "type": "integer", "description": "TRUE FALSE based on MPT provision", "format": "int64" }, "iomType": { "type": "integer", "format": "int32", "readOnly": true }, "portStateFPNumber": { "type": "integer", "description": "The value of portStateFPNumber indicates the forwarding plane number for this port.", "format": "int32", "readOnly": true }, "portStateMacChipNumber": { "type": "integer", "description": "The value of portStateMacChipNumber indicates the MAC chip number for this port.", "format": "int32", "readOnly": true }, "portStateLicensed": { "type": "boolean", "description": "The value of portStateLicensed indicates whether this port is licensed for the current licensed level of the assigned MDA.A value of 'true' indicates this port is licensed and can be used in service configuration.A value of 'false' indicates that the port is unlicensed and may not be used.", "readOnly": true }, "portRsFecOperMode": { "type": "integer", "description": "The value of portRsFecOperMode indicates the mode of Reed-Solomon Forward Error Correction (RS-FEC) in use on this port.When the value of portRsFecOperMode is set to 'none', the port is transmiting and receiving using standard 64B 66B encoding.", "format": "int32", "readOnly": true }, "unpPortType": { "type": "integer", "description": "Configures UNP functionality for the specified port", "format": "int32" }, "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "actionMask": { "type": "integer", "format": "int32" }, "selfAlarmed": { "type": "boolean", "default": false }, "name": { "type": "string" } }, "description": "Managed object abstract class" }, "retrieveDbInfoTransitIpAddressResponse": { "title": "retrieveDbInfoTransitIpAddressResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for DbInfoTransitIpAddress.retrieveDbInfoTransitIpAddress to encode json response from internal NFM-P object model" }, "findValidTerminatingPortsForService": { "title": "findValidTerminatingPortsForService", "type": "object", "properties": { "aInSiteIdList": { "type": "array", "items": { "type": "string" }, "description": "" }, "aInRate": { "type": "integer", "format": "int32" }, "aInProtectionType": { "type": "integer", "format": "int32" }, "aInDirection": { "type": "integer", "format": "int32" }, "aInIsQinQService": { "type": "boolean", "default": false }, "aInIsQinQFullRateService": { "type": "boolean", "default": false }, "aInSvcType": { "type": "integer", "format": "int32" }, "aInSitePosition": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for ServiceSite.findValidTerminatingPortsForService to decode json data to internal NFM-P object model" }, "retrieveGtpS11Sessions": { "title": "retrieveGtpS11Sessions", "required": [ "retrieveBearers" ], "type": "object", "properties": { "aInRetrGtpS11SessionStruct": { "allOf": [ { "$ref": "#/components/schemas/RetrGtpS11SessionStruct" }, { "description": "Model containing the method level model for struct RetrGtpS11SessionStruct. to decode json data to internal NFM-P object model" } ] }, "retrieveBearers": { "type": "boolean", "description": "Specifies if the Bearers should be retrieved,the default is \"false\".If true, the Bearers are retrieved for the GTP S11 Session.If false, the Bearers are not retrieved for the GTP S11 Session. default:false" } }, "description": "Model containing the method level model for S11Session.retrieveGtpS11Sessions to decode json data to internal NFM-P object model" }, "multipleFilteredFindResponse": { "title": "multipleFilteredFindResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "object" }, "description": "The response object." } }, "description": "Model containing the method level model for GenericObject.multipleFilteredFind to encode json response from internal NFM-P object model" }, "alterSeverityOfFaultList": { "title": "alterSeverityOfFaultList", "required": [ "faultObjectNameSet", "severity" ], "type": "object", "properties": { "faultObjectNameSet": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Set of the alarm full names to have their severity updated." }, "severity": { "type": "integer", "description": "New severity.", "format": "int32" } }, "description": "Model containing the method level model for FaultManager.alterSeverityOfFaultList to decode json data to internal NFM-P object model" }, "RetrievingIpoeSessionStruct": { "title": "RetrievingIpoeSessionStruct", "required": [ "objectClassName", "siteId", "svcId", "sapId", "innerEncap", "outerEncap", "sessionsMac", "sessionsId", "timeout" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "svcId": { "type": "integer", "format": "int64" }, "sapId": { "type": "string" }, "innerEncap": { "type": "integer", "format": "int64" }, "outerEncap": { "type": "integer", "format": "int64" }, "sessionsMac": { "type": "string" }, "sessionsId": { "type": "integer", "format": "int64" }, "timeout": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct RetrievingIpoeSessionStruct. to decode json data to internal NFM-P object model" }, "AbstractStatsPollerPolicy": { "title": "AbstractStatsPollerPolicy", "required": [ "displayedName", "id", "pollingSyncTime", "basePollingInterval", "administrativeState", "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties" ], "type": "object", "properties": { "displayedName": { "type": "string", "description": "[0,80]", "example": " maximum: 80" }, "id": { "type": "integer", "description": "[1,65535]", "format": "int32" }, "pollingSyncTime": { "type": "integer", "description": "Specifies the polling synchronizationstart time from which the polling intervals are calculated based ona 24-hour clock. When the server restarts, the next appropriate collection interval iscalculated and polling restarts for all enabled MIBs. The default is 00:00.Time is specified in milliseconds from 00:00 UTC.", "format": "int64" }, "basePollingInterval": { "type": "integer", "description": "Specifies how often MIB elements of discovered andmanaged devices are polled for statistics.", "format": "int32" }, "administrativeState": { "type": "integer", "format": "int32" }, "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "actionMask": { "type": "integer", "format": "int32" }, "selfAlarmed": { "type": "boolean", "default": false }, "name": { "type": "string" } }, "description": "Managed object abstract class" }, "SourceParam": { "title": "SourceParam", "required": [ "objectClassName", "sourceType", "source" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "sourceType": { "type": "string" }, "source": { "type": "string" } }, "description": "Model containing the method level model for struct SourceParam. to decode json data to internal NFM-P object model" }, "getRdRtPairingsResponse": { "title": "getRdRtPairingsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/RdRtPairing" }, "description": "The response object." } }, "description": "Model containing the method level model for ServiceBgpImpactAnalysisTimeRange.getRdRtPairings to encode json response from internal NFM-P object model" }, "findMissingTunnelsResponse": { "title": "findMissingTunnelsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for TopologyRule.findMissingTunnels to encode json response from internal NFM-P object model" }, "retrieveOFFlowTableCountsResponse": { "title": "retrieveOFFlowTableCountsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for OFFlowTableCounts.retrieveOFFlowTableCounts to encode json response from internal NFM-P object model" }, "findLogPolicyResponse": { "title": "findLogPolicyResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for Policy.findLogPolicy to encode json response from internal NFM-P object model" }, "getImportRouteTargetsResponse": { "title": "getImportRouteTargetsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for Site.getImportRouteTargets to encode json response from internal NFM-P object model" }, "createWithAutoFillForIncompleteConnections": { "title": "createWithAutoFillForIncompleteConnections", "required": [ "configInfo", "workingPathReverseOutLinkPointerList", "workingPathForwardOutLinkPointerList", "workingPathStaticHopNameList", "protectingPathReverseOutLinkPointerList", "protectingPathForwardOutLinkPointerList", "protectingPathStaticHopNameList" ], "type": "object", "properties": { "configInfo": { "allOf": [ { "$ref": "#/components/schemas/GlobalTPLspConfigInfo" }, { "description": "Model containing the method level model for Interface ConfigInfo GlobalTPLspConfigInfo. to decode json data to internal NFM-P object model" } ] }, "workingPathReverseOutLinkPointerList": { "type": "array", "items": { "type": "string" }, "description": "An ordered list of reverse out-link interface pointers for the working path (from LER A towards LER B, one direction only), if theworking path is configured.{p}In the given example above, the workingPathReverseOutLinkPointerList will contain MPLS interface pointers for a1, c2 and d2." }, "workingPathForwardOutLinkPointerList": { "type": "array", "items": { "type": "string" }, "description": "An ordered list of forward out-link interface pointers for the working path (from LER A towards LER B, one direction only), if theworking path is configured.{p}In the given example above, the workingPathForwardOutLinkPointerList will contain MPLS interface pointers for c1, d1 and b1." }, "workingPathStaticHopNameList": { "type": "array", "items": { "type": "string" }, "description": "An ordered list of names for the static hops to be created for the working path (from LER A towards LER B, one direction only), if theworking path is configured.{p}In the given example above, the workingPathStaticHopNameList will contain LSR path names for C and D." }, "protectingPathReverseOutLinkPointerList": { "type": "array", "items": { "type": "string" }, "description": "An ordered list of reverse out-Link interface pointers for the protecting path (from LER A towards LER B, one direction only), if theprotecting path is configured.{p}In the given example above, the protectingPathReverseOutLinkPointerList will contain MPLS interface pointers for a2 and e2." }, "protectingPathForwardOutLinkPointerList": { "type": "array", "items": { "type": "string" }, "description": "An ordered list of forward out-link interface pointers for the protecting path (from LER A towards LER B, one direction only), if theprotecting path is configured.{p}In the given example above, the protectingPathForwardOutLinkPointerList will contain MPLS interface pointers for e1 and b2." }, "protectingPathStaticHopNameList": { "type": "array", "items": { "type": "string" }, "description": "An ordered list of names for the static hops to be created for the protecting path (from LER A towards LER B, one direction only), if theprotecting path is configured.{p}In the given example above, the protectingPathStaticHopNameList will contain LSR path name for E." } }, "description": "Model containing the method level model for GlobalTPLsp.createWithAutoFillForIncompleteConnections to decode json data to internal NFM-P object model" }, "igpShortestPathFirstGraphExt": { "title": "igpShortestPathFirstGraphExt", "required": [ "igpAdminDomain", "sourceType", "source", "sourceLen", "destType", "dest", "destLen" ], "type": "object", "properties": { "igpAdminDomain": { "type": "string", "description": "The IGP Admin Domain ({{topology.AutonomousSystem}}) to perform the SPF in." }, "sourceType": { "type": "string", "description": "The address type of the source. Currently only ipv4 issupported." }, "source": { "type": "string", "description": "The source address of the managed route. The format ofthe source is based on the sourceType property." }, "sourceLen": { "type": "integer", "description": "The length of the source address. Its valid values dependon the sourceType.", "format": "int32" }, "destType": { "type": "string", "description": "The address type of the destination. Currently only ipv4 issupported." }, "dest": { "type": "string", "description": "The destination address of the managed route. The format ofthe destination is based on the destType property." }, "destLen": { "type": "integer", "description": "The length of the destination address. Its valid valuesdepend on the destType.", "format": "int32" } }, "description": "Model containing the method level model for TopologyManager.igpShortestPathFirstGraphExt to decode json data to internal NFM-P object model" }, "saveUXPrefs": { "title": "saveUXPrefs", "required": [ "prefName", "contents" ], "type": "object", "properties": { "prefName": { "type": "string", "description": "The preference name." }, "contents": { "type": "string", "description": "The preferences." } }, "description": "Model containing the method level model for UserGroup.saveUXPrefs to decode json data to internal NFM-P object model" }, "findQueueQroupPolicesAppliedOnPortResponse": { "title": "findQueueQroupPolicesAppliedOnPortResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for NetworkInterface.findQueueQroupPolicesAppliedOnPort to encode json response from internal NFM-P object model" }, "RoutingAlarmTypeInfo": { "title": "RoutingAlarmTypeInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" } }, "description": "Model containing the method level model for Interface RoutingAlarmTypeInfo. to decode json data to internal NFM-P object model" }, "filteredFind": { "title": "filteredFind", "required": [ "instanceFullName", "filter", "scopeType", "scopeDepth", "capabillities" ], "type": "object", "properties": { "instanceFullName": { "type": "string", "description": "The instance full name from the matched objects have to be retrieved." }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "scopeType": { "type": "integer", "description": "Scope type.Possible values - 0 (Single Object), 1 (Single Level), 2 (N_Levels, where N = scopeDepth), 3 (Whole Subtree)", "format": "int32" }, "scopeDepth": { "type": "integer", "description": "The number of levels to be searched.", "format": "int32" }, "capabillities": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Capability ID(s)." } }, "description": "Model containing the method level model for GenericObject.filteredFind to decode json data to internal NFM-P object model" }, "retrieveSAPHostsResponse": { "title": "retrieveSAPHostsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for SubscriberHost.retrieveSAPHosts to encode json response from internal NFM-P object model" }, "generateTeTests": { "title": "generateTeTests", "required": [ "testSuites", "testedEntity" ], "type": "object", "properties": { "testSuites": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "testedEntity": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" } }, "description": "Model containing the method level model for TestManager.generateTeTests to decode json data to internal NFM-P object model" }, "createRollbckCheckPt": { "title": "createRollbckCheckPt", "required": [ "neId", "checkPtComment" ], "type": "object", "properties": { "neId": { "type": "string" }, "checkPtComment": { "type": "string" } }, "description": "Model containing the method level model for RollbackNEInfo.createRollbckCheckPt to decode json data to internal NFM-P object model" }, "removeIpAddressResponse": { "title": "removeIpAddressResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/VirtualRouterIpAddressInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for MultiHomingInterface.removeIpAddress to encode json response from internal NFM-P object model" }, "findLsps": { "title": "findLsps", "required": [ "lspPathFilter", "lspFilter" ], "type": "object", "properties": { "lspPathFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "lspFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for Tunnel.findLsps to decode json data to internal NFM-P object model" }, "findServicePathsResponse": { "title": "findServicePathsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for Lsp.findServicePaths to encode json response from internal NFM-P object model" }, "findApplicableOdukFacilityObjectsResponse": { "title": "findApplicableOdukFacilityObjectsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for ApsGroup.findApplicableOdukFacilityObjects to encode json response from internal NFM-P object model" }, "CardInfo": { "title": "CardInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "administrativeState": { "type": "integer", "format": "int32" }, "oesShelfId": { "type": "integer", "format": "int32" }, "phyShelfClass": { "type": "integer", "format": "int32" }, "phyShelfType": { "type": "integer", "format": "int32" }, "lockOlcState": { "type": "boolean", "default": false }, "slotId": { "type": "integer", "format": "int32" }, "specificType": { "type": "integer", "format": "int32" }, "cardStatus": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for Interface CardInfo. to decode json data to internal NFM-P object model" }, "dhcpStickyLeaseAction": { "title": "dhcpStickyLeaseAction", "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInCircuitId": { "type": "string" }, "aInRoutingInstance": { "type": "string" }, "aInLocalDhcpServerName": { "type": "string" }, "aInAddressPoolName": { "type": "string" }, "aInHostName": { "type": "string" }, "aInMacAddress": { "type": "string" }, "aInClientId": { "type": "string" }, "aInStickyLseAddressType": { "type": "string" }, "aInStickyLseAddress": { "type": "string" }, "aInTimeout": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for AbstractAddressPool.dhcpStickyLeaseAction to decode json data to internal NFM-P object model" }, "generateStmDefaultsResponse": { "title": "generateStmDefaultsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for TestManager.generateStmDefaults to encode json response from internal NFM-P object model" }, "IndexedValue": { "title": "IndexedValue", "required": [ "objectClassName", "index", "value" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "index": { "type": "integer", "format": "int32" }, "value": { "type": "string" } }, "description": "Model containing the method level model for struct IndexedValue. to decode json data to internal NFM-P object model" }, "removeNetworkElementsFromGroupResponse": { "title": "removeNetworkElementsFromGroupResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/GroupBindingInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for Group.removeNetworkElementsFromGroup to encode json response from internal NFM-P object model" }, "retrieveRoutesResponse": { "title": "retrieveRoutesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/RouteResult" }, "description": "The response object." } }, "description": "Model containing the method level model for RouteManager.retrieveRoutes to encode json response from internal NFM-P object model" }, "findWithWorkOrderScanResponse": { "title": "findWithWorkOrderScanResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/PagingResult" }, { "description": "Model containing the method level model for struct PagingResult. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for ActivationManager.findWithWorkOrderScan to encode json response from internal NFM-P object model" }, "SiteUnion": { "title": "SiteUnion", "required": [ "objectClassName", "siteId", "ctdMap", "accessInterface", "staticRoute" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "ctdMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } }, "accessInterface": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" }, { "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } ] }, "staticRoute": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" }, { "description": "Model containing the method level model for struct CommonManagedEntityConfigurationInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for struct SiteUnion. to decode json data to internal NFM-P object model" }, "createMonitoredPath": { "title": "createMonitoredPath", "required": [ "sourceObjectNameSet", "isBidirectional", "pathType" ], "type": "object", "properties": { "sourceObjectNameSet": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The full name of the objects to create monitored paths from." }, "isBidirectional": { "type": "boolean", "description": "Whether to create bidirectional monitored paths or not.If true, all objects for which bidirectional paths cannot be created will be ignored." }, "pathType": { "type": "array", "items": { "type": "string" }, "description": "The LSP path types that are monitored on a LSP path monitor.Only applicable for LSP path monitors, ignored otherwise." } }, "description": "Model containing the method level model for MonitoredPathManager.createMonitoredPath to decode json data to internal NFM-P object model" }, "bgpRetrieveEventForNextHopResponse": { "title": "bgpRetrieveEventForNextHopResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/PagingResult" }, { "description": "Model containing the method level model for struct PagingResult. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for BgpImpactAnalysisTimeRange.bgpRetrieveEventForNextHop to encode json response from internal NFM-P object model" }, "configureSecondaryShapers": { "title": "configureSecondaryShapers", "required": [ "configInfo", "parentFullNameList" ], "type": "object", "properties": { "configInfo": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" }, { "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } ] }, "parentFullNameList": { "type": "array", "items": { "type": "string" }, "description": "The list of physical port full names.Hsmda Egress Secondary Shapers are created under this list of parent objects." } }, "description": "Model containing the method level model for HsmdaEgressSecondaryShaper.configureSecondaryShapers to decode json data to internal NFM-P object model" }, "LicenseConsumption": { "title": "LicenseConsumption", "required": [ "objectClassName", "licensedObj_fdn", "licenseObj_className", "extendSupport", "licensedProduct", "licenseConsumed" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "licensedObj_fdn": { "type": "string" }, "licenseObj_className": { "type": "string" }, "extendSupport": { "type": "string" }, "licensedProduct": { "type": "string" }, "licenseConsumed": { "type": "number" } }, "description": "Model containing the method level model for struct LicenseConsumption. to decode json data to internal NFM-P object model" }, "VirtualInterfaceInfo": { "title": "VirtualInterfaceInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "description": { "type": "string" }, "encapType": { "type": "integer", "format": "int32" }, "administrativeState": { "type": "integer", "format": "int32" }, "portPointer": { "type": "string" }, "innerEncapValue": { "type": "integer", "format": "int32" }, "outerEncapValue": { "type": "integer", "format": "int32" }, "reassembly": { "type": "boolean", "default": false }, "id": { "type": "integer", "format": "int64" }, "physicalAddress": { "type": "string" }, "interfaceClass": { "type": "integer", "format": "int32" }, "unnumberedReferenceType": { "type": "integer", "format": "int32" }, "unnumberedReference": { "type": "string" }, "cflowdType": { "type": "integer", "format": "int32" }, "directedBroadcast": { "type": "boolean", "default": false }, "isTrusted": { "type": "integer", "format": "int32" }, "loopbackEnabled": { "type": "boolean", "default": false }, "pimRPDelayedDownPeriod": { "type": "integer", "format": "int64" }, "pimRPDelayedUpPeriod": { "type": "integer", "format": "int64" }, "initDelayEnable": { "type": "boolean", "default": false }, "ipMtu": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for Interface VirtualInterfaceInfo. to decode json data to internal NFM-P object model" }, "findFaultsResponse": { "title": "findFaultsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "object" }, "description": "The response object." } }, "description": "Model containing the method level model for FaultManager.findFaults to encode json response from internal NFM-P object model" }, "findDaughterCardsResponse": { "title": "findDaughterCardsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/DaughterCardInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for NatIsaGroup.findDaughterCards to encode json response from internal NFM-P object model" }, "getGroupsByFdnForUserResponse": { "title": "getGroupsByFdnForUserResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for SupervisionManager.getGroupsByFdnForUser to encode json response from internal NFM-P object model" }, "retrievePPPoASessionsResponse": { "title": "retrievePPPoASessionsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for PPPoASession.retrievePPPoASessions to encode json response from internal NFM-P object model" }, "updateMasterResponse": { "title": "updateMasterResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for PolicySyncGroup.updateMaster to encode json response from internal NFM-P object model" }, "configureAdditionalTextPolicyResponse": { "title": "configureAdditionalTextPolicyResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for AdditionalTextPolicy.configureAdditionalTextPolicy to encode json response from internal NFM-P object model" }, "RetrievingSlaProfileInstStruct": { "title": "RetrievingSlaProfileInstStruct", "required": [ "objectClassName", "spiGroupType", "siteId", "subscrIdent", "portName", "innerEncap", "outerEncap", "slaProfileName", "spiGroupId", "timeout" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "spiGroupType": { "type": "string" }, "siteId": { "type": "string" }, "subscrIdent": { "type": "string" }, "portName": { "type": "string" }, "innerEncap": { "type": "integer", "format": "int64" }, "outerEncap": { "type": "integer", "format": "int64" }, "slaProfileName": { "type": "string" }, "spiGroupId": { "type": "integer", "format": "int64" }, "timeout": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct RetrievingSlaProfileInstStruct. to decode json data to internal NFM-P object model" }, "previewScriptWithParameters": { "title": "previewScriptWithParameters", "required": [ "scriptFullName", "parameters" ], "type": "object", "properties": { "scriptFullName": { "type": "string", "description": "Identifies the script to preview (version is not needed as latest version is previewed)." }, "parameters": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TargetParameterConfigInfo" }, "description": "The configuration info for the targets when previewing." } }, "description": "Model containing the method level model for ScriptManager.previewScriptWithParameters to decode json data to internal NFM-P object model" }, "setEpsPeerAdminState": { "title": "setEpsPeerAdminState", "required": [ "siteId", "epsType", "linkIndex", "adminState" ], "type": "object", "properties": { "siteId": { "type": "string" }, "epsType": { "type": "string" }, "linkIndex": { "type": "integer", "format": "int64" }, "adminState": { "type": "string" } }, "description": "Model containing the method level model for MmeEpsPeerSummary.setEpsPeerAdminState to decode json data to internal NFM-P object model" }, "retrieveWlanGwTunnelCount": { "title": "retrieveWlanGwTunnelCount", "required": [ "siteId", "tunnelServiceId", "remoteAddr", "localAddr", "addrFamily", "encap", "vlanEncapTag1", "vlanEncapTag2", "apSapPortId", "apSapEncap", "numUeMin", "numUeMax", "apMacAddressFailed", "ueType", "timeout" ], "type": "object", "properties": { "siteId": { "type": "string", "description": "Specifies the Network Element to query." }, "tunnelServiceId": { "type": "integer", "description": "Specifies the identifier of the service corresponding to thevirtual router instance where the tunneled traffic is routed.Valid values are -1 for the Base Routing Instance, or a validVPRN Service ID. default:0", "format": "int64" }, "remoteAddr": { "type": "string", "description": "Specifies the IP address of the remote endpoint of the tunnel. default:" }, "localAddr": { "type": "string", "description": "Specifies the IP address of the local endpoint of the tunnel. default:" }, "addrFamily": { "type": "string", "description": "Specifies the address family of the IP layer of the tunnel.The only values allowed are 'ipv4' and 'ipv6'. default:0" }, "encap": { "type": "array", "items": { "type": "string" }, "description": "Specifies the encapsulation types present in the traffic received through a tunnel. default:0" }, "vlanEncapTag1": { "type": "integer", "description": "Specifies the VLAN tag in case of IEEE 802.1Q encapsulation,or the outer tag (service tag, ethertype 0x88a8) in case of IEEE 802.1ad encapsulation,present in the traffic received through a tunnel. This parameteris only valid when the encap type is 'vlan'. If the encap value is not 'vlan',the value of vlanEncapTag1 must be the default minus one. default:-1", "format": "int32" }, "vlanEncapTag2": { "type": "integer", "description": "Specifies the inner tag (customer tag, ethertype 0x8100) in case of qinq encapsulationpresent in the traffic received through a tunnel.This parameter is only valid when the encap type is 'vlan'. If the encap value is not 'vlan',the value of vlanEncapTag2 must be the default minus one. default:-1", "format": "int32" }, "apSapPortId": { "type": "integer", "description": "Specifies the ID of the access port of the Access Point.If the encap value is not 'vlan', the value of apSapPortId must be the default 'invalid port ID'(503316480).Typically, the values of apSapPortId and apSapEncap are set together. default:503316480", "format": "int64" }, "apSapEncap": { "type": "integer", "description": "Specifies the value of the label used to identify the SAP of the Access Point.If the encap value is not 'vlan', the value of apSapEncap must be the default zero.Typically, the values of apSapEncap and apSapPortId are set together. default:0", "format": "int64" }, "numUeMin": { "type": "integer", "description": "Specifies the minimum number of UE's in the tunnel. default:0", "format": "int64" }, "numUeMax": { "type": "integer", "description": "Specifies the maximum number of UE's in the tunnel. default:4294967295", "format": "int64" }, "apMacAddressFailed": { "type": "string", "description": "Specifies if the learning of the MAC address of the Access Point failed. default:dontCare" }, "ueType": { "type": "array", "items": { "type": "string" }, "description": "Specifies the set of UE type values.When the value of ueType is not zero, the response will contain only objectswhere the number of UE's in one of the states corresponding to ueTypeis within the range of numUeMin and numUeMax. Typically, numUeMin will haveto be set to a non-default value of 1 or higher. default:0" }, "timeout": { "type": "integer", "description": "Specifies the timeout in milliseconds to wait before receiving the results.If no results are received in the given time, the method returns.This is an optional input parameter. The default value is 5 minutes (300000ms). default:300000", "format": "int64" } }, "description": "Model containing the method level model for WlanGwQbtTunnel.retrieveWlanGwTunnelCount to decode json data to internal NFM-P object model" }, "removeWlanGwUeCallTraceJobResponse": { "title": "removeWlanGwUeCallTraceJobResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for CallTraceConfig.removeWlanGwUeCallTraceJob to encode json response from internal NFM-P object model" }, "CreatePreProvNeResult": { "title": "CreatePreProvNeResult", "required": [ "objectClassName", "sessionFdn", "woFileName" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "sessionFdn": { "type": "string" }, "woFileName": { "type": "string" } }, "description": "Model containing the method level model for struct CreatePreProvNeResult. to decode json data to internal NFM-P object model" }, "getUpstreamRouters": { "title": "getUpstreamRouters", "required": [ "targetIp", "targetType", "serviceId", "svcComponentId" ], "type": "object", "properties": { "targetIp": { "type": "string" }, "targetType": { "type": "integer", "format": "int32" }, "serviceId": { "type": "integer", "format": "int64" }, "svcComponentId": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for UpstreamRouterBinding.getUpstreamRouters to decode json data to internal NFM-P object model" }, "validatePathResponse": { "title": "validatePathResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int32" } }, "description": "Model containing the method level model for MonitoredPath.validatePath to encode json response from internal NFM-P object model" }, "updateSchedule": { "title": "updateSchedule", "required": [ "sessionFdn", "scheduled", "scheduledAt", "suspendScheduledSession", "closeScheduledSession" ], "type": "object", "properties": { "sessionFdn": { "type": "string", "description": "The session to schedule unschedule" }, "scheduled": { "type": "boolean", "description": "True to schedule; false to un-schedule." }, "scheduledAt": { "type": "integer", "description": "Time to schedule. Only interpreted if scheduled is true.", "format": "int64" }, "suspendScheduledSession": { "type": "boolean", "description": "True to suspend the session to allow other actions on the NE; false to continue to lock the NE and forbid all actions on the NE until the end of the session." }, "closeScheduledSession": { "type": "boolean", "description": "True to closed the session at the end of the scheduled session; false to do nothing." } }, "description": "Model containing the method level model for Session.updateSchedule to decode json data to internal NFM-P object model" }, "ConnProfPolicyInfo": { "title": "ConnProfPolicyInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "description": { "type": "string" }, "id": { "type": "integer", "format": "int64" }, "templateObject": { "type": "string" }, "policyMode": { "type": "integer", "format": "int32" }, "configurationAction": { "type": "integer", "format": "int32" }, "rangeList": { "type": "string" } }, "description": "Model containing the method level model for Interface ConnProfPolicyInfo. to decode json data to internal NFM-P object model" }, "getAuditStatusResponse": { "title": "getAuditStatusResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/AuditStatus" }, { "description": "Model containing the method level model for struct AuditStatus. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for Manager.getAuditStatus to encode json response from internal NFM-P object model" }, "getStatsMibPolicyResponse": { "title": "getStatsMibPolicyResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/AbstractStatsPollerPolicy" }, { "description": "Managed object abstract class" } ] } }, "description": "Model containing the method level model for PollerManager.getStatsMibPolicy to encode json response from internal NFM-P object model" }, "SubscriberQosOverrideRtrvStruct": { "title": "SubscriberQosOverrideRtrvStruct", "required": [ "objectClassName", "subIdent", "siteId", "timeOut" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "subIdent": { "type": "string" }, "siteId": { "type": "string" }, "timeOut": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct SubscriberQosOverrideRtrvStruct. to decode json data to internal NFM-P object model" }, "invokeResyncDbInfoTransitSubscriber": { "title": "invokeResyncDbInfoTransitSubscriber", "required": [ "siteId", "isaGrpPartIndex" ], "type": "object", "properties": { "siteId": { "type": "string", "description": "Network Element site IP address." }, "isaGrpPartIndex": { "type": "integer", "description": "The ISA-AA Group Partition Index.", "format": "int64" } }, "description": "Model containing the method level model for DbInfoTransitSubscriber.invokeResyncDbInfoTransitSubscriber to decode json data to internal NFM-P object model" }, "upgradeFirmware": { "title": "upgradeFirmware", "required": [ "networkElements", "simId" ], "type": "object", "properties": { "networkElements": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "simId": { "type": "integer", "description": "default:1", "format": "int32" } }, "description": "Model containing the method level model for FirmwareFolderDescriptor.upgradeFirmware to decode json data to internal NFM-P object model" }, "findDownstreamSdpBindingsResponse": { "title": "findDownstreamSdpBindingsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for Vll.findDownstreamSdpBindings to encode json response from internal NFM-P object model" }, "clearCcrtReplaySession": { "title": "clearCcrtReplaySession", "required": [ "siteId", "diameterAppPolicy" ], "type": "object", "properties": { "siteId": { "type": "string", "description": "Specifies the NE.This is a required input parameter." }, "diameterAppPolicy": { "type": "string", "description": "Specifies the Diameter Application Policy name.This is a required input parameter." } }, "description": "Model containing the method level model for DiameterAppPolicy.clearCcrtReplaySession to decode json data to internal NFM-P object model" }, "configureKeyGroupRIBindingsResponse": { "title": "configureKeyGroupRIBindingsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "boolean", "description": "The response object." } }, "description": "Model containing the method level model for Domain.configureKeyGroupRIBindings to encode json response from internal NFM-P object model" }, "retrieveWlanGwUeCount": { "title": "retrieveWlanGwUeCount", "required": [ "timeout" ], "type": "object", "properties": { "aInBridgeId": { "type": "integer", "format": "int32" }, "aUeQueryStruct": { "allOf": [ { "$ref": "#/components/schemas/WlanGwQbtUeQueryStruct" }, { "description": "Model containing the method level model for struct WlanGwQbtUeQueryStruct. to decode json data to internal NFM-P object model" } ] }, "aInVlanQTag": { "type": "integer", "format": "int32" }, "timeout": { "type": "integer", "description": "Specifies the timeout in milliseconds to wait before receiving the results. If no results are received in the given time, the method returns. This is an optional input parameter. The default value is 5 minutes (300000ms). default:0", "format": "int64" } }, "description": "Model containing the method level model for WlanGwQbtUe.retrieveWlanGwUeCount to decode json data to internal NFM-P object model" }, "findVprnServiceResponse": { "title": "findVprnServiceResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for Domain.findVprnService to encode json response from internal NFM-P object model" }, "load": { "title": "load", "required": [ "sessionFdn", "neWorkOrders" ], "type": "object", "properties": { "sessionFdn": { "type": "string", "description": "The session to validate." }, "neWorkOrders": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The set of NE work orders to load. The NE work orders must be in the given session." } }, "description": "Model containing the method level model for Session.load to decode json data to internal NFM-P object model" }, "ConnectionTerminationPointInfo": { "title": "ConnectionTerminationPointInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" } }, "description": "Model containing the method level model for Interface ConnectionTerminationPointInfo. to decode json data to internal NFM-P object model" }, "SearchClassData": { "title": "SearchClassData", "required": [ "fullClassName" ], "type": "object", "properties": { "fullClassName": { "type": "string", "description": "ex: packageName.className", "example": "String" }, "simpleAttributeAndFilter": { "type": "object", "additionalProperties": { "type": "string" }, "description": "ex: {\"attribute1\":\"value1\",\"attribute2\":\"value2\"}" } }, "description": "Model containing the Data model to search for classes" }, "compareObjects": { "title": "compareObjects", "required": [ "comparisonFilter", "compareStarter", "base", "compareTo" ], "type": "object", "properties": { "comparisonFilter": { "allOf": [ { "$ref": "#/components/schemas/ComparisonFilter" }, { "description": "Model containing the method level model for struct ComparisonFilter. to decode json data to internal NFM-P object model" } ] }, "compareStarter": { "type": "string", "description": "The compare starter object that is implementing the StructCompareStartIf which,starts the comparison between the base and compareTo. CompareStrater is only usedwhen comparing structs and is not used when comparing managed objects." }, "base": { "type": "string", "description": "The base of the comparison." }, "compareTo": { "type": "string", "description": "The base is being compared to this object." } }, "description": "Model containing the method level model for GenericObject.compareObjects to decode json data to internal NFM-P object model" }, "retrieveChannelsResponse": { "title": "retrieveChannelsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for IngrPathMgmtOperationalChannelMda.retrieveChannels to encode json response from internal NFM-P object model" }, "retrieveSubSdpError": { "title": "retrieveSubSdpError", "required": [ "timeout" ], "type": "object", "properties": { "aInReportedTimeMinutes": { "type": "integer", "format": "int32" }, "aInReportedTimeSeconds": { "type": "integer", "format": "int32" }, "aInReportedTimeHours": { "type": "integer", "format": "int32" }, "aInSdpId": { "type": "integer", "format": "int64" }, "aInReportedTimeDay": { "type": "integer", "format": "int32" }, "aInReportedTimeMonth": { "type": "integer", "format": "int32" }, "aInReportedTimeYear": { "type": "integer", "format": "int32" }, "aInSdpBndIndex": { "type": "integer", "format": "int64" }, "aInSiteId": { "type": "string" }, "aInVcId": { "type": "integer", "format": "int64" }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait before receiving the results.The method returns if no results are received in the given time.This is an optional input parameter. The default value is 5 minutes (300000). default:300000", "format": "int64" } }, "description": "Model containing the method level model for SubscrSdpError.retrieveSubSdpError to decode json data to internal NFM-P object model" }, "impactAnalysisResponse": { "title": "impactAnalysisResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "object", "additionalProperties": { "type": "object" }, "description": "The response object." } }, "description": "Model containing the method level model for AbstractImpactAnalysisTimeRange.impactAnalysis to encode json response from internal NFM-P object model" }, "executeValidatorResponse": { "title": "executeValidatorResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for TestManager.executeValidator to encode json response from internal NFM-P object model" }, "FndAndClassList": { "title": "FndAndClassList", "type": "object", "properties": { "fdn": { "type": "string" }, "fullClassNameList": { "type": "array", "items": { "type": "string" }, "description": "" } }, "description": "Model containing a NFM-P FDN as a string and a list of children class name, Example: {'fdn':'securityManager', 'fullClassNameList:['security.User','security.Group']'}" }, "createDataServicePathSearch": { "title": "createDataServicePathSearch", "type": "object", "properties": { "aInDataServiceTemplateFdn": { "type": "string" }, "aInExistingDataServiceFdn": { "type": "string" }, "aInDataServiceOuterEncap": { "type": "integer", "format": "int32" }, "aInDataServiceInnerEncap": { "type": "integer", "format": "int32" }, "aInSiteIds": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "aInTspFdn": { "type": "string" } }, "description": "Model containing the method level model for Ring.createDataServicePathSearch to decode json data to internal NFM-P object model" }, "OpticalLinkInfo": { "title": "OpticalLinkInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "networkElementEndpointAPointer": { "type": "string" }, "networkElementEndpointBPointer": { "type": "string" }, "endpointAPointer": { "type": "string" }, "endpointBPointer": { "type": "string" }, "endPointASiteId": { "type": "string" }, "endPointBSiteId": { "type": "string" }, "endPointAType": { "type": "integer", "format": "int32" }, "endPointBType": { "type": "integer", "format": "int32" }, "usesManagedEndpointB": { "type": "boolean", "default": false }, "endpointALagInterfacePointer": { "type": "string" }, "endpointBLagInterfacePointer": { "type": "string" }, "endpointABundleInterfacePointer": { "type": "string" }, "endpointBBundleInterfacePointer": { "type": "string" }, "latency": { "type": "integer", "format": "int64" }, "opticalLinkId": { "type": "integer", "format": "int64" }, "notes": { "type": "string" }, "linkDirection": { "type": "integer", "format": "int32" }, "unManagedNEEndPoint": { "type": "string" }, "gneInterfaceEndpointAPointer": { "type": "string" }, "gneInterfaceEndpointBPointer": { "type": "string" }, "assignedRateEndPointA": { "type": "integer", "format": "int32" }, "assignedRateEndPointB": { "type": "integer", "format": "int32" }, "shelfId": { "type": "integer", "format": "int64" }, "endpointASnmpPortId": { "type": "integer", "format": "int64" }, "endpointBSnmpPortId": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for Interface OpticalLinkInfo. to decode json data to internal NFM-P object model" }, "auditResponse": { "title": "auditResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/AuditStatus" }, { "description": "Model containing the method level model for struct AuditStatus. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for AuditManager.audit to encode json response from internal NFM-P object model" }, "getSyncTaskResultResponse": { "title": "getSyncTaskResultResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int32" } }, "description": "Model containing the method level model for PolicyDefinition.getSyncTaskResult to encode json response from internal NFM-P object model" }, "findServicesUsingTunnelResponse": { "title": "findServicesUsingTunnelResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "object" }, "description": "The response object." } }, "description": "Model containing the method level model for CacManager.findServicesUsingTunnel to encode json response from internal NFM-P object model" }, "updateAutoRelease": { "title": "updateAutoRelease", "required": [ "sessionFdn", "autoRelease", "neWorkOrders" ], "type": "object", "properties": { "sessionFdn": { "type": "string", "description": "The session." }, "autoRelease": { "type": "boolean", "description": "True to auto release; false to keep in session" }, "neWorkOrders": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The set of NE work orders to auto-release. The NE work orders must be in the given session." } }, "description": "Model containing the method level model for Session.updateAutoRelease to decode json data to internal NFM-P object model" }, "getScriptContentsResponse": { "title": "getScriptContentsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for AbstractVersion.getScriptContents to encode json response from internal NFM-P object model" }, "findAllServerTrailsResponse": { "title": "findAllServerTrailsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/TrailInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for Trail.findAllServerTrails to encode json response from internal NFM-P object model" }, "executeViewCheckPointResponse": { "title": "executeViewCheckPointResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for RollbackNEInfo.executeViewCheckPoint to encode json response from internal NFM-P object model" }, "findFaultResponse": { "title": "findFaultResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/AlarmObject" }, { "description": "Model containing the method level model for struct AlarmObject. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for FaultManager.findFault to encode json response from internal NFM-P object model" }, "auditLocalPolicyWithInApplicableAttributeOptionResponse": { "title": "auditLocalPolicyWithInApplicableAttributeOptionResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/AuditLocalPolicyResultInfo" }, { "description": "Model containing the method level model for struct AuditLocalPolicyResultInfo. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for Manager.auditLocalPolicyWithInApplicableAttributeOption to encode json response from internal NFM-P object model" }, "requestClearIsaSubnetsResponse": { "title": "requestClearIsaSubnetsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for IsaPoolSubnet.requestClearIsaSubnets to encode json response from internal NFM-P object model" }, "findAlarmsForOfnsResponse": { "title": "findAlarmsForOfnsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AlarmListsStruct" }, "description": "The response object." } }, "description": "Model containing the method level model for FaultManager.findAlarmsForOfns to encode json response from internal NFM-P object model" }, "retrieveVRFStaticRoutesResponse": { "title": "retrieveVRFStaticRoutesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for StaticRoute.retrieveVRFStaticRoutes to encode json response from internal NFM-P object model" }, "getDeployersShallowResponse": { "title": "getDeployersShallowResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/DeployerInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for GenericObject.getDeployersShallow to encode json response from internal NFM-P object model" }, "retrieveWlanGwUesByMacAddrResponse": { "title": "retrieveWlanGwUesByMacAddrResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for WlanGwUe.retrieveWlanGwUesByMacAddr to encode json response from internal NFM-P object model" }, "retrieveManagedSubscriberHostsResponse": { "title": "retrieveManagedSubscriberHostsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for ManagedSubscriberHost.retrieveManagedSubscriberHosts to encode json response from internal NFM-P object model" }, "SeverityChangeThresholdConfigInfo": { "title": "SeverityChangeThresholdConfigInfo", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap", "containmentInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } }, "direction": { "type": "integer", "format": "int32" }, "frequencyThreshold": { "type": "integer", "format": "int64" }, "associatedSeverity": { "type": "integer", "format": "int32" }, "occurrenceThreshold": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for Interface ConfigInfo SeverityChangeThresholdConfigInfo. to decode json data to internal NFM-P object model" }, "retrieveGtpS11SessionsResponse": { "title": "retrieveGtpS11SessionsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for S11Session.retrieveGtpS11Sessions to encode json response from internal NFM-P object model" }, "listSummaryViewsResponse": { "title": "listSummaryViewsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for SupervisionGroup.listSummaryViews to encode json response from internal NFM-P object model" }, "cancelScriptFlow": { "title": "cancelScriptFlow", "required": [ "clientId", "targetScriptResultObjectFullNameToBeCanceled", "targetScriptConfig" ], "type": "object", "properties": { "clientId": { "type": "string", "description": "Identifies the client ID that requested the execution (used for sending an event to the specific client when execution is complete)." }, "targetScriptResultObjectFullNameToBeCanceled": { "type": "string", "description": "The FDN of target script result object to cancel.This result object is returned by method executeScriptFlow." }, "targetScriptConfig": { "allOf": [ { "$ref": "#/components/schemas/TargetScriptConfigInfo" }, { "description": "Model containing the method level model for Interface ConfigInfo TargetScriptConfigInfo. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for ScriptManager.cancelScriptFlow to decode json data to internal NFM-P object model" }, "findProvisionedPathResponse": { "title": "findProvisionedPathResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/Path" }, { "description": "Managed object abstract class" } ] } }, "description": "Model containing the method level model for Tunnel.findProvisionedPath to encode json response from internal NFM-P object model" }, "asyncCheckConfig": { "title": "asyncCheckConfig", "required": [ "fdnPolicy" ], "type": "object", "properties": { "aInContext": { "allOf": [ { "$ref": "#/components/schemas/Context" }, { "description": "Model containing the method level model for struct Context. to decode json data to internal NFM-P object model" } ] }, "aInFdn": { "type": "string" }, "fdnPolicy": { "type": "string", "description": "The FDN of Audit policy which it will be used, it can null." } }, "description": "Model containing the method level model for RcaManager.asyncCheckConfig to decode json data to internal NFM-P object model" }, "retrieveAaEsmHostsResponse": { "title": "retrieveAaEsmHostsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for AaEsmHostInfo.retrieveAaEsmHosts to encode json response from internal NFM-P object model" }, "ConvertOldDefinitionStruct": { "title": "ConvertOldDefinitionStruct", "required": [ "objectClassName", "sdpTemplatePointer", "lspTemplatePointer" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "sdpTemplatePointer": { "type": "string" }, "lspTemplatePointer": { "type": "string" } }, "description": "Model containing the method level model for struct ConvertOldDefinitionStruct. to decode json data to internal NFM-P object model" }, "findPotentialMembersIfgResponse": { "title": "findPotentialMembersIfgResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for RuleBasedGroup.findPotentialMembersIfg to encode json response from internal NFM-P object model" }, "shortestPathFirstGraphSet": { "title": "shortestPathFirstGraphSet", "required": [ "igpAdminDomain", "protocol", "sourceType", "source", "sourceLen", "destType", "dest", "destLen" ], "type": "object", "properties": { "igpAdminDomain": { "type": "string", "description": "The IGP Admin Domain ({{topology.AutonomousSystem}}) to perform the SPF in." }, "protocol": { "type": "string", "description": "The protocol to run SPF on. Currently OSPF, OSPFv3 and ISIS aresupported." }, "sourceType": { "type": "string", "description": "The address type of the source. Currently ipv4 and ipv6 aresupported." }, "source": { "type": "string", "description": "The source address. The format ofthe source is based on the sourceType property." }, "sourceLen": { "type": "integer", "description": "The length of the source address. Its valid values dependon the sourceType.", "format": "int32" }, "destType": { "type": "string", "description": "The address type of the destination. Currently ipv4 and ipv6 aresupported." }, "dest": { "type": "string", "description": "The destination address. The format ofthe destination is based on the destType property." }, "destLen": { "type": "integer", "description": "The length of the destination address. Its valid valuesdepend on the destType.", "format": "int32" } }, "description": "Model containing the method level model for TopologyManager.shortestPathFirstGraphSet to decode json data to internal NFM-P object model" }, "getEVPNSitesResponse": { "title": "getEVPNSitesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for EvpnSite.getEVPNSites to encode json response from internal NFM-P object model" }, "retrieveSlaProfileInstancesResponse": { "title": "retrieveSlaProfileInstancesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for SlaProfileInstance.retrieveSlaProfileInstances to encode json response from internal NFM-P object model" }, "moveTopologyGroupForObjects": { "title": "moveTopologyGroupForObjects", "required": [ "moveObjectNames", "sourceGroupName", "destinationGroupName" ], "type": "object", "properties": { "moveObjectNames": { "type": "array", "items": { "type": "string" }, "description": "" }, "sourceGroupName": { "type": "string" }, "destinationGroupName": { "type": "string" } }, "description": "Model containing the method level model for TopologyGroupManager.moveTopologyGroupForObjects to decode json data to internal NFM-P object model" }, "shouldWarnUserResponse": { "title": "shouldWarnUserResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for UserStatsQuery.shouldWarnUser to encode json response from internal NFM-P object model" }, "findGLSPsResponse": { "title": "findGLSPsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for ProvisionedPath.findGLSPs to encode json response from internal NFM-P object model" }, "clearCcrtReplayStatistics": { "title": "clearCcrtReplayStatistics", "required": [ "siteId", "diameterAppPolicy" ], "type": "object", "properties": { "siteId": { "type": "string", "description": "Specifies the NE.This is a required input parameter." }, "diameterAppPolicy": { "type": "string", "description": "Specifies the Diameter Application Policy name.This is a required input parameter." } }, "description": "Model containing the method level model for DiameterAppPolicy.clearCcrtReplayStatistics to decode json data to internal NFM-P object model" }, "importIsisRoutingDomain": { "title": "importIsisRoutingDomain", "required": [ "cpaa", "level" ], "type": "object", "properties": { "cpaa": { "type": "string", "description": "The pointer to the CPAA." }, "level": { "type": "string", "description": "The ISIS level." } }, "description": "Model containing the method level model for IgpTopologyModel.importIsisRoutingDomain to decode json data to internal NFM-P object model" }, "applyStaticPortMapRequestResponse": { "title": "applyStaticPortMapRequestResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/StaticPortMapRequestConfigInfo" }, { "description": "Model containing the method level model for Interface ConfigInfo StaticPortMapRequestConfigInfo. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for StaticPortMapRequest.applyStaticPortMapRequest to encode json response from internal NFM-P object model" }, "configureInstanceWithResult": { "title": "configureInstanceWithResult", "required": [ "distinguishedName", "configInfo", "includeChildren" ], "type": "object", "properties": { "distinguishedName": { "type": "string", "description": "Distinguished Name of object being configured." }, "configInfo": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" }, { "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } ] }, "includeChildren": { "type": "boolean", "description": "If false, only the resulting object will be returned from call.If true, resulting object and all children will be returned.Note that some classes do not return children. In such cases, this is specified in the class documentation." } }, "description": "Model containing the method level model for GenericObject.configureInstanceWithResult to decode json data to internal NFM-P object model" }, "findInstanceResponse": { "title": "findInstanceResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, { "description": "Model containing the method level model for struct CommonManagedEntityInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for GenericObject.findInstance to encode json response from internal NFM-P object model" }, "stopContinuousTestsResponse": { "title": "stopContinuousTestsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for TestManager.stopContinuousTests to encode json response from internal NFM-P object model" }, "getMonitoredObjectsByClassesResponse": { "title": "getMonitoredObjectsByClassesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for SummaryView.getMonitoredObjectsByClasses to encode json response from internal NFM-P object model" }, "compareObjectsResponse": { "title": "compareObjectsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/CompareResult" }, { "description": "Model containing the method level model for struct CompareResult. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for GenericObject.compareObjects to encode json response from internal NFM-P object model" }, "requestClearCpmMacFilterResponse": { "title": "requestClearCpmMacFilterResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for CpmMacFilterEntry.requestClearCpmMacFilter to encode json response from internal NFM-P object model" }, "autoCreateCheckpoints": { "title": "autoCreateCheckpoints", "required": [ "igpAdminDomainPointer", "protocolMask" ], "type": "object", "properties": { "igpAdminDomainPointer": { "type": "string", "description": "The pointer to the IGP admin domain that is beingcheckpointed." }, "protocolMask": { "type": "array", "items": { "type": "string" }, "description": "The protocols to create the checkpoints for." } }, "description": "Model containing the method level model for Checkpoint.autoCreateCheckpoints to decode json data to internal NFM-P object model" }, "validateUpgradePathResponse": { "title": "validateUpgradePathResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/DriverUpgradeInfo" }, { "description": "Model containing the method level model for struct DriverUpgradeInfo. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for GenericNeProfile.validateUpgradePath to encode json response from internal NFM-P object model" }, "AbstractInstanceConfigInfo": { "title": "AbstractInstanceConfigInfo", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap", "containmentInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } }, "vrId": { "type": "integer", "format": "int64" }, "owner": { "type": "integer", "format": "int32" }, "passive": { "type": "integer", "format": "int32" }, "macAddress": { "type": "string" }, "masterIntervalInherit": { "type": "integer", "format": "int32" }, "messageInterval": { "type": "integer", "format": "int64" }, "messageIntervalMilSec": { "type": "integer", "format": "int64" }, "pingReply": { "type": "integer", "format": "int32" }, "preempt": { "type": "integer", "format": "int32" }, "priority": { "type": "integer", "format": "int32" }, "sshReply": { "type": "integer", "format": "int32" }, "telnetReply": { "type": "integer", "format": "int32" }, "traceRouteReply": { "type": "integer", "format": "int32" }, "standByFwding": { "type": "integer", "format": "int32" }, "administrativeState": { "type": "integer", "format": "int32" }, "vrrpPolicyPointer": { "type": "string" }, "initDelay": { "type": "integer", "format": "int64" }, "bfdEnable": { "type": "boolean", "default": false }, "memberOperGroupName": { "type": "string" }, "memberOperGroupPtr": { "type": "string" }, "ntpReply": { "type": "boolean", "default": false }, "templateVersionPointer": { "type": "string" } }, "description": "Model containing the method level model for Interface ConfigInfo AbstractInstanceConfigInfo. to decode json data to internal NFM-P object model" }, "oneTimeValidateResponse": { "title": "oneTimeValidateResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for TestManager.oneTimeValidate to encode json response from internal NFM-P object model" }, "QosPoolConfigInfo": { "title": "QosPoolConfigInfo", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap", "containmentInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } }, "shelfId": { "type": "integer", "format": "int32" }, "equipmentPointer": { "type": "string" }, "equipmentType": { "type": "integer", "format": "int32" }, "appType": { "type": "integer", "format": "int32" }, "appPool": { "type": "string" }, "slopePolicyPointer": { "type": "string" } }, "description": "Model containing the method level model for Interface ConfigInfo QosPoolConfigInfo. to decode json data to internal NFM-P object model" }, "configurePSSCard": { "title": "configurePSSCard", "required": [ "fdn", "cardType" ], "type": "object", "properties": { "fdn": { "type": "string" }, "cardType": { "type": "string" } }, "description": "Model containing the method level model for CardSlot.configurePSSCard to decode json data to internal NFM-P object model" }, "findAssociatedEpipeSitesResponse": { "title": "findAssociatedEpipeSitesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for AbstractVpls.findAssociatedEpipeSites to encode json response from internal NFM-P object model" }, "executeOamTestContext": { "title": "executeOamTestContext", "required": [ "contextType", "testType", "testedEntities", "objectList", "testSuiteName", "continuous", "schedulePointer", "parameterList", "cfmLevel", "timeout" ], "type": "object", "properties": { "contextType": { "type": "string", "description": "This defines the type of object selected by user for OAM Context test generation." }, "testType": { "type": "string", "description": "The type of test to run on the objects provided in the entity object list." }, "testedEntities": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "List of Entity FDN to be tested in this request, applicability of these object types depend on the testType requested." }, "objectList": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "List of Object FDNs to test within the Entity, Used for CFM tests to specify specific Sites, SAPs and SdpBindings.for example: List of SAPs inside a VPLS entity, will only test between the specified SAPs." }, "testSuiteName": { "type": "string", "description": "This defines the Test Suite name to use for this context request. default:" }, "continuous": { "type": "boolean", "description": "This create tests as continuously executed, only applicable to CFM and IcmpPing type tests. default:false" }, "schedulePointer": { "type": "string", "description": "This provides the FDN of the execution schedule to use on the generated Test Suite. default:" }, "parameterList": { "type": "array", "items": { "type": "string" }, "description": "The parameterList is a list of property and value pairs, in orderfor example: [Test.ATTR_displayedName, \"Test Name\", Test.ATTR_PacketsToSend, \"5\"]generated tests will use the properties in the list set if applicable." }, "cfmLevel": { "type": "integer", "description": "The CFM Maintenance Domain Level the tests will execute on, this is only applicable to CFM test types. Default: 7 default:7", "format": "int32" }, "timeout": { "type": "integer", "description": "The length of time to wait for the results to be collected (in minutes). Default: 2 default:2", "format": "int32" } }, "description": "Model containing the method level model for TestManager.executeOamTestContext to decode json data to internal NFM-P object model" }, "CommonManagedContainmentEntityInformation": { "title": "CommonManagedContainmentEntityInformation", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityInformation. to decode json data to internal NFM-P object model" }, "getTimeZoneResponse": { "title": "getTimeZoneResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for Policy.getTimeZone to encode json response from internal NFM-P object model" }, "CommonManagedContainmentEntityConfigurationInformation": { "title": "CommonManagedContainmentEntityConfigurationInformation", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap", "containmentInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } } }, "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" }, "retrieveScriptSnippetReservedIdentifiersResponse": { "title": "retrieveScriptSnippetReservedIdentifiersResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for DynSvcSnippetInfo.retrieveScriptSnippetReservedIdentifiers to encode json response from internal NFM-P object model" }, "Vertex": { "title": "Vertex", "required": [ "objectClassName", "fdn", "egressEdges" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "fdn": { "type": "string" }, "egressEdges": { "type": "array", "items": { "$ref": "#/components/schemas/Edge" }, "description": "" } }, "description": "Model containing the method level model for struct Vertex. to decode json data to internal NFM-P object model" }, "findInstanceApsGroupsResponse": { "title": "findInstanceApsGroupsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for MultiChassisApsGroupContainer.findInstanceApsGroups to encode json response from internal NFM-P object model" }, "associateExecutableScriptResponse": { "title": "associateExecutableScriptResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, { "description": "Model containing the method level model for struct CommonManagedEntityInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for ControlScript.associateExecutableScript to encode json response from internal NFM-P object model" }, "retrieveQosResponse": { "title": "retrieveQosResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for WlanGwTuQos.retrieveQos to encode json response from internal NFM-P object model" }, "getNesAndSubgroupsForTopologyGroupResponse": { "title": "getNesAndSubgroupsForTopologyGroupResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for TopologyGroupManager.getNesAndSubgroupsForTopologyGroup to encode json response from internal NFM-P object model" }, "getServiceSitesResponse": { "title": "getServiceSitesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "object" }, "description": "The response object." } }, "description": "Model containing the method level model for CompositeService.getServiceSites to encode json response from internal NFM-P object model" }, "retrievePccRule": { "title": "retrievePccRule", "required": [ "retrievePccRuleStruct", "retrievePccRuleFlowEntry" ], "type": "object", "properties": { "retrievePccRuleStruct": { "allOf": [ { "$ref": "#/components/schemas/RetrievePccRuleStruct" }, { "description": "Model containing the method level model for struct RetrievePccRuleStruct. to decode json data to internal NFM-P object model" } ] }, "retrievePccRuleFlowEntry": { "type": "boolean", "description": "Specifies if Flow Entries should be retrieved,the default is \"true\". default:true" } }, "description": "Model containing the method level model for SubscriberPccRuleEntry.retrievePccRule to decode json data to internal NFM-P object model" }, "findDataBearerLinksResponse": { "title": "findDataBearerLinksResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/DbLinkInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for OTUTrail.findDataBearerLinks to encode json response from internal NFM-P object model" }, "configureChildInstanceResponse": { "title": "configureChildInstanceResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for GenericObject.configureChildInstance to encode json response from internal NFM-P object model" }, "retrieveL2TPSessionResponse": { "title": "retrieveL2TPSessionResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for SubscriberHost.retrieveL2TPSession to encode json response from internal NFM-P object model" }, "configureTargetResponse": { "title": "configureTargetResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for AbstractScript.configureTarget to encode json response from internal NFM-P object model" }, "bgpPerNextHopSummary": { "title": "bgpPerNextHopSummary", "required": [ "nextHopAddr", "eventAdded", "filter", "fields", "sortFields", "pageNumber", "pageSize" ], "type": "object", "properties": { "nextHopAddr": { "type": "string" }, "eventAdded": { "type": "boolean" }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "fields": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Sorting fields" }, "sortFields": { "type": "array", "items": { "type": "string" }, "description": "Sorting fields" }, "pageNumber": { "type": "integer", "description": "Page number", "format": "int32" }, "pageSize": { "type": "integer", "description": "The number of entries to return", "format": "int32" } }, "description": "Model containing the method level model for BgpImpactAnalysisTimeRange.bgpPerNextHopSummary to decode json data to internal NFM-P object model" }, "createPreProvNeFromTemplateResponse": { "title": "createPreProvNeFromTemplateResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/CreatePreProvNeResult" }, { "description": "Model containing the method level model for struct CreatePreProvNeResult. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for PreProvisionedNe.createPreProvNeFromTemplate to encode json response from internal NFM-P object model" }, "StaticPortMapRequestConfigInfo": { "title": "StaticPortMapRequestConfigInfo", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap", "containmentInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } }, "id": { "type": "integer", "format": "int32" }, "nodeId": { "type": "string" }, "routerId": { "type": "integer", "format": "int32" }, "redundantNodeId": { "type": "string" }, "redundantRouterId": { "type": "integer", "format": "int32" }, "redundantRouterNamePointer": { "type": "string" }, "subType": { "type": "integer", "format": "int32" }, "actionType": { "type": "integer", "format": "int32" }, "ipAddressType": { "type": "integer", "format": "int32" }, "ipAddress": { "type": "string" }, "b4AddressType": { "type": "integer", "format": "int32" }, "ipv6B4Address": { "type": "string" }, "aftrAddressType": { "type": "integer", "format": "int32" }, "ipv6AftrAddress": { "type": "string" }, "subIdent": { "type": "string" }, "port": { "type": "integer", "format": "int32" }, "protocol": { "type": "integer", "format": "int32" }, "outPort": { "type": "integer", "format": "int32" }, "outIpAddressType": { "type": "integer", "format": "int32" }, "outIpAddress": { "type": "string" }, "actionGo": { "type": "integer", "format": "int32" }, "timeout": { "type": "integer", "format": "int64" }, "success": { "type": "boolean", "default": false }, "lastActionTime": { "type": "integer", "format": "int64" }, "targetRouterInstance": { "type": "string" }, "supressDuplicateError": { "type": "boolean", "default": false }, "natPolicyPointer": { "type": "string" }, "redundantNatPolicyPointer": { "type": "string" }, "natFwdSaveConfig": { "type": "boolean", "default": false }, "creationOrigin": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for Interface ConfigInfo StaticPortMapRequestConfigInfo. to decode json data to internal NFM-P object model" }, "retrieveMldGroupIfSapGrp": { "title": "retrieveMldGroupIfSapGrp", "type": "object", "properties": { "aInGrpIfSapFdn": { "type": "string" }, "aInMldSapParams": { "allOf": [ { "$ref": "#/components/schemas/MldSapStruct" }, { "description": "Model containing the method level model for struct MldSapStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for GroupInterfaceSapGroup.retrieveMldGroupIfSapGrp to decode json data to internal NFM-P object model" }, "retrieveIsaPoolSubnets": { "title": "retrieveIsaPoolSubnets", "required": [ "timeout" ], "type": "object", "properties": { "PoolSubnetRtrvStruct": { "allOf": [ { "$ref": "#/components/schemas/PoolSubnetRtrvStruct" }, { "description": "Model containing the method level model for struct PoolSubnetRtrvStruct. to decode json data to internal NFM-P object model" } ] }, "timeout": { "type": "integer", "description": "(Optional) The number of milliseconds to wait beforereceiving the results. If the results are notreceived in the given time, the method returns. default:0", "format": "int64" } }, "description": "Model containing the method level model for IsaPoolSubnet.retrieveIsaPoolSubnets to decode json data to internal NFM-P object model" }, "requestClearIsaSvcChainVasFilterResponse": { "title": "requestClearIsaSvcChainVasFilterResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for SvcChainVasFilterPolicy.requestClearIsaSvcChainVasFilter to encode json response from internal NFM-P object model" }, "retrieveL2AwHostsResponse": { "title": "retrieveL2AwHostsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for L2AwHosts.retrieveL2AwHosts to encode json response from internal NFM-P object model" }, "resyncFreeAddressesResponse": { "title": "resyncFreeAddressesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for AddressPool.resyncFreeAddresses to encode json response from internal NFM-P object model" }, "findSpecificPoliciesResponse": { "title": "findSpecificPoliciesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/SpecificPolicyInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for SpecificPolicy.findSpecificPolicies to encode json response from internal NFM-P object model" }, "findValidTerminatingPortsForServiceResponse": { "title": "findValidTerminatingPortsForServiceResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for ServiceSite.findValidTerminatingPortsForService to encode json response from internal NFM-P object model" }, "retrieveCallTraceFile": { "title": "retrieveCallTraceFile", "required": [ "siteId", "jobStatus", "cpmSlotNumber", "cflashId", "fileName", "timeout" ], "type": "object", "properties": { "siteId": { "type": "string", "description": "Specifies the NE of the call-trace files(s).This is a required input parameter." }, "jobStatus": { "type": "string", "description": "Specifies the stauts of job, value could be either 'running' or 'finished'.This is an optional input parameter. default:-1" }, "cpmSlotNumber": { "type": "integer", "description": "Specifies the CPM slot where the cflash card containing the log file is present.Its value is between 1 and 128.This is an optional input parameter. Its value can only be specified if jobStatus is specified default:0", "format": "int32" }, "cflashId": { "type": "string", "description": "Specifies the ID of the cflash card on the CPM board.Its value could be either cf1 or cf2.This is an optional input parameter. Its value can only be specified if jobStatus and cpmSlotNumber is specified. default:0" }, "fileName": { "type": "string", "description": "Specifies the name of the call-trace file.This is an optional input parameter.Its value can only be specified if jobStatus, cpmSlotNumber andcflashId is specified. default:" }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns. default:300000", "format": "int64" } }, "description": "Model containing the method level model for CallTraceFile.retrieveCallTraceFile to decode json data to internal NFM-P object model" }, "retrieveWlanGwUeCallTraceJobsResponse": { "title": "retrieveWlanGwUeCallTraceJobsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for CallTraceJob.retrieveWlanGwUeCallTraceJobs to encode json response from internal NFM-P object model" }, "generateFromSampleResponse": { "title": "generateFromSampleResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, { "description": "Model containing the method level model for struct CommonManagedEntityInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for XmlApiConfigTemplate.generateFromSample to encode json response from internal NFM-P object model" }, "retrieveDhcpLeaseStateRadiusClasses": { "title": "retrieveDhcpLeaseStateRadiusClasses", "required": [ "siteId", "serviceId", "ipAddressType", "ipAddress", "clientHwAddress", "timeout" ], "type": "object", "properties": { "siteId": { "type": "string", "description": "Site ID for the DHCP Lease State." }, "serviceId": { "type": "integer", "description": "Service ID for service where the DHCP Lease State is.", "format": "int64" }, "ipAddressType": { "type": "integer", "description": "The IP address type of the DHCP Lease State, 1 for IPv4 or 2 for IPv6.This is an optional input parameter. If not specified, address type is inferredfrom IP address input parameter. default:0", "format": "int32" }, "ipAddress": { "type": "string", "description": "The IP address of the DHCP Lease State." }, "clientHwAddress": { "type": "string", "description": "The Client MAC address of the DHCP lease state, e.g. xx-xx-xx-xx-xx-xx." }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait before receiving the results.This is an optional input parameter. The default value is 5 minutes (300000). default:300000", "format": "int64" } }, "description": "Model containing the method level model for DhcpLeaseStateRadiusClassAttribute.retrieveDhcpLeaseStateRadiusClasses to decode json data to internal NFM-P object model" }, "EthernetTunnelEndpointConfigInfo": { "title": "EthernetTunnelEndpointConfigInfo", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap", "containmentInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } }, "administrativeState": { "type": "integer", "format": "int32" }, "oesShelfId": { "type": "integer", "format": "int32" }, "phyShelfClass": { "type": "integer", "format": "int32" }, "phyShelfType": { "type": "integer", "format": "int32" }, "lockOlcState": { "type": "boolean", "default": false }, "portId": { "type": "integer", "format": "int64" }, "description": { "type": "string" }, "mode": { "type": "integer", "format": "int32" }, "isl2UplinkMode": { "type": "boolean", "default": false }, "macAddress": { "type": "string" }, "encapType": { "type": "integer", "format": "int32" }, "holdTimeUp": { "type": "integer", "format": "int32" }, "holdTimeDown": { "type": "integer", "format": "int32" }, "mtuValue": { "type": "integer", "format": "int32" }, "speed": { "type": "integer", "format": "int32" }, "accountingPolicyObjectPointer": { "type": "string" }, "collectStats": { "type": "boolean", "default": false }, "etherAccountingPolicyObjectPointer": { "type": "string" }, "etherCollectStats": { "type": "boolean", "default": false }, "ethAccessAccountingPolicyObjectPointer": { "type": "string" }, "ethAccessCollectStats": { "type": "boolean", "default": false }, "networkQueueObjectPointer": { "type": "string" }, "loadBalanceAlgorithm": { "type": "integer", "format": "int32" }, "portSchedulerPolicyObjectPointer": { "type": "string" }, "portEgrHsmdaSchedulerPolicy": { "type": "string" }, "uniProfilePointer": { "type": "string" }, "portIngrNamedPoolPlcy": { "type": "string" }, "portEgrNamedPoolPlcy": { "type": "string" }, "portIngrPoolPercentageRate": { "type": "integer", "format": "int32" }, "portEgrPoolPercentageRate": { "type": "integer", "format": "int32" }, "vlanAutoBind": { "type": "boolean", "default": false }, "l2ProfilePointer": { "type": "string" }, "holdTimeUnits": { "type": "integer", "format": "int32" }, "linkTrap": { "type": "integer", "format": "int32" }, "userLabel": { "type": "string" }, "mptCombinerImplemented": { "type": "integer", "format": "int64" }, "numOfDot1qSapUsingVCP": { "type": "integer", "format": "int32" }, "isVCPUpdatedForDot1qSap": { "type": "boolean", "default": false }, "isVCPSapPort": { "type": "boolean", "default": false }, "unpPortType": { "type": "integer", "format": "int32" }, "tunnelEndpointId": { "type": "integer", "format": "int32" }, "endPointSiteIdAddrType": { "type": "integer", "format": "int32" }, "endPointSiteId": { "type": "string" }, "protectionType": { "type": "integer", "format": "int32" }, "revertTime": { "type": "integer", "format": "int32" }, "accessAdaptQos": { "type": "integer", "format": "int32" }, "perFpIngQueuing": { "type": "boolean", "default": false }, "pathThreshold": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for Interface ConfigInfo EthernetTunnelEndpointConfigInfo. to decode json data to internal NFM-P object model" }, "requestClearOamPmTwlRawStatsResponse": { "title": "requestClearOamPmTwlRawStatsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for TWLSession.requestClearOamPmTwlRawStats to encode json response from internal NFM-P object model" }, "retrieveSubSlaacHostRadiusClasses": { "title": "retrieveSubSlaacHostRadiusClasses", "required": [ "siteId", "serviceId", "ipAddressType", "ipAddress", "macAddress", "timeout" ], "type": "object", "properties": { "siteId": { "type": "string", "description": "Site ID for the Residential Subscriber SLAAC Host." }, "serviceId": { "type": "integer", "description": "Service ID for the Residential Subscriber SLAAC Host.", "format": "int64" }, "ipAddressType": { "type": "integer", "description": "The IP address type of the Residential Subscriber SLAAC Host, 1 for IPv4 or 2 for IPv6.This is an optional input parameter. If not specified, address type is inferredfrom IP address input parameter. default:0", "format": "int32" }, "ipAddress": { "type": "string", "description": "The IP address of the Residential Subscriber SLAAC Host." }, "macAddress": { "type": "string", "description": "The MAC address of the Residential Subscriber SLAAC Host." }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait before receiving the results.This is an optional input parameter. The default value is 5 minutes (300000). default:300000", "format": "int64" } }, "description": "Model containing the method level model for SubSlaacHostRadiusClassAttribute.retrieveSubSlaacHostRadiusClasses to decode json data to internal NFM-P object model" }, "retrieveWlanGwUesPerBd": { "title": "retrieveWlanGwUesPerBd", "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInTimeout": { "type": "integer", "format": "int64" }, "aInBridgeId": { "type": "integer", "format": "int64" }, "aInMacAddr": { "type": "string" } }, "description": "Model containing the method level model for WlanGwBdUe.retrieveWlanGwUesPerBd to decode json data to internal NFM-P object model" }, "clearPMCountersForSelected": { "title": "clearPMCountersForSelected", "required": [ "fdns", "intervalType" ], "type": "object", "properties": { "fdns": { "type": "array", "items": { "type": "string" }, "description": "FDNs of the selected ports, SAPs or SLM DM objects." }, "intervalType": { "type": "string", "description": "Counters to be cleared for the selected Interval type." } }, "description": "Model containing the method level model for CardStatsTCAProfile.clearPMCountersForSelected to decode json data to internal NFM-P object model" }, "configureKeyGroupEthBindingsResponse": { "title": "configureKeyGroupEthBindingsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "boolean", "description": "The response object." } }, "description": "Model containing the method level model for Domain.configureKeyGroupEthBindings to encode json response from internal NFM-P object model" }, "retrieveCallTraceTracesResponse": { "title": "retrieveCallTraceTracesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for CallTraceTrace.retrieveCallTraceTraces to encode json response from internal NFM-P object model" }, "getRekeyProgressInfoResponse": { "title": "getRekeyProgressInfoResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for NGEScheduledTask.getRekeyProgressInfo to encode json response from internal NFM-P object model" }, "showDhcp6Leases": { "title": "showDhcp6Leases", "required": [ "isSynchronized", "clientId", "systemScriptTargetConfigInfo" ], "type": "object", "properties": { "isSynchronized": { "type": "boolean", "description": "Identifies if the call to execute the script should wait until all scripts have beenexecuted. True to wait, false otherwise." }, "clientId": { "type": "string", "description": "Identifies the client Id that is requesting the execution (used for sending an event tothe specific client when execution is complete)." }, "systemScriptTargetConfigInfo": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" }, { "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for LocalDhcp6Server.showDhcp6Leases to decode json data to internal NFM-P object model" }, "updateTopology": { "title": "updateTopology", "required": [ "protocol", "cpaa" ], "type": "object", "properties": { "protocol": { "type": "string", "description": "The protocol to retrieve" }, "cpaa": { "type": "string", "description": "The management IP address of the CPAA." } }, "description": "Model containing the method level model for TopologyManager.updateTopology to decode json data to internal NFM-P object model" }, "retrieveSubIdStrTimestamp": { "title": "retrieveSubIdStrTimestamp", "required": [ "timeout" ], "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInSubIdStr": { "type": "string" }, "aInSubAddr": { "type": "string" }, "aInSubIdStrType": { "type": "integer", "format": "int32" }, "aInRouterId": { "type": "integer", "format": "int32" }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait before receiving the results. If no results arereceived in the given time, the method returns.This is an optional input parameter. The default value is 5 minutes (300000). default:300000", "format": "int64" } }, "description": "Model containing the method level model for ClassicLsnHost.retrieveSubIdStrTimestamp to decode json data to internal NFM-P object model" }, "discoverOverlayPathResponse": { "title": "discoverOverlayPathResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "object", "additionalProperties": { "type": "object" }, "description": "The response object." } }, "description": "Model containing the method level model for DataCenter.discoverOverlayPath to encode json response from internal NFM-P object model" }, "getOdu1PtfObjectResponse": { "title": "getOdu1PtfObjectResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for OdukPtf.getOdu1PtfObject to encode json response from internal NFM-P object model" }, "acknowledgeFaults": { "title": "acknowledgeFaults", "required": [ "instanceFullName", "alarmableInstanceFilter", "faultFilter", "scopeType", "scopeDepth", "alteredSeverity", "urgency", "text", "doMarkAsAcknowledged", "doDelete" ], "type": "object", "properties": { "instanceFullName": { "type": "string", "description": "Full name of the parent object for which alarms against it or the child objects are to be acknowledged." }, "alarmableInstanceFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "faultFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "scopeType": { "type": "integer", "description": "Scope of the parent and child search:0 = SINGLE_OBJECT1 = SINGLE_LEVEL2 = N_LEVELS3 = WHOLE_SUBTREE", "format": "int32" }, "scopeDepth": { "type": "integer", "description": "Indicates the depth of the parent and child search, used when scopeType is 1 (SINGLE_LEVEL) or 2 (N_LEVELS).", "format": "int32" }, "alteredSeverity": { "type": "string", "description": "New severity, unspecified severity leaves the severity unchanged." }, "urgency": { "type": "string", "description": "New urgency, unspecified urgency leaves the urgency unchanged." }, "text": { "type": "string", "description": "Text of the alarm note added as part of the acknowledgment." }, "doMarkAsAcknowledged": { "type": "boolean", "description": "Indicates whether to acknowledge the alarm or not." }, "doDelete": { "type": "boolean", "description": "Indicates whether to delete the alarm or not." } }, "description": "Model containing the method level model for FaultManager.acknowledgeFaults to decode json data to internal NFM-P object model" }, "findValidTerminatingPortsForVtsConnectionResponse": { "title": "findValidTerminatingPortsForVtsConnectionResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for VtsConnection.findValidTerminatingPortsForVtsConnection to encode json response from internal NFM-P object model" }, "findPolicyOfTypeResponse": { "title": "findPolicyOfTypeResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for Manager.findPolicyOfType to encode json response from internal NFM-P object model" }, "BackupPolicyConfigInfo": { "title": "BackupPolicyConfigInfo", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap", "containmentInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } }, "enableBackup": { "type": "boolean", "default": false }, "backupMode": { "type": "integer", "format": "int32" }, "policyType": { "type": "integer", "format": "int32" }, "autoBackupScheme": { "type": "integer", "format": "int32" }, "policyId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "autoBackupSchemeTreshold": { "type": "integer", "format": "int32" }, "scheduledBackupScheme": { "type": "integer", "format": "int32" }, "scheduledBackupTreshold": { "type": "integer", "format": "int32" }, "scheduledBackupFrequency": { "type": "integer", "format": "int32" }, "scheduledBackupSyncTime": { "type": "integer", "format": "int64" }, "cliConfigFileBackupMode": { "type": "integer", "format": "int32" }, "debugConfigFileBackupMode": { "type": "boolean", "default": false }, "bootOptionFileBackupMode": { "type": "integer", "format": "int32" }, "isAutoReboot": { "type": "boolean", "default": false }, "cliConfigSaveDetails": { "type": "boolean", "default": false }, "compressionMode": { "type": "integer", "format": "int32" }, "purgeMode": { "type": "integer", "format": "int32" }, "numBackupsToKeep": { "type": "integer", "format": "int32" }, "maxBackupAge": { "type": "integer", "format": "int32" }, "saveCertifyDir": { "type": "boolean", "default": false }, "commandToApply": { "type": "integer", "format": "int32" }, "saveNetworkDir": { "type": "boolean", "default": false }, "saveSystemDir": { "type": "boolean", "default": false }, "restoreDirectory": { "type": "string" }, "ftpUser": { "type": "string" }, "ftpPassword": { "type": "string" }, "ftpServerIPAddrType": { "type": "integer", "format": "int32" }, "ftpServerIP": { "type": "string" }, "ftpServerPort": { "type": "integer", "format": "int32" }, "ftpRootDir": { "type": "string" }, "ftpType": { "type": "integer", "format": "int32" }, "sshHostKeyFingerPrint": { "type": "string" }, "useActiveServer": { "type": "boolean", "default": false }, "sarRadioDbFileBackupMode": { "type": "boolean", "default": false }, "cliAdminSave": { "type": "boolean", "default": false }, "backupCertificates": { "type": "boolean", "default": false }, "backupRollbackFiles": { "type": "boolean", "default": false }, "backupTSFiles": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for Interface ConfigInfo BackupPolicyConfigInfo. to decode json data to internal NFM-P object model" }, "findActiveSecondaryStaticRoutesResponse": { "title": "findActiveSecondaryStaticRoutesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/PagingResult" }, { "description": "Model containing the method level model for struct PagingResult. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for AutonomousSystem.findActiveSecondaryStaticRoutes to encode json response from internal NFM-P object model" }, "getRoutingAlarmTypesResponse": { "title": "getRoutingAlarmTypesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/RoutingAlarmTypeInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for RoutingAlarmManager.getRoutingAlarmTypes to encode json response from internal NFM-P object model" }, "retrieveTransitSubscribersResponse": { "title": "retrieveTransitSubscribersResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/DbInfoTransitSubscriberResultStruct" }, "description": "The response object." } }, "description": "Model containing the method level model for DbInfoTransitSubscriberManager.retrieveTransitSubscribers to encode json response from internal NFM-P object model" }, "download": { "title": "download", "required": [ "networkElements", "requestId" ], "type": "object", "properties": { "networkElements": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "requestId": { "type": "string" } }, "description": "Model containing the method level model for RANSoftwareFolderDescriptor.download to decode json data to internal NFM-P object model" }, "DbInfoTransitSubscriberRetrievalStruct": { "title": "DbInfoTransitSubscriberRetrievalStruct", "required": [ "objectClassName", "siteId", "isaGrpPartIndex", "subName", "transitIpPlcyId", "transitPrefixPlcyId", "includeChildren" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "isaGrpPartIndex": { "type": "integer", "format": "int64" }, "subName": { "type": "string" }, "transitIpPlcyId": { "type": "integer", "format": "int64" }, "transitPrefixPlcyId": { "type": "integer", "format": "int64" }, "includeChildren": { "type": "boolean" } }, "description": "Model containing the method level model for struct DbInfoTransitSubscriberRetrievalStruct. to decode json data to internal NFM-P object model" }, "removeTriggerFilterResponse": { "title": "removeTriggerFilterResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for SupervisionGroup.removeTriggerFilter to encode json response from internal NFM-P object model" }, "getChannelUsageListForNEGroups": { "title": "getChannelUsageListForNEGroups", "type": "object", "properties": { "aInNeGroupsList": { "type": "array", "items": { "type": "string" }, "description": "" }, "aInFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for OpticalLink.getChannelUsageListForNEGroups to decode json data to internal NFM-P object model" }, "findAlarmsForOfnResponse": { "title": "findAlarmsForOfnResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/AlarmListsStruct" }, { "description": "Model containing the method level model for struct AlarmListsStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for FaultManager.findAlarmsForOfn to encode json response from internal NFM-P object model" }, "preactivate": { "title": "preactivate", "required": [ "sessionFdn", "neWorkOrders" ], "type": "object", "properties": { "sessionFdn": { "type": "string", "description": "The session to validate." }, "neWorkOrders": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The set of NE work orders to validate. The NE work orders must be in the given session." } }, "description": "Model containing the method level model for Session.preactivate to decode json data to internal NFM-P object model" }, "getNumberOfTestsResponse": { "title": "getNumberOfTestsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int64" } }, "description": "Model containing the method level model for TestSuite.getNumberOfTests to encode json response from internal NFM-P object model" }, "bgpRetrieveEventForNextHop": { "title": "bgpRetrieveEventForNextHop", "required": [ "nextHopAddr", "filter", "fields", "sortFields", "pageNumber", "pageSize" ], "type": "object", "properties": { "nextHopAddr": { "type": "string" }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "fields": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Sorting fields" }, "sortFields": { "type": "array", "items": { "type": "string" }, "description": "Sorting fields" }, "pageNumber": { "type": "integer", "description": "Page number", "format": "int32" }, "pageSize": { "type": "integer", "description": "The number of entries to return", "format": "int32" } }, "description": "Model containing the method level model for BgpImpactAnalysisTimeRange.bgpRetrieveEventForNextHop to decode json data to internal NFM-P object model" }, "validateUpgradePath": { "title": "validateUpgradePath", "required": [ "genericNeProfile", "oldDescriptorPointer", "newDescriptorPointer" ], "type": "object", "properties": { "genericNeProfile": { "type": "string" }, "oldDescriptorPointer": { "type": "string" }, "newDescriptorPointer": { "type": "string" } }, "description": "Model containing the method level model for GenericNeProfile.validateUpgradePath to decode json data to internal NFM-P object model" }, "findTestsResponse": { "title": "findTestsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for StreamingDelayTemplate.findTests to encode json response from internal NFM-P object model" }, "findUpstreamRoutersResponse": { "title": "findUpstreamRoutersResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for AbstractVirtualSite.findUpstreamRouters to encode json response from internal NFM-P object model" }, "RetrievingVirtualSubnetStruct": { "title": "RetrievingVirtualSubnetStruct", "required": [ "objectClassName", "siteId", "serviceId", "subscrIdent", "timeout" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "serviceId": { "type": "integer", "format": "int64" }, "subscrIdent": { "type": "string" }, "timeout": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct RetrievingVirtualSubnetStruct. to decode json data to internal NFM-P object model" }, "EvalLeaseStatePerSapReturnStruct": { "title": "EvalLeaseStatePerSapReturnStruct", "required": [ "objectClassName", "appliedHosts", "notApplicableHosts" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "appliedHosts": { "type": "array", "items": { "$ref": "#/components/schemas/SubHostBaseInfoStruct" }, "description": "" }, "notApplicableHosts": { "type": "array", "items": { "$ref": "#/components/schemas/SubHostBaseInfoStruct" }, "description": "" } }, "description": "Model containing the method level model for struct EvalLeaseStatePerSapReturnStruct. to decode json data to internal NFM-P object model" }, "resyncLeases": { "title": "resyncLeases", "required": [ "timeout" ], "type": "object", "properties": { "aInRtrId": { "type": "string" }, "aInLocalDhcpServerName": { "type": "string" }, "aInVirtualRtrId": { "type": "integer", "format": "int64" }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns.", "format": "int64" } }, "description": "Model containing the method level model for LocalDhcpServer.resyncLeases to decode json data to internal NFM-P object model" }, "getDCInventoryResponse": { "title": "getDCInventoryResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for DCInventoryRecord.getDCInventory to encode json response from internal NFM-P object model" }, "addNeWorkOrdersResponse": { "title": "addNeWorkOrdersResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for Session.addNeWorkOrders to encode json response from internal NFM-P object model" }, "findLdpTargetedPeersResponse": { "title": "findLdpTargetedPeersResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for Lsp.findLdpTargetedPeers to encode json response from internal NFM-P object model" }, "OchCrossConnectInfo": { "title": "OchCrossConnectInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "administrativeState": { "type": "integer", "format": "int32" }, "connId": { "type": "integer", "format": "int64" }, "biDirectional": { "type": "boolean", "default": false }, "connectionType": { "type": "integer", "format": "int32" }, "portAPointer": { "type": "string" }, "portZPointer": { "type": "string" }, "ctpAPointer": { "type": "string" }, "ctpZPointer": { "type": "string" }, "protectionState": { "type": "integer", "format": "int32" }, "protectionLevel": { "type": "integer", "format": "int32" }, "modifyFlag": { "type": "boolean", "default": false }, "isRidingOnConnGroup": { "type": "boolean", "default": false }, "xcId": { "type": "integer", "format": "int64" }, "xcName": { "type": "string" }, "siteId": { "type": "string" }, "siteName": { "type": "string" }, "srcIfIndex": { "type": "integer", "format": "int64" }, "srcChannel": { "type": "integer", "format": "int32" }, "spectralWidth": { "type": "number" }, "destIfIndex": { "type": "integer", "format": "int64" }, "destChannel": { "type": "integer", "format": "int32" }, "waveKey1AZ": { "type": "integer", "format": "int32" }, "waveKey2AZ": { "type": "integer", "format": "int32" }, "waveKey1ZA": { "type": "integer", "format": "int32" }, "waveKey2ZA": { "type": "integer", "format": "int32" }, "wavekeySelect": { "type": "integer", "format": "int32" }, "xcRowStatus": { "type": "integer", "format": "int32" }, "forceDelete": { "type": "boolean", "default": false }, "acceptPowers": { "type": "integer", "format": "int32" }, "technologyTypeAZ": { "type": "string" }, "technologyTypeZA": { "type": "string" }, "rekeyAZ": { "type": "boolean", "default": false }, "rekeyZA": { "type": "boolean", "default": false }, "forceOCHXcCreate": { "type": "boolean", "default": false }, "xcGroupPointer": { "type": "string" }, "showInGUI": { "type": "boolean", "default": false }, "waveKeyingPreference": { "type": "integer", "format": "int32" }, "rekeyWithDuplicatesAllowed": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for Interface OchCrossConnectInfo. to decode json data to internal NFM-P object model" }, "Constraints": { "title": "Constraints", "required": [ "objectClassName", "requiredBandwidth", "includedAdminGroups", "srlg", "excludedAdminGroups", "hopLimit", "excludedRouters", "excludedEgressLinks", "useTeMetric", "diffServClassType", "setupPriority", "holdPriority", "requestType", "leastFillMinThreshold" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "requiredBandwidth": { "type": "integer", "format": "int64" }, "includedAdminGroups": { "type": "integer", "format": "int32" }, "srlg": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "" }, "excludedAdminGroups": { "type": "integer", "format": "int32" }, "hopLimit": { "type": "integer", "format": "int64" }, "excludedRouters": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "excludedEgressLinks": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "useTeMetric": { "type": "boolean" }, "diffServClassType": { "type": "integer", "format": "int64" }, "setupPriority": { "type": "integer", "format": "int64" }, "holdPriority": { "type": "integer", "format": "int64" }, "requestType": { "type": "integer", "format": "int64" }, "leastFillMinThreshold": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct Constraints. to decode json data to internal NFM-P object model" }, "retrieveBgpEventsFilter": { "title": "retrieveBgpEventsFilter", "required": [ "filter", "fields", "sortFields", "filterInfo", "pageNumber", "pageSize", "fullClassName" ], "type": "object", "properties": { "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "fields": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Sorting fields" }, "sortFields": { "type": "array", "items": { "type": "string" }, "description": "Sorting fields" }, "filterInfo": { "type": "object", "description": "Filter info can be any of the following:BgpEventRetrievalFilter - To search specifically for BGP prefix eventsVprnBgpEventRetrievalFilter - To search for DC Prefix VPRN service related events" }, "pageNumber": { "type": "integer", "description": "Page number", "format": "int32" }, "pageSize": { "type": "integer", "description": "The number of entries to return", "format": "int32" }, "fullClassName": { "type": "string", "description": "The full class name to search for: topology.AbstractBgpEventStruct | topology.BgpPrefixEventStruct | topology.BgpDcEventStructtopology.AbstractBgpEventStruct will return all sub classes but only common properties" } }, "description": "Model containing the method level model for TopologyManager.retrieveBgpEventsFilter to decode json data to internal NFM-P object model" }, "SpecificPolicyInfo": { "title": "SpecificPolicyInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "specificAlarmInterval": { "type": "integer", "format": "int32" }, "alarmClassName": { "type": "string" }, "groupTag": { "type": "string" }, "isSquelched": { "type": "boolean", "default": false }, "autoAssignedSeverity": { "type": "integer", "format": "int32" }, "autoAssignedUrgency": { "type": "integer", "format": "int32" }, "autoDeletionRule": { "type": "integer", "format": "int32" }, "userText": { "type": "string" }, "alarmDebouncingHoldPeriod": { "type": "integer", "format": "int32" }, "alarmDebouncingEnabled": { "type": "boolean", "default": false }, "escalationEnabled": { "type": "boolean", "default": false }, "deEscalationEnabled": { "type": "boolean", "default": false }, "historyEnabled": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for Interface SpecificPolicyInfo. to decode json data to internal NFM-P object model" }, "retrieveWlanGwTunnels": { "title": "retrieveWlanGwTunnels", "required": [ "siteId", "tunnelServiceId", "remoteAddr", "localAddr", "addrFamily", "encap", "vlanEncapTag1", "vlanEncapTag2", "apSapPortId", "apSapEncap", "numUeMin", "numUeMax", "apMacAddressFailed", "ueType", "timeout" ], "type": "object", "properties": { "siteId": { "type": "string", "description": "Specifies the Network Element to query." }, "tunnelServiceId": { "type": "integer", "description": "Specifies the identifier of the service corresponding to thevirtual router instance where the tunneled traffic is routed.Valid values are -1 to indicate Base Routing Instance, or a validVPRN Service ID. default:0", "format": "int64" }, "remoteAddr": { "type": "string", "description": "Specifies the IP address of the remote endpoint of the tunnel. default:" }, "localAddr": { "type": "string", "description": "Specifies the IP address of the local endpoint of the tunnel. default:" }, "addrFamily": { "type": "string", "description": "Specifies the address family of the IP layer of the tunnel.The only values allowed are 'ipv4' and 'ipv6'. default:0" }, "encap": { "type": "array", "items": { "type": "string" }, "description": "Specifies the encapsulation types present in the traffic received through a tunnel. default:0" }, "vlanEncapTag1": { "type": "integer", "description": "Specifies the VLAN tag in case of IEEE 802.1Q encapsulation,or the outer tag (service tag, ethertype 0x88a8) in case of IEEE 802.1ad encapsulation,present in the traffic received through a tunnel. This parameteris only valid when the encap type is 'vlan'. If the encap value is not 'vlan',the value of vlanEncapTag1 must be the default minus one. default:-1", "format": "int32" }, "vlanEncapTag2": { "type": "integer", "description": "Specifies the inner tag (customer tag, ethertype 0x8100) in case of qinq encapsulationpresent in the traffic received through a tunnel.This parameter is only valid when the encap type is 'vlan'. If the encap value is not 'vlan',the value of vlanEncapTag2 must be the default minus one. default:-1", "format": "int32" }, "apSapPortId": { "type": "integer", "description": "Specifies the ID of the access port of the Access Point.If the encap value is not 'vlan', the value of apSapPortId must be the default 'invalid port ID'(503316480). default:503316480", "format": "int64" }, "apSapEncap": { "type": "integer", "description": "Specifies the value of the label used to identify the SAP of the Access Point.If the encap value is not 'vlan', the value of apSapEncap must be the default zero. default:0", "format": "int64" }, "numUeMin": { "type": "integer", "description": "Specifies the minimum number of UE's in the tunnel. default:0", "format": "int64" }, "numUeMax": { "type": "integer", "description": "Specifies the maximum number of UE's in the tunnel. default:4294967295", "format": "int64" }, "apMacAddressFailed": { "type": "string", "description": "Specifies if the learning of the MAC address of the Access Point failed. default:dontCare" }, "ueType": { "type": "array", "items": { "type": "string" }, "description": "Specifies the set of UE type values.When the value of ueType is not zero, the response will contain only objectswhere the number of UE's in one of the states corresponding to ueTypeis within the range of numUeMin and numUeMax. Typically, numUeMin will haveto be set to a non-default value of 1 or higher. default:0" }, "timeout": { "type": "integer", "description": "Specifies the timeout in milliseconds to wait before receiving the results.If no results are received in the given time, the method returns.This is an optional input parameter. The default value is 5 minutes (300000ms). default:300000", "format": "int64" } }, "description": "Model containing the method level model for WlanGwQbtTunnel.retrieveWlanGwTunnels to decode json data to internal NFM-P object model" }, "findPortResponse": { "title": "findPortResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/Port" }, { "description": "Managed object abstract class" } ] } }, "description": "Model containing the method level model for Hop.findPort to encode json response from internal NFM-P object model" }, "findMembersResponse": { "title": "findMembersResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/PortTerminationInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for Interface.findMembers to encode json response from internal NFM-P object model" }, "globalRingAuditCheckResponse": { "title": "globalRingAuditCheckResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "object" }, "description": "The response object." } }, "description": "Model containing the method level model for Ring.globalRingAuditCheck to encode json response from internal NFM-P object model" }, "findVPRNInstancesResponse": { "title": "findVPRNInstancesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for Policy.findVPRNInstances to encode json response from internal NFM-P object model" }, "retrieveWlanGwUes": { "title": "retrieveWlanGwUes", "required": [ "timeout" ], "type": "object", "properties": { "aInBridgeId": { "type": "integer", "format": "int32" }, "aUeQueryStruct": { "allOf": [ { "$ref": "#/components/schemas/WlanGwQbtUeQueryStruct" }, { "description": "Model containing the method level model for struct WlanGwQbtUeQueryStruct. to decode json data to internal NFM-P object model" } ] }, "aInVlanQTag": { "type": "integer", "format": "int32" }, "timeout": { "type": "integer", "description": "Specifies the timeout in milliseconds to wait before receiving the results.If no results are received in the given time, the method returns.This is an optional input parameter. The default value is 5 minutes (300000ms). default:0", "format": "int64" } }, "description": "Model containing the method level model for WlanGwQbtUe.retrieveWlanGwUes to decode json data to internal NFM-P object model" }, "findCtpResponse": { "title": "findCtpResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionTerminationPointInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for ConnectionTerminationPoint.findCtp to encode json response from internal NFM-P object model" }, "updateTimeSlots": { "title": "updateTimeSlots", "required": [ "otuOduFullName", "oduStructStr" ], "type": "object", "properties": { "otuOduFullName": { "type": "string", "description": "Pointer to a physical port" }, "oduStructStr": { "type": "string", "description": "Pointer to a physical port" } }, "description": "Model containing the method level model for OtuOduSpecifics.updateTimeSlots to decode json data to internal NFM-P object model" }, "findAllCheckpointsResponse": { "title": "findAllCheckpointsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for Area.findAllCheckpoints to encode json response from internal NFM-P object model" }, "retrieveAdaptiveClockHistory": { "title": "retrieveAdaptiveClockHistory", "required": [ "timeout" ], "type": "object", "properties": { "aInChannelName": { "type": "string" }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns.", "format": "int64" } }, "description": "Model containing the method level model for AdaptiveClockHistory.retrieveAdaptiveClockHistory to decode json data to internal NFM-P object model" }, "validatePathsResponse": { "title": "validatePathsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int32" } }, "description": "Model containing the method level model for MonitoredPath.validatePaths to encode json response from internal NFM-P object model" }, "renumId": { "title": "renumId", "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInAaGroupId": { "type": "integer", "format": "int32" }, "aInAaPartId": { "type": "integer", "format": "int32" }, "aInOldId": { "type": "integer", "format": "int32" }, "aInNewId": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for ApplicationFilter.renumId to decode json data to internal NFM-P object model" }, "FindClassWithFilter": { "title": "FindClassWithFilter", "required": [ "fullClassName" ], "type": "object", "properties": { "resultFilter": { "type": "array", "items": { "type": "string" }, "description": "string" }, "fullClassName": { "type": "string", "description": "string", "example": "security.UserGroup" }, "filterExpression": { "type": "string", "description": "string", "example": "groupName='admin' OR scopeOfCommandProfileName='admin'" } } }, "configureChildInstanceWithResultResponse": { "title": "configureChildInstanceWithResultResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, { "description": "Model containing the method level model for struct CommonManagedEntityInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for GenericObject.configureChildInstanceWithResult to encode json response from internal NFM-P object model" }, "retrieveWlanGwUesByMacAddr": { "title": "retrieveWlanGwUesByMacAddr", "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInMacAddr": { "type": "string" } }, "description": "Model containing the method level model for WlanGwUe.retrieveWlanGwUesByMacAddr to decode json data to internal NFM-P object model" }, "retrieveL2AwareBlockAllocationsResponse": { "title": "retrieveL2AwareBlockAllocationsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for L2AwareBlockAllocation.retrieveL2AwareBlockAllocations to encode json response from internal NFM-P object model" }, "configureVprnEncryptionServicesResponse": { "title": "configureVprnEncryptionServicesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "boolean", "description": "The response object." } }, "description": "Model containing the method level model for KeyGroup.configureVprnEncryptionServices to encode json response from internal NFM-P object model" }, "getNesMultipleTypesResponse": { "title": "getNesMultipleTypesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for GenericNeProfileManager.getNesMultipleTypes to encode json response from internal NFM-P object model" }, "retrieveWlanGwBdUesPerTunnel": { "title": "retrieveWlanGwBdUesPerTunnel", "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInTimeout": { "type": "integer", "format": "int64" }, "aInRouterId": { "type": "integer", "format": "int32" }, "aInRemoteAddr": { "type": "string" }, "aInLocalAddr": { "type": "string" }, "aInBridgeId": { "type": "integer", "format": "int64" }, "aInMacAddr": { "type": "string" } }, "description": "Model containing the method level model for WlanGwBdUe.retrieveWlanGwBdUesPerTunnel to decode json data to internal NFM-P object model" }, "requestClearOamPmDmRawStatsResponse": { "title": "requestClearOamPmDmRawStatsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for MplsDmSession.requestClearOamPmDmRawStats to encode json response from internal NFM-P object model" }, "findL3InterfacesResponse": { "title": "findL3InterfacesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for VrrpVirtualRouter.findL3Interfaces to encode json response from internal NFM-P object model" }, "previewScriptWithParametersResponse": { "title": "previewScriptWithParametersResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for ScriptManager.previewScriptWithParameters to encode json response from internal NFM-P object model" }, "AbstractBgpEventContributerResultStruct": { "title": "AbstractBgpEventContributerResultStruct", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects", "structObjectId", "rank", "key", "eventCounter", "percentOfTotal" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "structObjectId": { "type": "integer", "format": "int64" }, "rank": { "type": "integer", "format": "int32" }, "key": { "type": "string" }, "eventCounter": { "type": "integer", "format": "int64" }, "percentOfTotal": { "type": "number" } }, "description": "Model containing the method level model for struct AbstractBgpEventContributerResultStruct. to decode json data to internal NFM-P object model" }, "FindChildWithResultFilter": { "title": "FindChildWithResultFilter", "required": [ "childClassName" ], "type": "object", "properties": { "childClassName": { "type": "string", "description": "string", "example": "security.UserGroup" }, "resultFilter": { "type": "array", "items": { "type": "string" }, "description": "A list of attributes [\"name\",\"spanOfControlProfileName\",\"description\"]" } } }, "IfUtilizationDetail": { "title": "IfUtilizationDetail", "required": [ "objectClassName", "siteName", "siteId", "interfaceName", "l3Max", "l3Min", "l3Avg", "mplsMax", "mplsMin", "avg", "calculationTime", "mplsIfPtr", "portSpeed", "portName", "metric", "teMetric", "remoteSiteId", "interfaceSpeed" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteName": { "type": "string" }, "siteId": { "type": "string" }, "interfaceName": { "type": "string" }, "l3Max": { "type": "integer", "format": "int32" }, "l3Min": { "type": "integer", "format": "int32" }, "l3Avg": { "type": "integer", "format": "int32" }, "mplsMax": { "type": "integer", "format": "int32" }, "mplsMin": { "type": "integer", "format": "int32" }, "avg": { "type": "integer", "format": "int32" }, "calculationTime": { "type": "integer", "format": "int64" }, "mplsIfPtr": { "type": "string" }, "portSpeed": { "type": "integer", "format": "int64" }, "portName": { "type": "string" }, "metric": { "type": "integer", "format": "int32" }, "teMetric": { "type": "integer", "format": "int64" }, "remoteSiteId": { "type": "string" }, "interfaceSpeed": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct IfUtilizationDetail. to decode json data to internal NFM-P object model" }, "retrieveResidentialSubscriberResponse": { "title": "retrieveResidentialSubscriberResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, { "description": "Model containing the method level model for struct CommonManagedEntityInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for ResidentialSubscriberInstance.retrieveResidentialSubscriber to encode json response from internal NFM-P object model" }, "configureRuleElementResponse": { "title": "configureRuleElementResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/TopologyDiscoveryRuleElement" }, { "description": "Managed object abstract class" } ] } }, "description": "Model containing the method level model for TopologyDiscoveryRule.configureRuleElement to encode json response from internal NFM-P object model" }, "findSdpTunnelsResponse": { "title": "findSdpTunnelsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for Policy.findSdpTunnels to encode json response from internal NFM-P object model" }, "migrateMode": { "title": "migrateMode", "required": [ "distinguishedName", "portMode", "configInfo" ], "type": "object", "properties": { "distinguishedName": { "type": "string", "description": "Distinguished Name of Port LAG to be migrated." }, "portMode": { "type": "string", "description": "Desired Mode value" }, "configInfo": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" }, { "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for Port.migrateMode to decode json data to internal NFM-P object model" }, "AlarmHistoryDatabaseConfigInfo": { "title": "AlarmHistoryDatabaseConfigInfo", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap", "containmentInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } }, "maxLogSize": { "type": "integer", "format": "int64" }, "maxDailySize": { "type": "integer", "format": "int64" }, "administrativeState": { "type": "integer", "format": "int32" }, "logOnChange": { "type": "boolean", "default": false }, "logOnDeletion": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for Interface ConfigInfo AlarmHistoryDatabaseConfigInfo. to decode json data to internal NFM-P object model" }, "setDefaultFlowAttributes": { "title": "setDefaultFlowAttributes", "required": [ "srcPort", "dstPort", "transProtocol" ], "type": "object", "properties": { "srcPort": { "type": "integer", "description": "Default Flow Source Protocol default:0", "format": "int32" }, "dstPort": { "type": "integer", "description": "Default Flow Destination Protocol default:0", "format": "int32" }, "transProtocol": { "type": "string", "description": "Default Flow matching the TransPort Protocol default:0" } }, "description": "Model containing the method level model for AbstractVirtualPort.setDefaultFlowAttributes to decode json data to internal NFM-P object model" }, "retrieveSubscriberVirtualSubnetsResponse": { "title": "retrieveSubscriberVirtualSubnetsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for ResidentialSubscriberInstance.retrieveSubscriberVirtualSubnets to encode json response from internal NFM-P object model" }, "TopologyDiscoveryRule": { "title": "TopologyDiscoveryRule", "required": [ "id", "description", "operationalState", "administrativeState", "numberOfNodes", "lastActiveTime", "readMediationPolicyId", "readMediationPolicyName", "writeMediationPolicyId", "writeMediationPolicyName", "trapMediationPolicyId", "trapMediationPolicyName", "securityMediationPolicyId", "securityMediationPolicyName", "dualReadMediationPolicyId", "dualReadMediationPolicyName", "dualWriteMediationPolicyId", "dualWriteMediationPolicyName", "dualTrapMediationPolicyId", "dualTrapMediationPolicyName", "outOfBandPingPolicyId", "outOfBandPingPolicyName", "inBandPingPolicyId", "inBandPingPolicyName", "standbyCpmPingPolicyId", "standbyCpmPingPolicyName", "statsPollingPolicyId", "statsPollingPolicyName", "olcState", "revertOlcState", "scanInterval", "backupPolicyPointer", "topologyGroupPointer", "ipAddressType", "neSelfConfigurationPolicies", "defaultExternalEms", "dcInterconnectPointer", "postDiscoveryActionName", "postDiscoveryActionPointer", "discoveryProtocol", "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties" ], "type": "object", "properties": { "id": { "type": "integer", "description": "[1,25000] Mandatory on create.", "format": "int64" }, "description": { "type": "string", "description": "[0,80]", "example": " maximum: 80" }, "operationalState": { "type": "integer", "format": "int32", "readOnly": true }, "administrativeState": { "type": "integer", "format": "int32" }, "numberOfNodes": { "type": "integer", "format": "int32", "readOnly": true }, "lastActiveTime": { "type": "integer", "format": "int64", "readOnly": true }, "readMediationPolicyId": { "type": "integer", "format": "int32" }, "readMediationPolicyName": { "type": "string", "description": "80]", "readOnly": true, "example": " maximum: 80" }, "writeMediationPolicyId": { "type": "integer", "format": "int32" }, "writeMediationPolicyName": { "type": "string", "description": "80]", "readOnly": true, "example": " maximum: 80" }, "trapMediationPolicyId": { "type": "integer", "format": "int32" }, "trapMediationPolicyName": { "type": "string", "description": "80]", "readOnly": true, "example": " maximum: 80" }, "securityMediationPolicyId": { "type": "integer", "format": "int32" }, "securityMediationPolicyName": { "type": "string", "description": "80]", "readOnly": true, "example": " maximum: 80" }, "dualReadMediationPolicyId": { "type": "integer", "format": "int32" }, "dualReadMediationPolicyName": { "type": "string", "description": "80]", "readOnly": true, "example": " maximum: 80" }, "dualWriteMediationPolicyId": { "type": "integer", "format": "int32" }, "dualWriteMediationPolicyName": { "type": "string", "description": "80]", "readOnly": true, "example": " maximum: 80" }, "dualTrapMediationPolicyId": { "type": "integer", "format": "int32" }, "dualTrapMediationPolicyName": { "type": "string", "description": "80]", "readOnly": true, "example": " maximum: 80" }, "outOfBandPingPolicyId": { "type": "integer", "format": "int32" }, "outOfBandPingPolicyName": { "type": "string", "description": "80]", "readOnly": true, "example": " maximum: 80" }, "inBandPingPolicyId": { "type": "integer", "format": "int32" }, "inBandPingPolicyName": { "type": "string", "description": "80]", "readOnly": true, "example": " maximum: 80" }, "standbyCpmPingPolicyId": { "type": "integer", "format": "int32" }, "standbyCpmPingPolicyName": { "type": "string", "description": "80]", "readOnly": true, "example": " maximum: 80" }, "statsPollingPolicyId": { "type": "integer", "format": "int32" }, "statsPollingPolicyName": { "type": "string", "description": "80]", "readOnly": true, "example": " maximum: 80" }, "olcState": { "type": "integer", "format": "int32" }, "revertOlcState": { "type": "boolean", "description": "Revert the OLC state once a full discovery is complete" }, "scanInterval": { "type": "integer", "description": "How often to scan the IP ranges of this discovery rule.By default, global Discovery Rule Scan Interval value is used.", "format": "int32" }, "backupPolicyPointer": { "type": "string" }, "topologyGroupPointer": { "type": "string" }, "ipAddressType": { "type": "integer", "format": "int32" }, "neSelfConfigurationPolicies": { "type": "array", "items": { "type": "string" }, "description": "The list of NE self config policies one per network element type that is used to self configurenetwork elements discovered using this discovery rule." }, "defaultExternalEms": { "type": "string", "description": "It is used to specify the Installation Path for the External Application to be launched.The path is compatible to Windows,Linux,Solaris Path formats where the client is installed.The installation path must be located where the client is installed80]", "example": " maximum: 80" }, "dcInterconnectPointer": { "type": "string" }, "postDiscoveryActionName": { "type": "string", "description": "The name of the post discovery action assigned", "readOnly": true }, "postDiscoveryActionPointer": { "type": "string", "description": "The post discovery action assigned" }, "discoveryProtocol": { "type": "integer", "format": "int32" }, "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "actionMask": { "type": "integer", "format": "int32" }, "selfAlarmed": { "type": "boolean", "default": false }, "name": { "type": "string" } }, "description": "Managed object abstract class" }, "retrieveHostLockoutInfo": { "title": "retrieveHostLockoutInfo", "type": "object", "properties": { "aInSapPortId": { "type": "integer", "format": "int64" }, "aInSapEncapValue": { "type": "integer", "format": "int64" }, "aInSiteId": { "type": "string" } }, "description": "Model containing the method level model for HostLockoutInfo.retrieveHostLockoutInfo to decode json data to internal NFM-P object model" }, "PortTerminationInfo": { "title": "PortTerminationInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "description": { "type": "string" }, "encapType": { "type": "integer", "format": "int32" }, "administrativeState": { "type": "integer", "format": "int32" }, "portPointer": { "type": "string" }, "innerEncapValue": { "type": "integer", "format": "int32" }, "outerEncapValue": { "type": "integer", "format": "int32" }, "reassembly": { "type": "boolean", "default": false }, "bundlePortId": { "type": "integer", "format": "int64" }, "memberPortId": { "type": "integer", "format": "int64" }, "memberPortName": { "type": "string" }, "imaLinkPointer": { "type": "string" } }, "description": "Model containing the method level model for Interface PortTerminationInfo. to decode json data to internal NFM-P object model" }, "invokeLMGsCatchup": { "title": "invokeLMGsCatchup", "required": [ "networkElements", "forceOnPMPolicyDown" ], "type": "object", "properties": { "networkElements": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "forceOnPMPolicyDown": { "type": "boolean", "description": "default:false" } }, "description": "Model containing the method level model for LMGPMPolicy.invokeLMGsCatchup to decode json data to internal NFM-P object model" }, "requestClearIgmpHostTrackingResponse": { "title": "requestClearIgmpHostTrackingResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for ResidentialSubscriberInstance.requestClearIgmpHostTracking to encode json response from internal NFM-P object model" }, "retrievePccRulesPerSubscrHost": { "title": "retrievePccRulesPerSubscrHost", "required": [ "subHostPccRuleInfoStruct", "includeFlowsInRtrv", "timeout" ], "type": "object", "properties": { "subHostPccRuleInfoStruct": { "allOf": [ { "$ref": "#/components/schemas/SubHostPccRuleStruct" }, { "description": "Model containing the method level model for struct SubHostPccRuleStruct. to decode json data to internal NFM-P object model" } ] }, "includeFlowsInRtrv": { "type": "boolean", "description": "default:true" }, "timeout": { "type": "integer", "description": "default:0", "format": "int64" } }, "description": "Model containing the method level model for SubscriberPccRuleEntry.retrievePccRulesPerSubscrHost to decode json data to internal NFM-P object model" }, "findObjectsOnLinkOssi": { "title": "findObjectsOnLinkOssi", "required": [ "objectType", "filter", "pageNumber", "pageSize" ], "type": "object", "properties": { "objectType": { "type": "string" }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "pageNumber": { "type": "integer", "description": "Page number", "format": "int32" }, "pageSize": { "type": "integer", "description": "The number of entries to return", "format": "int32" } }, "description": "Model containing the method level model for BaseLink.findObjectsOnLinkOssi to decode json data to internal NFM-P object model" }, "auditLocalPolicyWithInApplicableAttributeOption": { "title": "auditLocalPolicyWithInApplicableAttributeOption", "required": [ "comparingPolicyObjectFullName", "comparedPolicySiteId", "includeInapplicableAttributes" ], "type": "object", "properties": { "comparingPolicyObjectFullName": { "type": "string", "description": "The object full name of one of the local policy." }, "comparedPolicySiteId": { "type": "string", "description": "The siteId of second local policy. Empty string or \"0.0.0.0\" means the global policy." }, "includeInapplicableAttributes": { "type": "boolean", "description": "True if inapplicable attributes needs to be considered during audit, else false." } }, "description": "Model containing the method level model for Manager.auditLocalPolicyWithInApplicableAttributeOption to decode json data to internal NFM-P object model" }, "retrieveWlanGwBdResponse": { "title": "retrieveWlanGwBdResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for WlanGwBridgeDomain.retrieveWlanGwBd to encode json response from internal NFM-P object model" }, "findTPSsResponse": { "title": "findTPSsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for TPSPMPolicy.findTPSs to encode json response from internal NFM-P object model" }, "initiatePlannedRestart": { "title": "initiatePlannedRestart", "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInOspfVersion": { "type": "integer", "format": "int32" }, "aInOspfInstanceIndex": { "type": "integer", "format": "int32" }, "aInRouterId": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for SiteExtension.initiatePlannedRestart to decode json data to internal NFM-P object model" }, "updateUserObjectLifecycleStatesAndLocksAndSchedulesResponse": { "title": "updateUserObjectLifecycleStatesAndLocksAndSchedulesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int64" } }, "description": "Model containing the method level model for GenericObject.updateUserObjectLifecycleStatesAndLocksAndSchedules to encode json response from internal NFM-P object model" }, "doInconsistenciesExistOnNodeResponse": { "title": "doInconsistenciesExistOnNodeResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "boolean", "description": "The response object." } }, "description": "Model containing the method level model for NetworkElement.doInconsistenciesExistOnNode to encode json response from internal NFM-P object model" }, "distributeV2": { "title": "distributeV2", "required": [ "siteIds", "allSitesIncluded" ], "type": "object", "properties": { "siteIds": { "type": "array", "items": { "type": "string" }, "description": "The siteId list for distribution. If the list is empty the behavior is driven bythe attribute allSitesIncluded." }, "allSitesIncluded": { "type": "boolean", "description": "(Optional) The default is \"false\". Applicable only if siteIds is an empty list.If allSitesIncluded is true, the policy is distributed to all applicable NEs. default:false" } }, "description": "Model containing the method level model for PolicyDefinition.distributeV2 to decode json data to internal NFM-P object model" }, "retrieveVpnBgpRouteProfilesAssociatedWithServiceResponse": { "title": "retrieveVpnBgpRouteProfilesAssociatedWithServiceResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/PagingResult" }, { "description": "Model containing the method level model for struct PagingResult. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for RouteProfileManager.retrieveVpnBgpRouteProfilesAssociatedWithService to encode json response from internal NFM-P object model" }, "createVrrpInstanceResponse": { "title": "createVrrpInstanceResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for VrrpVirtualRouter.createVrrpInstance to encode json response from internal NFM-P object model" }, "RetrieveManagedSubscriberHostsStruct": { "title": "RetrieveManagedSubscriberHostsStruct", "required": [ "objectClassName", "hostType", "siteId", "svcId", "ipAddress", "macAddress" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "hostType": { "type": "string" }, "siteId": { "type": "string" }, "svcId": { "type": "integer", "format": "int64" }, "ipAddress": { "type": "string" }, "macAddress": { "type": "string" } }, "description": "Model containing the method level model for struct RetrieveManagedSubscriberHostsStruct. to decode json data to internal NFM-P object model" }, "IgnoreSAPPortState": { "title": "IgnoreSAPPortState", "required": [ "action" ], "type": "object", "properties": { "ObjectName": { "type": "string" }, "action": { "type": "string", "description": "Optional filter." } }, "description": "Model containing the method level model for ServiceManager.IgnoreSAPPortState to decode json data to internal NFM-P object model" }, "CardSlotApsProtection": { "title": "CardSlotApsProtection", "required": [ "objectClassName", "cardSlot", "portList" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "cardSlot": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedContainmentEntityInformation" }, { "description": "Model containing the method level model for struct CommonManagedContainmentEntityInformation. to decode json data to internal NFM-P object model" } ] }, "portList": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "" } }, "description": "Model containing the method level model for struct CardSlotApsProtection. to decode json data to internal NFM-P object model" }, "retrieveSigNodeAdminResponse": { "title": "retrieveSigNodeAdminResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for CMMInstance.retrieveSigNodeAdmin to encode json response from internal NFM-P object model" }, "associateTemplateResponse": { "title": "associateTemplateResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, { "description": "Model containing the method level model for struct CommonManagedEntityInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for XmlApiConfigTemplate.associateTemplate to encode json response from internal NFM-P object model" }, "findLagsResponse": { "title": "findLagsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/InterfaceInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for Site.findLags to encode json response from internal NFM-P object model" }, "findMulticastClientPortsResponse": { "title": "findMulticastClientPortsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for OTPortSpecifics.findMulticastClientPorts to encode json response from internal NFM-P object model" }, "ClearSystemStatsDataTriggerStruct": { "title": "ClearSystemStatsDataTriggerStruct", "required": [ "objectClassName", "siteId" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" } }, "description": "Model containing the method level model for struct ClearSystemStatsDataTriggerStruct. to decode json data to internal NFM-P object model" }, "ApsGroupInfo": { "title": "ApsGroupInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "administrativeState": { "type": "integer", "format": "int32" }, "oesShelfId": { "type": "integer", "format": "int32" }, "phyShelfClass": { "type": "integer", "format": "int32" }, "phyShelfType": { "type": "integer", "format": "int32" }, "lockOlcState": { "type": "boolean", "default": false }, "portId": { "type": "integer", "format": "int64" }, "description": { "type": "string" }, "mode": { "type": "integer", "format": "int32" }, "isl2UplinkMode": { "type": "boolean", "default": false }, "macAddress": { "type": "string" }, "encapType": { "type": "integer", "format": "int32" }, "holdTimeUp": { "type": "integer", "format": "int32" }, "holdTimeDown": { "type": "integer", "format": "int32" }, "mtuValue": { "type": "integer", "format": "int32" }, "speed": { "type": "integer", "format": "int32" }, "accountingPolicyObjectPointer": { "type": "string" }, "collectStats": { "type": "boolean", "default": false }, "etherAccountingPolicyObjectPointer": { "type": "string" }, "etherCollectStats": { "type": "boolean", "default": false }, "ethAccessAccountingPolicyObjectPointer": { "type": "string" }, "ethAccessCollectStats": { "type": "boolean", "default": false }, "networkQueueObjectPointer": { "type": "string" }, "loadBalanceAlgorithm": { "type": "integer", "format": "int32" }, "portSchedulerPolicyObjectPointer": { "type": "string" }, "portEgrHsmdaSchedulerPolicy": { "type": "string" }, "uniProfilePointer": { "type": "string" }, "portIngrNamedPoolPlcy": { "type": "string" }, "portEgrNamedPoolPlcy": { "type": "string" }, "portIngrPoolPercentageRate": { "type": "integer", "format": "int32" }, "portEgrPoolPercentageRate": { "type": "integer", "format": "int32" }, "vlanAutoBind": { "type": "boolean", "default": false }, "l2ProfilePointer": { "type": "string" }, "holdTimeUnits": { "type": "integer", "format": "int32" }, "linkTrap": { "type": "integer", "format": "int32" }, "userLabel": { "type": "string" }, "mptCombinerImplemented": { "type": "integer", "format": "int64" }, "numOfDot1qSapUsingVCP": { "type": "integer", "format": "int32" }, "isVCPUpdatedForDot1qSap": { "type": "boolean", "default": false }, "isVCPSapPort": { "type": "boolean", "default": false }, "unpPortType": { "type": "integer", "format": "int32" }, "groupNumber": { "type": "integer", "format": "int32" }, "apsMode": { "type": "integer", "format": "int32" }, "direction": { "type": "integer", "format": "int32" }, "protectionType": { "type": "integer", "format": "int32" }, "revertMode": { "type": "integer", "format": "int32" }, "waitToRestore": { "type": "integer", "format": "int32" }, "holdTimeApslSignalFail": { "type": "integer", "format": "int32" }, "holdTimeApslSignalDegrade": { "type": "integer", "format": "int32" }, "rdiAlarmGeneration": { "type": "integer", "format": "int32" }, "nodeCardinality": { "type": "integer", "format": "int32" }, "multiChassisNeighborAddressType": { "type": "integer", "format": "int32" }, "multiChassisNeighborAddress": { "type": "string" }, "multiChassisAdvertiseInterval": { "type": "integer", "format": "int32" }, "multiChassisHoldTime": { "type": "integer", "format": "int32" }, "annexBCommandSwitch": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for Interface ApsGroupInfo. to decode json data to internal NFM-P object model" }, "commit": { "title": "commit", "required": [ "siteId", "isSynchronised", "clientId" ], "type": "object", "properties": { "siteId": { "type": "string", "description": "Identifies the siteId of the WMM node to perform the commit on." }, "isSynchronised": { "type": "boolean", "description": "Identifies if the call to execute the script should wait until all scripts have been executed.True to wait, false otherwise." }, "clientId": { "type": "string", "description": "Identifies the client Id that is requesting the execution(used for sending an event to the specific client when execution is complete)." } }, "description": "Model containing the method level model for MMESoftwareFolderDescriptor.commit to decode json data to internal NFM-P object model" }, "saveResultResponse": { "title": "saveResultResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for ResultManager.saveResult to encode json response from internal NFM-P object model" }, "findApplicablePortsResponse": { "title": "findApplicablePortsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for ApsGroup.findApplicablePorts to encode json response from internal NFM-P object model" }, "ClearRequest": { "title": "ClearRequest", "required": [ "id", "siteId", "requestState", "requestor", "clearApplication", "clearParams", "requestTime", "requestTimeOut", "lastStateChange", "requestResult", "requestErrorText", "hasProblem", "lastAuditTime", "creationOrigin", "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties" ], "type": "object", "properties": { "id": { "type": "integer", "description": "Id of the request[1,2147483647]", "format": "int64" }, "siteId": { "type": "string", "description": "System IP address of the node.64] Mandatory on create.", "example": " maximum: 64" }, "requestState": { "type": "integer", "description": "The state of this request", "format": "int32", "readOnly": true }, "requestor": { "type": "string", "description": "FDN of the requestor", "readOnly": true }, "clearApplication": { "type": "integer", "description": "The clear application, e.g. clear ARP cache of service. Mandatory on create.", "format": "int32" }, "clearParams": { "type": "string", "description": "Params for the clear.[0,1024]", "readOnly": true, "example": " maximum: 1024" }, "requestTime": { "type": "integer", "description": "Time when request was created reused.", "format": "int64", "readOnly": true }, "requestTimeOut": { "type": "integer", "description": "Time when request would time-out.", "format": "int64", "readOnly": true }, "lastStateChange": { "type": "integer", "description": "Last time the requestState changed.", "format": "int64", "readOnly": true }, "requestResult": { "type": "integer", "description": "The result of the request.", "format": "int32", "readOnly": true }, "requestErrorText": { "type": "string", "description": "If requestResult is 'failure' the reason for the failure.[0,255]", "readOnly": true, "example": " maximum: 255" }, "hasProblem": { "type": "boolean", "readOnly": true }, "lastAuditTime": { "type": "integer", "description": "Time of last running the RCA Audit of this object.", "format": "int64", "readOnly": true }, "creationOrigin": { "type": "integer", "format": "int32" }, "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "actionMask": { "type": "integer", "format": "int32" }, "selfAlarmed": { "type": "boolean", "default": false }, "name": { "type": "string" } }, "description": "Managed object abstract class" }, "addAnyCastRPMember": { "title": "addAnyCastRPMember", "type": "object", "properties": { "aInLocalAddressFdn": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "aInRpLoopbackIfName": { "type": "string" } }, "description": "Model containing the method level model for VirtualAnyCastRP.addAnyCastRPMember to decode json data to internal NFM-P object model" }, "createWithAutoFillForCompleteConnections": { "title": "createWithAutoFillForCompleteConnections", "required": [ "configInfo", "workingPathReverseOutLinkPointerList", "workingPathStaticHopNameList", "protectingPathReverseOutLinkPointerList", "protectingPathStaticHopNameList" ], "type": "object", "properties": { "configInfo": { "allOf": [ { "$ref": "#/components/schemas/GlobalTPLspConfigInfo" }, { "description": "Model containing the method level model for Interface ConfigInfo GlobalTPLspConfigInfo. to decode json data to internal NFM-P object model" } ] }, "workingPathReverseOutLinkPointerList": { "type": "array", "items": { "type": "string" }, "description": "An ordered list of reverse out-link interface pointers for the working path (from LER A towards LER B, one direction only), if theworking path is configured.{p}In the given example above, the workingPathReverseOutLinkPointerList will contain MPLS interface pointers for a1, c and d." }, "workingPathStaticHopNameList": { "type": "array", "items": { "type": "string" }, "description": "An ordered list of names for the static hops to be created for the working path (from LER A towards LER B, one direction only), if theworking path is configured.{p}In the given example above, the workingPathStaticHopNameList will contain the LSR path names for C and D." }, "protectingPathReverseOutLinkPointerList": { "type": "array", "items": { "type": "string" }, "description": "An ordered list of reverse out-link interface pointers for the protecting path (from LER A towards LER B, one direction only), if theprotecting path is configured.{p}In the given example above, the protectingPathReverseOutLinkPointerList will contain MPLS interface pointers for a2, and e." }, "protectingPathStaticHopNameList": { "type": "array", "items": { "type": "string" }, "description": "An ordered list of names for the static hops to be created for the protecting path (from LER A towards LER B, one direction only), if theprotecting path is configured.{p}In the given example above, the protectingPathStaticHopNameList will contain LSR path name for E." } }, "description": "Model containing the method level model for GlobalTPLsp.createWithAutoFillForCompleteConnections to decode json data to internal NFM-P object model" }, "PoolSubnetRtrvStruct": { "title": "PoolSubnetRtrvStruct", "required": [ "objectClassName", "siteId", "subnetAddress", "subnetPrefixLength" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "vRouterId": { "type": "integer", "format": "int32" }, "siteId": { "type": "string" }, "subnetAddress": { "type": "string" }, "subnetPrefixLength": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for struct PoolSubnetRtrvStruct. to decode json data to internal NFM-P object model" }, "ServiceConfigInfo": { "title": "ServiceConfigInfo", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap", "containmentInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } }, "id": { "type": "integer", "format": "int64" }, "displayedName": { "type": "string" }, "description": { "type": "string" }, "serviceId": { "type": "integer", "format": "int64" }, "templatePointer": { "type": "string" }, "subscriberPointer": { "type": "string" }, "groupPointer": { "type": "string" }, "administrativeState": { "type": "integer", "format": "int32" }, "tier": { "type": "integer", "format": "int32" }, "globalServiceName": { "type": "string" }, "globalServiceComments": { "type": "string" }, "svcPriority": { "type": "integer", "format": "int32" }, "enableAppPerfReporting": { "type": "boolean", "default": false }, "ipDetailCount": { "type": "integer", "format": "int32" }, "reportCustName": { "type": "string" }, "nsdManaged": { "type": "boolean", "default": false }, "lockOlcState": { "type": "boolean", "default": false }, "templateVersionPointer": { "type": "string" } }, "description": "Model containing the method level model for Interface ConfigInfo ServiceConfigInfo. to decode json data to internal NFM-P object model" }, "CardSlot": { "title": "CardSlot", "required": [ "displayedName", "shelfId", "hwIndex", "siteId", "siteName", "manufacturer", "serialNumber", "manufacturerBoardNumber", "manufactureDate", "equipmentCategory", "hwName", "cleiCode", "equipmentState", "containingEquipmentState", "compositeEquipmentState", "operationalState", "administrativeState", "isEquipped", "baseMacAddress", "hardwareFailureReason", "isEquipmentInserted", "manufacturingAssemblyNo", "manufacturingDeviations", "isTempSensorAvailable", "hardwareClass", "backgroundDiagnosticsState", "backgroundDiagnosticsFaultReason", "manufacturingVariant", "hwFirmwareRevisionStatus", "oesShelfId", "phyShelfClass", "phyShelfType", "olcState", "lockOlcState", "slotId", "supportedChildTypes", "assignedChildType", "equippedChildType", "replaceableUnitMismatch", "physicalId", "shelfType", "numberOfDaughterCards", "numberOfDaughterCardSlots", "numberOfXiomCards", "numberOfXiomCardSlots", "cardCapability", "protectionConfigurationIndex", "cardProtectionType", "cardProtectionRowStatus", "protectionGroupIndex", "protectionUnitIndex", "protectionRestorationCriteria", "currentSwitchCommand", "protectionSwitchCommands", "protectionSwitchStatus", "mgGroupAssociation", "assignedCardSubType", "equippedCardSubType", "cardEthernetAdminStatus", "nodeTiming", "failOnError", "resetOnRecoverableError", "revertive", "takeOverDelay", "cardAssignedLevel", "cardEquippedLevel", "cardLicensedLevel", "cardLicensedBandwidth", "cardPowerSave", "cardHashSeedShift", "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties" ], "type": "object", "properties": { "displayedName": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "shelfId": { "type": "integer", "format": "int32", "readOnly": true }, "hwIndex": { "type": "integer", "format": "int64", "readOnly": true }, "siteId": { "type": "string", "description": "64]", "readOnly": true, "example": " maximum: 64" }, "siteName": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "manufacturer": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "serialNumber": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "manufacturerBoardNumber": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "manufactureDate": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "equipmentCategory": { "type": "integer", "format": "int32", "readOnly": true }, "hwName": { "type": "string", "description": "[0,32]", "readOnly": true, "example": " maximum: 32" }, "cleiCode": { "type": "string", "description": "[0,16]", "readOnly": true, "example": " maximum: 16" }, "equipmentState": { "type": "integer", "format": "int32", "readOnly": true }, "containingEquipmentState": { "type": "integer", "format": "int32", "readOnly": true }, "compositeEquipmentState": { "type": "integer", "format": "int32", "readOnly": true }, "operationalState": { "type": "integer", "format": "int32", "readOnly": true }, "administrativeState": { "type": "integer", "format": "int32" }, "isEquipped": { "type": "boolean", "readOnly": true }, "baseMacAddress": { "type": "string", "readOnly": true }, "hardwareFailureReason": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "isEquipmentInserted": { "type": "boolean", "readOnly": true }, "manufacturingAssemblyNo": { "type": "string", "readOnly": true }, "manufacturingDeviations": { "type": "string", "readOnly": true }, "isTempSensorAvailable": { "type": "boolean", "readOnly": true }, "hardwareClass": { "type": "integer", "format": "int32", "readOnly": true }, "backgroundDiagnosticsState": { "type": "integer", "format": "int32", "readOnly": true }, "backgroundDiagnosticsFaultReason": { "type": "string", "readOnly": true }, "manufacturingVariant": { "type": "string", "readOnly": true }, "hwFirmwareRevisionStatus": { "type": "integer", "format": "int32", "readOnly": true }, "oesShelfId": { "type": "integer", "format": "int32" }, "phyShelfClass": { "type": "integer", "format": "int32" }, "phyShelfType": { "type": "integer", "format": "int32" }, "olcState": { "type": "integer", "description": "Object Life Cycle can be set using {{generic.GenericObject.updateUserObjectLifecycleStates()}}.", "format": "int32", "readOnly": true }, "lockOlcState": { "type": "boolean", "description": "This is used to lock the OLC State while in OLC Maintenance State only." }, "slotId": { "type": "integer", "description": "[1,", "format": "int32" }, "supportedChildTypes": { "type": "integer", "format": "int32", "readOnly": true }, "assignedChildType": { "type": "integer", "format": "int32" }, "equippedChildType": { "type": "integer", "format": "int32", "readOnly": true }, "replaceableUnitMismatch": { "type": "boolean", "readOnly": true }, "physicalId": { "type": "integer", "format": "int32", "readOnly": true }, "shelfType": { "type": "integer", "format": "int32", "readOnly": true }, "numberOfDaughterCards": { "type": "integer", "format": "int32", "readOnly": true }, "numberOfDaughterCardSlots": { "type": "integer", "format": "int32", "readOnly": true }, "numberOfXiomCards": { "type": "integer", "format": "int32", "readOnly": true }, "numberOfXiomCardSlots": { "type": "integer", "format": "int32", "readOnly": true }, "cardCapability": { "type": "integer", "format": "int64" }, "protectionConfigurationIndex": { "type": "integer", "format": "int32", "readOnly": true }, "cardProtectionType": { "type": "integer", "format": "int32" }, "cardProtectionRowStatus": { "type": "integer", "format": "int32" }, "protectionGroupIndex": { "type": "integer", "format": "int32", "readOnly": true }, "protectionUnitIndex": { "type": "integer", "format": "int32", "readOnly": true }, "protectionRestorationCriteria": { "type": "integer", "format": "int32" }, "currentSwitchCommand": { "type": "integer", "format": "int32", "readOnly": true }, "protectionSwitchCommands": { "type": "integer", "format": "int32" }, "protectionSwitchStatus": { "type": "integer", "format": "int32", "readOnly": true }, "mgGroupAssociation": { "type": "integer", "description": "The ISA-MG Group the Base Card in this Slot is servicing. Only applies in the context of aServing or PDN Gateway.", "format": "int64", "readOnly": true }, "assignedCardSubType": { "type": "integer", "format": "int32" }, "equippedCardSubType": { "type": "integer", "format": "int32", "readOnly": true }, "cardEthernetAdminStatus": { "type": "integer", "description": "The card admin status for 11ope8 and 11qce12x.", "format": "int32" }, "nodeTiming": { "type": "integer", "format": "int32" }, "failOnError": { "type": "integer", "format": "int64" }, "resetOnRecoverableError": { "type": "boolean" }, "revertive": { "type": "boolean", "description": "Specifies when enabled that the MDA will revert to control of the owner CPIOMwhen the Operational State for that CPIOM becomes Up." }, "takeOverDelay": { "type": "integer", "description": "Specifies the delay time in seconds before the standby CPIOMtakes control of the MDA when the Operational State of the owner CPIOM changes to Down.[-1,10]", "format": "int32" }, "cardAssignedLevel": { "type": "integer", "description": "An integer that specifies the administratively assigned(pre-provisioned) Card functional level variant that should occupythis slot in this chassis.", "format": "int32" }, "cardEquippedLevel": { "type": "integer", "description": "An integer that indicates the card functional-level variant that isphysically inserted into this slot in this chassis. If the value oftmnxCardAssignedLevel is not equal to the value oftmnxCardEquippedLevel, a mismatch alarm will be raised.", "format": "int32", "readOnly": true }, "cardLicensedLevel": { "type": "integer", "description": "An integer that indicates the card functional-level that is licensedfor this slot in this chassis.", "format": "int32", "readOnly": true }, "cardLicensedBandwidth": { "type": "integer", "description": "Indicates the amount of licensed bandwidth that is used on thecard for this slot in this chassis. Bandwidth becomes licensed asphysical connectors are provisioned or physical ports are enabled.Licensed bandwith on cards that have multiple functional levelssupported. The system enforces that the licensed bandwidth doesnot exceed any bandwidth restriction associated with this card'slicensed level.", "format": "int32", "readOnly": true }, "cardPowerSave": { "type": "boolean", "description": "Specifies whether or not the systemprevents the card from loading and keeps it in a low power mode. Ifthe value of cardPowerSave is 'true (1)', the system will resetthe card and keep it in a low power mode.The card must be 'shutdown' before setting power-save." }, "cardHashSeedShift": { "type": "integer", "description": "The value of CardHashSeedShift specifies the number of bitsthe hash seed result is shifted. The hash seed result obtained byshifting up to 16 bits is used by the hash polynomialecmpLoadBalancingHashPoly and lagLoadBalancingHashPoly,to optimize the load balancing distribution of packet flowsunder ECMP and LAG.[1,16]", "format": "int32" }, "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "actionMask": { "type": "integer", "format": "int32" }, "selfAlarmed": { "type": "boolean", "default": false }, "name": { "type": "string" } }, "description": "Managed object abstract class" }, "triggerIncrementalRequestWithRequestID": { "title": "triggerIncrementalRequestWithRequestID", "type": "object", "properties": { "aInIncrementalRequestId": { "type": "integer", "format": "int64" }, "aInIncrementalContext": { "allOf": [ { "$ref": "#/components/schemas/IncrementalContext" }, { "description": "Model containing the method level model for struct IncrementalContext. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for GenericObject.triggerIncrementalRequestWithRequestID to decode json data to internal NFM-P object model" }, "findByNameResponse": { "title": "findByNameResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/VirtualInterface" }, { "description": "Managed object abstract class" } ] } }, "description": "Model containing the method level model for VirtualInterface.findByName to encode json response from internal NFM-P object model" }, "createDataService": { "title": "createDataService", "type": "object", "properties": { "aInCustomerFdn": { "type": "string" }, "aInDataServiceTemplateFdn": { "type": "string" }, "aInExistingDataServiceFdn": { "type": "string" }, "aInDataServiceOuterEncap": { "type": "integer", "format": "int32" }, "aInDataServiceInnerEncap": { "type": "integer", "format": "int32" }, "aInSiteIds": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" } }, "description": "Model containing the method level model for Ring.createDataService to decode json data to internal NFM-P object model" }, "retrieveManagedSubscriberHosts": { "title": "retrieveManagedSubscriberHosts", "required": [ "retrieveManagedSubscriberHostsStruct", "timeout" ], "type": "object", "properties": { "retrieveManagedSubscriberHostsStruct": { "allOf": [ { "$ref": "#/components/schemas/RetrieveManagedSubscriberHostsStruct" }, { "description": "Model containing the method level model for struct RetrieveManagedSubscriberHostsStruct. to decode json data to internal NFM-P object model" } ] }, "timeout": { "type": "integer", "description": "(Optional) The number of milliseconds to wait beforereceiving the results. If the results are notreceived in the given time, the method returns. default:0", "format": "int64" } }, "description": "Model containing the method level model for ManagedSubscriberHost.retrieveManagedSubscriberHosts to decode json data to internal NFM-P object model" }, "findAvailableCtpsPerNode": { "title": "findAvailableCtpsPerNode", "required": [ "nodeId", "ctpFilter" ], "type": "object", "properties": { "nodeId": { "type": "string" }, "ctpFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for ConnectionTerminationPoint.findAvailableCtpsPerNode to decode json data to internal NFM-P object model" }, "retrieveSubMacErrorResponse": { "title": "retrieveSubMacErrorResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for SubscrMacError.retrieveSubMacError to encode json response from internal NFM-P object model" }, "getLicensePointsInventoryResponse": { "title": "getLicensePointsInventoryResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "object", "additionalProperties": { "type": "object" }, "description": "The response object." } }, "description": "Model containing the method level model for SamLicensePoints.getLicensePointsInventory to encode json response from internal NFM-P object model" }, "findApsGroupsResponse": { "title": "findApsGroupsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/ApsGroupInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for Shelf.findApsGroups to encode json response from internal NFM-P object model" }, "autoUpgrade": { "title": "autoUpgrade", "required": [ "networkElements", "auditSettings", "isConcurrent" ], "type": "object", "properties": { "networkElements": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "auditSettings": { "type": "integer", "description": "This parameter will pickup the local audit settings details defining Default Audit Settings Force Upgrade Only Node Backup Only Both Force Upgrade and Node Backup None.", "format": "int32" }, "isConcurrent": { "type": "boolean" } }, "description": "Model containing the method level model for OCSSoftwareFolderDescriptor.autoUpgrade to decode json data to internal NFM-P object model" }, "findSelectableServicesForDiverseResponse": { "title": "findSelectableServicesForDiverseResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for DiverseService.findSelectableServicesForDiverse to encode json response from internal NFM-P object model" }, "executeCompareCheckpoint": { "title": "executeCompareCheckpoint", "required": [ "isSynchronized", "clientId", "neId", "cliCommand" ], "type": "object", "properties": { "isSynchronized": { "type": "boolean" }, "clientId": { "type": "string" }, "neId": { "type": "string" }, "cliCommand": { "type": "string" } }, "description": "Model containing the method level model for RollbackNEInfo.executeCompareCheckpoint to decode json data to internal NFM-P object model" }, "getUpstreamRoutersResponse": { "title": "getUpstreamRoutersResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for UpstreamRouterBinding.getUpstreamRouters to encode json response from internal NFM-P object model" }, "executeCliResponse": { "title": "executeCliResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for NetworkElement.executeCli to encode json response from internal NFM-P object model" }, "getVirtualComponentsForVnodeResponse": { "title": "getVirtualComponentsForVnodeResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for VirtualNode.getVirtualComponentsForVnode to encode json response from internal NFM-P object model" }, "retrieveAAUrlListStatus": { "title": "retrieveAAUrlListStatus", "required": [ "siteId", "groupId", "urlListName" ], "type": "object", "properties": { "siteId": { "type": "string", "description": "Network Element site IP address." }, "groupId": { "type": "integer", "description": "The ISA-AA Group Partition Index.", "format": "int64" }, "urlListName": { "type": "string", "description": "AA URL List name." } }, "description": "Model containing the method level model for AAUrlListPolicy.retrieveAAUrlListStatus to decode json data to internal NFM-P object model" }, "findMlpppBundlesResponse": { "title": "findMlpppBundlesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for MlpppIngressQosProfile.findMlpppBundles to encode json response from internal NFM-P object model" }, "findTunnelGroupEndpointMembersResponse": { "title": "findTunnelGroupEndpointMembersResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for GmplsLsp.findTunnelGroupEndpointMembers to encode json response from internal NFM-P object model" }, "getOptsgObjectsResponse": { "title": "getOptsgObjectsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "object" }, "description": "The response object." } }, "description": "Model containing the method level model for OdukPtf.getOptsgObjects to encode json response from internal NFM-P object model" }, "resetToReleasedPolicyResponse": { "title": "resetToReleasedPolicyResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for PolicyDefinition.resetToReleasedPolicy to encode json response from internal NFM-P object model" }, "constructTemplatedServiceResponse": { "title": "constructTemplatedServiceResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for TemplateService.constructTemplatedService to encode json response from internal NFM-P object model" }, "findL3Interfaces": { "title": "findL3Interfaces", "required": [ "filter" ], "type": "object", "properties": { "aInBackUpAddress": { "type": "string" }, "aInBackupAddressType": { "type": "integer", "format": "int32" }, "aInVrId": { "type": "integer", "format": "int64" }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for VrrpVirtualRouter.findL3Interfaces to decode json data to internal NFM-P object model" }, "PagingResult": { "title": "PagingResult", "required": [ "objectClassName", "infoObjects", "pageSize", "totalSize", "pageNumber", "isTooMuchResult", "threshold", "lastClassDrivePageNumber", "lastClassDriveRowCount" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "infoObjects": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "pageSize": { "type": "integer", "format": "int32" }, "totalSize": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "isTooMuchResult": { "type": "boolean" }, "threshold": { "type": "integer", "format": "int32" }, "lastClassDrivePageNumber": { "type": "integer", "format": "int32" }, "lastClassDriveRowCount": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for struct PagingResult. to decode json data to internal NFM-P object model" }, "scheduleUpgrade": { "title": "scheduleUpgrade", "required": [ "schedule", "networkElements", "isConcurrent" ], "type": "object", "properties": { "schedule": { "type": "string" }, "networkElements": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "isConcurrent": { "type": "boolean" } }, "description": "Model containing the method level model for OCSSoftwareFolderDescriptor.scheduleUpgrade to decode json data to internal NFM-P object model" }, "AlarmInfo": { "title": "AlarmInfo", "required": [ "severity", "previousSeverity", "originalSeverity", "highestSeverity", "operatorAssignedUrgency", "olcState", "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "probableCause", "userText", "alarmName", "type", "specificProblem", "affectedObjectFullName", "affectedObjectClassName", "isAcknowledged", "wasAcknowledged", "acknowldegedBy", "clearedBy", "deletedBy", "firstTimeDetected", "lastTimeDetected", "lastTimeSeverityChanged", "lastTimeCleared", "lastTimePromoted", "lastTimeDemoted", "lastTimeEscalated", "lastTimeDeEscalated", "lastTimeAcknowledged", "nodeTimeOffset", "frequency", "occurences", "numberOfOccurences", "numberOfOccurencesSinceClear", "numberOfOccurencesSinceAck", "isServiceAffecting", "additionalText", "urgencyAssignedBy", "relatedObjects", "affectingObjects", "subscriberId", "nodeId", "nodeName", "affectedObjectDisplayedName", "applicationDomain", "displayedClass", "alarmClassTag", "affectedObjectClassIndex", "affectedObjectInstanceIndex", "correlatingAlarm", "isImplicitlyCleared", "numberOfCorrelatedAlarms" ], "type": "object", "properties": { "severity": { "type": "string" }, "previousSeverity": { "type": "string" }, "originalSeverity": { "type": "string" }, "highestSeverity": { "type": "string" }, "operatorAssignedUrgency": { "type": "string" }, "olcState": { "type": "string" }, "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "probableCause": { "type": "integer", "format": "int32" }, "userText": { "type": "string" }, "alarmName": { "type": "integer", "format": "int32" }, "type": { "type": "integer", "format": "int32" }, "specificProblem": { "type": "integer", "format": "int32" }, "affectedObjectFullName": { "type": "string" }, "affectedObjectClassName": { "type": "string" }, "isAcknowledged": { "type": "boolean" }, "wasAcknowledged": { "type": "boolean" }, "acknowldegedBy": { "type": "string" }, "clearedBy": { "type": "string" }, "deletedBy": { "type": "string" }, "firstTimeDetected": { "type": "integer", "format": "int64" }, "lastTimeDetected": { "type": "integer", "format": "int64" }, "lastTimeSeverityChanged": { "type": "integer", "format": "int64" }, "lastTimeCleared": { "type": "integer", "format": "int64" }, "lastTimePromoted": { "type": "integer", "format": "int64" }, "lastTimeDemoted": { "type": "integer", "format": "int64" }, "lastTimeEscalated": { "type": "integer", "format": "int64" }, "lastTimeDeEscalated": { "type": "integer", "format": "int64" }, "lastTimeAcknowledged": { "type": "integer", "format": "int64" }, "nodeTimeOffset": { "type": "integer", "format": "int64" }, "frequency": { "type": "integer", "format": "int64" }, "occurences": { "type": "string" }, "numberOfOccurences": { "type": "integer", "format": "int64" }, "numberOfOccurencesSinceClear": { "type": "integer", "format": "int64" }, "numberOfOccurencesSinceAck": { "type": "integer", "format": "int64" }, "isServiceAffecting": { "type": "boolean" }, "additionalText": { "type": "string" }, "urgencyAssignedBy": { "type": "string" }, "relatedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "subscriberId": { "type": "integer", "format": "int64" }, "nodeId": { "type": "string" }, "nodeName": { "type": "string" }, "affectedObjectDisplayedName": { "type": "string" }, "applicationDomain": { "type": "string" }, "displayedClass": { "type": "string" }, "alarmClassTag": { "type": "string" }, "affectedObjectClassIndex": { "type": "integer", "format": "int32" }, "affectedObjectInstanceIndex": { "type": "integer", "format": "int64" }, "correlatingAlarm": { "type": "string" }, "isImplicitlyCleared": { "type": "boolean" }, "numberOfCorrelatedAlarms": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for struct AlarmInfo. to decode json data to internal NFM-P object model" }, "importFromXML": { "title": "importFromXML", "required": [ "importFileName", "requestId" ], "type": "object", "properties": { "importFileName": { "type": "string" }, "requestId": { "type": "string" } }, "description": "Model containing the method level model for Domain.importFromXML to decode json data to internal NFM-P object model" }, "requestClearIpoeSessionsResponse": { "title": "requestClearIpoeSessionsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for IPoESession.requestClearIpoeSessions to encode json response from internal NFM-P object model" }, "refreshEnodeBWithResultResponse": { "title": "refreshEnodeBWithResultResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for RANRadioMeasureManager.refreshEnodeBWithResult to encode json response from internal NFM-P object model" }, "findServiceCircuitsResponse": { "title": "findServiceCircuitsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for Lsp.findServiceCircuits to encode json response from internal NFM-P object model" }, "findMcRingProtectedSaps": { "title": "findMcRingProtectedSaps", "required": [ "portFdn", "sapFilter" ], "type": "object", "properties": { "portFdn": { "type": "string" }, "sapFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for L2AccessInterface.findMcRingProtectedSaps to decode json data to internal NFM-P object model" }, "findCardSlotResponse": { "title": "findCardSlotResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/CardSlotApsProtection" }, { "description": "Model containing the method level model for struct CardSlotApsProtection. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for OTPortSpecifics.findCardSlot to encode json response from internal NFM-P object model" }, "findGroupsResponse": { "title": "findGroupsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/GroupInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for GroupManager.findGroups to encode json response from internal NFM-P object model" }, "rediscoverDestinationSiteResponse": { "title": "rediscoverDestinationSiteResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for L2TPv3Tunnel.rediscoverDestinationSite to encode json response from internal NFM-P object model" }, "retrieveIPoESessions": { "title": "retrieveIPoESessions", "required": [ "retrievingIpoeSessionStruct", "retrieveQoSOvr", "retrieveManagedRoutes", "retrieveBgpPeerInfo" ], "type": "object", "properties": { "aInCircuitId": { "type": "string" }, "aInRemoteId": { "type": "string" }, "retrievingIpoeSessionStruct": { "allOf": [ { "$ref": "#/components/schemas/RetrievingIpoeSessionStruct" }, { "description": "Model containing the method level model for struct RetrievingIpoeSessionStruct. to decode json data to internal NFM-P object model" } ] }, "retrieveQoSOvr": { "type": "boolean", "description": "Specifies if QoS Override should be retrieved,the default is \"true\".The QoS Override won't be retrieved if Service preferences \"retrieveQoSOvr\" is false. default:true" }, "retrieveManagedRoutes": { "type": "boolean", "description": "Specifies if Managed Routes should be retrieved,the default is \"true\".The Managed Routes won't be retrieved if Service preferences \"retrieveManagedRoutes\" isfalse. default:true" }, "retrieveBgpPeerInfo": { "type": "boolean", "description": "Specifies if BGP Peer Info should be retrieved,the default is \"true\".The Managed Routes won't be retrieved if Service preferences \"retrieveManagedRoutes\" isfalse. default:true" } }, "description": "Model containing the method level model for IPoESession.retrieveIPoESessions to decode json data to internal NFM-P object model" }, "cancelScriptFlowResponse": { "title": "cancelScriptFlowResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "boolean", "description": "The response object." } }, "description": "Model containing the method level model for ScriptManager.cancelScriptFlow to encode json response from internal NFM-P object model" }, "backout": { "title": "backout", "required": [ "siteId", "isSynchronised", "clientId" ], "type": "object", "properties": { "siteId": { "type": "string", "description": "Identifies the siteId of the WMM node to perform the Backout on." }, "isSynchronised": { "type": "boolean", "description": "Identifies if the call to execute the script should wait until all scripts have been executed.True to wait, false otherwise." }, "clientId": { "type": "string", "description": "Identifies the client Id that is requesting the execution(used for sending an event to the specific client when execution is complete)." } }, "description": "Model containing the method level model for MMESoftwareFolderDescriptor.backout to decode json data to internal NFM-P object model" }, "removeTest": { "title": "removeTest", "required": [ "testGroupRole", "test" ], "type": "object", "properties": { "testGroupRole": { "type": "string", "description": "The test group from which to remove this test." }, "test": { "type": "string", "description": "The pointer to the test to remove." } }, "description": "Model containing the method level model for TestSuite.removeTest to decode json data to internal NFM-P object model" }, "retrieveBgpEventStartFromBgpStatIntervalResponse": { "title": "retrieveBgpEventStartFromBgpStatIntervalResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int64" } }, "description": "Model containing the method level model for BgpEventPartitionManager.retrieveBgpEventStartFromBgpStatInterval to encode json response from internal NFM-P object model" }, "deleteRollbckCheckPt": { "title": "deleteRollbckCheckPt", "required": [ "neId", "rollbackIndex" ], "type": "object", "properties": { "neId": { "type": "string" }, "rollbackIndex": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for RollbackNEInfo.deleteRollbckCheckPt to decode json data to internal NFM-P object model" }, "MldHostRetrievalStruct": { "title": "MldHostRetrievalStruct", "required": [ "objectClassName", "siteId", "routerId", "serviceId", "grpIfIndex", "includeChildren", "timeout" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "routerId": { "type": "integer", "format": "int64" }, "serviceId": { "type": "integer", "format": "int64" }, "grpIfIndex": { "type": "integer", "format": "int64" }, "includeChildren": { "type": "boolean" }, "timeout": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct MldHostRetrievalStruct. to decode json data to internal NFM-P object model" }, "keepAliveUpdateResponse": { "title": "keepAliveUpdateResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int64" } }, "description": "Model containing the method level model for SupervisionManager.keepAliveUpdate to encode json response from internal NFM-P object model" }, "audit": { "title": "audit", "required": [ "networkElements", "auditSettings" ], "type": "object", "properties": { "networkElements": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "auditSettings": { "type": "integer", "description": "This parameter will pickup the local audit settings details defining Default Audit Settings Force Upgrade Only Node Backup Only Both Force Upgrade and Node Backup None.", "format": "int32" } }, "description": "Model containing the method level model for OCSSoftwareFolderDescriptor.audit to decode json data to internal NFM-P object model" }, "AbstractApsGroupInfo": { "title": "AbstractApsGroupInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "groupId": { "type": "integer", "format": "int64" }, "groupType": { "type": "integer", "format": "int32" }, "siteName": { "type": "string" }, "siteId": { "type": "string" }, "protectionMode": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "direction": { "type": "integer", "format": "int32" }, "cardSubType": { "type": "integer", "format": "int32" }, "revertMode": { "type": "integer", "format": "int32" }, "extraTraffic": { "type": "integer", "format": "int32" }, "waitToRestore": { "type": "integer", "format": "int32" }, "holdOffTimer": { "type": "integer", "format": "int32" }, "requestFor": { "type": "integer", "format": "int32" }, "members": { "type": "string" }, "apsAction": { "type": "integer", "format": "int32" }, "xcDirection": { "type": "integer", "format": "int32" }, "apsGroupMethod": { "type": "integer", "format": "int32" }, "apsPingMethod": { "type": "integer", "format": "int32" }, "apsSdEnable": { "type": "boolean", "default": false }, "clientPortIfIndex": { "type": "integer", "format": "int64" }, "clientPortIfIndexLo": { "type": "integer", "format": "int64" }, "workingPortIfIndex": { "type": "integer", "format": "int64" }, "workingPortIfIndexLo": { "type": "integer", "format": "int64" }, "protectionPortIfIndex": { "type": "integer", "format": "int64" }, "protectionPortIfIndexLo": { "type": "integer", "format": "int64" }, "clientPort": { "type": "string" }, "workingPort": { "type": "string" }, "protectionPort": { "type": "string" }, "clientCtp": { "type": "string" }, "workingCtp": { "type": "string" }, "protectionCtp": { "type": "string" }, "protectionSwitch": { "type": "integer", "format": "int32" }, "clientFacilityPointer": { "type": "string" }, "workingFacilityPointer": { "type": "string" }, "protectionFacilityPointer": { "type": "string" }, "onDeleteAction": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for Interface AbstractApsGroupInfo. to decode json data to internal NFM-P object model" }, "retrieveEnbLinkStatus": { "title": "retrieveEnbLinkStatus", "required": [ "siteId", "epsType", "mcc", "mnc", "macroEnbId" ], "type": "object", "properties": { "siteId": { "type": "string" }, "epsType": { "type": "string" }, "mcc": { "type": "string" }, "mnc": { "type": "string" }, "macroEnbId": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for MmeEpsPeerSummary.retrieveEnbLinkStatus to decode json data to internal NFM-P object model" }, "findFlexAlgoDefinitions": { "title": "findFlexAlgoDefinitions", "required": [ "filter" ], "type": "object", "properties": { "aInClassName": { "type": "string" }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for AdminGroupPolicy.findFlexAlgoDefinitions to decode json data to internal NFM-P object model" }, "addInclusionFilterResponse": { "title": "addInclusionFilterResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for SupervisionGroup.addInclusionFilter to encode json response from internal NFM-P object model" }, "CrossConnectConfigInfo": { "title": "CrossConnectConfigInfo", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap", "containmentInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } }, "displayedName": { "type": "string" }, "description": { "type": "string" }, "firstSvcPointer": { "type": "string" }, "secondSvcPointer": { "type": "string" }, "firstSitePointer": { "type": "string" }, "secondSitePointer": { "type": "string" }, "ccagPointer": { "type": "string" }, "ccId": { "type": "integer", "format": "int32" }, "firstAccessInterfacePointer": { "type": "string" }, "secondAccessInterfacePointer": { "type": "string" } }, "description": "Model containing the method level model for Interface ConfigInfo CrossConnectConfigInfo. to decode json data to internal NFM-P object model" }, "Context": { "title": "Context", "required": [ "objectClassName", "depth", "appDefinedContext", "time" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "depth": { "type": "integer", "format": "int32" }, "appDefinedContext": { "type": "object" }, "time": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct Context. to decode json data to internal NFM-P object model" }, "DeployerInfo": { "title": "DeployerInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects", "state", "temporality", "type", "tag", "lastDeployment", "userName", "requestId", "deplType", "isIncludeChildren", "appName", "appData", "sessionId", "sessionTime", "sessionIp", "sessionType" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "state": { "type": "string" }, "temporality": { "type": "string" }, "type": { "type": "string" }, "tag": { "type": "string" }, "lastDeployment": { "type": "integer", "format": "int64" }, "userName": { "type": "string" }, "requestId": { "type": "string" }, "deplType": { "type": "string" }, "isIncludeChildren": { "type": "boolean" }, "appName": { "type": "string" }, "appData": { "type": "string" }, "sessionId": { "type": "string" }, "sessionTime": { "type": "integer", "format": "int64" }, "sessionIp": { "type": "string" }, "sessionType": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for struct DeployerInfo. to decode json data to internal NFM-P object model" }, "addMember": { "title": "addMember", "type": "object", "properties": { "aInMemberFdn": { "type": "string" }, "aInPosition": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for RuleBasedGroup.addMember to decode json data to internal NFM-P object model" }, "findFlexAlgoDefinitionsResponse": { "title": "findFlexAlgoDefinitionsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for AdminGroupPolicy.findFlexAlgoDefinitions to encode json response from internal NFM-P object model" }, "requestClearSpokeSdpBfdSessionResponse": { "title": "requestClearSpokeSdpBfdSessionResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for SpokeSdpBinding.requestClearSpokeSdpBfdSession to encode json response from internal NFM-P object model" }, "getVlanConnProfSAPsResponse": { "title": "getVlanConnProfSAPsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for VlanConnProfPolicy.getVlanConnProfSAPs to encode json response from internal NFM-P object model" }, "ObjectDiff": { "title": "ObjectDiff", "required": [ "objectClassName", "diffType", "className", "baseFdn", "compareToFdn", "baseDisplay", "compareToDisplay", "propertyDiffs", "extraObjectInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "diffType": { "type": "string" }, "className": { "type": "string" }, "baseFdn": { "type": "string" }, "compareToFdn": { "type": "string" }, "baseDisplay": { "type": "string" }, "compareToDisplay": { "type": "string" }, "propertyDiffs": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/PropertyDiff" }, "description": "" }, "extraObjectInfo": { "type": "string", "description": "cdata:true The property is returned as CDATA element.value:true ." } }, "description": "Model containing the method level model for struct ObjectDiff. to decode json data to internal NFM-P object model" }, "configureTargetsResponse": { "title": "configureTargetsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for AbstractScript.configureTargets to encode json response from internal NFM-P object model" }, "PollerPolicyConfigInfo": { "title": "PollerPolicyConfigInfo", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap", "containmentInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } }, "pollingInterval": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "versionId": { "type": "integer", "format": "int32" }, "mibEntityOid": { "type": "string" }, "administrativeState": { "type": "integer", "format": "int32" }, "numberOfVarPerPdu": { "type": "integer", "format": "int32" }, "useBulkRequest": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for Interface ConfigInfo PollerPolicyConfigInfo. to decode json data to internal NFM-P object model" }, "findLmgNodesResponse": { "title": "findLmgNodesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for LMGPMPolicy.findLmgNodes to encode json response from internal NFM-P object model" }, "store": { "title": "store", "required": [ "body", "reloadTemplates" ], "type": "object", "properties": { "body": { "type": "string", "description": "Template body." }, "reloadTemplates": { "type": "boolean", "description": "Reload all velocity templates after storing thisone (useful when only one templates gets stored)(invoke method 'reload')" } }, "description": "Model containing the method level model for VelocityTemplate.store to decode json data to internal NFM-P object model" }, "triggerIncrementalRequestResponse": { "title": "triggerIncrementalRequestResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int64" } }, "description": "Model containing the method level model for GenericObject.triggerIncrementalRequest to encode json response from internal NFM-P object model" }, "findAdminGroups": { "title": "findAdminGroups", "required": [ "filter", "siteId" ], "type": "object", "properties": { "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "siteId": { "type": "string" } }, "description": "Model containing the method level model for AdminGroupPolicy.findAdminGroups to decode json data to internal NFM-P object model" }, "findCircuitsResponse": { "title": "findCircuitsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for AbstractTunnel.findCircuits to encode json response from internal NFM-P object model" }, "connectToConsoleResponse": { "title": "connectToConsoleResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for NetworkElement.connectToConsole to encode json response from internal NFM-P object model" }, "updateTxTimeslot": { "title": "updateTxTimeslot", "type": "object", "properties": { "aInOdu1PtfChnanelDn": { "type": "string" }, "aInTimeslotStr": { "type": "string" } }, "description": "Model containing the method level model for Odu1PtfChannel.updateTxTimeslot to decode json data to internal NFM-P object model" }, "getResult": { "title": "getResult", "required": [ "auditParam", "objectType" ], "type": "object", "properties": { "auditParam": { "allOf": [ { "$ref": "#/components/schemas/AuditParam" }, { "description": "Model containing the method level model for struct AuditParam. to decode json data to internal NFM-P object model" } ] }, "objectType": { "type": "string" } }, "description": "Model containing the method level model for AuditManager.getResult to decode json data to internal NFM-P object model" }, "findMDAsResponse": { "title": "findMDAsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for Policy.findMDAs to encode json response from internal NFM-P object model" }, "constructTemplatedObjectResponse": { "title": "constructTemplatedObjectResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, { "description": "Model containing the method level model for struct CommonManagedEntityInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for AbstractResSubscrTemplate.constructTemplatedObject to encode json response from internal NFM-P object model" }, "preDeleteENBsResponse": { "title": "preDeleteENBsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for TCE.preDeleteENBs to encode json response from internal NFM-P object model" }, "applyStaticPortMapRequestWithResultResponse": { "title": "applyStaticPortMapRequestWithResultResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/StaticPortMappingInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for StaticPortMapRequest.applyStaticPortMapRequestWithResult to encode json response from internal NFM-P object model" }, "getDeployerResponse": { "title": "getDeployerResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/DeployerInfo" }, { "description": "Model containing the method level model for struct DeployerInfo. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for GenericObject.getDeployer to encode json response from internal NFM-P object model" }, "getLicenseUsageResponse": { "title": "getLicenseUsageResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "description": "The response object." } }, "description": "Model containing the method level model for RANLicenseManager.getLicenseUsage to encode json response from internal NFM-P object model" }, "retrievePPPSessionRadiusClassesResponse": { "title": "retrievePPPSessionRadiusClassesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for PPPSessionRadiusClassAttribute.retrievePPPSessionRadiusClasses to encode json response from internal NFM-P object model" }, "FetchGlobalPolicyInfo": { "title": "FetchGlobalPolicyInfo", "required": [ "objectClassName", "globalPolicyFDN", "isPolicyAlreadyExists" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "globalPolicyFDN": { "type": "string" }, "isPolicyAlreadyExists": { "type": "boolean" } }, "description": "Model containing the method level model for struct FetchGlobalPolicyInfo. to decode json data to internal NFM-P object model" }, "findObjectsOnLinkOssiResponse": { "title": "findObjectsOnLinkOssiResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/ObjectsOnLinkStruct" }, { "description": "Model containing the method level model for struct ObjectsOnLinkStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for BaseLink.findObjectsOnLinkOssi to encode json response from internal NFM-P object model" }, "findVWMsResponse": { "title": "findVWMsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for VWMPMPolicy.findVWMs to encode json response from internal NFM-P object model" }, "getNumFailedCellsResponse": { "title": "getNumFailedCellsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int32" } }, "description": "Model containing the method level model for SummaryView.getNumFailedCells to encode json response from internal NFM-P object model" }, "HybridMigrationResultStruct": { "title": "HybridMigrationResultStruct", "required": [ "objectClassName", "noOfSapsToBeMigrated", "noOfSapsMigrated", "noOfSapsFailed", "failedSapsDn" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "noOfSapsToBeMigrated": { "type": "integer", "format": "int32" }, "noOfSapsMigrated": { "type": "integer", "format": "int32" }, "noOfSapsFailed": { "type": "integer", "format": "int32" }, "failedSapsDn": { "type": "string" } }, "description": "Model containing the method level model for struct HybridMigrationResultStruct. to decode json data to internal NFM-P object model" }, "shortestPathFirstGraphSetResponse": { "title": "shortestPathFirstGraphSetResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ShortestPathGraph" }, "description": "The response object." } }, "description": "Model containing the method level model for TopologyManager.shortestPathFirstGraphSet to encode json response from internal NFM-P object model" }, "ClearSapStruct": { "title": "ClearSapStruct", "required": [ "objectClassName", "hostType", "sapId" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "hostType": { "type": "string" }, "sapId": { "type": "string" } }, "description": "Model containing the method level model for struct ClearSapStruct. to decode json data to internal NFM-P object model" }, "ClearWppHostsLoggingOutStruct": { "title": "ClearWppHostsLoggingOutStruct", "required": [ "objectClassName", "siteId", "svcId", "portalName", "hostAddress" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "svcId": { "type": "integer", "format": "int64" }, "portalName": { "type": "string" }, "hostAddress": { "type": "string" } }, "description": "Model containing the method level model for struct ClearWppHostsLoggingOutStruct. to decode json data to internal NFM-P object model" }, "createSubSvcComponents": { "title": "createSubSvcComponents", "required": [ "neSystemAddress", "vlanPerSub", "esm", "templates", "downstreamLineRate", "upstreamLineRate", "ingressAcls", "egressAcls", "allRates" ], "type": "object", "properties": { "neSystemAddress": { "type": "string", "description": "System address of the NE to deploy the profileor policy to (i.e. where the sub resides).NFM-P may detect that a requested profile policyalready exists in NFM-P but hasn't been deployed tothis node yet; then NFM-P will deploy it." }, "vlanPerSub": { "type": "boolean", "description": "true for SAP (VLAN) per subscriberfalse for SAP (VLAN) per service (any flavor)" }, "esm": { "type": "boolean", "description": "false if subscriber uses assigned SAPs;true otherwise (enhanced subscriber managementa.k.a. ESM)" }, "templates": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TemplateIdPair" }, "description": "Map of the NFM-P profiles or QoS policies FDNs toclone.The values: structures containing two strings:1) \"ossAssignedName\" - the name OSS assigned tothis profile or policy.2) \"fdn\" - the FDN of the template SLA profile (forESM) or QoS scheduler policy to replicate (forassigned SAPs).The keys follow the naming convention:* For ESM:Application|\"subscriber\"Where:o Application can be one of (unchecked):\"all\"|\"hsi\"|voip\"|\"video\"\"\"all\" is used for VLAN per subscribermodel, other values - for VLAN perservice modelso \"subscriber\" represents the subscriberprofile* For assigned SAP model:Direction-Application-PolicyTypeWhere:o Direction:\"ingress\"|\"egress\"o Application - the same values as in theESM case above - i.e.\"all\"|\"hsi\"|voip\"|\"video\"o PolicyType:\"qos\"|\"scheduler\"Examples of the keys in the map:- \"subscriber\" - ESM, VLAN per subscriber,subscriber profile, at most 1 entry- \"all\" - ESM, VLAN per subscriber, SLAprofile, at most 1 entry- \"hsi\" - ESM, VLAN per service, SLA profile- \"ingress-all-qos\" - assigned SAP, VLAN persubscriber, QoS policy- \"egress-hsi-scheduler\" - assigned SAP,VLAN per service, scheduler policyAn invocation should have the following entries:- for ESM, VLAN per subscriber:\"subscriber\", \"all\"- for ESM, VLAN per service:\"subscriber\", \"all\",\"hsi\",voip\",\"video\"- for assigned SAPs, VLAN per subscriber:\"egress-all-qos\"\"egress-all-scheduler\"\"ingress-all-qos\"\"ingress-all-scheduler\"- for assigned SAPs, VLAN per service:\"egress-hsi-qos\"\"egress-hsi-scheduler\"\"ingress-hsi-qos\"\"ingress-hsi-scheduler\"\"egress-video-qos\"\"egress-video-scheduler\"\"ingress-video-qos\"\"ingress-video-scheduler\"\"egress-voip-qos\"\"egress-voip-scheduler\"\"ingress-voip-qos\"\"ingress-voip-scheduler\"" }, "downstreamLineRate": { "type": "integer", "description": "Subscriber downstream DSL line rate", "format": "int32" }, "upstreamLineRate": { "type": "integer", "description": "Subscriber upstream DSL line rate", "format": "int32" }, "ingressAcls": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of ingress ACL FDNs to use in the clone.Keys are the applications:- for VLAN per service models:\"hsi\"|voip\"|\"video\" (unchecked)- for VLAN per subscriber model:\"all\" (1 and only 1 entry).DEFAULT blank (null)" }, "egressAcls": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Map of ingress ACL FDNs to use in the clone.Keys are the applications:- for VLAN per service models:\"hsi\"|voip\"|\"video\" (unchecked)- for VLAN per subscriber model:\"all\" (1 and only 1 entry).DEFAULT blank (null)" }, "allRates": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "description": "Map of all rates to configure in the profiles (QoS scheduler) policies being createdEntries are named using the following convention:Direction-ForwardingClass-CirOrPir-Application-svcNumberwhere:Direction:\"ingress\"|\"egress\"ForwardingClass:\"be\"|\"l2\"|\"af\"|\"l1\"|\"h2\"|\"ef\"|\"h1\"|\"nc\"CirOrPir:\"cir\"|\"pir\" - CIR cannot be specified without corresponding PIR rate configuration.Both CIR and PIR may be specified as \"-1\" meaning \"MAX\"Application (unchecked):\"hsi\"|voip\"|\"video\"svcNumber:1..n (unique integer per application instance)Example:\"ingress-ef-pir-video-1\"" } }, "description": "Model containing the method level model for ResidentialSubscriberManager.createSubSvcComponents to decode json data to internal NFM-P object model" }, "requestClearCallTraceIpoeSessionResponse": { "title": "requestClearCallTraceIpoeSessionResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for CallTraceConfig.requestClearCallTraceIpoeSession to encode json response from internal NFM-P object model" }, "startManualRekey": { "title": "startManualRekey", "type": "object", "properties": { "aInForceRekey": { "type": "boolean", "default": false }, "aInProgressiveRekey": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for NGEScheduledTask.startManualRekey to decode json data to internal NFM-P object model" }, "getServicesResponse": { "title": "getServicesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "object" }, "description": "The response object." } }, "description": "Model containing the method level model for CompositeService.getServices to encode json response from internal NFM-P object model" }, "updateUserObjectLifecycleStatesResponse": { "title": "updateUserObjectLifecycleStatesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int32" } }, "description": "Model containing the method level model for GenericObject.updateUserObjectLifecycleStates to encode json response from internal NFM-P object model" }, "findLocalResponse": { "title": "findLocalResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for PolicyDefinition.findLocal to encode json response from internal NFM-P object model" }, "retrieveIPoESessionsResponse": { "title": "retrieveIPoESessionsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for IPoESession.retrieveIPoESessions to encode json response from internal NFM-P object model" }, "generate": { "title": "generate", "required": [ "templateConfiguration", "additionalParameters" ], "type": "object", "properties": { "templateConfiguration": { "allOf": [ { "$ref": "#/components/schemas/XmlApiConfigTemplateConfigInfo" }, { "description": "Model containing the method level model for Interface ConfigInfo XmlApiConfigTemplateConfigInfo. to decode json data to internal NFM-P object model" } ] }, "additionalParameters": { "allOf": [ { "$ref": "#/components/schemas/XmlApiConfigTemplateParams" }, { "description": "Model containing the method level model for struct XmlApiConfigTemplateParams. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for XmlApiConfigTemplate.generate to decode json data to internal NFM-P object model" }, "navigateToFarEndMemberResponse": { "title": "navigateToFarEndMemberResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for TunnelGroupEndpointMember.navigateToFarEndMember to encode json response from internal NFM-P object model" }, "getHopsCountResponse": { "title": "getHopsCountResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int32" } }, "description": "Model containing the method level model for TransportService.getHopsCount to encode json response from internal NFM-P object model" }, "importFwImage": { "title": "importFwImage", "required": [ "imageFileNames", "imageLocation", "shelfType", "firmwareVersion" ], "type": "object", "properties": { "imageFileNames": { "type": "array", "items": { "type": "string" }, "description": "List of file names to be imported. If empty, all the files in the directory referred to by \"imageLocation\" parametershall be picked up." }, "imageLocation": { "type": "string", "description": "Relative name of the directory containing all the image files (relative to the local directory server_install_dir nms nodeSoftware )." }, "shelfType": { "type": "integer", "description": "shelfType - for SAR-Hm it is 413 and SAR-Hmc it is 515", "format": "int32" }, "firmwareVersion": { "type": "string", "description": "firmware version" } }, "description": "Model containing the method level model for SoftwareFolderManager.importFwImage to decode json data to internal NFM-P object model" }, "findValidTerminationPointsForTrailResponse": { "title": "findValidTerminationPointsForTrailResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for TrailSite.findValidTerminationPointsForTrail to encode json response from internal NFM-P object model" }, "PollerPolicy": { "title": "PollerPolicy", "required": [ "pollingInterval", "productName", "productOfficialName", "productId", "versionName", "versionId", "mibEntityOid", "administrativeState", "mibName", "mibEntryName", "numberOfVarPerPdu", "useBulkRequest", "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties" ], "type": "object", "properties": { "pollingInterval": { "type": "integer", "format": "int32" }, "productName": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "productOfficialName": { "type": "string", "description": "The official name of the product.252]", "readOnly": true, "example": " maximum: 252" }, "productId": { "type": "integer", "description": "Mandatory on create.", "format": "int32" }, "versionName": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "versionId": { "type": "integer", "description": "Mandatory on create.", "format": "int32" }, "mibEntityOid": { "type": "string", "description": "252] Mandatory on create.", "example": " maximum: 252" }, "administrativeState": { "type": "integer", "format": "int32" }, "mibName": { "type": "string", "description": "100]", "readOnly": true, "example": " maximum: 100" }, "mibEntryName": { "type": "string", "description": "100]", "readOnly": true, "example": " maximum: 100" }, "numberOfVarPerPdu": { "type": "integer", "description": "The value is used to build a pdu with number of varbind and if the number of varbind more then this value the pdu will be splitit. This value must be changed when the size of PDU is big and the network node could not handle it(MTU).This could affect the resync time.[20,200]", "format": "int32" }, "useBulkRequest": { "type": "boolean", "description": "To indicate whether SNMP GETBULK mechanism is used to walk SNMP table.If set to false, SNMP GETNEXT will be used.Be careful when it is enabled because it will create jumbo PDU andif the network doesn't support jumbo PDU, the packet can be fragmented and it can be SNMP timeout." }, "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "actionMask": { "type": "integer", "format": "int32" }, "selfAlarmed": { "type": "boolean", "default": false }, "name": { "type": "string" } }, "description": "Managed object abstract class" }, "preDeleteENBs": { "title": "preDeleteENBs", "required": [ "configInfo", "forceDelete" ], "type": "object", "properties": { "configInfo": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" }, { "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } ] }, "forceDelete": { "type": "boolean", "description": "To force eNB unassignment from TCE." } }, "description": "Model containing the method level model for TCE.preDeleteENBs to decode json data to internal NFM-P object model" }, "alterSeverityOfFaultsOnObject": { "title": "alterSeverityOfFaultsOnObject", "required": [ "baseInstanceFullName", "faultFilter", "severity" ], "type": "object", "properties": { "baseInstanceFullName": { "type": "string", "description": "Full name of the affected object for which alarms against it should have their severity updated." }, "faultFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "severity": { "type": "integer", "description": "New severity.", "format": "int32" } }, "description": "Model containing the method level model for FaultManager.alterSeverityOfFaultsOnObject to decode json data to internal NFM-P object model" }, "copyMoveSapsWithSapList": { "title": "copyMoveSapsWithSapList", "required": [ "sapList", "destinationPortFdn", "outerEncapShiftOffset", "innerEncapShiftOffset", "isMoving" ], "type": "object", "properties": { "sapList": { "type": "array", "items": { "type": "string" }, "description": "" }, "destinationPortFdn": { "type": "string" }, "outerEncapShiftOffset": { "type": "integer", "format": "int32" }, "innerEncapShiftOffset": { "type": "integer", "format": "int32" }, "isMoving": { "type": "boolean" } }, "description": "Model containing the method level model for L2AccessInterface.copyMoveSapsWithSapList to decode json data to internal NFM-P object model" }, "findLinkMapProfilesResponse": { "title": "findLinkMapProfilesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for NetworkInterface.findLinkMapProfiles to encode json response from internal NFM-P object model" }, "retrieveBgpEventStartFromBgpStatInterval": { "title": "retrieveBgpEventStartFromBgpStatInterval", "required": [ "bgpAsFdn", "statStartTime", "statEndTime" ], "type": "object", "properties": { "bgpAsFdn": { "type": "string" }, "statStartTime": { "type": "integer", "format": "int64" }, "statEndTime": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for BgpEventPartitionManager.retrieveBgpEventStartFromBgpStatInterval to decode json data to internal NFM-P object model" }, "findInstanceChannelPortsResponse": { "title": "findInstanceChannelPortsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for ApsGroup.findInstanceChannelPorts to encode json response from internal NFM-P object model" }, "createScriptVersion": { "title": "createScriptVersion", "required": [ "versionConfigInfo", "bodyScript" ], "type": "object", "properties": { "versionConfigInfo": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" }, { "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } ] }, "bodyScript": { "type": "array", "items": { "type": "string" }, "description": "The script version body (list of commands)." } }, "description": "Model containing the method level model for AbstractScript.createScriptVersion to decode json data to internal NFM-P object model" }, "findCrossconnectsResponse": { "title": "findCrossconnectsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for P2MPDynamicLsp.findCrossconnects to encode json response from internal NFM-P object model" }, "removeMCMCardResponse": { "title": "removeMCMCardResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/MCMCard" }, { "description": "Managed object abstract class" } ] } }, "description": "Model containing the method level model for MCMCardSlot.removeMCMCard to encode json response from internal NFM-P object model" }, "requestRecoverEsaVm": { "title": "requestRecoverEsaVm", "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInTimeout": { "type": "integer", "format": "int64" }, "aInEsaNum": { "type": "integer", "format": "int32" }, "aInEsaVappNum": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for NatVapp.requestRecoverEsaVm to decode json data to internal NFM-P object model" }, "retrieveL2AwareSubscribers": { "title": "retrieveL2AwareSubscribers", "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInresidentialSubscriber": { "type": "string" } }, "description": "Model containing the method level model for L2AwSubscriber.retrieveL2AwareSubscribers to decode json data to internal NFM-P object model" }, "generateNewRouteDistinguisher": { "title": "generateNewRouteDistinguisher", "required": [ "neId", "routeDistinguisherType" ], "type": "object", "properties": { "neId": { "type": "string", "description": "The Network Element ID. This value must be a valid NE ID and cannot be null nor empty." }, "routeDistinguisherType": { "type": "string", "description": "At this time only type0(0) is supported." } }, "description": "Model containing the method level model for ServiceSite.generateNewRouteDistinguisher to decode json data to internal NFM-P object model" }, "requestPolicyAccountStatsClearResponse": { "title": "requestPolicyAccountStatsClearResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for NetworkInterface.requestPolicyAccountStatsClear to encode json response from internal NFM-P object model" }, "createRoutedVplsConnectorResponse": { "title": "createRoutedVplsConnectorResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for CompositeService.createRoutedVplsConnector to encode json response from internal NFM-P object model" }, "XmlApiConfigTemplateParams": { "title": "XmlApiConfigTemplateParams", "required": [ "objectClassName", "parentTemplatePointer", "generateBody", "generateVelocityParameters", "templatableObjectPointer", "containmentLevel", "includedVelocityParameters" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "parentTemplatePointer": { "type": "string" }, "generateBody": { "type": "boolean" }, "generateVelocityParameters": { "type": "boolean" }, "templatableObjectPointer": { "type": "string" }, "containmentLevel": { "type": "integer", "format": "int32" }, "includedVelocityParameters": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" } }, "description": "Model containing the method level model for struct XmlApiConfigTemplateParams. to decode json data to internal NFM-P object model" }, "AuditLocalPolicyEntityResultInfo": { "title": "AuditLocalPolicyEntityResultInfo", "required": [ "objectClassName", "isNewEntry", "properties" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "isNewEntry": { "type": "boolean" }, "properties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" } }, "description": "Model containing the method level model for struct AuditLocalPolicyEntityResultInfo. to decode json data to internal NFM-P object model" }, "requestNatPoolHistogramResponse": { "title": "requestNatPoolHistogramResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/NatPoolHistogram" }, "description": "The response object." } }, "description": "Model containing the method level model for NatPool.requestNatPoolHistogram to encode json response from internal NFM-P object model" }, "findInactivePrimaryStaticRoutes": { "title": "findInactivePrimaryStaticRoutes", "required": [ "fields", "sortFields", "pageNumber", "pageSize" ], "type": "object", "properties": { "fields": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Sorting fields" }, "sortFields": { "type": "array", "items": { "type": "string" }, "description": "Sorting fields" }, "pageNumber": { "type": "integer", "description": "Page number", "format": "int32" }, "pageSize": { "type": "integer", "description": "The number of entries to return", "format": "int32" } }, "description": "Model containing the method level model for AutonomousSystem.findInactivePrimaryStaticRoutes to decode json data to internal NFM-P object model" }, "retrieveScriptSnippetReferencesResponse": { "title": "retrieveScriptSnippetReferencesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for DynSvcSnippetInfo.retrieveScriptSnippetReferences to encode json response from internal NFM-P object model" }, "saveResult": { "title": "saveResult", "required": [ "resultConfigInfo", "resultBody" ], "type": "object", "properties": { "resultConfigInfo": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" }, { "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } ] }, "resultBody": { "type": "string", "description": "The result text from the execution of the target script." } }, "description": "Model containing the method level model for ResultManager.saveResult to decode json data to internal NFM-P object model" }, "triggerNeAuditResponse": { "title": "triggerNeAuditResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for NeAuditManager.triggerNeAudit to encode json response from internal NFM-P object model" }, "TopologyDiscoveryRuleElementConfigInfo": { "title": "TopologyDiscoveryRuleElementConfigInfo", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap", "containmentInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } }, "ipAddressType": { "type": "integer", "format": "int32" }, "ipAddress": { "type": "string" }, "maskBits": { "type": "integer", "format": "int32" }, "usage": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for Interface ConfigInfo TopologyDiscoveryRuleElementConfigInfo. to decode json data to internal NFM-P object model" }, "listUnusedClassesResponse": { "title": "listUnusedClassesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for SizeConstrainedClass.listUnusedClasses to encode json response from internal NFM-P object model" }, "findFaultsOnObjectResponse": { "title": "findFaultsOnObjectResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "object" }, "description": "The response object." } }, "description": "Model containing the method level model for FaultManager.findFaultsOnObject to encode json response from internal NFM-P object model" }, "retrievePPPoESessions": { "title": "retrievePPPoESessions", "required": [ "retrievingSessionStruct", "shallowRetrieval", "retrieveL2tpPeerAddress", "retrieveManagedRoutes", "retrieveQoSOvr", "retrieveAcclpEncap", "retrieveBgpPeerInfo", "retrieveBgpPeerV6Info" ], "type": "object", "properties": { "aInCircuitId": { "type": "string" }, "aInRemoteId": { "type": "string" }, "retrievingSessionStruct": { "allOf": [ { "$ref": "#/components/schemas/RetrievingSessionStruct" }, { "description": "Model containing the method level model for struct RetrievingSessionStruct. to decode json data to internal NFM-P object model" } ] }, "shallowRetrieval": { "type": "boolean", "description": "If it is true, not all of the properties are retrieved for quick response default:false" }, "retrieveL2tpPeerAddress": { "type": "boolean", "description": "Specifies if l2tpPeerAddress should be retrieved,the default is \"false\". default:false" }, "retrieveManagedRoutes": { "type": "boolean", "description": "Specifies if Managed Routes should be retrieved,the default is \"true\".The Managed Routes won't be retrieved if Service preferences \"retrieveManagedRoutes\" is false. default:true" }, "retrieveQoSOvr": { "type": "boolean", "description": "Specifies if QoS Override should be retrieved,the default is \"true\".The QoS Override won't be retrieved if Service preferences \"retrieveQoSOvr\" is false. default:true" }, "retrieveAcclpEncap": { "type": "boolean", "description": "Specifies if Access Loop Encapsulation should be retrieved,the default is \"true\".The Access Loop Encapsulation won't be retrieved if Service preferences \"retrieveAcclpEncap\" is false. default:true" }, "retrieveBgpPeerInfo": { "type": "boolean", "description": "Specifies if IPv4 BGP Peer Info should be retrieved,the default is \"true\".The BGP Peer Info won't be retrieved if System Preferences \"retrieveBgpPeerInfo\" isfalse. default:true" }, "retrieveBgpPeerV6Info": { "type": "boolean", "description": "Specifies if IPv6 BGP Peer Info should be retrieved,the default is \"true\".The BGP Peer Info won't be retrieved if System Preferences \"retrieveBgpPeerV6Info\" isfalse. default:true" } }, "description": "Model containing the method level model for PPPoESession.retrievePPPoESessions to decode json data to internal NFM-P object model" }, "getDefinedObjectResponse": { "title": "getDefinedObjectResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for MFibEntry.getDefinedObject to encode json response from internal NFM-P object model" }, "purge": { "title": "purge", "required": [ "logEntityType", "className", "purgeType", "recordFilter" ], "type": "object", "properties": { "logEntityType": { "type": "string", "description": "Type of record to be purged." }, "className": { "type": "string", "description": "Class name of the records to be purged." }, "purgeType": { "type": "string", "description": "Not used." }, "recordFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for LogPolicy.purge to decode json data to internal NFM-P object model" }, "SessionStruct": { "title": "SessionStruct", "required": [ "objectClassName", "siteId", "routerId", "connectionId", "filter", "timeout" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "routerId": { "type": "integer", "format": "int64" }, "connectionId": { "type": "integer", "format": "int64" }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "timeout": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct SessionStruct. to decode json data to internal NFM-P object model" }, "ShortestPathGraph": { "title": "ShortestPathGraph", "required": [ "objectClassName", "sourceType", "destType", "type", "source", "sourceLen", "dest", "destLen", "totalCostValid", "totalCosts", "nodes", "errors" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "sourceType": { "type": "string" }, "destType": { "type": "string" }, "type": { "type": "string" }, "source": { "type": "string" }, "sourceLen": { "type": "integer", "format": "int32" }, "dest": { "type": "string" }, "destLen": { "type": "integer", "format": "int32" }, "totalCostValid": { "type": "boolean" }, "totalCosts": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "" }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/SPNode" }, "description": "" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/DetailedError" }, "description": "" } }, "description": "Model containing the method level model for struct ShortestPathGraph. to decode json data to internal NFM-P object model" }, "retrieveAntiSpoofingFilters": { "title": "retrieveAntiSpoofingFilters", "required": [ "timeout" ], "type": "object", "properties": { "aInRtrId": { "type": "string" }, "aInPortPointer": { "type": "string" }, "aInSvcId": { "type": "integer", "format": "int64" }, "aInPortId": { "type": "integer", "format": "int64" }, "aInInnerEncapValue": { "type": "integer", "format": "int32" }, "aInOuterEncapValue": { "type": "integer", "format": "int32" }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns.", "format": "int64" } }, "description": "Model containing the method level model for AntiSpoofingFilter.retrieveAntiSpoofingFilters to decode json data to internal NFM-P object model" }, "RtrvHostSharedFilterStruct": { "title": "RtrvHostSharedFilterStruct", "required": [ "objectClassName", "filterType", "retrieveEntryOption", "entryApplicationType", "siteId", "filterId" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "filterType": { "type": "string" }, "retrieveEntryOption": { "type": "string" }, "entryApplicationType": { "type": "string" }, "siteId": { "type": "string" }, "filterId": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct RtrvHostSharedFilterStruct. to decode json data to internal NFM-P object model" }, "retrieveMldHostPerSubscrHostResponse": { "title": "retrieveMldHostPerSubscrHostResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for MldHost.retrieveMldHostPerSubscrHost to encode json response from internal NFM-P object model" }, "findAssociatedObjects": { "title": "findAssociatedObjects", "required": [ "filter" ], "type": "object", "properties": { "aInClassName": { "type": "string" }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for FlexibleAlgorithmDefinition.findAssociatedObjects to decode json data to internal NFM-P object model" }, "retrieveLacMlpppBundlesResponse": { "title": "retrieveLacMlpppBundlesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for LacMlpppBundle.retrieveLacMlpppBundles to encode json response from internal NFM-P object model" }, "importPolicies": { "title": "importPolicies", "required": [ "importFileName", "overrideExistingGlobalPolicy" ], "type": "object", "properties": { "importFileName": { "type": "string", "description": "Indicates the xml file name from which the global policies would be created in NFM-P." }, "overrideExistingGlobalPolicy": { "type": "boolean", "description": "Indicates if the global policy already exists in NFM-P, then, should it overridden with the imported global policy or not." } }, "description": "Model containing the method level model for Manager.importPolicies to decode json data to internal NFM-P object model" }, "retrieveBgpEventTopNContributers": { "title": "retrieveBgpEventTopNContributers", "required": [ "numOfResults", "contributerType", "changeType", "addrType", "startTime", "endTime" ], "type": "object", "properties": { "numOfResults": { "type": "integer", "description": "The number of results to retrieve, from 1 to 100", "format": "int32" }, "contributerType": { "type": "string", "description": "The type of contributer" }, "changeType": { "type": "array", "items": { "type": "string" }, "description": "The event change type" }, "addrType": { "type": "string", "description": "The BGP Address type" }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for BgpAutonomousSystem.retrieveBgpEventTopNContributers to decode json data to internal NFM-P object model" }, "requestClearArpCacheResponse": { "title": "requestClearArpCacheResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for Site.requestClearArpCache to encode json response from internal NFM-P object model" }, "getUXPrefsResponse": { "title": "getUXPrefsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for UserGroup.getUXPrefs to encode json response from internal NFM-P object model" }, "findCtpsOnMultiplePortsWithFilter": { "title": "findCtpsOnMultiplePortsWithFilter", "required": [ "portObjectFilter", "ctpFilter" ], "type": "object", "properties": { "portObjectFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "ctpFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for ConnectionTerminationPoint.findCtpsOnMultiplePortsWithFilter to decode json data to internal NFM-P object model" }, "Pair": { "title": "Pair", "required": [ "objectClassName", "firstObject", "secondObject" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "firstObject": { "allOf": [ { "$ref": "#/components/schemas/L3AccessInterfaceConfigInfo" }, { "description": "Model containing the method level model for Interface ConfigInfo L3AccessInterfaceConfigInfo. to decode json data to internal NFM-P object model" } ] }, "secondObject": { "allOf": [ { "$ref": "#/components/schemas/IPSecTunnelConfigInfo" }, { "description": "Model containing the method level model for Interface ConfigInfo IPSecTunnelConfigInfo. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for struct Pair. to decode json data to internal NFM-P object model" }, "RestFilter": { "title": "RestFilter", "required": [ "fullClassName", "filterExpression" ], "type": "object", "properties": { "fullClassName": { "type": "string", "description": "string", "example": "netw.NetworkElement" }, "filterExpression": { "type": "string", "description": "string", "example": "siteId = '1.1.1.1'" } }, "description": "Model containing the Data model for RestFilter" }, "AuditSelectedPoliciesInfo": { "title": "AuditSelectedPoliciesInfo", "required": [ "objectClassName", "selectedPolicies", "alarmAllDifferences", "selectedNEList", "localEditDifferences", "globalSyncNonDifferences", "globalPoliciesNames" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "selectedPolicies": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "" }, "alarmAllDifferences": { "type": "boolean" }, "selectedNEList": { "type": "array", "items": { "type": "string" }, "description": "" }, "localEditDifferences": { "type": "boolean" }, "globalSyncNonDifferences": { "type": "boolean" }, "globalPoliciesNames": { "type": "array", "items": { "type": "string" }, "description": "" } }, "description": "Model containing the method level model for struct AuditSelectedPoliciesInfo. to decode json data to internal NFM-P object model" }, "findCandidateGroupsForNewMembersResponse": { "title": "findCandidateGroupsForNewMembersResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/GroupInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for GroupManager.findCandidateGroupsForNewMembers to encode json response from internal NFM-P object model" }, "findServicePathResponse": { "title": "findServicePathResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/ServicePathInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for TransportService.findServicePath to encode json response from internal NFM-P object model" }, "TemplateIdPair": { "title": "TemplateIdPair", "required": [ "objectClassName", "ossAssignedName", "ossAssignedDescription", "fdn" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "ossAssignedName": { "type": "string" }, "ossAssignedDescription": { "type": "string" }, "fdn": { "type": "string" } }, "description": "Model containing the method level model for struct TemplateIdPair. to decode json data to internal NFM-P object model" }, "findManagedNodesResponse": { "title": "findManagedNodesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for Domain.findManagedNodes to encode json response from internal NFM-P object model" }, "updateBgpRouteTargets": { "title": "updateBgpRouteTargets", "required": [ "cpaa", "vpnType" ], "type": "object", "properties": { "cpaa": { "type": "string", "description": "The management IP address of the CPAA." }, "vpnType": { "type": "string", "description": "The the type of VPN for the Cpaa to retieve. Right now, IPv4 and L2 VPN only." } }, "description": "Model containing the method level model for TopologyManager.updateBgpRouteTargets to decode json data to internal NFM-P object model" }, "retrieveIpMappings": { "title": "retrieveIpMappings", "required": [ "evpnId", "ipAddress" ], "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInTimeout": { "type": "integer", "format": "int64" }, "evpnId": { "type": "integer", "description": "Specifies EVPN ID. This is mandatory parameter.", "format": "int64" }, "ipAddress": { "type": "string", "description": "Specifies Service Forward IP Address. This is optional parameter. default:" } }, "description": "Model containing the method level model for SvcChainIpMapping.retrieveIpMappings to decode json data to internal NFM-P object model" }, "findNonMembersResponse": { "title": "findNonMembersResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/NetworkElementInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for GroupManager.findNonMembers to encode json response from internal NFM-P object model" }, "LoOdukCrossConnectInfo": { "title": "LoOdukCrossConnectInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "administrativeState": { "type": "integer", "format": "int32" }, "connId": { "type": "integer", "format": "int64" }, "biDirectional": { "type": "boolean", "default": false }, "connectionType": { "type": "integer", "format": "int32" }, "portAPointer": { "type": "string" }, "portZPointer": { "type": "string" }, "ctpAPointer": { "type": "string" }, "ctpZPointer": { "type": "string" }, "protectionState": { "type": "integer", "format": "int32" }, "protectionLevel": { "type": "integer", "format": "int32" }, "modifyFlag": { "type": "boolean", "default": false }, "isRidingOnConnGroup": { "type": "boolean", "default": false }, "xcId": { "type": "integer", "format": "int64" }, "xcName": { "type": "string" }, "siteId": { "type": "string" }, "siteName": { "type": "string" }, "shelfId": { "type": "integer", "format": "int32" }, "slotId": { "type": "integer", "format": "int64" }, "srcVtsNumber": { "type": "integer", "format": "int32" }, "destVtsNumber": { "type": "integer", "format": "int32" }, "vtsNumber": { "type": "integer", "format": "int32" }, "vtsLine": { "type": "integer", "format": "int32" }, "odukXcRate": { "type": "integer", "format": "int32" }, "odukXcName": { "type": "string" }, "odukXcSrcIfIndex": { "type": "integer", "format": "int64" }, "odukXcSrcIfIndexLo": { "type": "integer", "format": "int64" }, "odukXcSrcGid": { "type": "integer", "format": "int32" }, "odukXcDestIfIndex": { "type": "integer", "format": "int64" }, "odukXcDestIfIndexLo": { "type": "integer", "format": "int64" }, "isOth": { "type": "boolean", "default": false }, "odukXcDestGid": { "type": "integer", "format": "int32" }, "odukXcRowStatus": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for Interface LoOdukCrossConnectInfo. to decode json data to internal NFM-P object model" }, "findValidTerminatingPortsForServiceControlPlane": { "title": "findValidTerminatingPortsForServiceControlPlane", "type": "object", "properties": { "aInSiteIdList": { "type": "array", "items": { "type": "string" }, "description": "" }, "aInRate": { "type": "integer", "format": "int32" }, "aInProtectionType": { "type": "integer", "format": "int32" }, "aInDirection": { "type": "integer", "format": "int32" }, "aInIsQinQService": { "type": "boolean", "default": false }, "aInIsQinQFullRateService": { "type": "boolean", "default": false }, "aInSvcType": { "type": "integer", "format": "int32" }, "aInMgtDomain": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for ServiceSite.findValidTerminatingPortsForServiceControlPlane to decode json data to internal NFM-P object model" }, "findNumberOfMacsResponse": { "title": "findNumberOfMacsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int32" } }, "description": "Model containing the method level model for ProxyArpNdMacList.findNumberOfMacs to encode json response from internal NFM-P object model" }, "requestClearNeighborCacheResponse": { "title": "requestClearNeighborCacheResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for Site.requestClearNeighborCache to encode json response from internal NFM-P object model" }, "findPolicyResponse": { "title": "findPolicyResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/PollerPolicyInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for PollerManager.findPolicy to encode json response from internal NFM-P object model" }, "RetrGtpS11SessionStruct": { "title": "RetrGtpS11SessionStruct", "required": [ "objectClassName", "siteId", "imsi", "apn", "timeout" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "imsi": { "type": "string" }, "apn": { "type": "string" }, "timeout": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct RetrGtpS11SessionStruct. to decode json data to internal NFM-P object model" }, "findSitesFor": { "title": "findSitesFor", "required": [ "filter", "expandChildren" ], "type": "object", "properties": { "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "expandChildren": { "type": "boolean" } }, "description": "Model containing the method level model for VirtualRouterIpAddress.findSitesFor to decode json data to internal NFM-P object model" }, "removeFaultsOnObject": { "title": "removeFaultsOnObject", "required": [ "baseInstanceFullName", "faultFilter" ], "type": "object", "properties": { "baseInstanceFullName": { "type": "string", "description": "Full name of the affected object on which the alarms should be deleted." }, "faultFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for FaultManager.removeFaultsOnObject to decode json data to internal NFM-P object model" }, "removeNeWorkOrders": { "title": "removeNeWorkOrders", "required": [ "sessionFdn", "neWorkOrders" ], "type": "object", "properties": { "sessionFdn": { "type": "string", "description": "The session to validate." }, "neWorkOrders": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The set of NE work orders to remove from the session." } }, "description": "Model containing the method level model for Session.removeNeWorkOrders to decode json data to internal NFM-P object model" }, "addCASites": { "title": "addCASites", "required": [ "siteIdList", "caFullName" ], "type": "object", "properties": { "siteIdList": { "type": "array", "items": { "type": "string" }, "description": "List of siteIds." }, "caFullName": { "type": "string" } }, "description": "Model containing the method level model for ConnectivityAssociation.addCASites to decode json data to internal NFM-P object model" }, "getAllVlanRanegSAPsResponse": { "title": "getAllVlanRanegSAPsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for PssConnProfPolicy.getAllVlanRanegSAPs to encode json response from internal NFM-P object model" }, "stopContinuousTests": { "title": "stopContinuousTests", "required": [ "tests", "testOrTestsuite" ], "type": "object", "properties": { "tests": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "testOrTestsuite": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for TestManager.stopContinuousTests to decode json data to internal NFM-P object model" }, "setConfigurationModeToDraftResponse": { "title": "setConfigurationModeToDraftResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int32" } }, "description": "Model containing the method level model for PolicyDefinition.setConfigurationModeToDraft to encode json response from internal NFM-P object model" }, "retrieveMldHostsResponse": { "title": "retrieveMldHostsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for MldHost.retrieveMldHosts to encode json response from internal NFM-P object model" }, "configureScriptResponse": { "title": "configureScriptResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for AbstractScript.configureScript to encode json response from internal NFM-P object model" }, "requestRecoverL2AwBypass": { "title": "requestRecoverL2AwBypass", "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInTimeout": { "type": "integer", "format": "int64" }, "aInMdaNumber": { "type": "integer", "format": "int32" }, "aInSlotNumber": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for IsaMda.requestRecoverL2AwBypass to decode json data to internal NFM-P object model" }, "cancelRunningCliExecution": { "title": "cancelRunningCliExecution", "required": [ "clientId" ], "type": "object", "properties": { "aInTargetScriptFdn": { "type": "string" }, "clientId": { "type": "string", "description": "The client ID of the client that requested the execution of the target script." } }, "description": "Model containing the method level model for ScriptManager.cancelRunningCliExecution to decode json data to internal NFM-P object model" }, "executeCLITargetScriptsResponse": { "title": "executeCLITargetScriptsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for ScriptManager.executeCLITargetScripts to encode json response from internal NFM-P object model" }, "resync": { "title": "resync", "required": [ "neIdOrNameList", "mibOidList", "ignoreTimestamps" ], "type": "object", "properties": { "neIdOrNameList": { "type": "array", "items": { "type": "string" }, "description": "list of network elements to be resynched" }, "mibOidList": { "type": "array", "items": { "type": "string" }, "description": "list of the mibs to be resynched" }, "ignoreTimestamps": { "type": "boolean", "description": "ignore time stamps" } }, "description": "Model containing the method level model for PollerManager.resync to decode json data to internal NFM-P object model" }, "createControlService": { "title": "createControlService", "type": "object", "properties": { "aInCustomerFdn": { "type": "string" }, "aInControlServiceTemplateFdn": { "type": "string" }, "aInUpperRingOuterEncap": { "type": "integer", "format": "int32" }, "aInUpperRingInnerEncap": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for Ring.createControlService to decode json data to internal NFM-P object model" }, "findExportPolicyFileInfoResponse": { "title": "findExportPolicyFileInfoResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ExportPolicyFileInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for Manager.findExportPolicyFileInfo to encode json response from internal NFM-P object model" }, "executeCLIScript": { "title": "executeCLIScript", "required": [ "isSynchronized", "clientId", "targetScriptFullNameList" ], "type": "object", "properties": { "isSynchronized": { "type": "boolean", "description": "Identifies if the call to execute the script should wait until all scripts have been executed. True to wait, false otherwise." }, "clientId": { "type": "string", "description": "Identifies the client ID that is requesting the execution (used for sending an event to the specific client when execution is complete)." }, "targetScriptFullNameList": { "type": "array", "items": { "type": "string" }, "description": "Identifies the list of target scripts to execute." } }, "description": "Model containing the method level model for ScriptManager.executeCLIScript to decode json data to internal NFM-P object model" }, "createControlServiceResponse": { "title": "createControlServiceResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for Ring.createControlService to encode json response from internal NFM-P object model" }, "applyStaticPortMapRequestWithResult": { "title": "applyStaticPortMapRequestWithResult", "type": "object", "properties": { "aInValidate": { "type": "boolean", "default": false }, "aInRequest": { "allOf": [ { "$ref": "#/components/schemas/StaticPortMapRequestConfigInfo" }, { "description": "Model containing the method level model for Interface ConfigInfo StaticPortMapRequestConfigInfo. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for StaticPortMapRequest.applyStaticPortMapRequestWithResult to decode json data to internal NFM-P object model" }, "findInterfacesResponse": { "title": "findInterfacesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for SharedRiskLinkGroup.findInterfaces to encode json response from internal NFM-P object model" }, "QosPool": { "title": "QosPool", "required": [ "siteId", "shelfId", "equipmentId", "equipmentPointer", "equipmentType", "appType", "appPool", "reservedCbs", "slopePolicy", "slopePolicyPointer", "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties" ], "type": "object", "properties": { "siteId": { "type": "string", "description": "50]", "readOnly": true, "example": " maximum: 50" }, "shelfId": { "type": "integer", "format": "int32" }, "equipmentId": { "type": "integer", "format": "int64", "readOnly": true }, "equipmentPointer": { "type": "string", "description": "252]", "example": " maximum: 252" }, "equipmentType": { "type": "integer", "format": "int32" }, "appType": { "type": "integer", "format": "int32" }, "appPool": { "type": "string", "description": "32] Mandatory on create.", "example": " maximum: 32" }, "reservedCbs": { "type": "integer", "description": "[-1,100]", "format": "int32", "readOnly": true }, "slopePolicy": { "type": "string", "description": "[1,32]", "readOnly": true, "example": " maximum: 32" }, "slopePolicyPointer": { "type": "string" }, "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "actionMask": { "type": "integer", "format": "int32" }, "selfAlarmed": { "type": "boolean", "default": false }, "name": { "type": "string" } }, "description": "Managed object abstract class" }, "configureChildInstanceWithResult": { "title": "configureChildInstanceWithResult", "required": [ "distinguishedName", "childConfigInfo" ], "type": "object", "properties": { "distinguishedName": { "type": "string", "description": "Distinguished Name of parent under which object is being configured." }, "childConfigInfo": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" }, { "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for GenericObject.configureChildInstanceWithResult to decode json data to internal NFM-P object model" }, "stopTunnels": { "title": "stopTunnels", "type": "object", "properties": { "aInGroupNameList": { "type": "array", "items": { "type": "string" }, "description": "" }, "aInSiteId": { "type": "string" }, "aInRouterId": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for GroupProfile.stopTunnels to decode json data to internal NFM-P object model" }, "checkBulkDistributeWithinCapacity": { "title": "checkBulkDistributeWithinCapacity", "required": [ "siteIds", "instanceNames" ], "type": "object", "properties": { "siteIds": { "type": "array", "items": { "type": "string" }, "description": "The siteId list for distribution. If the list is empty the behavior is driven bythe attribute allSitesIncluded." }, "instanceNames": { "type": "array", "items": { "type": "string" }, "description": "List of policy instance names to be distributed." } }, "description": "Model containing the method level model for Manager.checkBulkDistributeWithinCapacity to decode json data to internal NFM-P object model" }, "getResultBodyResponse": { "title": "getResultBodyResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for Result.getResultBody to encode json response from internal NFM-P object model" }, "findPolicyOfType": { "title": "findPolicyOfType", "required": [ "policyType", "filter" ], "type": "object", "properties": { "policyType": { "type": "string" }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for Manager.findPolicyOfType to decode json data to internal NFM-P object model" }, "configureMultipleInstances": { "title": "configureMultipleInstances", "required": [ "routingInstanceSites", "configInfo" ], "type": "object", "properties": { "routingInstanceSites": { "type": "array", "items": { "type": "string" }, "description": "" }, "configInfo": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" }, { "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for RoutingInstanceSite.configureMultipleInstances to decode json data to internal NFM-P object model" }, "checkConfigResponse": { "title": "checkConfigResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for RcaManager.checkConfig to encode json response from internal NFM-P object model" }, "findApplicableOdukFacilityObjects": { "title": "findApplicableOdukFacilityObjects", "type": "object", "properties": { "aInApsGroupConfigInfo": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" }, { "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } ] }, "aInOdukFacilityType": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for ApsGroup.findApplicableOdukFacilityObjects to decode json data to internal NFM-P object model" }, "retrieveWlanGwUesResponse": { "title": "retrieveWlanGwUesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for WlanGwQbtUe.retrieveWlanGwUes to encode json response from internal NFM-P object model" }, "createBidirMonitoredPathResponse": { "title": "createBidirMonitoredPathResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/BidirBulkCreationResult" }, { "description": "Model containing the method level model for struct BidirBulkCreationResult. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for MonitoredPathManager.createBidirMonitoredPath to encode json response from internal NFM-P object model" }, "FindSyncTagsInputStruct": { "title": "FindSyncTagsInputStruct", "required": [ "objectClassName", "portFilter", "validForMcRing" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "portFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "validForMcRing": { "type": "boolean" } }, "description": "Model containing the method level model for struct FindSyncTagsInputStruct. to decode json data to internal NFM-P object model" }, "adhocExecuteAndWaitResponse": { "title": "adhocExecuteAndWaitResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/TestResult" }, { "description": "Model containing the method level model for struct TestResult. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for Test.adhocExecuteAndWait to encode json response from internal NFM-P object model" }, "testAlarm": { "title": "testAlarm", "required": [ "objectInstanceName", "alarmNameId", "alarmTypeId", "probableCauseId", "severity", "alarmClassTag", "namingComponent", "additionalText", "nodeTimeOffset" ], "type": "object", "properties": { "objectInstanceName": { "type": "string", "description": "Full name of the managed object on which to create the test alarm." }, "alarmNameId": { "type": "integer", "description": "Alarm name of the test alarm. please refer to {{fm.AlarmObject.alarmName}} for details.", "format": "int32" }, "alarmTypeId": { "type": "integer", "description": "Alarm type of the test alarm. please refer to {{fm.AlarmObject.type}} for details.", "format": "int32" }, "probableCauseId": { "type": "integer", "description": "Probable cause of the test alarm. please refer to {{fm.AlarmObject.probableCause}} for details.", "format": "int32" }, "severity": { "type": "string", "description": "Severity of the test alarm. please refer to {{fm.AlarmObject.severity}} for details." }, "alarmClassTag": { "type": "string", "description": "Alarm class tag of the test alarm. please refer to {{fm.AlarmObject.alarmClassTag}} for details." }, "namingComponent": { "type": "string", "description": "Naming component of the test alarm. Used to distinguish two alarms with the same name, type and probable cause on the same affected object." }, "additionalText": { "type": "string", "description": "Additional text of the test alarm." }, "nodeTimeOffset": { "type": "integer", "description": "Node time offset indicating the time zone.", "format": "int64" } }, "description": "Model containing the method level model for FaultManager.testAlarm to decode json data to internal NFM-P object model" }, "unProtect": { "title": "unProtect", "type": "object", "properties": { "aInFdns": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "aInRemoveWorkingPath": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for TdmFacilityProtectionGroup.unProtect to decode json data to internal NFM-P object model" }, "findByIpAddress": { "title": "findByIpAddress", "required": [ "nodeId", "routingInstance", "ipAddress" ], "type": "object", "properties": { "nodeId": { "type": "string" }, "routingInstance": { "type": "integer", "format": "int64" }, "ipAddress": { "type": "string" } }, "description": "Model containing the method level model for VirtualInterface.findByIpAddress to decode json data to internal NFM-P object model" }, "retrieveDslLineInfoResponse": { "title": "retrieveDslLineInfoResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for AncpDslLineInfo.retrieveDslLineInfo to encode json response from internal NFM-P object model" }, "findGroupsContainingObject": { "title": "findGroupsContainingObject", "required": [ "filter" ], "type": "object", "properties": { "aInObjectFullName": { "type": "string" }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for GroupDirector.findGroupsContainingObject to decode json data to internal NFM-P object model" }, "setBaselineResponse": { "title": "setBaselineResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int64" } }, "description": "Model containing the method level model for SupervisionGroup.setBaseline to encode json response from internal NFM-P object model" }, "setGroupBaselineResponse": { "title": "setGroupBaselineResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "integer", "description": "The response object.", "format": "int64" } }, "description": "Model containing the method level model for SummaryView.setGroupBaseline to encode json response from internal NFM-P object model" }, "retrieveWlanGwUesPerBdResponse": { "title": "retrieveWlanGwUesPerBdResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for WlanGwBdUe.retrieveWlanGwUesPerBd to encode json response from internal NFM-P object model" }, "retrieveBgpEventsFilterResponse": { "title": "retrieveBgpEventsFilterResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/PagingResult" }, { "description": "Model containing the method level model for struct PagingResult. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for TopologyManager.retrieveBgpEventsFilter to encode json response from internal NFM-P object model" }, "retrieveSigNodeAdmin": { "title": "retrieveSigNodeAdmin", "required": [ "siteId", "sigNodeTypeFlags", "networkTechType", "gwtsName" ], "type": "object", "properties": { "siteId": { "type": "string" }, "sigNodeTypeFlags": { "type": "array", "items": { "type": "string" }, "description": "default:0" }, "networkTechType": { "type": "string", "description": "default:lte" }, "gwtsName": { "type": "string", "description": "default:" }, "requestId": { "type": "string", "description": "Non documentable API" } }, "description": "Model containing the method level model for CMMInstance.retrieveSigNodeAdmin to decode json data to internal NFM-P object model" }, "aldUpgradeResponse": { "title": "aldUpgradeResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for RANAldSoftwareFolderDescriptor.aldUpgrade to encode json response from internal NFM-P object model" }, "findHopsResponse": { "title": "findHopsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/PreviewHopInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for PreviewPath.findHops to encode json response from internal NFM-P object model" }, "importRANLicenses": { "title": "importRANLicenses", "required": [ "licenseFileName", "clientIpAddressSource", "clientUserNameSource", "licenseFileContents" ], "type": "object", "properties": { "licenseFileName": { "type": "string" }, "clientIpAddressSource": { "type": "string" }, "clientUserNameSource": { "type": "string" }, "licenseFileContents": { "type": "string" } }, "description": "Model containing the method level model for RANLicenseManager.importRANLicenses to decode json data to internal NFM-P object model" }, "requestNatPoolHistogram": { "title": "requestNatPoolHistogram", "type": "object", "properties": { "aInNatPoolFullName": { "type": "string" }, "aInBucketSize": { "type": "integer", "format": "int64" }, "aInNumBuckets": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for NatPool.requestNatPoolHistogram to decode json data to internal NFM-P object model" }, "findFaultsOnObject": { "title": "findFaultsOnObject", "required": [ "baseInstanceFullName", "faultFilter" ], "type": "object", "properties": { "baseInstanceFullName": { "type": "string", "description": "Full name of the affected object on which the alarms should be listed." }, "faultFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for FaultManager.findFaultsOnObject to decode json data to internal NFM-P object model" }, "DynSvcSnippetInfoRetrievalStruct": { "title": "DynSvcSnippetInfoRetrievalStruct", "required": [ "objectClassName", "siteId", "snippetName", "snippetInstance", "timeout" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "snippetName": { "type": "string" }, "snippetInstance": { "type": "string" }, "timeout": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct DynSvcSnippetInfoRetrievalStruct. to decode json data to internal NFM-P object model" }, "requestClearIdleOnlyMsapsResponse": { "title": "requestClearIdleOnlyMsapsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for Policy.requestClearIdleOnlyMsaps to encode json response from internal NFM-P object model" }, "activateFirmwareImage": { "title": "activateFirmwareImage", "required": [ "networkElements", "simId" ], "type": "object", "properties": { "networkElements": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "simId": { "type": "integer", "description": "default:1", "format": "int32" } }, "description": "Model containing the method level model for FirmwareFolderDescriptor.activateFirmwareImage to decode json data to internal NFM-P object model" }, "bgpPrefixAnalysisResponse": { "title": "bgpPrefixAnalysisResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "object", "additionalProperties": { "type": "object" }, "description": "The response object." } }, "description": "Model containing the method level model for BgpImpactAnalysisTimeRange.bgpPrefixAnalysis to encode json response from internal NFM-P object model" }, "alterOLCStateOfFaultList": { "title": "alterOLCStateOfFaultList", "required": [ "faultObjectNameSet", "olcState" ], "type": "object", "properties": { "faultObjectNameSet": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Set of the alarm full names to have their OLC state updated." }, "olcState": { "type": "integer", "description": "New OLC state.", "format": "int32" } }, "description": "Model containing the method level model for FaultManager.alterOLCStateOfFaultList to decode json data to internal NFM-P object model" }, "InterfaceInfo": { "title": "InterfaceInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "administrativeState": { "type": "integer", "format": "int32" }, "oesShelfId": { "type": "integer", "format": "int32" }, "phyShelfClass": { "type": "integer", "format": "int32" }, "phyShelfType": { "type": "integer", "format": "int32" }, "lockOlcState": { "type": "boolean", "default": false }, "portId": { "type": "integer", "format": "int64" }, "description": { "type": "string" }, "mode": { "type": "integer", "format": "int32" }, "isl2UplinkMode": { "type": "boolean", "default": false }, "macAddress": { "type": "string" }, "encapType": { "type": "integer", "format": "int32" }, "holdTimeUp": { "type": "integer", "format": "int32" }, "holdTimeDown": { "type": "integer", "format": "int32" }, "mtuValue": { "type": "integer", "format": "int32" }, "speed": { "type": "integer", "format": "int32" }, "accountingPolicyObjectPointer": { "type": "string" }, "collectStats": { "type": "boolean", "default": false }, "etherAccountingPolicyObjectPointer": { "type": "string" }, "etherCollectStats": { "type": "boolean", "default": false }, "ethAccessAccountingPolicyObjectPointer": { "type": "string" }, "ethAccessCollectStats": { "type": "boolean", "default": false }, "networkQueueObjectPointer": { "type": "string" }, "loadBalanceAlgorithm": { "type": "integer", "format": "int32" }, "portSchedulerPolicyObjectPointer": { "type": "string" }, "portEgrHsmdaSchedulerPolicy": { "type": "string" }, "uniProfilePointer": { "type": "string" }, "portIngrNamedPoolPlcy": { "type": "string" }, "portEgrNamedPoolPlcy": { "type": "string" }, "portIngrPoolPercentageRate": { "type": "integer", "format": "int32" }, "portEgrPoolPercentageRate": { "type": "integer", "format": "int32" }, "vlanAutoBind": { "type": "boolean", "default": false }, "l2ProfilePointer": { "type": "string" }, "holdTimeUnits": { "type": "integer", "format": "int32" }, "linkTrap": { "type": "integer", "format": "int32" }, "userLabel": { "type": "string" }, "mptCombinerImplemented": { "type": "integer", "format": "int64" }, "numOfDot1qSapUsingVCP": { "type": "integer", "format": "int32" }, "isVCPUpdatedForDot1qSap": { "type": "boolean", "default": false }, "isVCPSapPort": { "type": "boolean", "default": false }, "unpPortType": { "type": "integer", "format": "int32" }, "assignedCardSubType": { "type": "integer", "format": "int32" }, "lagId": { "type": "integer", "format": "int32" }, "slotId": { "type": "integer", "format": "int32" }, "portThreshold": { "type": "integer", "format": "int32" }, "portThresholdAction": { "type": "integer", "format": "int32" }, "portThresholdStaticCost": { "type": "integer", "format": "int64" }, "dynamicCosting": { "type": "boolean", "default": false }, "adaptiveLoadBalancing": { "type": "boolean", "default": false }, "tolerance": { "type": "integer", "format": "int32" }, "adaptiveLbInterval": { "type": "integer", "format": "int32" }, "lagPortType": { "type": "integer", "format": "int32" }, "adaptQoS": { "type": "integer", "format": "int32" }, "perLinkHashing": { "type": "boolean", "default": false }, "perFpIngQueuing": { "type": "boolean", "default": false }, "perFpEgrQueuing": { "type": "boolean", "default": false }, "includeEgrHashCfg": { "type": "boolean", "default": false }, "perFpSapInstance": { "type": "boolean", "default": false }, "lagName": { "type": "string" }, "lagNameId": { "type": "string" }, "lagSize": { "type": "integer", "format": "int32" }, "lagType": { "type": "integer", "format": "int32" }, "lagUniProfilePointer": { "type": "string" }, "portShgName": { "type": "string" }, "portShgPointer": { "type": "string" }, "vplsMode": { "type": "integer", "format": "int32" }, "lagAggrType": { "type": "integer", "format": "int32" }, "lagAggrHashing": { "type": "integer", "format": "int32" }, "lagMbrSize": { "type": "integer", "format": "int32" }, "lagMinSize": { "type": "integer", "format": "int32" }, "channelSize": { "type": "integer", "format": "int32" }, "lagWTR": { "type": "integer", "format": "int64" }, "lagTPID": { "type": "integer", "format": "int32" }, "lagLosProp": { "type": "integer", "format": "int32" }, "laglptConsequenceAction": { "type": "integer", "format": "int32" }, "spbServicePortMode": { "type": "integer", "format": "int32" }, "portAccessDescription": { "type": "string" }, "portVlanXlation": { "type": "integer", "format": "int32" }, "weightThreshold": { "type": "integer", "format": "int32" }, "weightThresholdAction": { "type": "integer", "format": "int32" }, "weightThresholdStaticCost": { "type": "integer", "format": "int64" }, "hashWeightThreshold": { "type": "integer", "format": "int32" }, "hashWeightThresholdAction": { "type": "integer", "format": "int32" }, "hashWeightThresholdStaticCost": { "type": "integer", "format": "int64" }, "portWeightSpeed": { "type": "integer", "format": "int32" }, "perLinkHashWeighted": { "type": "boolean", "default": false }, "autoRebalance": { "type": "boolean", "default": false }, "enableDei": { "type": "boolean", "default": false }, "lagLoadBalancing": { "type": "integer", "format": "int32" }, "role": { "type": "integer", "format": "int32" }, "lagBfdDisableSoftReset": { "type": "boolean", "default": false }, "accessBandwidth": { "type": "integer", "format": "int64" }, "accessBookingFactor": { "type": "integer", "format": "int64" }, "customProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "enableTableClassification": { "type": "boolean", "default": false }, "monitorOperGroupName": { "type": "string" }, "monitorOperGroupPtr": { "type": "string" }, "accessBandwidthHi": { "type": "integer", "format": "int64" }, "ingressQosMode": { "type": "integer", "format": "int32" }, "schedulerMode": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for Interface InterfaceInfo. to decode json data to internal NFM-P object model" }, "ServiceBgpInfo": { "title": "ServiceBgpInfo", "required": [ "objectClassName", "bgpAsFullNames", "rdRtPairings" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "bgpAsFullNames": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "rdRtPairings": { "type": "array", "items": { "$ref": "#/components/schemas/RdRtPairing" }, "description": "" } }, "description": "Model containing the method level model for struct ServiceBgpInfo. to decode json data to internal NFM-P object model" }, "createDataServiceResponse": { "title": "createDataServiceResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for Ring.createDataService to encode json response from internal NFM-P object model" }, "changeLocalUserPassword": { "title": "changeLocalUserPassword", "required": [ "role", "login", "password" ], "type": "object", "properties": { "role": { "type": "string", "description": "default:1" }, "login": { "type": "string" }, "password": { "type": "string" } }, "description": "Model containing the method level model for AbstractMRBTS.changeLocalUserPassword to decode json data to internal NFM-P object model" }, "SpecificPolicyConfigInfo": { "title": "SpecificPolicyConfigInfo", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap", "containmentInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } }, "specificAlarmInterval": { "type": "integer", "format": "int32" }, "alarmClassName": { "type": "string" }, "groupTag": { "type": "string" }, "isSquelched": { "type": "boolean", "default": false }, "autoAssignedSeverity": { "type": "integer", "format": "int32" }, "autoAssignedUrgency": { "type": "integer", "format": "int32" }, "autoDeletionRule": { "type": "integer", "format": "int32" }, "userText": { "type": "string" }, "alarmDebouncingHoldPeriod": { "type": "integer", "format": "int32" }, "alarmDebouncingEnabled": { "type": "boolean", "default": false }, "escalationEnabled": { "type": "boolean", "default": false }, "deEscalationEnabled": { "type": "boolean", "default": false }, "historyEnabled": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for Interface ConfigInfo SpecificPolicyConfigInfo. to decode json data to internal NFM-P object model" }, "CreatePreProvNeParam": { "title": "CreatePreProvNeParam", "required": [ "objectClassName", "submitWOToActivationSession", "version", "templateAndSpecificDataList" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "woFileName": { "type": "string", "description": "Non documentable API" }, "submitWOToActivationSession": { "type": "boolean" }, "version": { "type": "string" }, "templateAndSpecificDataList": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateAndSpecificData" }, "description": "" } }, "description": "Model containing the method level model for struct CreatePreProvNeParam. to decode json data to internal NFM-P object model" }, "auditLocalPolicy": { "title": "auditLocalPolicy", "required": [ "comparingPolicyObjectFullName", "comparedPolicySiteId" ], "type": "object", "properties": { "comparingPolicyObjectFullName": { "type": "string", "description": "The object full name of one of the local policy." }, "comparedPolicySiteId": { "type": "string", "description": "The siteId of second local policy. Empty string or \"0.0.0.0\" means the global policy." } }, "description": "Model containing the method level model for Manager.auditLocalPolicy to decode json data to internal NFM-P object model" }, "findApsGroupResponse": { "title": "findApsGroupResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/TdmFacilityProtectionGroupInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for TdmFacility.findApsGroup to encode json response from internal NFM-P object model" }, "retrieveArpHostRadiusClasses": { "title": "retrieveArpHostRadiusClasses", "required": [ "siteId", "serviceId", "ipAddressType", "ipAddress", "timeout" ], "type": "object", "properties": { "siteId": { "type": "string", "description": "Site ID for the ARP Host." }, "serviceId": { "type": "integer", "description": "Service ID for the ARP Host.", "format": "int64" }, "ipAddressType": { "type": "integer", "description": "IP address type of the ARP host, 1 for IPv4 or 2 for IPv6.This is an optional input parameter. If not specified, address type is inferredfrom IP address input parameter. default:0", "format": "int32" }, "ipAddress": { "type": "string", "description": "The IP address of the ARP host." }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait before receiving the results.This is an optional input parameter. The default value is 5 minutes (300000). default:300000", "format": "int64" } }, "description": "Model containing the method level model for ArpHostRadiusClassAttribute.retrieveArpHostRadiusClasses to decode json data to internal NFM-P object model" }, "expandPolicyStatement": { "title": "expandPolicyStatement", "required": [ "neId", "policyName", "entryId" ], "type": "object", "properties": { "neId": { "type": "string" }, "policyName": { "type": "string" }, "entryId": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for FromCriteria.expandPolicyStatement to decode json data to internal NFM-P object model" }, "AaEsmHostRtrvStruct": { "title": "AaEsmHostRtrvStruct", "required": [ "objectClassName", "siteId", "serviceId", "portName", "innerEncap", "outerEncap" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "serviceId": { "type": "integer", "format": "int64" }, "portName": { "type": "string" }, "innerEncap": { "type": "integer", "format": "int64" }, "outerEncap": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct AaEsmHostRtrvStruct. to decode json data to internal NFM-P object model" }, "createSubSvcComponentsDynResponse": { "title": "createSubSvcComponentsDynResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for ResidentialSubscriberManager.createSubSvcComponentsDyn to encode json response from internal NFM-P object model" }, "isCacEnabledResponse": { "title": "isCacEnabledResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "boolean", "description": "The response object." } }, "description": "Model containing the method level model for CacManager.isCacEnabled to encode json response from internal NFM-P object model" }, "NavigateToOppositeObjResponse": { "title": "NavigateToOppositeObjResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for ServiceManager.NavigateToOppositeObj to encode json response from internal NFM-P object model" }, "ServicePathInfo": { "title": "ServicePathInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "administrativeState": { "type": "integer", "format": "int32" }, "connId": { "type": "integer", "format": "int64" }, "biDirectional": { "type": "boolean", "default": false }, "connectionType": { "type": "integer", "format": "int32" }, "portAPointer": { "type": "string" }, "portZPointer": { "type": "string" }, "ctpAPointer": { "type": "string" }, "ctpZPointer": { "type": "string" }, "protectionState": { "type": "integer", "format": "int32" }, "protectionLevel": { "type": "integer", "format": "int32" }, "modifyFlag": { "type": "boolean", "default": false }, "isRidingOnConnGroup": { "type": "boolean", "default": false }, "pathId": { "type": "integer", "format": "int32" }, "serviceMode": { "type": "integer", "format": "int32" }, "weight": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for Interface ServicePathInfo. to decode json data to internal NFM-P object model" }, "fixProblemResponse": { "title": "fixProblemResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/PreFixData" }, { "description": "Model containing the method level model for struct PreFixData. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for RcaManager.fixProblem to encode json response from internal NFM-P object model" }, "ObjectStateSummary": { "title": "ObjectStateSummary", "required": [ "objectClassName", "fdn", "name", "type", "baselineTime", "basicKPIs", "extraKPIs", "extraStateAttributes" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "fdn": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "baselineTime": { "type": "integer", "format": "int64" }, "basicKPIs": { "allOf": [ { "$ref": "#/components/schemas/BasicKPIs" }, { "description": "Model containing the method level model for struct BasicKPIs. to decode json data to internal NFM-P object model" } ] }, "extraKPIs": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/KPI" } }, "extraStateAttributes": { "type": "object", "additionalProperties": { "type": "object" } } }, "description": "Model containing the method level model for struct ObjectStateSummary. to decode json data to internal NFM-P object model" }, "retrieveAAUrlListStatusResponse": { "title": "retrieveAAUrlListStatusResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for AAUrlListPolicy.retrieveAAUrlListStatus to encode json response from internal NFM-P object model" }, "findEmptyValidatorTestSuitesResponse": { "title": "findEmptyValidatorTestSuitesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for TestManager.findEmptyValidatorTestSuites to encode json response from internal NFM-P object model" }, "XmlApiConfigTemplateConfigInfo": { "title": "XmlApiConfigTemplateConfigInfo", "required": [ "objectClassName", "actionBitmask", "relativeOrDistinguishedName", "propertyValuePolicyMap", "containmentInfo" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "actionBitmask": { "type": "array", "items": { "type": "string" }, "description": "" }, "containedClassProperties": { "type": "object", "additionalProperties": { "type": "object" } }, "relativeOrDistinguishedName": { "type": "string" }, "propertyValuePolicyMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValueEntry" } }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityConfigurationInformation" } }, "mtosi_id": { "type": "integer", "format": "int64" }, "scriptName": { "type": "string" }, "mtosi_description": { "type": "string" }, "mtosi_type": { "type": "string" }, "scriptState": { "type": "integer", "format": "int32" }, "scriptMode": { "type": "integer", "format": "int32" }, "contentType": { "type": "integer", "format": "int32" }, "scriptType": { "type": "integer", "format": "int32" }, "useLatestVersion": { "type": "boolean", "default": false }, "autoSaveResult": { "type": "boolean", "default": false }, "reserveTargets": { "type": "boolean", "default": false }, "id": { "type": "integer", "format": "int64" }, "displayedName": { "type": "string" }, "description": { "type": "string" }, "bundleId": { "type": "integer", "format": "int32" }, "scopeOfCommandProfilePointer": { "type": "string" }, "configuredClass": { "type": "string" }, "configuredClassCategories": { "type": "string" }, "includeChildrenCreation": { "type": "boolean", "default": false }, "commandType": { "type": "integer", "format": "int32" }, "showCreatedObject": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for Interface ConfigInfo XmlApiConfigTemplateConfigInfo. to decode json data to internal NFM-P object model" }, "ExportPolicyFileInfo": { "title": "ExportPolicyFileInfo", "required": [ "objectClassName", "fileName", "samVersion", "samMinorVersion", "description" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "fileName": { "type": "string" }, "samVersion": { "type": "string" }, "samMinorVersion": { "type": "string" }, "description": { "type": "string" } }, "description": "Model containing the method level model for struct ExportPolicyFileInfo. to decode json data to internal NFM-P object model" }, "findActiveSecondaryStaticRoutes": { "title": "findActiveSecondaryStaticRoutes", "required": [ "fields", "sortFields", "pageNumber", "pageSize" ], "type": "object", "properties": { "fields": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Sorting fields" }, "sortFields": { "type": "array", "items": { "type": "string" }, "description": "Sorting fields" }, "pageNumber": { "type": "integer", "description": "Page number", "format": "int32" }, "pageSize": { "type": "integer", "description": "The number of entries to return", "format": "int32" } }, "description": "Model containing the method level model for AutonomousSystem.findActiveSecondaryStaticRoutes to decode json data to internal NFM-P object model" }, "createTransitServiceResponse": { "title": "createTransitServiceResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for Ring.createTransitService to encode json response from internal NFM-P object model" }, "configureTunnelAndPathResponse": { "title": "configureTunnelAndPathResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/TunnelAndPathResult" }, { "description": "Model containing the method level model for struct TunnelAndPathResult. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for Tunnel.configureTunnelAndPath to encode json response from internal NFM-P object model" }, "constructServiceTemplateResponse": { "title": "constructServiceTemplateResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/TemplateService" }, { "description": "Managed object abstract class" } ] } }, "description": "Model containing the method level model for TemplateService.constructServiceTemplate to encode json response from internal NFM-P object model" }, "resyncPerVtsObjectAsap": { "title": "resyncPerVtsObjectAsap", "type": "object", "properties": { "aInSiteId": { "type": "string" }, "aInVtsMapIfIndexList": { "type": "array", "items": { "type": "integer", "format": "int64" }, "description": "" } }, "description": "Model containing the method level model for VtsAlarmCategory.resyncPerVtsObjectAsap to decode json data to internal NFM-P object model" }, "getChannelUsageListForNEGroupsResponse": { "title": "getChannelUsageListForNEGroupsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for OpticalLink.getChannelUsageListForNEGroups to encode json response from internal NFM-P object model" }, "findAssociatedVplsSapsResponse": { "title": "findAssociatedVplsSapsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for MultiChassisRingNode.findAssociatedVplsSaps to encode json response from internal NFM-P object model" }, "getSearchResultResponse": { "title": "getSearchResultResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for NetworkElement.getSearchResult to encode json response from internal NFM-P object model" }, "requestClearIdleOnlyMsaps": { "title": "requestClearIdleOnlyMsaps", "type": "object", "properties": { "aInPolicyName": { "type": "string" }, "aInSiteId": { "type": "string" } }, "description": "Model containing the method level model for Policy.requestClearIdleOnlyMsaps to decode json data to internal NFM-P object model" }, "createSessionResponse": { "title": "createSessionResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for WorkOrder.createSession to encode json response from internal NFM-P object model" }, "findAggregationSchedulersResponse": { "title": "findAggregationSchedulersResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for Policy.findAggregationSchedulers to encode json response from internal NFM-P object model" }, "executeTargetScriptsWithParametersResponse": { "title": "executeTargetScriptsWithParametersResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for ScriptManager.executeTargetScriptsWithParameters to encode json response from internal NFM-P object model" }, "getDeployersResponse": { "title": "getDeployersResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/DeployerInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for GenericObject.getDeployers to encode json response from internal NFM-P object model" }, "findPMSessionsNEsResponse": { "title": "findPMSessionsNEsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for TestManager.findPMSessionsNEs to encode json response from internal NFM-P object model" }, "AlarmObject": { "title": "AlarmObject", "required": [ "severity", "previousSeverity", "originalSeverity", "highestSeverity", "operatorAssignedUrgency", "olcState", "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "probableCause", "userText", "alarmName", "type", "specificProblem", "affectedObjectFullName", "affectedObjectClassName", "isAcknowledged", "wasAcknowledged", "acknowldegedBy", "clearedBy", "deletedBy", "firstTimeDetected", "lastTimeDetected", "lastTimeSeverityChanged", "lastTimeCleared", "lastTimePromoted", "lastTimeDemoted", "lastTimeEscalated", "lastTimeDeEscalated", "lastTimeAcknowledged", "nodeTimeOffset", "frequency", "occurences", "numberOfOccurences", "numberOfOccurencesSinceClear", "numberOfOccurencesSinceAck", "isServiceAffecting", "additionalText", "urgencyAssignedBy", "relatedObjects", "affectingObjects", "subscriberId", "nodeId", "nodeName", "affectedObjectDisplayedName", "applicationDomain", "displayedClass", "alarmClassTag", "affectedObjectClassIndex", "affectedObjectInstanceIndex", "correlatingAlarm", "isImplicitlyCleared", "numberOfCorrelatedAlarms" ], "type": "object", "properties": { "severity": { "type": "string" }, "previousSeverity": { "type": "string" }, "originalSeverity": { "type": "string" }, "highestSeverity": { "type": "string" }, "operatorAssignedUrgency": { "type": "string" }, "olcState": { "type": "string" }, "name": { "type": "string" }, "selfAlarmed": { "type": "boolean", "default": false }, "modifiedName": { "type": "boolean", "default": false }, "modifiedSelfAlarmed": { "type": "boolean", "default": false }, "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "probableCause": { "type": "integer", "format": "int32" }, "userText": { "type": "string" }, "alarmName": { "type": "integer", "format": "int32" }, "type": { "type": "integer", "format": "int32" }, "specificProblem": { "type": "integer", "format": "int32" }, "affectedObjectFullName": { "type": "string" }, "affectedObjectClassName": { "type": "string" }, "isAcknowledged": { "type": "boolean" }, "wasAcknowledged": { "type": "boolean" }, "acknowldegedBy": { "type": "string" }, "clearedBy": { "type": "string" }, "deletedBy": { "type": "string" }, "firstTimeDetected": { "type": "integer", "format": "int64" }, "lastTimeDetected": { "type": "integer", "format": "int64" }, "lastTimeSeverityChanged": { "type": "integer", "format": "int64" }, "lastTimeCleared": { "type": "integer", "format": "int64" }, "lastTimePromoted": { "type": "integer", "format": "int64" }, "lastTimeDemoted": { "type": "integer", "format": "int64" }, "lastTimeEscalated": { "type": "integer", "format": "int64" }, "lastTimeDeEscalated": { "type": "integer", "format": "int64" }, "lastTimeAcknowledged": { "type": "integer", "format": "int64" }, "nodeTimeOffset": { "type": "integer", "format": "int64" }, "frequency": { "type": "integer", "format": "int64" }, "occurences": { "type": "string" }, "numberOfOccurences": { "type": "integer", "format": "int64" }, "numberOfOccurencesSinceClear": { "type": "integer", "format": "int64" }, "numberOfOccurencesSinceAck": { "type": "integer", "format": "int64" }, "isServiceAffecting": { "type": "boolean" }, "additionalText": { "type": "string" }, "urgencyAssignedBy": { "type": "string" }, "relatedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "subscriberId": { "type": "integer", "format": "int64" }, "nodeId": { "type": "string" }, "nodeName": { "type": "string" }, "affectedObjectDisplayedName": { "type": "string" }, "applicationDomain": { "type": "string" }, "displayedClass": { "type": "string" }, "alarmClassTag": { "type": "string" }, "affectedObjectClassIndex": { "type": "integer", "format": "int32" }, "affectedObjectInstanceIndex": { "type": "integer", "format": "int64" }, "correlatingAlarm": { "type": "string" }, "isImplicitlyCleared": { "type": "boolean" }, "numberOfCorrelatedAlarms": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for struct AlarmObject. to decode json data to internal NFM-P object model" }, "findAssociationsResponse": { "title": "findAssociationsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/FwPolicyDefinitionInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for FwPolicyDefinition.findAssociations to encode json response from internal NFM-P object model" }, "findGroupDomainBindingResponse": { "title": "findGroupDomainBindingResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for Domain.findGroupDomainBinding to encode json response from internal NFM-P object model" }, "findAnchorPortsResponse": { "title": "findAnchorPortsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/AnchorPortInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for MdaXconnectMac.findAnchorPorts to encode json response from internal NFM-P object model" }, "GroupEntriesActionResult": { "title": "GroupEntriesActionResult", "required": [ "objectClassName", "filterType", "result", "siteId", "filterId", "feedback" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "filterType": { "type": "string" }, "result": { "type": "string" }, "siteId": { "type": "string" }, "filterId": { "type": "integer", "format": "int64" }, "feedback": { "type": "string" } }, "description": "Model containing the method level model for struct GroupEntriesActionResult. to decode json data to internal NFM-P object model" }, "RestfulConfigurationContainer": { "title": "RestfulConfigurationContainer", "required": [ "fdn", "configInfo" ], "type": "object", "properties": { "fdn": { "type": "string", "description": "The fully distinguished name of the parent object" }, "configInfo": { "allOf": [ { "$ref": "#/components/schemas/configInfo" }, { "description": "Model containing the Data model for RestfulConfigurationInfo" } ] } }, "description": "Model containing the Data model for RestfulConfigurationContainer" }, "generateNewRouteDistinguisherResponse": { "title": "generateNewRouteDistinguisherResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for ServiceSite.generateNewRouteDistinguisher to encode json response from internal NFM-P object model" }, "retrieveSubUnknownError": { "title": "retrieveSubUnknownError", "required": [ "timeout" ], "type": "object", "properties": { "aInReportedTimeMinutes": { "type": "integer", "format": "int32" }, "aInReportedTimeSeconds": { "type": "integer", "format": "int32" }, "aInReportedTimeHours": { "type": "integer", "format": "int32" }, "aInIndex": { "type": "integer", "format": "int64" }, "aInReportedTimeDay": { "type": "integer", "format": "int32" }, "aInReportedTimeMonth": { "type": "integer", "format": "int32" }, "aInReportedTimeYear": { "type": "integer", "format": "int32" }, "aInSiteId": { "type": "string" }, "aInMacAddress": { "type": "string" }, "aInServiceId": { "type": "integer", "format": "int64" }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait before receiving the results.The method returns if no results are received in the given time.This is an optional input parameter. The default value is 5 minutes (300000). default:300000", "format": "int64" } }, "description": "Model containing the method level model for SubscrUnknownError.retrieveSubUnknownError to decode json data to internal NFM-P object model" }, "storeResponse": { "title": "storeResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for VelocityTemplate.store to encode json response from internal NFM-P object model" }, "saveUXPrefsResponse": { "title": "saveUXPrefsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for UserGroup.saveUXPrefs to encode json response from internal NFM-P object model" }, "CacBWAttribute": { "title": "CacBWAttribute", "required": [ "objectClassName", "cos0EndPtABW", "cos1EndPtABW", "cos2EndPtABW", "cos3EndPtABW", "cos4EndPtABW", "cos5EndPtABW", "cos6EndPtABW", "cos7EndPtABW", "cos0EndPtBBW", "cos1EndPtBBW", "cos2EndPtBBW", "cos3EndPtBBW", "cos4EndPtBBW", "cos5EndPtBBW", "cos6EndPtBBW", "cos7EndPtBBW" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "cos0EndPtABW": { "type": "integer", "format": "int64" }, "cos1EndPtABW": { "type": "integer", "format": "int64" }, "cos2EndPtABW": { "type": "integer", "format": "int64" }, "cos3EndPtABW": { "type": "integer", "format": "int64" }, "cos4EndPtABW": { "type": "integer", "format": "int64" }, "cos5EndPtABW": { "type": "integer", "format": "int64" }, "cos6EndPtABW": { "type": "integer", "format": "int64" }, "cos7EndPtABW": { "type": "integer", "format": "int64" }, "cos0EndPtBBW": { "type": "integer", "format": "int64" }, "cos1EndPtBBW": { "type": "integer", "format": "int64" }, "cos2EndPtBBW": { "type": "integer", "format": "int64" }, "cos3EndPtBBW": { "type": "integer", "format": "int64" }, "cos4EndPtBBW": { "type": "integer", "format": "int64" }, "cos5EndPtBBW": { "type": "integer", "format": "int64" }, "cos6EndPtBBW": { "type": "integer", "format": "int64" }, "cos7EndPtBBW": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct CacBWAttribute. to decode json data to internal NFM-P object model" }, "removeUXPrefs": { "title": "removeUXPrefs", "required": [ "prefName", "userName" ], "type": "object", "properties": { "prefName": { "type": "string", "description": "The preference name." }, "userName": { "type": "string", "description": "The user name." } }, "description": "Model containing the method level model for TSecurityManager.removeUXPrefs to decode json data to internal NFM-P object model" }, "retrieveSubscriberHosts": { "title": "retrieveSubscriberHosts", "required": [ "timeout", "retrieveQoSOvr", "retrieveSlaacAddr", "retrieveBgpPeerInfo" ], "type": "object", "properties": { "aInSubscrId": { "type": "string" }, "aInAdditionalStateInfo": { "type": "boolean", "default": false }, "aInCrdtCtrlOperValues": { "type": "boolean", "default": false }, "aInSiteId": { "type": "string" }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns.", "format": "int64" }, "retrieveQoSOvr": { "type": "boolean", "description": "Specifies if Sub SLAAC QoS Override should be retrieved,the default is \"true\".It won't be retrieved if ESM System preferences \"retrieveQoSOvr\" is false. default:true" }, "retrieveSlaacAddr": { "type": "boolean", "description": "Specifies if retrieval of subscriber SLAAC host addresses is also desired.This is an optional input parameter. The default value is true.The SLAAC Host Address retrieval will be performed only on \"retrieveSlaacAddr\" is true for the method and\"retrieveSlaacHostAddr\" is true for the ResidentialSubscriberManager. default:true" }, "retrieveBgpPeerInfo": { "type": "boolean", "description": "Specifies if Sub SLAAC BGP Peer Info should be retrieved,the default is \"true\".It won't be retrieved if ESM System preferences \"retrieveBgpPeerInfo\" is false. default:true" } }, "description": "Model containing the method level model for SubscriberHost.retrieveSubscriberHosts to decode json data to internal NFM-P object model" }, "RetrieveCallTraceStruct": { "title": "RetrieveCallTraceStruct", "required": [ "objectClassName", "siteId", "id" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "id": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct RetrieveCallTraceStruct. to decode json data to internal NFM-P object model" }, "findServiceInterfacesResponse": { "title": "findServiceInterfacesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for Policy.findServiceInterfaces to encode json response from internal NFM-P object model" }, "SPEdge": { "title": "SPEdge", "required": [ "objectClassName", "fdn", "originFdn", "terminationFdn" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "fdn": { "type": "string" }, "originFdn": { "type": "string" }, "terminationFdn": { "type": "string" } }, "description": "Model containing the method level model for struct SPEdge. to decode json data to internal NFM-P object model" }, "retrieveHostSharedPccRuleEgressPolicyResponse": { "title": "retrieveHostSharedPccRuleEgressPolicyResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, { "description": "Model containing the method level model for struct CommonManagedEntityInformation. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for Policy.retrieveHostSharedPccRuleEgressPolicy to encode json response from internal NFM-P object model" }, "requestClearWppHostsLoggingOutResponse": { "title": "requestClearWppHostsLoggingOutResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for WppHost.requestClearWppHostsLoggingOut to encode json response from internal NFM-P object model" }, "requestClearOamPmSlmRawStatsResponse": { "title": "requestClearOamPmSlmRawStatsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for CfmSlmSession.requestClearOamPmSlmRawStats to encode json response from internal NFM-P object model" }, "getExportRouteTargetsResponse": { "title": "getExportRouteTargetsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for Site.getExportRouteTargets to encode json response from internal NFM-P object model" }, "configRedundancyRlbkSync": { "title": "configRedundancyRlbkSync", "required": [ "neId", "configSyncType" ], "type": "object", "properties": { "neId": { "type": "string" }, "configSyncType": { "type": "boolean" } }, "description": "Model containing the method level model for RollbackNEInfo.configRedundancyRlbkSync to decode json data to internal NFM-P object model" }, "ConnectionTerminationPoint": { "title": "ConnectionTerminationPoint", "required": [ "displayedName", "underlyingResourceState", "nodeId", "nodeName", "terminatedObjectPointer", "terminatedObjectName", "terminatedObjectClassName", "numberOfConnections", "locale", "aggregationTagging", "isTerminatable", "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties" ], "type": "object", "properties": { "displayedName": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "underlyingResourceState": { "type": "integer", "format": "int32", "readOnly": true }, "nodeId": { "type": "string", "description": "50]", "readOnly": true, "example": " maximum: 50" }, "nodeName": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "terminatedObjectPointer": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "terminatedObjectName": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "terminatedObjectClassName": { "type": "string", "description": "252]", "readOnly": true, "example": " maximum: 252" }, "numberOfConnections": { "type": "integer", "format": "int32", "readOnly": true }, "locale": { "type": "integer", "format": "int32", "readOnly": true }, "aggregationTagging": { "type": "integer", "format": "int32", "readOnly": true }, "isTerminatable": { "type": "boolean", "readOnly": true }, "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "actionMask": { "type": "integer", "format": "int32" }, "selfAlarmed": { "type": "boolean", "default": false }, "name": { "type": "string" } }, "description": "Managed object abstract class" }, "findCtpsOnMultiplePortsResponse": { "title": "findCtpsOnMultiplePortsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectionTerminationPointInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for ConnectionTerminationPoint.findCtpsOnMultiplePorts to encode json response from internal NFM-P object model" }, "findGroupsContainingObjectResponse": { "title": "findGroupsContainingObjectResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/GroupInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for GroupDirector.findGroupsContainingObject to encode json response from internal NFM-P object model" }, "ResidentialSubscriberResultStruct": { "title": "ResidentialSubscriberResultStruct", "required": [ "objectClassName", "status", "details" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "status": { "type": "string" }, "details": { "type": "object" } }, "description": "Model containing the method level model for struct ResidentialSubscriberResultStruct. to decode json data to internal NFM-P object model" }, "configureTunnelAndPath": { "title": "configureTunnelAndPath", "required": [ "pathConfigInfo", "tunnelConfigInfo" ], "type": "object", "properties": { "pathConfigInfo": { "allOf": [ { "$ref": "#/components/schemas/PathConfigInfo" }, { "description": "Model containing the method level model for Interface ConfigInfo PathConfigInfo. to decode json data to internal NFM-P object model" } ] }, "tunnelConfigInfo": { "allOf": [ { "$ref": "#/components/schemas/TunnelConfigInfo" }, { "description": "Model containing the method level model for Interface ConfigInfo TunnelConfigInfo. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for Tunnel.configureTunnelAndPath to decode json data to internal NFM-P object model" }, "resyncFreeAddresses": { "title": "resyncFreeAddresses", "required": [ "timeout" ], "type": "object", "properties": { "aInRtrId": { "type": "string" }, "aInLocalDhcpServerName": { "type": "string" }, "aInAddressPoolName": { "type": "string" }, "aInVirtualRtrId": { "type": "integer", "format": "int64" }, "aInDhcpSvrSubnetAddress": { "type": "string" }, "aInDhcpSvrSubnetPrefixLength": { "type": "integer", "format": "int64" }, "aInDhcpSvrFreeAddress": { "type": "string" }, "timeout": { "type": "integer", "description": "The number of milliseconds to wait beforereceiving the results. If no results arereceived in the given time, the method returns.", "format": "int64" } }, "description": "Model containing the method level model for AddressPool.resyncFreeAddresses to decode json data to internal NFM-P object model" }, "addNetworkElementsToGroupResponse": { "title": "addNetworkElementsToGroupResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/GroupBindingInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for Group.addNetworkElementsToGroup to encode json response from internal NFM-P object model" }, "findNetworkIpInterfacesResponse": { "title": "findNetworkIpInterfacesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for AbstractFilterDefinition.findNetworkIpInterfaces to encode json response from internal NFM-P object model" }, "getVirtualComponentsResponse": { "title": "getVirtualComponentsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for AbstractVirtualComponentGlobal.getVirtualComponents to encode json response from internal NFM-P object model" }, "L2TPEthernetSessionStruct": { "title": "L2TPEthernetSessionStruct", "required": [ "objectClassName", "siteId", "routerId", "groupName", "vcId", "filter", "timeout" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "routerId": { "type": "integer", "format": "int64" }, "groupName": { "type": "string" }, "vcId": { "type": "integer", "format": "int64" }, "filter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] }, "timeout": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct L2TPEthernetSessionStruct. to decode json data to internal NFM-P object model" }, "isAnalyticalBaseEnabledResponse": { "title": "isAnalyticalBaseEnabledResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "boolean", "description": "The response object." } }, "description": "Model containing the method level model for AnalyticsManager.isAnalyticalBaseEnabled to encode json response from internal NFM-P object model" }, "PollerPolicyInfo": { "title": "PollerPolicyInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "pollingInterval": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "versionId": { "type": "integer", "format": "int32" }, "mibEntityOid": { "type": "string" }, "administrativeState": { "type": "integer", "format": "int32" }, "numberOfVarPerPdu": { "type": "integer", "format": "int32" }, "useBulkRequest": { "type": "boolean", "default": false } }, "description": "Model containing the method level model for Interface PollerPolicyInfo. to decode json data to internal NFM-P object model" }, "findProtocolsResponse": { "title": "findProtocolsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for VirtualInterface.findProtocols to encode json response from internal NFM-P object model" }, "findByIpAddressListResponse": { "title": "findByIpAddressListResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/VirtualInterfaceInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for VirtualInterface.findByIpAddressList to encode json response from internal NFM-P object model" }, "configScriptVersion": { "title": "configScriptVersion", "required": [ "versionConfigInfo", "bodyScript" ], "type": "object", "properties": { "versionConfigInfo": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" }, { "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } ] }, "bodyScript": { "type": "array", "items": { "type": "string" }, "description": "The script version body (list of commands)." } }, "description": "Model containing the method level model for AbstractScript.configScriptVersion to decode json data to internal NFM-P object model" }, "findInterfaceResponse": { "title": "findInterfaceResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/VirtualInterface" }, { "description": "Managed object abstract class" } ] } }, "description": "Model containing the method level model for Hop.findInterface to encode json response from internal NFM-P object model" }, "addTests": { "title": "addTests", "required": [ "testGroupRole", "tests" ], "type": "object", "properties": { "testGroupRole": { "type": "string", "description": "The test group to which to add these tests." }, "tests": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "A set of test pointers to add." } }, "description": "Model containing the method level model for TestSuite.addTests to decode json data to internal NFM-P object model" }, "WlanGwQbtUeQueryStruct": { "title": "WlanGwQbtUeQueryStruct", "required": [ "objectClassName", "ueEncapsulation", "ueState", "siteId", "macAddr", "ueAddress", "dhcpV6Addr", "slaacPrefix", "tunnelRouterId", "serviceId", "tunnelSrcAddr", "tunnelDstAddr", "isaGroupId", "isaMemberId" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "ueEncapsulation": { "type": "string" }, "ueState": { "type": "array", "items": { "type": "string" }, "description": "" }, "siteId": { "type": "string" }, "macAddr": { "type": "string" }, "ueAddress": { "type": "string" }, "dhcpV6Addr": { "type": "string" }, "slaacPrefix": { "type": "string" }, "tunnelRouterId": { "type": "integer", "format": "int32" }, "serviceId": { "type": "integer", "format": "int64" }, "tunnelSrcAddr": { "type": "string" }, "tunnelDstAddr": { "type": "string" }, "isaGroupId": { "type": "integer", "format": "int32" }, "isaMemberId": { "type": "integer", "format": "int32" } }, "description": "Model containing the method level model for struct WlanGwQbtUeQueryStruct. to decode json data to internal NFM-P object model" }, "getMigrationResultResponse": { "title": "getMigrationResultResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/HybridMigrationResultStruct" }, { "description": "Model containing the method level model for struct HybridMigrationResultStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for Port.getMigrationResult to encode json response from internal NFM-P object model" }, "retrieveL2TPv3EthernetTunnelStatsResponse": { "title": "retrieveL2TPv3EthernetTunnelStatsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for L2TPSession.retrieveL2TPv3EthernetTunnelStats to encode json response from internal NFM-P object model" }, "retrieveResidentialSubscribersResponse": { "title": "retrieveResidentialSubscribersResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/ResidentialSubscriberResultStruct" }, "description": "The response object." } }, "description": "Model containing the method level model for ResidentialSubscriberManager.retrieveResidentialSubscribers to encode json response from internal NFM-P object model" }, "removeInclusionFilterResponse": { "title": "removeInclusionFilterResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for SupervisionGroup.removeInclusionFilter to encode json response from internal NFM-P object model" }, "AlarmNoteObjectInfo": { "title": "AlarmNoteObjectInfo", "required": [ "objectClassName", "objectFullName", "allomorphicClassName", "objectId", "displayedName", "lifeCycleState", "deploymentState", "neId", "spanObjectPointer", "parentClassName", "managedObjectId", "unsetProperties", "containmentInfo", "affectedObjects", "affectingObjects" ], "type": "object", "properties": { "objectClassName": { "type": "string" }, "objectFullName": { "type": "string" }, "allomorphicClassName": { "type": "string" }, "objectId": { "type": "integer", "format": "int32" }, "displayedName": { "type": "string" }, "lifeCycleState": { "type": "string" }, "deploymentState": { "type": "string" }, "neId": { "type": "string" }, "spanObjectPointer": { "type": "string" }, "parentClassName": { "type": "string" }, "managedObjectId": { "type": "integer", "format": "int64" }, "unsetProperties": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "containmentInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CommonManagedEntityInformation" } }, "affectedObjects": { "type": "object" }, "affectingObjects": { "type": "object" }, "text": { "type": "string" }, "createdBy": { "type": "string" }, "lastModifiedBy": { "type": "string" }, "isAckNote": { "type": "boolean", "default": false }, "timeAdded": { "type": "integer", "format": "int64" }, "lastTimeModified": { "type": "integer", "format": "int64" }, "status": { "type": "integer", "format": "int32" }, "previousStatus": { "type": "integer", "format": "int32" }, "timeStatusChanged": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for Interface AlarmNoteObjectInfo. to decode json data to internal NFM-P object model" }, "requestRecoverEsaVmResponse": { "title": "requestRecoverEsaVmResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for NatVapp.requestRecoverEsaVm to encode json response from internal NFM-P object model" }, "updateResponse": { "title": "updateResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for AbstractResSubscrTemplate.update to encode json response from internal NFM-P object model" }, "addToMembersResponse": { "title": "addToMembersResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for PolicySyncGroup.addToMembers to encode json response from internal NFM-P object model" }, "getGroupsByFdnResponse": { "title": "getGroupsByFdnResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "object", "additionalProperties": {}, "description": "The response object." } }, "description": "Model containing the method level model for SupervisionManager.getGroupsByFdn to encode json response from internal NFM-P object model" }, "AlarmListsStruct": { "title": "AlarmListsStruct", "required": [ "objectClassName", "alarms", "affectingAlarms", "aggregatedAlarms", "relatedAlarms" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "alarms": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AlarmInfo" } }, "affectingAlarms": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AlarmInfo" } }, "aggregatedAlarms": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AlarmInfo" } }, "relatedAlarms": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AlarmInfo" } } }, "description": "Model containing the method level model for struct AlarmListsStruct. to decode json data to internal NFM-P object model" }, "getMonitoredObjectsByClasses": { "title": "getMonitoredObjectsByClasses", "required": [ "supervisionGroupName", "classes" ], "type": "object", "properties": { "supervisionGroupName": { "type": "string", "description": "Supervision Group name." }, "classes": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Classes of objects in this group to fetch.If null or empty, get all monitored objects inthe group." } }, "description": "Model containing the method level model for SummaryView.getMonitoredObjectsByClasses to decode json data to internal NFM-P object model" }, "invokeFlexisCatchup": { "title": "invokeFlexisCatchup", "required": [ "networkElements", "forceOnPMPolicyDown" ], "type": "object", "properties": { "networkElements": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "" }, "forceOnPMPolicyDown": { "type": "boolean", "description": "default:false" } }, "description": "Model containing the method level model for FlexiPMPolicy.invokeFlexisCatchup to decode json data to internal NFM-P object model" }, "retrieveEpsPeersResponse": { "title": "retrieveEpsPeersResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for MmeEpsPeerSummary.retrieveEpsPeers to encode json response from internal NFM-P object model" }, "SPNode": { "title": "SPNode", "required": [ "objectClassName", "type", "fdn", "egressLinks" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "type": { "type": "string" }, "fdn": { "type": "string" }, "egressLinks": { "type": "array", "items": { "$ref": "#/components/schemas/SPEdge" }, "description": "" } }, "description": "Model containing the method level model for struct SPNode. to decode json data to internal NFM-P object model" }, "getCpTopologyResponse": { "title": "getCpTopologyResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for Checkpoint.getCpTopology to encode json response from internal NFM-P object model" }, "exportPolicies": { "title": "exportPolicies", "required": [ "selectedGlobalPolicies", "exportFileName", "description" ], "type": "object", "properties": { "selectedGlobalPolicies": { "type": "array", "items": { "type": "string" }, "description": "List of global policies that needs to be exported to an xml file." }, "exportFileName": { "type": "string", "description": "Indicates the xml file name in which the selected global policies in NFM-P will be exported too." }, "description": { "type": "string", "description": "This can be used to denote user description before executing the export operation." } }, "description": "Model containing the method level model for Manager.exportPolicies to decode json data to internal NFM-P object model" }, "retrieveVRFRoutes": { "title": "retrieveVRFRoutes", "type": "object", "properties": { "aInSiteFdn": { "type": "string" }, "aInSvcFdn": { "type": "string" }, "aInSubnetWithLength": { "type": "string" } }, "description": "Model containing the method level model for Site.retrieveVRFRoutes to decode json data to internal NFM-P object model" }, "switchToRedundantSapsResponse": { "title": "switchToRedundantSapsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "string" }, "description": "The response object." } }, "description": "Model containing the method level model for L2AccessInterface.switchToRedundantSaps to encode json response from internal NFM-P object model" }, "retrieveMldGroupIfSapGrpResponse": { "title": "retrieveMldGroupIfSapGrpResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for GroupInterfaceSapGroup.retrieveMldGroupIfSapGrp to encode json response from internal NFM-P object model" }, "getAlarmsWithFilterResponse": { "title": "getAlarmsWithFilterResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "type": "object" }, "description": "The response object." } }, "description": "Model containing the method level model for SummaryView.getAlarmsWithFilter to encode json response from internal NFM-P object model" }, "ContainmentConfigInfoStruct": { "title": "ContainmentConfigInfoStruct", "required": [ "objectClassName", "containmentConfigInfo", "distinguishedName" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "containmentConfigInfo": { "allOf": [ { "$ref": "#/components/schemas/CommonManagedContainmentEntityConfigurationInformation" }, { "description": "Model containing the method level model for struct CommonManagedContainmentEntityConfigurationInformation. to decode json data to internal NFM-P object model" } ] }, "distinguishedName": { "type": "string" } }, "description": "Model containing the method level model for struct ContainmentConfigInfoStruct. to decode json data to internal NFM-P object model" }, "bgpImpactAnalysisResponse": { "title": "bgpImpactAnalysisResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "object", "additionalProperties": { "type": "object" }, "description": "The response object." } }, "description": "Model containing the method level model for BgpImpactAnalysisTimeRange.bgpImpactAnalysis to encode json response from internal NFM-P object model" }, "moveSapToAnotherService": { "title": "moveSapToAnotherService", "required": [ "sourceSapFdn", "destSiteFdn" ], "type": "object", "properties": { "sourceSapFdn": { "type": "string" }, "destSiteFdn": { "type": "string" } }, "description": "Model containing the method level model for AccessInterface.moveSapToAnotherService to decode json data to internal NFM-P object model" }, "findS2lPathsResponse": { "title": "findS2lPathsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for Tunnel.findS2lPaths to encode json response from internal NFM-P object model" }, "configureResponse": { "title": "configureResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for Site.configure to encode json response from internal NFM-P object model" }, "requestClearProxyArpDynResponse": { "title": "requestClearProxyArpDynResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for Site.requestClearProxyArpDyn to encode json response from internal NFM-P object model" }, "getDCInventory": { "title": "getDCInventory", "type": "object", "properties": { "aInDCName": { "type": "string" }, "aInCountFilter": { "allOf": [ { "$ref": "#/components/schemas/RestFilter" }, { "description": "Model containing the Data model for RestFilter" } ] } }, "description": "Model containing the method level model for DCInventoryRecord.getDCInventory to decode json data to internal NFM-P object model" }, "invokeResyncAaSubInfo": { "title": "invokeResyncAaSubInfo", "required": [ "siteId", "isaGrpPartIndex" ], "type": "object", "properties": { "siteId": { "type": "string", "description": "Network Element site IP address." }, "isaGrpPartIndex": { "type": "integer", "description": "The ISA-AA Group Partition Index.", "format": "int64" } }, "description": "Model containing the method level model for AaSubInfo.invokeResyncAaSubInfo to decode json data to internal NFM-P object model" }, "findServerTrailsResponse": { "title": "findServerTrailsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/TrailInfo" }, "description": "The response object." } }, "description": "Model containing the method level model for Trail.findServerTrails to encode json response from internal NFM-P object model" }, "MultiTemplateTargetParameterMap": { "title": "MultiTemplateTargetParameterMap", "required": [ "objectClassName", "templateFdn", "targetParam", "children" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "templateFdn": { "type": "string" }, "targetParam": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TargetParameterConfigInfo" } }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/MultiTemplateTargetParameterMap" }, "description": "" } }, "description": "Model containing the method level model for struct MultiTemplateTargetParameterMap. to decode json data to internal NFM-P object model" }, "ImportGlobalPolicyResultInfo": { "title": "ImportGlobalPolicyResultInfo", "required": [ "objectClassName", "globalPolicyFDN", "importOperationStatus", "isExistingPolicyOverriden" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "globalPolicyFDN": { "type": "string" }, "importOperationStatus": { "type": "integer", "format": "int32" }, "isExistingPolicyOverriden": { "type": "boolean" } }, "description": "Model containing the method level model for struct ImportGlobalPolicyResultInfo. to decode json data to internal NFM-P object model" }, "clearDhcpServerLeasesResponse": { "title": "clearDhcpServerLeasesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "allOf": [ { "$ref": "#/components/schemas/RequestHandleStruct" }, { "description": "Model containing the method level model for struct RequestHandleStruct. to decode json data to internal NFM-P object model" } ] } }, "description": "Model containing the method level model for LocalDhcpServer.clearDhcpServerLeases to encode json response from internal NFM-P object model" }, "retrieveIgpPrefixList": { "title": "retrieveIgpPrefixList", "required": [ "igpAdminDomain", "igpPrefixFilter" ], "type": "object", "properties": { "igpAdminDomain": { "type": "string", "description": "The IGP Admin Domain ({{topology.AutonomousSystem}}) to retrieve the prefixes." }, "igpPrefixFilter": { "type": "string", "description": "The Filter ({{topology.IgpPrefixListFilter}}) to be applied for the retrieval." } }, "description": "Model containing the method level model for TopologyManager.retrieveIgpPrefixList to decode json data to internal NFM-P object model" }, "distributeUsingGroupsResponse": { "title": "distributeUsingGroupsResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "string", "description": "The response object." } }, "description": "Model containing the method level model for PolicyDefinition.distributeUsingGroups to encode json response from internal NFM-P object model" }, "SubHostPccRuleStruct": { "title": "SubHostPccRuleStruct", "required": [ "objectClassName", "siteId", "serviceId", "sapPortId", "sapEncapValue", "ipAddress", "macAddress", "pppSessionIndex" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "serviceId": { "type": "integer", "format": "int64" }, "sapPortId": { "type": "integer", "format": "int64" }, "sapEncapValue": { "type": "integer", "format": "int64" }, "ipAddress": { "type": "string" }, "macAddress": { "type": "string" }, "pppSessionIndex": { "type": "integer", "format": "int64" } }, "description": "Model containing the method level model for struct SubHostPccRuleStruct. to decode json data to internal NFM-P object model" }, "findValidAmplifierCardsforConnectedToResponse": { "title": "findValidAmplifierCardsforConnectedToResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for DryContact.findValidAmplifierCardsforConnectedTo to encode json response from internal NFM-P object model" }, "retrieveSubSdpErrorResponse": { "title": "retrieveSubSdpErrorResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for SubscrSdpError.retrieveSubSdpError to encode json response from internal NFM-P object model" }, "findAccessInterfacesResponse": { "title": "findAccessInterfacesResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for AbstractVirtualSite.findAccessInterfaces to encode json response from internal NFM-P object model" }, "RemoveTraceInfoStruct": { "title": "RemoveTraceInfoStruct", "required": [ "objectClassName", "siteId", "circuitId", "remoteId", "sapFdn", "macAddress", "traceName" ], "type": "object", "properties": { "objectClassName": { "type": "string", "description": "packageName.className of the child object", "example": "String" }, "siteId": { "type": "string" }, "circuitId": { "type": "string" }, "remoteId": { "type": "string" }, "sapFdn": { "type": "string" }, "macAddress": { "type": "string" }, "traceName": { "type": "string" } }, "description": "Model containing the method level model for struct RemoveTraceInfoStruct. to decode json data to internal NFM-P object model" }, "findReroutePathResponse": { "title": "findReroutePathResponse", "required": [ "Result" ], "type": "object", "properties": { "Result": { "type": "array", "items": { "$ref": "#/components/schemas/CommonManagedEntityInformation" }, "description": "The response object." } }, "description": "Model containing the method level model for Session.findReroutePath to encode json response from internal NFM-P object model" } }, "securitySchemes": { "api_key": { "type": "apiKey", "name": "Authorization", "in": "header" } } }, "security": [], "tags": [ { "name": "samo_autoconfig" }, { "name": "samo_cflowd" }, { "name": "samo_aapolicy" }, { "name": "samo_synce" }, { "name": "samo_subscrauth" }, { "name": "samo_opticalacl" }, { "name": "samo_fwd" }, { "name": "samo_atm" }, { "name": "samo_neaudit" }, { "name": "samo_racfltdd" }, { "name": "samo_msappolicy" }, { "name": "samo_ltetwag" }, { "name": "samo_sbts" }, { "name": "samo_lteperf" }, { "name": "samo_mvpls" }, { "name": "samo_nelicense" }, { "name": "samo_wpp" }, { "name": "samo_ageoutcstr" }, { "name": "samo_assurance" }, { "name": "samo_aengr" }, { "name": "samo_entity" }, { "name": "samo_vll" }, { "name": "samo_lag" }, { "name": "samo_ltes1mme" }, { "name": "samo_rmon" }, { "name": "samo_vwmsas" }, { "name": "samo_mpls" }, { "name": "samo_monitor" }, { "name": "samo_fabricqos" }, { "name": "search" }, { "name": "samo_racgnbdu" }, { "name": "samo_gsmp" }, { "name": "samo_rp" }, { "name": "samo_ixrqos" }, { "name": "samo_subscrprofile" }, { "name": "samo_hsm" }, { "name": "samo_negcss" }, { "name": "samo_qosprefixlist" }, { "name": "samo_ethernetoam" }, { "name": "samo_schedule" }, { "name": "samo_fpresource" }, { "name": "samo_simulator" }, { "name": "samo_flexiperf" }, { "name": "samo_hwaggshapersched" }, { "name": "samo_hsqos" }, { "name": "samo_sysact" }, { "name": "samo_monpath" }, { "name": "samo_ltessg" }, { "name": "samo_circem" }, { "name": "samo_wireless" }, { "name": "samo_policing" }, { "name": "samo_pim" }, { "name": "samo_radioequipment" }, { "name": "samo_lteggsn" }, { "name": "samo_lrp" }, { "name": "samo_dynmgmt" }, { "name": "samo_radiusaccounting" }, { "name": "samo_fr" }, { "name": "samo_tmf814" }, { "name": "samo_db" }, { "name": "samo_macsec" }, { "name": "samo_slope" }, { "name": "samo_ipfix" }, { "name": "samo_tca" }, { "name": "samo_l2fwd" }, { "name": "samo_niegr" }, { "name": "samo_connprof" }, { "name": "samo_nrdperf" }, { "name": "samo_policy" }, { "name": "samo_gmpls" }, { "name": "samo_ipdr" }, { "name": "samo_event" }, { "name": "samo_dcp" }, { "name": "samo_acl" }, { "name": "samo_rsvp" }, { "name": "samo_pppoeia" }, { "name": "samo_racflperf" }, { "name": "samo_resources" }, { "name": "samo_snmp" }, { "name": "samo_ancp" }, { "name": "samo_shg" }, { "name": "samo_smmuser" }, { "name": "samo_ltesas" }, { "name": "samo_vwm" }, { "name": "samo_extalarm" }, { "name": "samo_ltecmm" }, { "name": "samo_racgnbc" }, { "name": "samo_flexigrp" }, { "name": "samo_aggregation" }, { "name": "samo_syscflowd" }, { "name": "samo_aclfilter" }, { "name": "samo_wlangw" }, { "name": "samo_server" }, { "name": "samo_localfwd" }, { "name": "samo_tod" }, { "name": "samo_georedundancy" }, { "name": "samo_fm" }, { "name": "samo_vpls" }, { "name": "samo_isa" }, { "name": "samo_analytics" }, { "name": "samo_oth" }, { "name": "samo_fpmr" }, { "name": "samo_cellularequipment" }, { "name": "samo_statsplot" }, { "name": "samo_protection" }, { "name": "samo_olc" }, { "name": "samo_gtp" }, { "name": "samo_vs" }, { "name": "samo_ethernettunnel" }, { "name": "samo_racloms" }, { "name": "samo_ipipe" }, { "name": "samo_ipsec" }, { "name": "samo_esa" }, { "name": "samo_trapmapper" }, { "name": "samo_bmp" }, { "name": "samo_pbbvlan" }, { "name": "samo_sonetequipment" }, { "name": "samo_ies" }, { "name": "samo_ospf" }, { "name": "samo_vxlan" }, { "name": "samo_svt" }, { "name": "samo_general" }, { "name": "samo_aggregator" }, { "name": "samo_socketprofile" }, { "name": "samo_saspm" }, { "name": "samo_lmgperf" }, { "name": "samo_opticalrouting" }, { "name": "samo_propertyrules" }, { "name": "samo_opticsperf" }, { "name": "samo_calltrace" }, { "name": "samo_filter" }, { "name": "samo_l3fwd" }, { "name": "samo_bgp" }, { "name": "samo_crdtctrl" }, { "name": "samo_mvrp" }, { "name": "samo_cpipe" }, { "name": "samo_ppp" }, { "name": "samo_genericlog" }, { "name": "samo_ethring" }, { "name": "samo_srmrmtauth" }, { "name": "samo_ltethreshold" }, { "name": "samo_tunnelmgmt" }, { "name": "samo_ccag" }, { "name": "samo_igh" }, { "name": "samo_sw" }, { "name": "samo_multicast" }, { "name": "samo_udptunnel" }, { "name": "samo_porttemplate" }, { "name": "samo_isis" }, { "name": "samo_mwa" }, { "name": "samo_georedreplipolicy" }, { "name": "samo_fpipe" }, { "name": "samo_subscrident" }, { "name": "samo_mirror" }, { "name": "samo_lps" }, { "name": "samo_diameter" }, { "name": "samo_service" }, { "name": "samo_bundle" }, { "name": "samo_user" }, { "name": "samo_localuserdb" }, { "name": "samo_mld" }, { "name": "samo_ltemme" }, { "name": "samo_mediation" }, { "name": "samo_analysis" }, { "name": "samo_layer2" }, { "name": "samo_topologysim" }, { "name": "samo_lteradius" }, { "name": "samo_unpprofile" }, { "name": "samo_rmd" }, { "name": "samo_aingr" }, { "name": "samo_mirrorli" }, { "name": "samo_hip" }, { "name": "samo_audit" }, { "name": "samo_nat" }, { "name": "samo_ethernetservice" }, { "name": "samo_ranlicense" }, { "name": "samo_msdp" }, { "name": "samo_netw" }, { "name": "samo_subscrexpmap" }, { "name": "samo_ptp" }, { "name": "samo_slaprofile" }, { "name": "samo_rca" }, { "name": "samo_url" }, { "name": "samo_spanrules" }, { "name": "samo_log" }, { "name": "samo_nqueue" }, { "name": "samo_clear" }, { "name": "samo_managed objects" }, { "name": "samo_netca" }, { "name": "samo_rip" }, { "name": "samo_securityqueue" }, { "name": "samo_swflexi" }, { "name": "samo_l2fib" }, { "name": "samo_qgroup" }, { "name": "samo_aosqos" }, { "name": "samo_histcorr" }, { "name": "samo_lteepdg" }, { "name": "samo_sbtsperf" }, { "name": "samo_opticalequipment" }, { "name": "samo_vprn" }, { "name": "samo_policytestutil" }, { "name": "samo_topology" }, { "name": "samo_vlan" }, { "name": "samo_epipe" }, { "name": "samo_taskmgmt" }, { "name": "samo_firewall" }, { "name": "samo_aosredundancy" }, { "name": "samo_pcep" }, { "name": "samo_tpsperf" }, { "name": "samo_vrrp" }, { "name": "samo_statistics" }, { "name": "samo_accounting" }, { "name": "samo_rtr" }, { "name": "samo_ne3s" }, { "name": "samo_vwmperf" }, { "name": "samo_optical" }, { "name": "samo_todsuite" }, { "name": "samo_workspace" }, { "name": "samo_nge" }, { "name": "samo_gmplsuni" }, { "name": "samo_sitesec" }, { "name": "samo_mmepolicy" }, { "name": "samo_svr" }, { "name": "samo_telcoaclfilter" }, { "name": "samo_tdm" }, { "name": "samo_racflf" }, { "name": "samo_ltehomeagent" }, { "name": "samo_mdaxconnect" }, { "name": "samo_pdnprofile" }, { "name": "samo_lmp" }, { "name": "samo_sas" }, { "name": "samo_lldp" }, { "name": "samo_accessuplink" }, { "name": "samo_ltesecurity" }, { "name": "samo_tps" }, { "name": "samo_sflow" }, { "name": "samo_qos" }, { "name": "samo_selfconfig" }, { "name": "samo_dcap" }, { "name": "samo_racgnb" }, { "name": "samo_shaperqos" }, { "name": "samo_portscheduler" }, { "name": "samo_bfd" }, { "name": "samo_ltepolicyoptions" }, { "name": "samo_template" }, { "name": "samo_semvalidation" }, { "name": "samo_lte" }, { "name": "samo_ethernetequipment" }, { "name": "samo_apipe" }, { "name": "samo_security" }, { "name": "samo_file" }, { "name": "samo_qosprofile" }, { "name": "samo_bier" }, { "name": "samo_ntp" }, { "name": "samo_dns" }, { "name": "samo_icmp" }, { "name": "samo_pae802_1x" }, { "name": "samo_postpolicermapping" }, { "name": "samo_lte5g" }, { "name": "samo_subscr" }, { "name": "samo_hpipe" }, { "name": "samo_sasqos" }, { "name": "samo_lteservice" }, { "name": "samo_adp" }, { "name": "samo_rules" }, { "name": "samo_nfv" }, { "name": "samo_aaa" }, { "name": "samo_wlanequipment" }, { "name": "samo_equipment" }, { "name": "samo_squeue" }, { "name": "samo_dynsvc" }, { "name": "samo_svq" }, { "name": "samo_pppoe" }, { "name": "samo_spb" }, { "name": "samo_dctr" }, { "name": "samo_sonet" }, { "name": "samo_l2tp" }, { "name": "samo_auth" }, { "name": "samo_multichassis" }, { "name": "samo_openflow" }, { "name": "samo_ltepool" }, { "name": "samo_generic" }, { "name": "samo_ressubscr" }, { "name": "samo_tdmequipment" }, { "name": "samo_info" }, { "name": "samo_mplstp" }, { "name": "samo_nodelog" }, { "name": "samo_filterprefixlist" }, { "name": "samo_srrp" }, { "name": "samo_lteanr" }, { "name": "samo_multicastmgr" }, { "name": "samo_srpythonmgmt" }, { "name": "samo_activation" }, { "name": "samo_cac" }, { "name": "samo_ltesgsn" }, { "name": "samo_lmg" }, { "name": "samo_gnssequipment" }, { "name": "samo_dhcp" }, { "name": "samo_ltepmip" }, { "name": "samo_igmp" }, { "name": "samo_arp" }, { "name": "samo_cflowdlog" }, { "name": "samo_revoke" }, { "name": "samo_udprelay" }, { "name": "samo_aps" }, { "name": "samo_lteuserstats" }, { "name": "samo_atmpolicy" }, { "name": "samo_antispoof" }, { "name": "samo_lteli" }, { "name": "samo_sup" }, { "name": "samo_bulk" }, { "name": "samo_customdata" }, { "name": "samo_aclfilterli" }, { "name": "samo_pxc" }, { "name": "samo_resiliency" }, { "name": "samo_customproperties" }, { "name": "samo_webclient" }, { "name": "samo_securitypolicy" }, { "name": "samo_genericne" }, { "name": "samo_qosportlist" }, { "name": "samo_script" }, { "name": "samo_flex" }, { "name": "samo_ldp" }, { "name": "samo_ltegw" }, { "name": "samo_aossas" }, { "name": "samo_rollback" }, { "name": "samo_ranradiom" }, { "name": "samo_mpr" }, { "name": "samo_redirectfilter" }, { "name": "samo_swran" }, { "name": "samo_flexi" } ] }