Info
Title: cisco-exec-ipam
Description: ''
Version: '2021-06-01'
basePath: /restconf
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.
Title: cisco-exec-ipam
Description: ''
Version: '2021-06-01'
basePath: /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
schemes:
- http
- https
produces:
- application/yang-data+json
consumes:
- application/yang-data+json
get:
Tags:
- root
- get
Summary: ''
Description: ''
Operation ID: root_get
produces:
- application/yang-data+json
Parameters: []
Responses:
'200':
Description: OK
Schema:
Reference: '#/definitions/root'
'204':
Reference: '#/responses/204'
'400':
Reference: '#/responses/400'
'401':
Reference: '#/responses/401'
'404':
Reference: '#/responses/404'
'405':
Reference: '#/responses/405'
'409':
Reference: '#/responses/409'
security:
- basicAuth: []
head:
Tags:
- root
- head
Summary: ''
Description: ''
Operation ID: root_head
produces:
- application/yang-data+json
Parameters: []
Responses:
'200':
Reference: '#/responses/200'
security:
- basicAuth: []
get:
Tags:
- operations
- get
Summary: ''
Description: ''
Operation ID: operations_get
produces:
- application/yang-data+json
Parameters: []
Responses:
'200':
Description: OK
Schema:
Reference: '#/definitions/operations'
'204':
Reference: '#/responses/204'
'400':
Reference: '#/responses/400'
'401':
Reference: '#/responses/401'
'404':
Reference: '#/responses/404'
'405':
Reference: '#/responses/405'
'409':
Reference: '#/responses/409'
security:
- basicAuth: []
get:
Tags:
- yang-library-version
- get
Summary: ''
Description: ''
Operation ID: yang_library_version_get
produces:
- application/yang-data+json
Parameters: []
Responses:
'200':
Description: OK
Schema:
Reference: '#/definitions/yang-library-version'
'204':
Reference: '#/responses/204'
'400':
Reference: '#/responses/400'
'401':
Reference: '#/responses/401'
'404':
Reference: '#/responses/404'
'405':
Reference: '#/responses/405'
'409':
Reference: '#/responses/409'
security:
- basicAuth: []
head:
Tags:
- yang-library-version
- head
Summary: ''
Description: ''
Operation ID: yang_library_version_head
produces:
- application/yang-data+json
Parameters: []
Responses:
'200':
Reference: '#/responses/200'
security:
- basicAuth: []
get:
Tags:
- data
- get
Summary: ''
Description: ''
Operation ID: data_get
produces:
- application/yang-data+json
Parameters: []
Responses:
'200':
Description: OK
Schema:
Reference: '#/definitions/data'
'204':
Reference: '#/responses/204'
'400':
Reference: '#/responses/400'
'401':
Reference: '#/responses/401'
'404':
Reference: '#/responses/404'
'405':
Reference: '#/responses/405'
'409':
Reference: '#/responses/409'
security:
- basicAuth: []
head:
Tags:
- data
- head
Summary: ''
Description: ''
Operation ID: data_head
produces:
- application/yang-data+json
Parameters: []
Responses:
'200':
Reference: '#/responses/200'
security:
- basicAuth: []
Method: Post
Tags:
- data
- post
Summary: ''
Description: ''
Operation ID: data_post
produces:
- application/yang-data+json
Parameters:
- $ref: '#/parameters/data-post'
Responses:
'201':
Description: Created
'400':
Reference: '#/responses/400'
'401':
Reference: '#/responses/401'
'404':
Reference: '#/responses/404'
'405':
Reference: '#/responses/405'
'409':
Reference: '#/responses/409'
security:
- basicAuth: []
put:
Tags:
- data
- put
Summary: ''
Description: ''
Operation ID: data_put
produces:
- application/yang-data+json
Parameters:
- $ref: '#/parameters/data-put-patch'
Responses:
'201':
Description: Created
'400':
Reference: '#/responses/400'
'401':
Reference: '#/responses/401'
'404':
Reference: '#/responses/404'
'405':
Reference: '#/responses/405'
'409':
Reference: '#/responses/409'
security:
- basicAuth: []
patch:
Tags:
- data
- patch
Summary: ''
Description: ''
Operation ID: data_patch
produces:
- application/yang-data+json
Parameters:
- $ref: '#/parameters/data-put-patch'
Responses:
'204':
Description: No Content
'400':
Reference: '#/responses/400'
'401':
Reference: '#/responses/401'
'404':
Reference: '#/responses/404'
'405':
Reference: '#/responses/405'
'409':
Reference: '#/responses/409'
security:
- basicAuth: []
get:
Tags:
- data
- get
Summary: ''
Description: ''
Operation ID: data_cisco_exec_ipam_reconcile_get
produces:
- application/yang-data+json
Parameters:
- $ref: '#/parameters/content'
- $ref: '#/parameters/depth'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/with-defaults'
Responses:
'200':
Description: OK
Schema:
Reference: '#/definitions/data_cisco-exec-ipam_reconcile'
'204':
Reference: '#/responses/204'
'400':
Reference: '#/responses/400'
'401':
Reference: '#/responses/401'
'404':
Reference: '#/responses/404'
'405':
Reference: '#/responses/405'
'409':
Reference: '#/responses/409'
security:
- basicAuth: []
head:
Tags:
- data
- head
Summary: ''
Description: ''
Operation ID: data_cisco_exec_ipam_reconcile_head
produces:
- application/yang-data+json
Parameters:
- $ref: '#/parameters/content'
- $ref: '#/parameters/depth'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/filter'
- $ref: '#/parameters/with-defaults'
Responses:
'200':
Reference: '#/responses/200'
security:
- basicAuth: []
Parameters:
Content:
name: content
In: query
Description: controlling descendant nodes in response
Required/Optional: false
Type: string
Format: enumeration
Default: config
enum:
- config
- nonconfig
- all
depth:
name: depth
In: query
Description: limit the depth of nodes in response
Required/Optional: false
Type: integer
Format: uint16
fields:
name: fields
In: query
Description: optionally identify specific data nodes in response
Required/Optional: false
Type: string
Format: string
filter:
name: filter
In: query
Description: xpath expression to filter data nodes in response
Required/Optional: false
Type: string
Format: string
with-defaults:
name: with-defaults
In: query
Description: controlling default values in response
Required/Optional: false
Type: string
Format: enumeration
Default: report-all
enum:
- report-all
- trim
- explicit
- report-all-tagged
insert:
name: insert
In: query
Description: controlling the order when adding new list elements
Required/Optional: false
Type: string
Format: enumeration
Default: first
enum:
- first
- last
- before
- after
point:
name: point
In: query
Description: used to specify the insertion point
Required/Optional: false
Type: string
Format: string
data-post:
name: data
In: body
Description: ''
Required/Optional: true
Schema:
Reference: '#/definitions/data-post'
data-put-patch:
name: data
In: body
Description: ''
Required/Optional: true
Schema:
Reference: '#/definitions/data-put-patch'
Responses:
'200':
Description: OK
'201':
Description: Created
'204':
Description: No Content
'400':
Description: Bad Request
'401':
Description: Unauthorized
'404':
Description: Not Found
'405':
Description: Method Not Allowed
'409':
Description: Conflict
securityDefinitions:
basicAuth:
Type: basic
definitions:
data:
Type: object
Properties:
ietf-restconf:data:
Type: object
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
Properties: {}
data-post:
Type: object
Properties:
cisco-exec-ipam:reconcile:
Description: (non-presence)
Type: object
x-yang:
Type: container
is_presence: 'false'
Properties: {}
data-put-patch:
Type: object
Properties:
ietf-restconf:data:
Description: ''
Type: object
x-yang:
Type: datastore
Properties:
cisco-exec-ipam:reconcile:
Description: (non-presence)
Type: object
x-yang:
Type: container
is_presence: 'false'
Properties: {}
data_cisco-exec-ipam_reconcile:
Type: object
Properties:
cisco-exec-ipam:reconcile:
Description: (non-presence)
Type: object
x-yang:
Type: container
is_presence: 'false'
Properties: {}
operations:
Type: object
Properties:
ietf-restconf:operations:
Type: object
x-yang:
Type: operations
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.
Properties: {}
root:
Type: object
Properties:
ietf-restconf:restconf:
Type: object
x-yang:
Type: root
Description: This is the RESTCONF root resource for the RESTCONF datastore
and operation resources. See RESTCONF RFC 8040 for further information.
Properties:
data:
Type: object
Properties: {}
operations:
Type: object
Properties: {}
yang-library-version:
Type: string
yang-library-version:
Type: object
Properties:
ietf-restconf:yang-library-version:
Type: object
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
Properties: {}