@itentialopensource/adapter-nokia_nsp_nfm_p

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â\x80\x99s properties, values, descriptions , types, inheritance and relationships. The NFM-P (SAMO) object Model is documented in the <a href=\"https://145.40.97.123:8543/help/advanced/content.jsp?topic=%2FXML_Reference%2Findex_no_banner.html\">NSP NFM-P XML Reference </a> 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 \x91/nfm-p/rest/api/v1/auth\x92 API will be available up to NSP 22.11 and removed in NSP 23.03.\n Support for the \x91/nfm-p/rest/api/v1\x92 API will be available up to NSP 22.11 and removed in NSP 23.03. \nDisclaimer: 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: allOf: - $ref: '#/components/schemas/configureResponse' - description: Model containing the method level model for Site.configure to encode json response from internal NFM-P object model '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 description: '' 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 description: '' 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 description: '' 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: allOf: - $ref: '#/components/schemas/retrieveAAUrlListStatusResponse' - description: Model containing the method level model for AAUrlListPolicy.retrieveAAUrlListStatus to encode json response from internal NFM-P object model '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 description: '' 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 description: '' 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: allOf: - $ref: '#/components/schemas/retrieveDbInfoTransitIpAddressResponse' - description: Model containing the method level model for DbInfoTransitIpAddress.retrieveDbInfoTransitIpAddress to encode json response from internal NFM-P object model '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: allOf: - $ref: '#/components/schemas/retrieveDbInfoTransitPrefixAddressResponse' - description: Model containing the method level model for DbInfoTransitPrefixAddress.retrieveDbInfoTransitPrefixAddress to encode json response from internal NFM-P object model '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 description: '' 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: allOf: - $ref: '#/components/schemas/retrieveTransitSubscribersResponse' - description: Model containing the method level model for DbInfoTransitSubscriberManager.retrieveTransitSubscribers to encode json response from internal NFM-P object model '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: allOf: - $ref: '#/components/schemas/findSyncESitesResponse' - description: Model containing the method level model for SyncEDomain.findSyncESites to encode json response from internal NFM-P object model '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: $ref: '#/components/schemas/Content-Type' responses: '200': description: Returns a successful object headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/getServiceDependencyCountResponse' - description: Model containing the method level model for Policy.getServiceDependencyCount to encode json response from internal NFM-P object model '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 description: '' 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: $ref: '#/components/schemas/Content-Type' responses: '200': description: Returns a successful object headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/getAllConnectionProfileResponse' - description: Model containing the method level model for Interface.getAllConnectionProfile to encode json response from internal NFM-P object model '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 description: '' 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: allOf: - $ref: '#/components/schemas/triggerNeAuditResponse' - description: Model containing the method level model for NeAuditManager.triggerNeAudit to encode json response from internal NFM-P object model '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: allOf: - $ref: '#/components/schemas/triggerNesAuditResponse' - description: Model containing the method level model for NeAuditManager.triggerNesAudit to encode json response from internal NFM-P object model '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: allOf: - $ref: '#/components/schemas/requestClearIdleOnlyMsapsResponse' - description: Model containing the method level model for Policy.requestClearIdleOnlyMsaps to encode json response from internal NFM-P object model '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: $ref: '#/components/schemas/Content-Type' responses: '200': description: Returns a successfully modified object headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/requestClearMsapsResponse' - description: Model containing the method level model for Policy.requestClearMsaps to encode json response from internal NFM-P object model '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: allOf: - $ref: '#/components/schemas/requestClearIgmpHostTrackingResponse' - description: Model containing the method level model for ResidentialSubscriberInstance.requestClearIgmpHostTracking to encode json response from internal NFM-P object model '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: allOf: - $ref: '#/components/schemas/requestClearIgmpHostTrackingResponse' - description: Model containing the method level model for ResidentialSubscriberInstance.requestClearIgmpHostTracking to encode json response from internal NFM-P object model '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 description: '' 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: $ref: '#/components/schemas/Content-Type' responses: '200': description: Returns a successful object headers: {} content: application/json: schema: allOf: - $ref: '#/components/schemas/retrieveHostResponse' - description: Model containing the method level model for Portal.retrieveHost to encode json response from internal NFM-P object model '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: allOf: - $ref: '#/components/schemas/requestClearWppHostsLoggingOutResponse' - description: Model containing the method level model for WppHost.requestClearWppHostsLoggingOut to encode json response from internal NFM-P object model '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 description: '' 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 description: '' 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 description: '' 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: allOf: - $ref: '#/components/schemas/retrieveHostSharedPccRuleEgressPolicyResponse' - description: Model containing the method level model for Policy.retrieveHostSharedPccRuleEgressPolicy to encode json response from internal NFM-P object model '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: allOf: - $ref: '#/components/schemas/createDefaultTestHeadProfileResponse' - description: Model containing the method level model for L2AccessInterface.createDefaultTestHeadProfile to encode json response from internal NFM-P object model '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 description: '' 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: allOf: - $ref: '#/components/schemas/switchToRedundantSapsResponse' - description: Model containing the method level model for L2AccessInterface.switchToRedundantSaps to encode json response from internal NFM-P object model '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 description: '' 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: C