List of top-level policy definitions - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"List of top-level policy definitions","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/6489938a-86e5-302e-a992-577b2d687313","info":{"title":"cisco-l3vpn-routing-policy","description":"This YANG module defines models that l3vpn-ntw-deviations\nwill make ietf-l3vpn-ntw to depend on.","termsOfService":"http://www.cisco.com/web/siteassets/legal/terms_condition.html","contact":{"name":"Cisco Systems","url":"https://www.cisco.com","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"},"version":"7.1.0"},"security":[{"bearerAuth":[]}],"tags":[{"name":"data","description":"data resources"}],"x-parser-conf":{"overview":{"markdownPath":"reference/CNC/cisco-l3vpn-routing-policy-api-overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://{cnc-host}:{cnc-port}/crosswork/proxy/nso/restconf","variables":{"cnc-host":{"default":"127.0.0.1","description":"host name or ip address of the target CNC Cluster"},"cnc-port":{"default":"30603","description":"port number of the target CNC Cluster"}}}],"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}},"spec":{"tags":["data"],"summary":"List of top-level policy definitions","description":"List of top-level policy definitions","operationId":"data_cisco_l3vpn_routing_policy_l3vpn_routing_policy_policy_definitions_policy_definition_policy_definition_name_get","parameters":[{"name":"policy-definition-name","in":"path","description":"Name of the top-level policy definition; this name\nis used in references to the current policy.","required":true,"schema":{"type":"string","format":"string"}},{"name":"content","in":"query","description":"controlling descendant nodes in response","schema":{"type":"string","format":"enumeration","default":"config","enum":["config","nonconfig","all"]}},{"name":"depth","in":"query","description":"limit the depth of nodes in response","schema":{"type":"integer","format":"uint16"}},{"name":"fields","in":"query","description":"optionally identify specific data nodes in response","schema":{"type":"string","format":"string"}},{"name":"filter","in":"query","description":"xpath expression to filter data nodes in response","schema":{"type":"string","format":"string"}},{"name":"with-defaults","in":"query","description":"controlling default values in response","schema":{"type":"string","format":"enumeration","default":"report-all","enum":["report-all","trim","explicit","report-all-tagged"]}}],"responses":{"200":{"description":"List of top-level policy definitions","content":{"application/yang-data+json":{"schema":{"type":"object","properties":{"cisco-l3vpn-routing-policy:policy-definition":{"type":"array","description":"List of top-level policy definitions (list)","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the top-level policy definition; this name\nis used in references to the current policy. (leaf)","format":"string","x-yang":{"type":"leaf"}},"statements":{"type":"object","properties":{"statement":{"type":"array","description":"Policy statements group conditions and actions\nwithin a policy definition evaluated in\nthe order specified. (list)","items":{"type":"object","properties":{"name":{"type":"string","description":"Name of the policy statement. (leaf)","format":"string","x-yang":{"type":"leaf"}},"conditions":{"type":"object","properties":{"match-source-prefix-set":{"type":"object","properties":{"prefix-set":{"type":"string","description":"References a defined prefix set. Used only in the MVPN case. (leaf)","format":"leafref","x-yang":{"type":"leaf"}}},"description":"Match a referenced prefix-set. Used only in the MVPN case. (presence)","x-yang":{"is_presence":"true","type":"container"}},"match-dest-prefix-set":{"type":"object","properties":{"prefix-set":{"type":"string","description":"References a defined prefix set. (leaf)","format":"leafref","x-yang":{"type":"leaf"}}},"description":"Match a referenced prefix-set according to the\nlogic defined in the match-set-options leaf. (presence)","x-yang":{"is_presence":"true","type":"container"}}},"description":"Condition statements for the current policy\nstatement. (non-presence)","x-yang":{"is_presence":"false","type":"container"}},"actions":{"type":"object","properties":{"multicast-actions":{"type":"object","properties":{"set-data-mdt":{"type":"string","description":"Set named data mdt (leaf)","format":"string","x-yang":{"type":"leaf"}},"set-on-demand-color":{"type":"string","description":"References a defined tag set. (leaf)","format":"leafref","x-yang":{"type":"leaf"}},"set-fast-reroute":{"type":"object","properties":{"set-lfa":{"type":"object","properties":{},"description":"Set LFA Fast Re-route (presence)","x-yang":{"is_presence":"true","type":"container"}}},"description":"Set Fast Re-route protection for MVPN Tree-SID route policy only (presence)","x-yang":{"is_presence":"true","type":"container"}}},"description":"Top-level container for multicast-specific actions (presence)","x-yang":{"is_presence":"true","type":"container"}},"apply-policy":{"type":"object","properties":{"extra-policy":{"type":"array","items":{"type":"string","description":"List of policy names in sequence to be applied. (leaf-list)","format":"string"},"x-yang":{"type":"leaf-list"}}},"description":"Anchor point for extra routing policies in the model (presence)","x-yang":{"is_presence":"true","type":"container"}},"bgp-actions":{"type":"object","properties":{"set-ext-community":{"type":"object","properties":{"ext-community-set-ref":{"type":"string","description":"References a defined extended community set by name. Creating routing-policy tag-set is mandatory and needs to be mapped here. (leaf)","format":"leafref","x-yang":{"type":"leaf"}}},"description":"Action to set the extended community attributes (presence)","x-yang":{"is_presence":"true","type":"container"}}},"description":"Top-level container for BGP-specific actions (presence)","x-yang":{"is_presence":"true","type":"container"}},"policy-result":{"type":"string","description":"Select accept disposition for the route.\nStatement cannot contain conditions with only policy-result action (leaf)","format":"enumeration","default":"accept-route","enum":["accept-route"],"x-yang":{"type":"leaf"}}},"description":"Top-level container for policy action\nstatements. (non-presence)","x-yang":{"is_presence":"false","type":"container"}}}},"x-yang":{"type":"list"}}},"description":"Enclosing container for policy statements. (non-presence)","x-yang":{"is_presence":"false","type":"container"}}}},"x-yang":{"type":"list"}}},"$$ref":"#/components/schemas/data_cisco-l3vpn-routing-policy_l3vpn-routing-policy_policy-definitions_policy-definition_policy-definition-name"}}}},"204":{"description":"No Content","content":{}},"400":{"description":"Bad Request","content":{}},"401":{"description":"Unauthorized","content":{}},"404":{"description":"Not Found","content":{}},"405":{"description":"Method Not Allowed","content":{}},"409":{"description":"Conflict","content":{}}},"security":[{"bearerAuth":[]}],"__originalOperationId":"data_cisco_l3vpn_routing_policy_l3vpn_routing_policy_policy_definitions_policy_definition_policy_definition_name_get","method":"get","path":"/data/cisco-l3vpn-routing-policy:l3vpn-routing-policy/policy-definitions/policy-definition={policy-definition-name}"}}