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.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.
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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successfully modified object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/purgeStaleEntriesOnHsmResponse'
- description: Model containing the method level model for HSMConfig.purgeStaleEntriesOnHsm 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/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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successfully modified object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/testConnectionToHsmResponse'
- description: Model containing the method level model for HSMConfig.testConnectionToHsm 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/ethernetoam/AbstractAccessInterfaceMip/resyncMip/{instanceFullName}:
post:
tags:
- samo_ethernetoam
summary: rest_ethernetoam_AbstractAccessInterfaceMip_resyncMip
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successfully modified object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/requestClearOamPmDmmRawStatsResponse'
- description: Model containing the method level model for CfmDmmSession.requestClearOamPmDmmRawStats 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/ethernetoam/CfmLMTest/stopCfmlm/{instanceFullName}:
post:
tags:
- samo_ethernetoam
summary: rest_ethernetoam_CfmLMTest_stopCfmlm
description: ''
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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successfully modified object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/requestClearOamPmLmmRawStatsResponse'
- description: Model containing the method level model for CfmLmmSession.requestClearOamPmLmmRawStats 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/ethernetoam/CfmLoopback/stopCfmLoopBackTest/{instanceFullName}:
post:
tags:
- samo_ethernetoam
summary: rest_ethernetoam_CfmLoopback_stopCfmLoopBackTest
description: ''
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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successfully modified object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/requestClearOamPmSlmRawStatsResponse'
- description: Model containing the method level model for CfmSlmSession.requestClearOamPmSlmRawStats 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/ethernetoam/CfmTwoWayDelayTest/stopCfmTwoWayDelayTest/{instanceFullName}:
post:
tags:
- samo_ethernetoam
summary: rest_ethernetoam_CfmTwoWayDelayTest_stopCfmTwoWayDelayTest
description: ''
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
description: ''
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
description: ''
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
description: ''
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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successful object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/getTimeZoneResponse'
- description: Model containing the method level model for Policy.getTimeZone 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/schedule/ScheduledTask/shutDown/{instanceFullName}:
post:
tags:
- samo_schedule
summary: rest_schedule_ScheduledTask_shutDown
description: ''
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
description: ''
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
description: ''
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
description: ''
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:
allOf:
- $ref: '#/components/schemas/findServicesResponse'
- description: Model containing the method level model for IpPathRecord.findServices 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/simulator/Scenario/analyzeImpact/{instanceFullName}:
post:
tags:
- samo_simulator
summary: rest_simulator_Scenario_analyzeImpact
description: ''
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
description: ''
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
description: ''
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
description: ''
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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successful object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/findFlexiNodesResponse'
- description: Model containing the method level model for FlexiPMPolicy.findFlexiNodes 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/flexiperf/FlexiPMPolicy/invokeCatchup:
post:
tags:
- samo_flexiperf
summary: rest_flexiperf_FlexiPMPolicy_invokeCatchup
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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:
allOf:
- $ref: '#/components/schemas/findServicesResponse'
- description: Model containing the method level model for IpPathRecord.findServices 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/monpath/MonitoredLspPath/captureCurrentPath/{instanceFullName}:
post:
tags:
- samo_monpath
summary: rest_monpath_MonitoredLspPath_captureCurrentPath
description: ''
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:
allOf:
- $ref: '#/components/schemas/findServicesResponse'
- description: Model containing the method level model for IpPathRecord.findServices 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/monpath/MonitoredP2MPLspPath/captureCurrentPath/{instanceFullName}:
post:
tags:
- samo_monpath
summary: rest_monpath_MonitoredP2MPLspPath_captureCurrentPath
description: ''
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:
allOf:
- $ref: '#/components/schemas/findServicesResponse'
- description: Model containing the method level model for IpPathRecord.findServices 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/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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successful object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/validatePathResponse'
- description: Model containing the method level model for MonitoredPath.validatePath 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/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:
allOf:
- $ref: '#/components/schemas/validatePathsResponse'
- description: Model containing the method level model for MonitoredPath.validatePaths 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/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:
allOf:
- $ref: '#/components/schemas/createBidirMonitoredPathResponse'
- description: Model containing the method level model for MonitoredPathManager.createBidirMonitoredPath 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/monpath/MonitoredPathManager/createMonitoredPath:
post:
tags:
- samo_monpath
summary: rest_monpath_MonitoredPathManager_createMonitoredPath
description: ''
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
description: ''
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:
allOf:
- $ref: '#/components/schemas/findServicesResponse'
- description: Model containing the method level model for IpPathRecord.findServices 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/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:
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/pim/VirtualAnyCastRP/addAnyCastRPMember/{instanceFullName}:
post:
tags:
- samo_pim
summary: rest_pim_VirtualAnyCastRP_addAnyCastRPMember
description: ''
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:
allOf:
- $ref: '#/components/schemas/findLocalAddressResponse'
- description: Model containing the method level model for VirtualAnyCastRP.findLocalAddress 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/pim/VirtualAnyCastRP/updateStatusFlags/{instanceFullName}:
put:
tags:
- samo_pim
summary: rest_pim_VirtualAnyCastRP_updateStatusFlags
description: ''
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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successful object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/findVPRNInstancesResponse'
- description: Model containing the method level model for Policy.findVPRNInstances 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/db/AuxiliaryDbBackup/AuxDbBackup/{instanceFullName}:
post:
tags:
- samo_db
summary: rest_db_AuxiliaryDbBackup_AuxDbBackup
description: ''
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
description: ''
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.
<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>
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:
allOf:
- $ref: '#/components/schemas/TokenAttribute'
- description: The mandatory attributes of Bearer token
'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:
allOf:
- $ref: '#/components/schemas/findInstanceContainedPeersResponse'
- description: Model containing the method level model for AbstractMultiChassisPeer.findInstanceContainedPeers 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/multichassis/AbstractMultiChassisPeer/pushDownPeerSyncSymmetricalConfig/{instanceFullName}:
post:
tags:
- samo_multichassis
summary: rest_multichassis_AbstractMultiChassisPeer_pushDownPeerSyncSymmetricalConfig
description: ''
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:
allOf:
- $ref: '#/components/schemas/resetPeerSyncProtocolsResponse'
- description: Model containing the method level model for AbstractMultiChassisPeer.resetPeerSyncProtocols 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/multichassis/McOmcrStat/resyncMcOmcrStat:
post:
tags:
- samo_multichassis
summary: rest_multichassis_McOmcrStat_resyncMcOmcrStat
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successful object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/getDependencyCountResponse'
- description: Model containing the method level model for PortCrossConnect.getDependencyCount 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/multichassis/MultiChassisPeerMobileGateway/mobilePeerSwitchOver/{instanceFullName}:
post:
tags:
- samo_multichassis
summary: rest_multichassis_MultiChassisPeerMobileGateway_mobilePeerSwitchOver
description: ''
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
description: ''
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
description: ''
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:
allOf:
- $ref: '#/components/schemas/findAssociatedVplsSapsResponse'
- description: Model containing the method level model for MultiChassisRingNode.findAssociatedVplsSaps 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/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:
allOf:
- $ref: '#/components/schemas/findReferencedSapsResponse'
- description: Model containing the method level model for MultiChassisRingNode.findReferencedSaps 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/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:
allOf:
- $ref: '#/components/schemas/findReferencedStaticHostsResponse'
- description: Model containing the method level model for MultiChassisRingNode.findReferencedStaticHosts 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/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:
allOf:
- $ref: '#/components/schemas/findSyncTagsResponse'
- description: Model containing the method level model for PeerSynchronizationProtocol.findSyncTags 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/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:
allOf:
- $ref: '#/components/schemas/retrieveOFFlowTableCountsResponse'
- description: Model containing the method level model for OFFlowTableCounts.retrieveOFFlowTableCounts 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/generic/GenericObject/clearDeployer:
post:
tags:
- samo_generic
summary: rest_generic_GenericObject_clearDeployer
description: ''
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:
allOf:
- $ref: '#/components/schemas/compareObjectsResponse'
- description: Model containing the method level model for GenericObject.compareObjects 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/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:
allOf:
- $ref: '#/components/schemas/configureChildInstanceResponse'
- description: Model containing the method level model for GenericObject.configureChildInstance 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/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:
allOf:
- $ref: '#/components/schemas/configureChildInstanceWithResultResponse'
- description: Model containing the method level model for GenericObject.configureChildInstanceWithResult 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/generic/GenericObject/configureInstance:
post:
tags:
- samo_generic
summary: rest_generic_GenericObject_configureInstance
description: ''
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:
allOf:
- $ref: '#/components/schemas/configureInstanceWithResultResponse'
- description: Model containing the method level model for GenericObject.configureInstanceWithResult 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/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:
allOf:
- $ref: '#/components/schemas/countInstanceResponse'
- description: Model containing the method level model for GenericObject.countInstance 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/generic/GenericObject/deleteInstance:
delete:
tags:
- samo_generic
summary: rest_generic_GenericObject_deleteInstance
description: ''
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
description: ''
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:
allOf:
- $ref: '#/components/schemas/filteredFindResponse'
- description: Model containing the method level model for GenericObject.filteredFind 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/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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successful object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/findInstanceResponse'
- description: Model containing the method level model for GenericObject.findInstance 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/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:
allOf:
- $ref: '#/components/schemas/findMultipleInstancesResponse'
- description: Model containing the method level model for GenericObject.findMultipleInstances 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/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:
allOf:
- $ref: '#/components/schemas/findMultipleInstancesShallowResponse'
- description: Model containing the method level model for GenericObject.findMultipleInstancesShallow 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/generic/GenericObject/forceSubmitDeployer:
post:
tags:
- samo_generic
summary: rest_generic_GenericObject_forceSubmitDeployer
description: ''
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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successful object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/getDeployerResponse'
- description: Model containing the method level model for GenericObject.getDeployer 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/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:
allOf:
- $ref: '#/components/schemas/getDeployersResponse'
- description: Model containing the method level model for GenericObject.getDeployers 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/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:
allOf:
- $ref: '#/components/schemas/getDeployersShallowResponse'
- description: Model containing the method level model for GenericObject.getDeployersShallow 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/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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successful object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/getIncrementalRequestIDResponse'
- description: Model containing the method level model for GenericObject.getIncrementalRequestID 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/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:
allOf:
- $ref: '#/components/schemas/multipleFilteredFindResponse'
- description: Model containing the method level model for GenericObject.multipleFilteredFind 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/generic/GenericObject/removeMany:
post:
tags:
- samo_generic
summary: rest_generic_GenericObject_removeMany
description: ''
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
description: ''
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
description: ''
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
description: ''
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:
allOf:
- $ref: '#/components/schemas/triggerIncrementalRequestResponse'
- description: Model containing the method level model for GenericObject.triggerIncrementalRequest 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/generic/GenericObject/triggerIncrementalRequestWithRequestID:
post:
tags:
- samo_generic
summary: rest_generic_GenericObject_triggerIncrementalRequestWithRequestID
description: ''
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:
allOf:
- $ref: '#/components/schemas/triggerResyncResponse'
- description: Model containing the method level model for GenericObject.triggerResync 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/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:
allOf:
- $ref: '#/components/schemas/updateUserObjectLifecycleStatesResponse'
- description: Model containing the method level model for GenericObject.updateUserObjectLifecycleStates 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/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:
allOf:
- $ref: '#/components/schemas/updateUserObjectLifecycleStatesAndLocksResponse'
- description: Model containing the method level model for GenericObject.updateUserObjectLifecycleStatesAndLocks 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/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:
allOf:
- $ref: '#/components/schemas/updateUserObjectLifecycleStatesAndLocksAndSchedulesResponse'
- description: Model containing the method level model for GenericObject.updateUserObjectLifecycleStatesAndLocksAndSchedules 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/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:
allOf:
- $ref: '#/components/schemas/updateUserObjectLifecycleStatesAndSchedulesResponse'
- description: Model containing the method level model for GenericObject.updateUserObjectLifecycleStatesAndSchedules 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/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:
allOf:
- $ref: '#/components/schemas/constructTemplatedObjectResponse'
- description: Model containing the method level model for AbstractResSubscrTemplate.constructTemplatedObject 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/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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successfully modified object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/updateResponse'
- description: Model containing the method level model for AbstractResSubscrTemplate.update 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/ressubscr/BrgProfile/clearPassword/{instanceFullName}:
post:
tags:
- samo_ressubscr
summary: rest_ressubscr_BrgProfile_clearPassword
description: ''
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:
allOf:
- $ref: '#/components/schemas/retrieveDhcpLeaseResponse'
- description: Model containing the method level model for DhcpLeaseState.retrieveDhcpLease 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/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:
allOf:
- $ref: '#/components/schemas/retrieveDhcpLeaseStateRadiusClassesResponse'
- description: Model containing the method level model for DhcpLeaseStateRadiusClassAttribute.retrieveDhcpLeaseStateRadiusClasses 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/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:
allOf:
- $ref: '#/components/schemas/retrieveHostLockoutInfoResponse'
- description: Model containing the method level model for HostLockoutInfo.retrieveHostLockoutInfo 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/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:
allOf:
- $ref: '#/components/schemas/retrieveHostTrackedSubscribersResponse'
- description: Model containing the method level model for HostTrackedSubscriber.retrieveHostTrackedSubscribers 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/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:
allOf:
- $ref: '#/components/schemas/requestClearIpoeSessionsResponse'
- description: Model containing the method level model for IPoESession.requestClearIpoeSessions 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/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:
allOf:
- $ref: '#/components/schemas/retrieveIPoESessionsResponse'
- description: Model containing the method level model for IPoESession.retrieveIPoESessions 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/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:
allOf:
- $ref: '#/components/schemas/retrieveIPoESessionRadiusClassesResponse'
- description: Model containing the method level model for IPoESessionRadiusClassAttribute.retrieveIPoESessionRadiusClasses 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/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:
allOf:
- $ref: '#/components/schemas/retrieveManagedSubscriberHostsResponse'
- description: Model containing the method level model for ManagedSubscriberHost.retrieveManagedSubscriberHosts 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/ressubscr/ResidentialSubscriber/modifySubscriberIdent:
post:
tags:
- samo_ressubscr
summary: rest_ressubscr_ResidentialSubscriber_modifySubscriberIdent
description: ''
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:
allOf:
- $ref: '#/components/schemas/clearSubscriberHostDhcp6LeaseStateResponse'
- description: Model containing the method level model for ResidentialSubscriberInstance.clearSubscriberHostDhcp6LeaseState 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/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:
allOf:
- $ref: '#/components/schemas/clearSubscriberHostLeaseStateResponse'
- description: Model containing the method level model for ResidentialSubscriberInstance.clearSubscriberHostLeaseState 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/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:
allOf:
- $ref: '#/components/schemas/requestClearHostIgmpHostTrackingResponse'
- description: Model containing the method level model for ResidentialSubscriberInstance.requestClearHostIgmpHostTracking 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/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:
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/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:
allOf:
- $ref: '#/components/schemas/retrieveL2tpTunnelsResponse'
- description: Model containing the method level model for ResidentialSubscriberInstance.retrieveL2tpTunnels 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/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:
allOf:
- $ref: '#/components/schemas/retrieveResidentialSubscriberResponse'
- description: Model containing the method level model for ResidentialSubscriberInstance.retrieveResidentialSubscriber 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/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:
allOf:
- $ref: '#/components/schemas/retrieveSubscriberVirtualSubnetsResponse'
- description: Model containing the method level model for ResidentialSubscriberInstance.retrieveSubscriberVirtualSubnets 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/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:
allOf:
- $ref: '#/components/schemas/clearDynamicHostResponse'
- description: Model containing the method level model for ResidentialSubscriberManager.clearDynamicHost 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/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:
allOf:
- $ref: '#/components/schemas/clearSapResponse'
- description: Model containing the method level model for ResidentialSubscriberManager.clearSap 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/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:
allOf:
- $ref: '#/components/schemas/createSubSvcComponentsResponse'
- description: Model containing the method level model for ResidentialSubscriberManager.createSubSvcComponents 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/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:
allOf:
- $ref: '#/components/schemas/createSubSvcComponentsDynResponse'
- description: Model containing the method level model for ResidentialSubscriberManager.createSubSvcComponentsDyn 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/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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successfully modified object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/deleteSubSvcComponentsResponse'
- description: Model containing the method level model for ResidentialSubscriberManager.deleteSubSvcComponents 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/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:
allOf:
- $ref: '#/components/schemas/retrieveResidentialSubscribersResponse'
- description: Model containing the method level model for ResidentialSubscriberManager.retrieveResidentialSubscribers 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/ressubscr/ResidentialSubscriberManager/triggerCollect:
post:
tags:
- samo_ressubscr
summary: rest_ressubscr_ResidentialSubscriberManager_triggerCollect
description: ''
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:
allOf:
- $ref: '#/components/schemas/updateSubSvcComponentsDynAclResponse'
- description: Model containing the method level model for ResidentialSubscriberManager.updateSubSvcComponentsDynAcl 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/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:
allOf:
- $ref: '#/components/schemas/retrieveSlaProfileInstancesResponse'
- description: Model containing the method level model for SlaProfileInstance.retrieveSlaProfileInstances 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/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:
allOf:
- $ref: '#/components/schemas/retrieveAddrPoolsResponse'
- description: Model containing the method level model for SubBrgAddressPool.retrieveAddrPools 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/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:
allOf:
- $ref: '#/components/schemas/retrieveSubSlaacHostRadiusClassesResponse'
- description: Model containing the method level model for SubSlaacHostRadiusClassAttribute.retrieveSubSlaacHostRadiusClasses 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/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:
allOf:
- $ref: '#/components/schemas/retrieveSubMacErrorResponse'
- description: Model containing the method level model for SubscrMacError.retrieveSubMacError 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/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:
allOf:
- $ref: '#/components/schemas/retrieveSubSapErrorResponse'
- description: Model containing the method level model for SubscrSapError.retrieveSubSapError 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/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:
allOf:
- $ref: '#/components/schemas/retrieveSubSdpErrorResponse'
- description: Model containing the method level model for SubscrSdpError.retrieveSubSdpError 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/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:
allOf:
- $ref: '#/components/schemas/retrieveSubUnknownErrorResponse'
- description: Model containing the method level model for SubscrUnknownError.retrieveSubUnknownError 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/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:
allOf:
- $ref: '#/components/schemas/findSlaProfileStringSuggestionsResponse'
- description: Model containing the method level model for SubscriberHost.findSlaProfileStringSuggestions 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/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:
allOf:
- $ref: '#/components/schemas/retrieveL2TPSessionResponse'
- description: Model containing the method level model for SubscriberHost.retrieveL2TPSession 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/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:
allOf:
- $ref: '#/components/schemas/retrieveSAPHostsResponse'
- description: Model containing the method level model for SubscriberHost.retrieveSAPHosts 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/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:
allOf:
- $ref: '#/components/schemas/retrieveSubscriberHostsResponse'
- description: Model containing the method level model for SubscriberHost.retrieveSubscriberHosts 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/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:
allOf:
- $ref: '#/components/schemas/evalLeaseStatePerSapResponse'
- description: Model containing the method level model for SubscriberHostConfiguration.evalLeaseStatePerSap 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/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:
allOf:
- $ref: '#/components/schemas/evalLeaseStatePerSapIdResponse'
- description: Model containing the method level model for SubscriberHostConfiguration.evalLeaseStatePerSapId 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/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:
allOf:
- $ref: '#/components/schemas/updateMultipleSubscrHostsResponse'
- description: Model containing the method level model for SubscriberHostConfiguration.updateMultipleSubscrHosts 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/ressubscr/SubscriberHostCreditReset/resetCredit:
post:
tags:
- samo_ressubscr
summary: rest_ressubscr_SubscriberHostCreditReset_resetCredit
description: ''
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
description: ''
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:
allOf:
- $ref: '#/components/schemas/retrievePccRuleResponse'
- description: Model containing the method level model for SubscriberPccRuleEntry.retrievePccRule 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/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:
allOf:
- $ref: '#/components/schemas/retrievePccRulesPerSubscrHostResponse'
- description: Model containing the method level model for SubscriberPccRuleEntry.retrievePccRulesPerSubscrHost 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/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:
allOf:
- $ref: '#/components/schemas/retrieveSubscriberQosOverridesResponse'
- description: Model containing the method level model for SubscriberQosOverride.retrieveSubscriberQosOverrides 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/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:
allOf:
- $ref: '#/components/schemas/retrieveSubSvcResponse'
- description: Model containing the method level model for SubscriberService.retrieveSubSvc 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/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:
allOf:
- $ref: '#/components/schemas/retrieveAdaptiveClockHistoryResponse'
- description: Model containing the method level model for AdaptiveClockHistory.retrieveAdaptiveClockHistory 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/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:
allOf:
- $ref: '#/components/schemas/findP2PLspResponse'
- description: Model containing the method level model for BFDTemplate.findP2PLsp 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/mplstp/GlobalTPLsp/createWithAutoFillForCompleteConnections:
post:
tags:
- samo_mplstp
summary: rest_mplstp_GlobalTPLsp_createWithAutoFillForCompleteConnections
description: ''
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
description: ''
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:
allOf:
- $ref: '#/components/schemas/findGroupDomainBindingResponse'
- description: Model containing the method level model for Domain.findGroupDomainBinding 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/multicastmgr/Group/syncGroups:
post:
tags:
- samo_multicastmgr
summary: rest_multicastmgr_Group_syncGroups
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successful object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/retrieveWorkOrderXMLResponse'
- description: Model containing the method level model for AbstractWorkOrder.retrieveWorkOrderXML 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/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:
allOf:
- $ref: '#/components/schemas/findWithWorkOrderScanResponse'
- description: Model containing the method level model for ActivationManager.findWithWorkOrderScan 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/activation/ActivationManager/scanWorkOrderRepository:
post:
tags:
- samo_activation
summary: rest_activation_ActivationManager_scanWorkOrderRepository
description: ''
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
description: ''
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
description: ''
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:
allOf:
- $ref: '#/components/schemas/addNeWorkOrdersResponse'
- description: Model containing the method level model for Session.addNeWorkOrders 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/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:
allOf:
- $ref: '#/components/schemas/addWorkOrderResponse'
- description: Model containing the method level model for Session.addWorkOrder 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/activation/Session/closeSession:
post:
tags:
- samo_activation
summary: rest_activation_Session_closeSession
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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:
allOf:
- $ref: '#/components/schemas/addInclusionFilterResponse'
- description: Model containing the method level model for SupervisionGroup.addInclusionFilter 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/activation/Snapshot/extract/{instanceFullName}:
post:
tags:
- samo_activation
summary: rest_activation_Snapshot_extract
description: ''
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:
allOf:
- $ref: '#/components/schemas/removeInclusionFilterResponse'
- description: Model containing the method level model for SupervisionGroup.removeInclusionFilter 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/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:
allOf:
- $ref: '#/components/schemas/createSessionResponse'
- description: Model containing the method level model for WorkOrder.createSession 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/cac/CacManager/bookBwForReservedTunnel:
post:
tags:
- samo_cac
summary: rest_cac_CacManager_bookBwForReservedTunnel
description: ''
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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successful object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/findServicesUsingTunnelResponse'
- description: Model containing the method level model for CacManager.findServicesUsingTunnel 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/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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successful object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/isCacEnabledResponse'
- description: Model containing the method level model for CacManager.isCacEnabled 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/cac/CacManager/verifyCac:
post:
tags:
- samo_cac
summary: rest_cac_CacManager_verifyCac
description: ''
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:
allOf:
- $ref: '#/components/schemas/dhcpStickyLeaseActionResponse'
- description: Model containing the method level model for AbstractAddressPool.dhcpStickyLeaseAction 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/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:
allOf:
- $ref: '#/components/schemas/forcePartnerDownResponse'
- description: Model containing the method level model for AbstractDhcpServerFailover.forcePartnerDown 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/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:
allOf:
- $ref: '#/components/schemas/resyncDeclinedAddressesResponse'
- description: Model containing the method level model for AddressPool.resyncDeclinedAddresses 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/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:
allOf:
- $ref: '#/components/schemas/resyncFreeAddressesResponse'
- description: Model containing the method level model for AddressPool.resyncFreeAddresses 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/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:
allOf:
- $ref: '#/components/schemas/showDhcp6LeasesResponse'
- description: Model containing the method level model for LocalDhcp6Server.showDhcp6Leases 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/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:
allOf:
- $ref: '#/components/schemas/clearDhcpServerLeasesResponse'
- description: Model containing the method level model for LocalDhcpServer.clearDhcpServerLeases 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/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:
allOf:
- $ref: '#/components/schemas/clearDhcpServerStickyLeasesResponse'
- description: Model containing the method level model for LocalDhcpServer.clearDhcpServerStickyLeases 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/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:
allOf:
- $ref: '#/components/schemas/resyncLeasesResponse'
- description: Model containing the method level model for LocalDhcpServer.resyncLeases 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/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:
allOf:
- $ref: '#/components/schemas/retrieveStickyLeasesResponse'
- description: Model containing the method level model for StickyLeaseData.retrieveStickyLeases 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/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:
allOf:
- $ref: '#/components/schemas/retrieveIgmpGroupIfSapGrpResponse'
- description: Model containing the method level model for GroupInterfaceSapGroup.retrieveIgmpGroupIfSapGrp 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/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:
allOf:
- $ref: '#/components/schemas/retrieveIgmpGroupIfSapGrpSrcResponse'
- description: Model containing the method level model for GroupInterfaceSapGroupSource.retrieveIgmpGroupIfSapGrpSrc 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/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:
allOf:
- $ref: '#/components/schemas/retrieveIgmpHostsResponse'
- description: Model containing the method level model for IgmpHost.retrieveIgmpHosts 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/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:
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/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:
allOf:
- $ref: '#/components/schemas/retrieveArpHostRadiusClassesResponse'
- description: Model containing the method level model for ArpHostRadiusClassAttribute.retrieveArpHostRadiusClasses 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: []
/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 \x91/nfm-p/rest/api/v1\x92 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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successful object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/getDependencyCountResponse'
- description: Model containing the method level model for PortCrossConnect.getDependencyCount 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/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:
allOf:
- $ref: '#/components/schemas/findInstanceChannelPortsResponse'
- description: Model containing the method level model for ApsGroup.findInstanceChannelPorts 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/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:
allOf:
- $ref: '#/components/schemas/findInstanceApsGroupsResponse'
- description: Model containing the method level model for MultiChassisApsGroupContainer.findInstanceApsGroups 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/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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successful object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/getDependencyCountResponse'
- description: Model containing the method level model for PortCrossConnect.getDependencyCount 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/lteuserstats/UserStatsManager/cancelAllQueries:
delete:
tags:
- samo_lteuserstats
summary: rest_lteuserstats_UserStatsManager_cancelAllQueries
description: ''
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
description: ''
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
description: ''
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:
allOf:
- $ref: '#/components/schemas/shouldWarnUserResponse'
- description: Model containing the method level model for UserStatsQuery.shouldWarnUser 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/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:
allOf:
- $ref: '#/components/schemas/retrieveAntiSpoofingFiltersResponse'
- description: Model containing the method level model for AntiSpoofingFilter.retrieveAntiSpoofingFilters 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/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:
allOf:
- $ref: '#/components/schemas/addGroupsResponse'
- description: Model containing the method level model for SummaryView.addGroups 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/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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successful object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/getAlarmsResponse'
- description: Model containing the method level model for SummaryView.getAlarms 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/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:
allOf:
- $ref: '#/components/schemas/getAlarmsWithFilterResponse'
- description: Model containing the method level model for SummaryView.getAlarmsWithFilter 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/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:
allOf:
- $ref: '#/components/schemas/getCachedHistoryResponse'
- description: Model containing the method level model for SummaryView.getCachedHistory 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/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:
allOf:
- $ref: '#/components/schemas/getMonitoredObjectsByClassesResponse'
- description: Model containing the method level model for SummaryView.getMonitoredObjectsByClasses 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/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:
allOf:
- $ref: '#/components/schemas/getMonitoredObjectsSummariesResponse'
- description: Model containing the method level model for SummaryView.getMonitoredObjectsSummaries 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/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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successful object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/getNeTraceStatusObjectsByGroupResponse'
- description: Model containing the method level model for SummaryView.getNeTraceStatusObjectsByGroup 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/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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successful object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/getNumFailedCellsResponse'
- description: Model containing the method level model for SummaryView.getNumFailedCells 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/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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successful object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/listGroupsResponse'
- description: Model containing the method level model for SummaryView.listGroups 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/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:
allOf:
- $ref: '#/components/schemas/removeGroupsResponse'
- description: Model containing the method level model for SummaryView.removeGroups 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/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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successfully modified object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/setBaselineResponse'
- description: Model containing the method level model for SupervisionGroup.setBaseline 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/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:
allOf:
- $ref: '#/components/schemas/setGroupBaselineResponse'
- description: Model containing the method level model for SummaryView.setGroupBaseline 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/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:
allOf:
- $ref: '#/components/schemas/addInclusionFilterResponse'
- description: Model containing the method level model for SupervisionGroup.addInclusionFilter 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/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:
allOf:
- $ref: '#/components/schemas/addTriggerFilterResponse'
- description: Model containing the method level model for SupervisionGroup.addTriggerFilter 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/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:
allOf:
- $ref: '#/components/schemas/getHistoryBufferResponse'
- description: Model containing the method level model for SupervisionGroup.getHistoryBuffer 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/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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successful object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/getInfoWithMonitoredObjectsResponse'
- description: Model containing the method level model for SupervisionGroup.getInfoWithMonitoredObjects 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/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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successful object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/listSummaryViewsResponse'
- description: Model containing the method level model for SupervisionGroup.listSummaryViews 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/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:
allOf:
- $ref: '#/components/schemas/removeInclusionFilterResponse'
- description: Model containing the method level model for SupervisionGroup.removeInclusionFilter 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/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:
allOf:
- $ref: '#/components/schemas/removeTriggerFilterResponse'
- description: Model containing the method level model for SupervisionGroup.removeTriggerFilter 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/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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successfully modified object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/setBaselineResponse'
- description: Model containing the method level model for SupervisionGroup.setBaseline 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/sup/SupervisionManager/clearAllHistory:
post:
tags:
- samo_sup
summary: rest_sup_SupervisionManager_clearAllHistory
description: ''
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:
allOf:
- $ref: '#/components/schemas/dumpLogResponse'
- description: Model containing the method level model for SupervisionManager.dumpLog 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/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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successful object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/getGroupsByFdnResponse'
- description: Model containing the method level model for SupervisionManager.getGroupsByFdn 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/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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successful object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/getGroupsByFdnForUserResponse'
- description: Model containing the method level model for SupervisionManager.getGroupsByFdnForUser 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/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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successful object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/keepAliveUpdateResponse'
- description: Model containing the method level model for SupervisionManager.keepAliveUpdate 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/sup/SupervisionManager/rebuildCache:
post:
tags:
- samo_sup
summary: rest_sup_SupervisionManager_rebuildCache
description: ''
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:
allOf:
- $ref: '#/components/schemas/searchMonitoredObjectResponse'
- description: Model containing the method level model for SupervisionManager.searchMonitoredObject 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/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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successfully modified object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/setBaselineResponse'
- description: Model containing the method level model for SupervisionGroup.setBaseline 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/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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successfully modified object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/takeSnapshotResponse'
- description: Model containing the method level model for SupervisionManager.takeSnapshot 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/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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successful object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/getDependencyCountResponse'
- description: Model containing the method level model for PortCrossConnect.getDependencyCount 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/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:
allOf:
- $ref: '#/components/schemas/requestClearEfmOamEventLogsResponse'
- description: Model containing the method level model for PortCrossConnectSubPort.requestClearEfmOamEventLogs 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/pxc/PortCrossConnectSubPort/requestResyncEfmOamEventLogs/{instanceFullName}:
post:
tags:
- samo_pxc
summary: rest_pxc_PortCrossConnectSubPort_requestResyncEfmOamEventLogs
description: ''
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
description: ''
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
description: ''
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
description: ''
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:
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/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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successful object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/findScriptsResponse'
- description: Model containing the method level model for GenericNeProfile.findScripts 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/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:
allOf:
- $ref: '#/components/schemas/validateUpgradePathResponse'
- description: Model containing the method level model for GenericNeProfile.validateUpgradePath 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/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:
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/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:
allOf:
- $ref: '#/components/schemas/getNesMultipleTypesResponse'
- description: Model containing the method level model for GenericNeProfileManager.getNesMultipleTypes 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/script/AbstractScript/changeScriptVersion/{instanceFullName}:
post:
tags:
- samo_script
summary: rest_script_AbstractScript_changeScriptVersion
description: ''
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:
allOf:
- $ref: '#/components/schemas/configScriptVersionResponse'
- description: Model containing the method level model for AbstractScript.configScriptVersion 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/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:
allOf:
- $ref: '#/components/schemas/configureScriptResponse'
- description: Model containing the method level model for AbstractScript.configureScript 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/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:
allOf:
- $ref: '#/components/schemas/configureTargetResponse'
- description: Model containing the method level model for AbstractScript.configureTarget 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/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:
allOf:
- $ref: '#/components/schemas/configureTargetsResponse'
- description: Model containing the method level model for AbstractScript.configureTargets 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/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:
allOf:
- $ref: '#/components/schemas/createScriptVersionResponse'
- description: Model containing the method level model for AbstractScript.createScriptVersion 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/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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successful object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/getScriptContentsResponse'
- description: Model containing the method level model for AbstractVersion.getScriptContents 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/script/Bundle/addScripts/{instanceFullName}:
post:
tags:
- samo_script
summary: rest_script_Bundle_addScripts
description: ''
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
description: ''
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
description: ''
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:
allOf:
- $ref: '#/components/schemas/associateExecutableScriptResponse'
- description: Model containing the method level model for ControlScript.associateExecutableScript 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/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:
allOf:
- $ref: '#/components/schemas/associateHandlerScriptResponse'
- description: Model containing the method level model for ControlScript.associateHandlerScript 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/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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successful object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/getResultBodyResponse'
- description: Model containing the method level model for Result.getResultBody 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/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:
allOf:
- $ref: '#/components/schemas/saveResultResponse'
- description: Model containing the method level model for ResultManager.saveResult 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/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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successful object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/cancelExecutionResponse'
- description: Model containing the method level model for ScriptManager.cancelExecution 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/script/ScriptManager/cancelRunningCliExecution:
delete:
tags:
- samo_script
summary: rest_script_ScriptManager_cancelRunningCliExecution
description: ''
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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successful object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/cancelScriptFlowResponse'
- description: Model containing the method level model for ScriptManager.cancelScriptFlow 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/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:
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/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:
allOf:
- $ref: '#/components/schemas/executeCLIScriptResponse'
- description: Model containing the method level model for ScriptManager.executeCLIScript 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/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:
allOf:
- $ref: '#/components/schemas/executeCLITargetScriptsResponse'
- description: Model containing the method level model for ScriptManager.executeCLITargetScripts 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/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:
allOf:
- $ref: '#/components/schemas/executeScriptResponse'
- description: Model containing the method level model for ScriptManager.executeScript 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/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:
allOf:
- $ref: '#/components/schemas/executeScriptFlowResponse'
- description: Model containing the method level model for ScriptManager.executeScriptFlow 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/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:
allOf:
- $ref: '#/components/schemas/executeSystemScriptsResponse'
- description: Model containing the method level model for ScriptManager.executeSystemScripts 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/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:
allOf:
- $ref: '#/components/schemas/executeTargetScriptsResponse'
- description: Model containing the method level model for ScriptManager.executeTargetScripts 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/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:
allOf:
- $ref: '#/components/schemas/executeTargetScriptsWithParametersResponse'
- description: Model containing the method level model for ScriptManager.executeTargetScriptsWithParameters 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/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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successful object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/getBodyOfTargetScriptResultResponse'
- description: Model containing the method level model for ScriptManager.getBodyOfTargetScriptResult 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/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:
allOf:
- $ref: '#/components/schemas/previewScriptWithParametersResponse'
- description: Model containing the method level model for ScriptManager.previewScriptWithParameters 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/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:
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/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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successful object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/cancelExecutionResponse'
- description: Model containing the method level model for ScriptManager.cancelExecution 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/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:
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/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:
allOf:
- $ref: '#/components/schemas/executeCLIScriptResponse'
- description: Model containing the method level model for ScriptManager.executeCLIScript 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/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:
allOf:
- $ref: '#/components/schemas/executeCLITargetScriptResponse'
- description: Model containing the method level model for TargetScript.executeCLITargetScript 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/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:
allOf:
- $ref: '#/components/schemas/executeScriptResponse'
- description: Model containing the method level model for ScriptManager.executeScript 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/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:
allOf:
- $ref: '#/components/schemas/executeTargetScriptResponse'
- description: Model containing the method level model for TargetScript.executeTargetScript 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/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:
allOf:
- $ref: '#/components/schemas/previewResponse'
- description: Model containing the method level model for TargetScript.preview 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/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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successful object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/getTargetScriptResultResponse'
- description: Model containing the method level model for TargetScriptResult.getTargetScriptResult 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/script/VelocityTemplate/reload:
post:
tags:
- samo_script
summary: rest_script_VelocityTemplate_reload
description: ''
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:
allOf:
- $ref: '#/components/schemas/storeResponse'
- description: Model containing the method level model for VelocityTemplate.store 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/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:
allOf:
- $ref: '#/components/schemas/associateTemplateResponse'
- description: Model containing the method level model for XmlApiConfigTemplate.associateTemplate 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/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:
allOf:
- $ref: '#/components/schemas/convertOldTemplatesResponse'
- description: Model containing the method level model for XmlApiConfigTemplate.convertOldTemplates 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/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:
allOf:
- $ref: '#/components/schemas/executeResponse'
- description: Model containing the method level model for XmlApiConfigTemplate.execute 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/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:
allOf:
- $ref: '#/components/schemas/executeMultiResponse'
- description: Model containing the method level model for XmlApiConfigTemplate.executeMulti 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/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:
allOf:
- $ref: '#/components/schemas/generateResponse'
- description: Model containing the method level model for XmlApiConfigTemplate.generate 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/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:
allOf:
- $ref: '#/components/schemas/generateFromSampleResponse'
- description: Model containing the method level model for XmlApiConfigTemplate.generateFromSample 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/ldp/AccountingFecPrefix/shutDown/{instanceFullName}:
post:
tags:
- samo_ldp
summary: rest_ldp_AccountingFecPrefix_shutDown
description: ''
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
description: ''
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
description: ''
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:
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/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:
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/aossas/CPETestGroupHead/cancelCPETestGroupExection/{instanceFullName}:
delete:
tags:
- samo_aossas
summary: rest_aossas_CPETestGroupHead_cancelCPETestGroupExection
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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:
allOf:
- $ref: '#/components/schemas/executeCompareCheckpointResponse'
- description: Model containing the method level model for RollbackNEInfo.executeCompareCheckpoint 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/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:
allOf:
- $ref: '#/components/schemas/executeViewCheckPointResponse'
- description: Model containing the method level model for RollbackNEInfo.executeViewCheckPoint 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/rollback/RollbackNEInfo/redundancyRollbackSync:
post:
tags:
- samo_rollback
summary: rest_rollback_RollbackNEInfo_redundancyRollbackSync
description: ''
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
description: ''
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
description: ''
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:
$ref: '#/components/schemas/Content-Type'
responses:
'200':
description: Returns a successful object
headers: {}
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/findEnodeBsReadyForRadioMeasurementResponse'
- description: Model containing the method level model for RANRadioMeasureManager.findEnodeBsReadyForRadioMeasurement 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/ranradiom/RANRadioMeasureManager/refreshEnodeB:
post:
tags:
- samo_ranradiom
summary: rest_ranradiom_RANRadioMeasureManager_refreshEnodeB
description: ''
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:
allOf:
- $ref: '#/components/schemas/refreshEnodeBWithResultResponse'
- description: Model containing the method level model for RANRadioMeasureManager.refreshEnodeBWithResult 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/ranradiom/RANRadioMeasureManager/startPolling:
post:
tags:
- samo_ranradiom
summary: rest_ranradiom_RANRadioMeasureManager_startPolling
description: ''
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:
allOf:
- $ref: '#/components/schemas/startPollingWithResultResponse'
- description: Model containing the method level model for RANRadioMeasureManager.startPollingWithResult 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/ranradiom/RANRadioMeasureManager/stopPolling:
post:
tags:
- samo_ranradiom
summary: rest_ranradiom_RANRadioMeasureManager_stopPolling
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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
description: ''
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/Result1'
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.
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:
$ref: '#/components/schemas/Result2'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/PppSessionRetrievalStruct2'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/CtpFilter'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/Service'
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:
$ref: '#/components/schemas/RemoveFilter'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/RetrieveDynSvcDataTriggersStruct2'
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:
$ref: '#/components/schemas/ConfigInfo1'
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:
$ref: '#/components/schemas/Result6'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/Result8'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/CtpFilter'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/CtpFilter'
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:
$ref: '#/components/schemas/Result12'
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:
$ref: '#/components/schemas/Result13'
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:
$ref: '#/components/schemas/AInApsGroupConfigInfo'
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:
$ref: '#/components/schemas/LspPathFilter'
lspFilter:
$ref: '#/components/schemas/LspFilter'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/Result16'
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:
$ref: '#/components/schemas/Result13'
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:
$ref: '#/components/schemas/Result18'
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:
$ref: '#/components/schemas/Result19'
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:
$ref: '#/components/schemas/AInPreFixData'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/CtpFilter'
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:
$ref: '#/components/schemas/ClearHostStruct2'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/AInFilter'
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:
$ref: '#/components/schemas/TargetScriptConfig'
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:
$ref: '#/components/schemas/Result24'
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:
$ref: '#/components/schemas/TopologyGroupInfo'
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:
$ref: '#/components/schemas/AInFilter'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/RetrieveCallTraceStruct1'
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:
$ref: '#/components/schemas/Result12'
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:
$ref: '#/components/schemas/Result26'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/Result12'
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:
$ref: '#/components/schemas/FaultFilter'
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:
$ref: '#/components/schemas/AnInfilter'
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:
$ref: '#/components/schemas/SapFilter'
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:
$ref: '#/components/schemas/AInTrailInfo'
aInTrailSiteInfo:
$ref: '#/components/schemas/AInTrailSiteInfo'
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:
$ref: '#/components/schemas/Result13'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/Constraints2'
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:
$ref: '#/components/schemas/RetrievingSessionStruct1'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/Result32'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/Test'
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:
$ref: '#/components/schemas/Result35'
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:
$ref: '#/components/schemas/Result12'
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:
$ref: '#/components/schemas/FaultFilter'
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:
$ref: '#/components/schemas/ResultInfo'
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:
$ref: '#/components/schemas/Filter'
synchronous:
type: boolean
description: boolean
default: false
example: false
resultFilter:
$ref: '#/components/schemas/ResultFilter'
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:
$ref: '#/components/schemas/Result19'
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:
$ref: '#/components/schemas/RetrieveCallTraceStruct1'
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:
$ref: '#/components/schemas/Result26'
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:
$ref: '#/components/schemas/Result12'
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:
$ref: '#/components/schemas/CtpFilter'
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:
$ref: '#/components/schemas/Result18'
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:
$ref: '#/components/schemas/CtpFilter'
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:
$ref: '#/components/schemas/Result13'
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:
$ref: '#/components/schemas/TemplateConfiguration'
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:
$ref: '#/components/schemas/AnInfilter'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/Result42'
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:
$ref: '#/components/schemas/Result13'
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:
$ref: '#/components/schemas/Result44'
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:
$ref: '#/components/schemas/Result45'
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:
$ref: '#/components/schemas/ConfigInfo1'
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:
$ref: '#/components/schemas/Result18'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/Result12'
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:
$ref: '#/components/schemas/TemplateConfiguration'
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:
$ref: '#/components/schemas/Result13'
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:
$ref: '#/components/schemas/Result18'
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:
$ref: '#/components/schemas/Result50'
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:
$ref: '#/components/schemas/Result12'
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:
$ref: '#/components/schemas/Result12'
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:
$ref: '#/components/schemas/Result18'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/Result55'
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:
$ref: '#/components/schemas/CtpFilter'
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:
$ref: '#/components/schemas/Result12'
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:
$ref: '#/components/schemas/ConfigInfo1'
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:
$ref: '#/components/schemas/AInFilter'
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:
$ref: '#/components/schemas/AInFirewallHostRtrvStruct'
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:
$ref: '#/components/schemas/ChildConfigInfo'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/Result13'
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:
$ref: '#/components/schemas/Result12'
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:
$ref: '#/components/schemas/Result60'
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:
$ref: '#/components/schemas/Result61'
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:
$ref: '#/components/schemas/Result19'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/Result63'
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:
$ref: '#/components/schemas/AInPreFixData'
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:
$ref: '#/components/schemas/RetrievingSlaProfileInstStruct2'
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:
$ref: '#/components/schemas/Result13'
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:
$ref: '#/components/schemas/SessionStruct2'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/Result12'
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:
$ref: '#/components/schemas/S2lPathFilter'
lspFilter:
$ref: '#/components/schemas/LspFilter'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/AInVrrpInstance'
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:
$ref: '#/components/schemas/Result67'
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:
$ref: '#/components/schemas/Result68'
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:
$ref: '#/components/schemas/RetrieveCallTraceStruct1'
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:
$ref: '#/components/schemas/RetrievingDhcpLeaseStruct1'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/Result12'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/BasicKPIs1'
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:
$ref: '#/components/schemas/Result72'
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:
$ref: '#/components/schemas/Result73'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/Result19'
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:
$ref: '#/components/schemas/Result12'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/IpsecSecuredCtdInfo'
privateService:
$ref: '#/components/schemas/PrivateService'
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:
$ref: '#/components/schemas/CopyMoveStruct'
sourceSapFilter:
$ref: '#/components/schemas/SourceSapFilter'
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:
$ref: '#/components/schemas/ResultFilter'
description: RestRegister SAS Log to file model
RegisterFindDto:
title: RegisterFindDto
required:
- fullClassName
type: object
properties:
fullClassName:
type: string
description: string
example: netw.NetworkElement
filter:
$ref: '#/components/schemas/Filter'
resultFilter:
$ref: '#/components/schemas/ResultFilter'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/Result13'
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:
$ref: '#/components/schemas/Result77'
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:
$ref: '#/components/schemas/AInHostInfoRtrvStruct'
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:
$ref: '#/components/schemas/Filter'
resultFilter:
$ref: '#/components/schemas/ResultFilter'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/AInContext'
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:
$ref: '#/components/schemas/Result79'
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:
$ref: '#/components/schemas/Result80'
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:
$ref: '#/components/schemas/TunnelGroupEndpointMemberFilter'
tunnelGroupEndpointFilter:
$ref: '#/components/schemas/TunnelGroupEndpointFilter'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/Result12'
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:
$ref: '#/components/schemas/AInRetrGtpS11SessionStruct'
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:
$ref: '#/components/schemas/ConfigInfo4'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/LspPathFilter'
lspFilter:
$ref: '#/components/schemas/LspFilter'
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:
$ref: '#/components/schemas/Result12'
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:
$ref: '#/components/schemas/AccessInterface'
staticRoute:
$ref: '#/components/schemas/StaticRoute'
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:
$ref: '#/components/schemas/Result12'
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:
$ref: '#/components/schemas/ConfigInfo1'
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:
$ref: '#/components/schemas/Result24'
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:
$ref: '#/components/schemas/Result86'
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:
$ref: '#/components/schemas/AUeQueryStruct'
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:
$ref: '#/components/schemas/ComparisonFilter1'
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:
$ref: '#/components/schemas/Result24'
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:
$ref: '#/components/schemas/Result88'
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:
$ref: '#/components/schemas/Result60'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/TargetScriptConfig'
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:
$ref: '#/components/schemas/Result50'
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:
$ref: '#/components/schemas/AInContext'
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:
$ref: '#/components/schemas/Result92'
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:
$ref: '#/components/schemas/ConfigInfo1'
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:
$ref: '#/components/schemas/Result13'
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:
$ref: '#/components/schemas/Result94'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/Result96'
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:
$ref: '#/components/schemas/Result13'
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:
$ref: '#/components/schemas/RetrievePccRuleStruct1'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/Result98'
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:
$ref: '#/components/schemas/AInMldSapParams'
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:
$ref: '#/components/schemas/PoolSubnetRtrvStruct2'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/Result13'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/SystemScriptTargetConfigInfo'
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:
$ref: '#/components/schemas/AlarmableInstanceFilter'
faultFilter:
$ref: '#/components/schemas/FaultFilter'
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:
$ref: '#/components/schemas/Result12'
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:
$ref: '#/components/schemas/AInFilter'
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:
$ref: '#/components/schemas/Result103'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/Result104'
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:
$ref: '#/components/schemas/AUeQueryStruct'
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:
$ref: '#/components/schemas/Result13'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/Result13'
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:
$ref: '#/components/schemas/Result108'
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:
$ref: '#/components/schemas/ConfigInfo1'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/SubHostPccRuleInfoStruct'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/Result12'
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:
$ref: '#/components/schemas/CardSlot2'
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:
$ref: '#/components/schemas/Result13'
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:
$ref: '#/components/schemas/ConfigInfo4'
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:
$ref: '#/components/schemas/AInIncrementalContext'
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:
$ref: '#/components/schemas/Result68'
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:
$ref: '#/components/schemas/RetrieveManagedSubscriberHostsStruct1'
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:
$ref: '#/components/schemas/CtpFilter'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/SapFilter'
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:
$ref: '#/components/schemas/Result114'
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:
$ref: '#/components/schemas/RetrievingIpoeSessionStruct1'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/AuditParam1'
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:
$ref: '#/components/schemas/Result13'
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:
$ref: '#/components/schemas/Result117'
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:
$ref: '#/components/schemas/Result118'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/TemplateConfiguration'
additionalParameters:
$ref: '#/components/schemas/AdditionalParameters'
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:
$ref: '#/components/schemas/ConfigInfo1'
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:
$ref: '#/components/schemas/FaultFilter'
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:
$ref: '#/components/schemas/VersionConfigInfo'
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:
$ref: '#/components/schemas/Result120'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/ResultConfigInfo'
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:
$ref: '#/components/schemas/RetrievingSessionStruct1'
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:
$ref: '#/components/schemas/RecordFilter'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/PortObjectFilter'
ctpFilter:
$ref: '#/components/schemas/CtpFilter'
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:
$ref: '#/components/schemas/FirstObject'
secondObject:
$ref: '#/components/schemas/SecondObject'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/FaultFilter'
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:
$ref: '#/components/schemas/AInRequest'
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:
$ref: '#/components/schemas/ChildConfigInfo'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/ConfigInfo1'
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:
$ref: '#/components/schemas/AInApsGroupConfigInfo'
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:
$ref: '#/components/schemas/Result124'
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:
$ref: '#/components/schemas/PortFilter'
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:
$ref: '#/components/schemas/Result45'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/Result12'
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:
$ref: '#/components/schemas/FaultFilter'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/Result6'
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:
$ref: '#/components/schemas/BasicKPIs1'
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:
$ref: '#/components/schemas/Result129'
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:
$ref: '#/components/schemas/Result130'
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:
$ref: '#/components/schemas/ConfigInfo11'
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:
$ref: '#/components/schemas/Result13'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/PathConfigInfo1'
tunnelConfigInfo:
$ref: '#/components/schemas/TunnelConfigInfo1'
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:
$ref: '#/components/schemas/Filter'
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:
$ref: '#/components/schemas/VersionConfigInfo'
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:
$ref: '#/components/schemas/Result68'
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:
$ref: '#/components/schemas/Result135'
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:
$ref: '#/components/schemas/ContainmentConfigInfo'
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:
$ref: '#/components/schemas/Result'
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:
$ref: '#/components/schemas/AInCountFilter'
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:
$ref: '#/components/schemas/Result'
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
AccessInterface:
title: AccessInterface
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'
AdditionalParameters:
title: AdditionalParameters
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: ''
AInApsGroupConfigInfo:
title: AInApsGroupConfigInfo
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'
AInContext:
title: AInContext
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
AInCountFilter:
title: AInCountFilter
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'
AInFilter:
title: AInFilter
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'
AInFirewallHostRtrvStruct:
title: AInFirewallHostRtrvStruct
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
AInHostInfoRtrvStruct:
title: AInHostInfoRtrvStruct
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
AInIncrementalContext:
title: AInIncrementalContext
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
AInMldSapParams:
title: AInMldSapParams
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
AInPreFixData:
title: AInPreFixData
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: ''
AInRequest:
title: AInRequest
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
AInRetrGtpS11SessionStruct:
title: AInRetrGtpS11SessionStruct
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
AInTrailInfo:
title: AInTrailInfo
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'
AInTrailSiteInfo:
title: AInTrailSiteInfo
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'
AInVrrpInstance:
title: AInVrrpInstance
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
AlarmableInstanceFilter:
title: AlarmableInstanceFilter
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'
AnInfilter:
title: AnInfilter
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'
AuditParam1:
title: AuditParam1
required:
- objectClassName
- fdn
type: object
properties:
objectClassName:
type: string
description: packageName.className of the child object
example: String
fdn:
type: string
AUeQueryStruct:
title: AUeQueryStruct
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
BasicKPIs1:
title: BasicKPIs1
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
CardSlot2:
title: CardSlot2
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
ChildConfigInfo:
title: ChildConfigInfo
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'
ClearHostStruct2:
title: ClearHostStruct2
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
ComparisonFilter1:
title: ComparisonFilter1
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
ConfigInfo1:
title: ConfigInfo1
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'
ConfigInfo4:
title: ConfigInfo4
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
ConfigInfo11:
title: ConfigInfo11
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"}'
Constraints2:
title: Constraints2
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
ContainmentConfigInfo:
title: ContainmentConfigInfo
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'
Content-Type:
title: Content-Type
enum:
- application/json
type: string
Content-Type114:
title: Content-Type114
enum:
- application/x-www-form-urlencoded
type: string
CopyMoveStruct:
title: CopyMoveStruct
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
CtpFilter:
title: CtpFilter
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'
FaultFilter:
title: FaultFilter
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'
Filter:
title: Filter
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'
FirstObject:
title: FirstObject
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
IpsecSecuredCtdInfo:
title: IpsecSecuredCtdInfo
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
LspFilter:
title: LspFilter
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'
LspPathFilter:
title: LspPathFilter
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'
PathConfigInfo1:
title: PathConfigInfo1
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
PoolSubnetRtrvStruct2:
title: PoolSubnetRtrvStruct2
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
PortFilter:
title: PortFilter
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'
PortObjectFilter:
title: PortObjectFilter
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'
PppSessionRetrievalStruct2:
title: PppSessionRetrievalStruct2
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
PrivateService:
title: PrivateService
required:
- objectClassName
- service
- siteList
type: object
properties:
objectClassName:
type: string
description: packageName.className of the child object
example: String
service:
$ref: '#/components/schemas/Service'
siteList:
type: array
items:
$ref: '#/components/schemas/SiteUnion'
description: ''
RecordFilter:
title: RecordFilter
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'
RemoveFilter:
title: RemoveFilter
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'
Result:
title: Result
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
Result1:
title: Result1
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
Result2:
title: Result2
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
Result6:
title: Result6
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: ''
Result8:
title: Result8
required:
- objectClassName
- resultInfo
- resultBody
type: object
properties:
objectClassName:
type: string
description: packageName.className of the child object
example: String
resultInfo:
$ref: '#/components/schemas/ResultInfo'
resultBody:
type: string
Result12:
title: Result12
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
Result13:
title: Result13
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: ''
Result16:
title: Result16
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
Result18:
title: Result18
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
Result19:
title: Result19
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: ''
Result24:
title: Result24
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
Result26:
title: Result26
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: ''
Result32:
title: Result32
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
Result35:
title: Result35
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
Result42:
title: Result42
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
Result44:
title: Result44
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
Result45:
title: Result45
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'
Result50:
title: Result50
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
Result55:
title: Result55
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
Result60:
title: Result60
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'
Result61:
title: Result61
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
Result63:
title: Result63
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
Result67:
title: Result67
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: ''
Result68:
title: Result68
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
Result72:
title: Result72
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
Result73:
title: Result73
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
Result77:
title: Result77
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
Result79:
title: Result79
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: ''
Result80:
title: Result80
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
Result86:
title: Result86
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
Result88:
title: Result88
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
Result92:
title: Result92
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
Result94:
title: Result94
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: ''
Result96:
title: Result96
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
Result98:
title: Result98
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
Result103:
title: Result103
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'
Result104:
title: Result104
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
Result108:
title: Result108
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
Result114:
title: Result114
required:
- objectClassName
- cardSlot
- portList
type: object
properties:
objectClassName:
type: string
description: packageName.className of the child object
example: String
cardSlot:
$ref: '#/components/schemas/CardSlot2'
portList:
type: array
items:
$ref: '#/components/schemas/CommonManagedEntityInformation'
description: ''
Result117:
title: Result117
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
Result118:
title: Result118
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:
$ref: '#/components/schemas/Result12'
Result120:
title: Result120
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
Result124:
title: Result124
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
Result129:
title: Result129
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
Result130:
title: Result130
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
Result135:
title: Result135
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
ResultConfigInfo:
title: ResultConfigInfo
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'
ResultFilter:
title: ResultFilter
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]
ResultInfo:
title: ResultInfo
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
RetrieveCallTraceStruct1:
title: RetrieveCallTraceStruct1
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
RetrieveDynSvcDataTriggersStruct2:
title: RetrieveDynSvcDataTriggersStruct2
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
RetrieveManagedSubscriberHostsStruct1:
title: RetrieveManagedSubscriberHostsStruct1
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
RetrievePccRuleStruct1:
title: RetrievePccRuleStruct1
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
RetrievingDhcpLeaseStruct1:
title: RetrievingDhcpLeaseStruct1
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
RetrievingIpoeSessionStruct1:
title: RetrievingIpoeSessionStruct1
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
RetrievingSessionStruct1:
title: RetrievingSessionStruct1
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
RetrievingSlaProfileInstStruct2:
title: RetrievingSlaProfileInstStruct2
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
S2lPathFilter:
title: S2lPathFilter
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'
SapFilter:
title: SapFilter
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'
SecondObject:
title: SecondObject
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
Service:
title: Service
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'
SessionStruct2:
title: SessionStruct2
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:
$ref: '#/components/schemas/Filter'
timeout:
type: integer
format: int64
SourceSapFilter:
title: SourceSapFilter
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'
StaticRoute:
title: StaticRoute
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'
SubHostPccRuleInfoStruct:
title: SubHostPccRuleInfoStruct
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
SystemScriptTargetConfigInfo:
title: SystemScriptTargetConfigInfo
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'
TargetScriptConfig:
title: TargetScriptConfig
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
TemplateConfiguration:
title: TemplateConfiguration
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
Test:
title: Test
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
TopologyGroupInfo:
title: TopologyGroupInfo
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'
TunnelConfigInfo1:
title: TunnelConfigInfo1
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
TunnelGroupEndpointFilter:
title: TunnelGroupEndpointFilter
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'
TunnelGroupEndpointMemberFilter:
title: TunnelGroupEndpointMemberFilter
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'
V1ManagedobjectsChildrenRequest:
title: V1ManagedobjectsChildrenRequest
type: object
properties:
fdn:
type: string
fullClassNameList:
type: array
items:
type: string
description: ''
V1ManagedobjectsSearchRequest:
title: V1ManagedobjectsSearchRequest
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"}'
VersionConfigInfo:
title: VersionConfigInfo
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'
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