{"type":"api","title":"Retrieve NSO policy","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/49adc1db-9339-395c-acc6-4b4e3bae3fce","info":{"title":"Crosswork Proxy API actions to NSO API","description":"Crosswork has several Cisco Network Services Orchestrator (NSO) APIs proxied from its API. This is a list of those actions.","version":"1.0.0","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"https://www.cisco.com/public/sw-license-agreement.html"}},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/DLM/nso_sp_api.md"}},"swagger":"2.0","basePath":"/crosswork/inventory/v1","schemes":["http","https"],"securityDefinitions":{"bearerAuth":{"type":"apiKey","description":"bearer auth","name":"Authorization","in":"header"}}},"spec":{"summary":"Retrieve NSO policy","description":"Get the DLM to NSO Policy, input is empty body, e.g. {} NsoPolicy object as an input is just to satisfy API.","operationId":"Nso_GetNSOPolicy","responses":{"200":{"description":"A successful response.","schema":{"type":"object","properties":{"name":{"type":"string"},"providers_criteria":{"type":"string"},"provider_policy":{"type":"object","additionalProperties":{"type":"object","properties":{"match":{"type":"boolean"},"matchRule":{"type":"string"},"onboardTo":{"type":"boolean"},"onboardToRule":{"type":"string"},"onboardFrom":{"type":"boolean"},"onboardFromRule":{"type":"string"},"syncFrom":{"type":"boolean"},"syncFromRule":{"type":"string"},"checkSync":{"type":"boolean"},"checkSyncRule":{"type":"string"},"neds":{"type":"array","items":{"type":"object","properties":{"ned":{"type":"string"},"rule":{"type":"string"}},"$$ref":"#/definitions/nso_sp_apiNedRule"}}},"$$ref":"#/definitions/nso_sp_apiNsoProviderPolicy"}},"lsa":{"type":"boolean"},"policy":{"type":"object","properties":{"auto_onboard_rfs":{"type":"boolean"},"rfs_spread_method":{"type":"string","enum":["ARBITRARY_USER_CONTROL","ROUND_ROBIN","RFS_CAPACITY"],"default":"ARBITRARY_USER_CONTROL","$$ref":"#/definitions/nso_sp_apiRFSOnboardingMethod"},"rfs_spread_value":{"type":"integer","format":"int64"}},"$$ref":"#/definitions/nso_sp_apiLsaPolicy"}},"example":{"name":"string","providers_criteria":"string","provider_policy":{"additionalProp1":{"match":true,"matchRule":"string","onboardTo":true,"onboardToRule":"string","onboardFrom":true,"onboardFromRule":"string","syncFrom":true,"syncFromRule":"string","checkSync":true,"checkSyncRule":"string","neds":[{"ned":"string","rule":"string"}]},"additionalProp2":{"match":true,"matchRule":"string","onboardTo":true,"onboardToRule":"string","onboardFrom":true,"onboardFromRule":"string","syncFrom":true,"syncFromRule":"string","checkSync":true,"checkSyncRule":"string","neds":[{"ned":"string","rule":"string"}]},"additionalProp3":{"match":true,"matchRule":"string","onboardTo":true,"onboardToRule":"string","onboardFrom":true,"onboardFromRule":"string","syncFrom":true,"syncFromRule":"string","checkSync":true,"checkSyncRule":"string","neds":[{"ned":"string","rule":"string"}]}},"lsa":true,"policy":{"auto_onboard_rfs":true,"rfs_spread_method":"ARBITRARY_USER_CONTROL","rfs_spread_value":0}},"$$ref":"#/definitions/nso_sp_apiNsoPolicy"}},"default":{"description":"An unexpected error response.","schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"integer","format":"int32"},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"type_url":{"type":"string"},"value":{"type":"string","format":"byte"}},"$$ref":"#/definitions/protobufAny"}}},"example":{"error":"string","code":0,"message":"string","details":[{"type_url":"string","value":"string"}]},"$$ref":"#/definitions/runtimeError"}}},"parameters":[{"name":"body","in":"body","description":"Request to get NSO Policy","required":true,"schema":{"type":"object","properties":{"name":{"type":"string"},"providers_criteria":{"type":"string"},"provider_policy":{"type":"object","additionalProperties":{"type":"object","properties":{"match":{"type":"boolean"},"matchRule":{"type":"string"},"onboardTo":{"type":"boolean"},"onboardToRule":{"type":"string"},"onboardFrom":{"type":"boolean"},"onboardFromRule":{"type":"string"},"syncFrom":{"type":"boolean"},"syncFromRule":{"type":"string"},"checkSync":{"type":"boolean"},"checkSyncRule":{"type":"string"},"neds":{"type":"array","items":{"type":"object","properties":{"ned":{"type":"string"},"rule":{"type":"string"}},"$$ref":"#/definitions/nso_sp_apiNedRule"}}},"$$ref":"#/definitions/nso_sp_apiNsoProviderPolicy"}},"lsa":{"type":"boolean"},"policy":{"type":"object","properties":{"auto_onboard_rfs":{"type":"boolean"},"rfs_spread_method":{"type":"string","enum":["ARBITRARY_USER_CONTROL","ROUND_ROBIN","RFS_CAPACITY"],"default":"ARBITRARY_USER_CONTROL","$$ref":"#/definitions/nso_sp_apiRFSOnboardingMethod"},"rfs_spread_value":{"type":"integer","format":"int64"}},"$$ref":"#/definitions/nso_sp_apiLsaPolicy"}},"example":{"name":"string","providers_criteria":"string","provider_policy":{"additionalProp1":{"match":true,"matchRule":"string","onboardTo":true,"onboardToRule":"string","onboardFrom":true,"onboardFromRule":"string","syncFrom":true,"syncFromRule":"string","checkSync":true,"checkSyncRule":"string","neds":[{"ned":"string","rule":"string"}]},"additionalProp2":{"match":true,"matchRule":"string","onboardTo":true,"onboardToRule":"string","onboardFrom":true,"onboardFromRule":"string","syncFrom":true,"syncFromRule":"string","checkSync":true,"checkSyncRule":"string","neds":[{"ned":"string","rule":"string"}]},"additionalProp3":{"match":true,"matchRule":"string","onboardTo":true,"onboardToRule":"string","onboardFrom":true,"onboardFromRule":"string","syncFrom":true,"syncFromRule":"string","checkSync":true,"checkSyncRule":"string","neds":[{"ned":"string","rule":"string"}]}},"lsa":true,"policy":{"auto_onboard_rfs":true,"rfs_spread_method":"ARBITRARY_USER_CONTROL","rfs_spread_value":0}},"$$ref":"#/definitions/nso_sp_apiNsoPolicy"}}],"tags":["Nso"],"__originalOperationId":"Nso_GetNSOPolicy","consumes":["application/json"],"produces":["application/json"],"security":[{"bearerAuth":[]}],"method":"post","path":"/nso/policy/query"}}