OpenAPI
OpenAPI Version: 3.0.1
The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
OpenAPI Version: 3.0.1
Title: cnbng-infra
Description: 'This module contains a collection of YANG definitions for Cisco Cloud-Native
BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
Version: '2021-06-23'
URL: /restconf
- Name: root
Description: root resources
- Name: operations
Description: operations resources
- Name: data
Description: data resources
- Name: get
Description: get resources
- Name: head
Description: head resources
- Name: post
Description: post resources
- Name: patch
Description: patch resources
- Name: put
Description: put resources
- Name: options
Description: options resources
- Name: delete
Description: delete resources
get:
Tags:
- root
- get
Summary: 'This module contains a collection of YANG definitions for Cisco Cloud-Native
BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
Description: 'This module contains a collection of YANG definitions for Cisco
Cloud-Native BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
Operation ID: root_get
Responses:
'200':
Description: 'This module contains a collection of YANG definitions for
Cisco Cloud-Native BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
Content:
application/yang-data+json:
Schema:
Reference: '#/components/schemas/root'
'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:
- basicAuth: []
head:
Tags:
- root
- head
Summary: 'This module contains a collection of YANG definitions for Cisco Cloud-Native
BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
Description: 'This module contains a collection of YANG definitions for Cisco
Cloud-Native BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
Operation ID: root_head
Responses:
'200':
Description: OK
Content: {}
security:
- basicAuth: []
get:
Tags:
- operations
- get
Summary: 'This module contains a collection of YANG definitions for Cisco Cloud-Native
BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
Description: 'This module contains a collection of YANG definitions for Cisco
Cloud-Native BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
Operation ID: operations_get
Responses:
'200':
Description: 'This module contains a collection of YANG definitions for
Cisco Cloud-Native BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
Content:
application/yang-data+json:
Schema:
Reference: '#/components/schemas/operations'
'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:
- basicAuth: []
get:
Tags:
- yang-library-version
- get
Summary: 'This module contains a collection of YANG definitions for Cisco Cloud-Native
BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
Description: 'This module contains a collection of YANG definitions for Cisco
Cloud-Native BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
Operation ID: yang_library_version_get
Responses:
'200':
Description: 'This module contains a collection of YANG definitions for
Cisco Cloud-Native BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
Content:
application/yang-data+json:
Schema:
Reference: '#/components/schemas/yang-library-version'
'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:
- basicAuth: []
head:
Tags:
- yang-library-version
- head
Summary: 'This module contains a collection of YANG definitions for Cisco Cloud-Native
BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
Description: 'This module contains a collection of YANG definitions for Cisco
Cloud-Native BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
Operation ID: yang_library_version_head
Responses:
'200':
Description: OK
Content: {}
security:
- basicAuth: []
get:
Tags:
- data
- get
Summary: 'This module contains a collection of YANG definitions for Cisco Cloud-Native
BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
Description: 'This module contains a collection of YANG definitions for Cisco
Cloud-Native BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
Operation ID: data_get
Responses:
'200':
Description: 'This module contains a collection of YANG definitions for
Cisco Cloud-Native BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
Content:
application/yang-data+json:
Schema:
Reference: '#/components/schemas/data'
'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:
- basicAuth: []
put:
Tags:
- data
- put
Summary: 'This module contains a collection of YANG definitions for Cisco Cloud-Native
BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
Description: 'This module contains a collection of YANG definitions for Cisco
Cloud-Native BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
Operation ID: data_put
Request Body:
Description: 'This module contains a collection of YANG definitions for Cisco
Cloud-Native BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
Content:
application/yang-data+json:
Schema:
Reference: '#/components/schemas/data-put-patch'
Required/Optional: true
Responses:
'201':
Description: 'This module contains a collection of YANG definitions for
Cisco Cloud-Native BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
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:
- basicAuth: []
x-codegen-request-body-name: data
Method: Post
Tags:
- data
- post
Summary: 'This module contains a collection of YANG definitions for Cisco Cloud-Native
BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
Description: 'This module contains a collection of YANG definitions for Cisco
Cloud-Native BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
Operation ID: data_post
Request Body:
Description: 'This module contains a collection of YANG definitions for Cisco
Cloud-Native BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
Content:
application/yang-data+json:
Schema:
Reference: '#/components/schemas/data-post'
Required/Optional: true
Responses:
'201':
Description: 'This module contains a collection of YANG definitions for
Cisco Cloud-Native BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
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:
- basicAuth: []
x-codegen-request-body-name: data
head:
Tags:
- data
- head
Summary: 'This module contains a collection of YANG definitions for Cisco Cloud-Native
BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
Description: 'This module contains a collection of YANG definitions for Cisco
Cloud-Native BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
Operation ID: data_head
Responses:
'200':
Description: OK
Content: {}
security:
- basicAuth: []
patch:
Tags:
- data
- patch
Summary: 'This module contains a collection of YANG definitions for Cisco Cloud-Native
BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
Description: 'This module contains a collection of YANG definitions for Cisco
Cloud-Native BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
Operation ID: data_patch
Request Body:
Description: 'This module contains a collection of YANG definitions for Cisco
Cloud-Native BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
Content:
application/yang-data+json:
Schema:
Reference: '#/components/schemas/data-put-patch'
Required/Optional: true
Responses:
'204':
Description: 'This module contains a collection of YANG definitions for
Cisco Cloud-Native BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
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:
- basicAuth: []
x-codegen-request-body-name: data
get:
Tags:
- data
- get
Operation ID: data_cnbng_infra_subscriber_get
Parameters:
- Name: content
In: query
Description: controlling descendant nodes in response
Required/Optional: false
Style: form
Explode: true
Schema:
Type: string
Format: enumeration
enum:
- config
- nonconfig
- all
Default: config
- Name: depth
In: query
Description: limit the depth of nodes in response
Required/Optional: false
Style: form
Explode: true
Schema:
Type: integer
Format: uint16
- Name: fields
In: query
Description: optionally identify specific data nodes in response
Required/Optional: false
Style: form
Explode: true
Schema:
Type: string
Format: string
- Name: filter
In: query
Description: xpath expression to filter data nodes in response
Required/Optional: false
Style: form
Explode: true
Schema:
Type: string
Format: string
- Name: with-defaults
In: query
Description: controlling default values in response
Required/Optional: false
Style: form
Explode: true
Schema:
Type: string
Format: enumeration
enum:
- report-all
- trim
- explicit
- report-all-tagged
Default: report-all
Responses:
'200':
Description: OK
Content:
application/yang-data+json:
Schema:
Reference: '#/components/schemas/data_cnbng-infra_subscriber'
'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:
- basicAuth: []
put:
Tags:
- data
- put
Operation ID: data_cnbng_infra_subscriber_put
Request Body:
Content:
application/yang-data+json:
Schema:
Reference: '#/components/schemas/data_cnbng-infra_subscriber'
Required/Optional: true
Responses:
'201':
Description: container subscriber created or replaced
Content: {}
'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:
- basicAuth: []
x-codegen-request-body-name: subscriber
Method: Post
Tags:
- data
- post
Operation ID: data_cnbng_infra_subscriber_post
Request Body:
Content:
application/yang-data+json:
Schema:
Reference: '#/components/schemas/data_cnbng-infra_subscriber-post'
Required/Optional: true
Responses:
'201':
Description: container subscriber created
Content: {}
'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:
- basicAuth: []
x-codegen-request-body-name: subscriber
delete:
Tags:
- data
- delete
Operation ID: data_cnbng_infra_subscriber_delete
Responses:
'204':
Description: No Content
Content: {}
security:
- basicAuth: []
options:
Tags:
- data
- options
Operation ID: data_cnbng_infra_subscriber_options
Responses:
'200':
Description: OK
Content: {}
security:
- basicAuth: []
head:
Tags:
- data
- head
Operation ID: data_cnbng_infra_subscriber_head
Parameters:
- Name: content
In: query
Description: controlling descendant nodes in response
Required/Optional: false
Style: form
Explode: true
Schema:
Type: string
Format: enumeration
enum:
- config
- nonconfig
- all
Default: config
- Name: depth
In: query
Description: limit the depth of nodes in response
Required/Optional: false
Style: form
Explode: true
Schema:
Type: integer
Format: uint16
- Name: fields
In: query
Description: optionally identify specific data nodes in response
Required/Optional: false
Style: form
Explode: true
Schema:
Type: string
Format: string
- Name: filter
In: query
Description: xpath expression to filter data nodes in response
Required/Optional: false
Style: form
Explode: true
Schema:
Type: string
Format: string
- Name: with-defaults
In: query
Description: controlling default values in response
Required/Optional: false
Style: form
Explode: true
Schema:
Type: string
Format: enumeration
enum:
- report-all
- trim
- explicit
- report-all-tagged
Default: report-all
Responses:
'200':
Description: OK
Content: {}
security:
- basicAuth: []
patch:
Tags:
- data
- patch
Operation ID: data_cnbng_infra_subscriber_patch
Request Body:
Content:
application/yang-data+json:
Schema:
Reference: '#/components/schemas/data_cnbng-infra_subscriber'
Required/Optional: true
Responses:
'204':
Description: container subscriber updated
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:
- basicAuth: []
x-codegen-request-body-name: subscriber
schemas:
data:
Type: object
Properties:
ietf-restconf:data:
Type: object
Properties: {}
Description: This resource represents the combined configuration and state
data resources that can be accessed by a client and cannot be created
or deleted by the client. See RESTCONF RFC 8040 for further information.
x-yang:
Type: datastore
data-post:
Type: object
Properties:
cnbng-infra:subscriber:
Type: object
Properties: {}
Description: (non-presence)
x-yang:
Type: container
is_presence: 'false'
data-put-patch:
Type: object
Properties:
ietf-restconf:data:
Reference: '#/components/schemas/dataputpatch_ietfrestconfdata'
data_cnbng-infra_subscriber:
Type: object
Properties:
cnbng-infra:subscriber:
Type: object
Properties: {}
Description: (non-presence)
x-yang:
Type: container
is_presence: 'false'
data_cnbng-infra_subscriber-post:
Type: object
operations:
Type: object
Properties:
ietf-restconf:operations:
Type: object
Properties: {}
Description: This resource is a container that provides access to the data-model-specific
RPC operations supported by the server. See RESTCONF RFC 8040 for further
information.
x-yang:
Type: operations
root:
Type: object
Properties:
ietf-restconf:restconf:
Reference: '#/components/schemas/root_ietfrestconfrestconf'
yang-library-version:
Type: object
Properties:
ietf-restconf:yang-library-version:
Type: object
Properties: {}
Description: This leaf identifies the revision date of the 'ietf-yang-library'
YANG module that is implemented by this server. See RESTCONF RFC 8040
for further information.
x-yang:
Type: leaf
dataputpatch_ietfrestconfdata:
Type: object
Properties:
cnbng-infra:subscriber:
Type: object
Properties: {}
Description: (non-presence)
x-yang:
Type: container
is_presence: 'false'
Description: 'This module contains a collection of YANG definitions for Cisco
Cloud-Native BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
example: null
root_ietfrestconfrestconf:
Type: object
Properties:
data:
Type: object
Properties: {}
operations:
Type: object
Properties: {}
yang-library-version:
Type: string
Description: This is the RESTCONF root resource for the RESTCONF datastore and
operation resources. See RESTCONF RFC 8040 for further information.
example: null
responses:
'200':
Description: OK
content: {}
'201':
Description: Created
content: {}
'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: {}
parameters:
content:
name: content
in: query
Description: controlling descendant nodes in response
Required: false
style: form
explode: true
schema:
Type: string
format: enumeration
enum:
- config
- nonconfig
- all
Default: config
depth:
name: depth
in: query
Description: limit the depth of nodes in response
Required: false
style: form
explode: true
schema:
Type: integer
format: uint16
fields:
name: fields
in: query
Description: optionally identify specific data nodes in response
Required: false
style: form
explode: true
schema:
Type: string
format: string
filter:
name: filter
in: query
Description: xpath expression to filter data nodes in response
Required: false
style: form
explode: true
schema:
Type: string
format: string
with-defaults:
name: with-defaults
in: query
Description: controlling default values in response
Required: false
style: form
explode: true
schema:
Type: string
format: enumeration
enum:
- report-all
- trim
- explicit
- report-all-tagged
Default: report-all
insert:
name: insert
in: query
Description: controlling the order when adding new list elements
Required: false
style: form
explode: true
schema:
Type: string
format: enumeration
enum:
- first
- last
- before
- after
Default: first
point:
name: point
in: query
Description: used to specify the insertion point
Required: false
style: form
explode: true
schema:
Type: string
format: string
requestBodies:
data-post:
Description: 'This module contains a collection of YANG definitions for Cisco
Cloud-Native BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
content:
application/yang-data+json:
schema:
Reference: '#/components/schemas/data-post'
Required: true
data-put-patch:
Description: 'This module contains a collection of YANG definitions for Cisco
Cloud-Native BNG Control-Plane configuration.
Copyright (c) 2020 by Cisco Systems, Inc. All rights reserved.'
content:
application/yang-data+json:
schema:
Reference: '#/components/schemas/data-put-patch'
Required: true
data_cnbng-infra_subscriber:
content:
application/yang-data+json:
schema:
Reference: '#/components/schemas/data_cnbng-infra_subscriber'
Required: true
data_cnbng-infra_subscriber-post:
content:
application/yang-data+json:
schema:
Reference: '#/components/schemas/data_cnbng-infra_subscriber-post'
Required: true
securitySchemes:
basicAuth:
Type: http
scheme: basic