openapi: 3.2.0
info:
title: Cisco Secure Firewall Devices API
version: 1.13.0
contact:
name: Cisco Firepower TAC
email: ngfw-support@cisco.com
description: 'Operations tagged Devices across 2 of this provider''s published API definitions: cdfmc-openapi.yaml, cisco-secure-firewall-cdfmc-openapi.yml.
Each path carries the servers of the definition it was published in.'
x-provenance:
method: harvested
first_party: true
harvested: '2026-08-19'
source: https://raw.githubusercontent.com/CiscoDevNet/scc-public-api-docs/main/cdo/cdfmc-openapi.yaml
source_repo: https://github.com/CiscoDevNet/scc-public-api-docs
note: Verbatim first-party OpenAPI published by Cisco in the CiscoDevNet scc-public-api-docs repository, the source of
record for developer.cisco.com/docs/cisco-security-cloud-control-firewall-manager/. Not authored or modified by API
Evangelist.
derived_view: Per-tag view of cisco-secure-firewall-cdfmc-openapi.yml, the provider's source document. Operations and
schemas are the provider's, unmodified; only the partition is ours.
derived_from: cisco-secure-firewall-cdfmc-openapi.yml
operation_coverage: 223/223
x-evidence:
fetched: '2026-08-19'
url: https://raw.githubusercontent.com/CiscoDevNet/scc-public-api-docs/main/cdo/cdfmc-openapi.yaml
http_status: 200
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
tags:
- name: Devices
paths:
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/certificates:
get:
deprecated: false
description: '**Get a list of all the certificates enrolled in devices.**'
operationId: getDeviceCertificateModel
parameters:
- description: Filter by deviceId or filter by expiryInDays. When filtering by deviceId:{id},
lists all certificates enrolled on the given device. If filtering by expiryInDays:{number of days},
lists only the certificates which will expire within the given number of days.
in: query
name: filter
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceCertificateModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/certificatesexportdata/{objectId}:
get:
deprecated: false
description: '**Get the exported certificate for download.**'
operationId: getDeviceCertificateExportData
parameters:
- description: Unique identifier for the task.
in: path
name: objectId
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceCertificateExportData'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/copyconfigrequests:
post:
deprecated: false
description: '**Copy device configuration. _Check the response section for applicable examples (if any)._**'
operationId: createDeviceCopyConfigRequest
parameters:
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/DomainUUID/devices/copyconfigrequests ( Device copy config request )':
value:
copySharedPolicies: false
sourceDevice:
id: device_uuid
type: Device
targetDeviceList:
- id: device_uuid
type: Device
? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/devices/copyconfigrequests ( Device copy config request
for FTD HA to stanalone devices )'
: value:
copySharedPolicies: false
sourceDevice:
id: container_uuid
type: DeviceHAPair
targetDeviceList:
- id: device_uuid
type: Device
schema:
$ref: '#/components/schemas/DeviceCopyConfigRequest'
type: object
description: Input for Copy configuration request.
required: true
responses:
'202':
content:
application/json:
examples:
'Example 1 : POST /fmc_config/v1/domain/DomainUUID/devices/copyconfigrequests ( Device copy config request )':
value:
copySharedPolicies: false
metadata:
task:
id: task_id
links:
self: https://fmc_host/api/fmc_config/v1/domain/domainUuid/job/taskstatuses/task_id
type: TaskStatus
sourceDevice:
id: device_uuid
type: Device
targetDeviceList:
- id: device_uuid
type: Device
type: CopyConfigRequest
? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/devices/copyconfigrequests ( Device copy config request
for FTD HA to stanalone devices )'
: value:
copySharedPolicies: false
metadata:
task:
id: task_id
links:
self: https://fmc_host/api/fmc_config/v1/domain/domainUuid/job/taskstatuses/task_id
type: TaskStatus
sourceDevice:
id: container_uuid
type: DeviceHAPair
targetDeviceList:
- id: device_uuid
type: Device
type: CopyConfigRequest
schema:
$ref: '#/components/schemas/DeviceCopyConfigRequest'
type: object
description: Accepted
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords:
get:
deprecated: false
description: '**Get the list of all device records.**'
operationId: getAllDevice
parameters:
- description: 'Filter to retrieve all device records based upon filter parameters specified.
Filter criteria
should be name:{name};isUZTNAEnabled:{true|false};hostName:{hostName};serialNumber:{ABCXXXXX};containerType:{value};version:{x.x.x};clusterBootstrapSupported:{true|false};analyticsOnly:{true|false};includeOtherAssociatedPolicies:{true|false};modelType:{NGFW|Chassis};isMCDManaged:{true|false}
containerType
-- Allowed values are {DeviceCluster|DeviceHAPair|DeviceStack}
clusterBootstrapSupported
-- Allowed values are {true|false}
analyticsOnly -- Allowed values are {true|false}
modelType
-- Allowed values are {NGFW|Chassis}. NGFW fetches all NGFW devices. Chassis
fetches all FXOS chassis (also known as MIO). If you don''t specify the type, then all devices and chassis are fetched.includeOtherAssociatedPolicies
-- Allowed values are {true|false}. When set to true, will give following policies if
assigned to device: [RAVpn,FTDS2SVpn,PlatformSettingsPolicy,QosPolicy,NatPolicy,FlexConfigPolicy]
isMCDManaged
-- Allowed values are {true|false}'
in: query
name: filter
required: false
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/object/devices/devicerecords ( Get all paginated network
objects without offset and limit )'
: {}
schema:
$ref: '#/components/schemas/DeviceListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/bridgegroupinterfaces:
get:
deprecated: false
description: '**Get the list of all bridge group interfaces associated with the specified NGFW device ID.
More details on netmod events(out of sync interfaces): GET /interfaceevents
.**'
operationId: getAllFTDBridgeGroupInterface
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/bridgegroupinterfaces
( Success: Test GET ALL success )'
: value:
items:
- id: '1'
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/bridgegroupinterfaces/bridgegroupinterfaceUUID1
name: s1p3.1
type: BridgeGroupInterface
- id: bridgegroupinterfaceUUID2
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/bridgegroupinterfaces/bridgegroupinterfaceUUID2
name: s1p4.2
type: BridgeGroupInterface
- id: bridgegroupinterfaceUUID3
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/bridgegroupinterfaces/bridgegroupinterfaceUUID3
name: hybrid_1
type: BridgeGroupInterface
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/bridgegroupinterfaces?offset=0&limit=3
paging:
count: 3
limit: 3
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/bridgegroupinterfaces/bridgegroupinterfaceUUID?expanded=true
( Success: Test GET ALL success with expanded=true )'
: value:
items:
- MTU: 1500
applicationMonitoring:
enable: true
bridgeGroupId: 1
enabled: true
id: bridgegroupinterfaceUUID1
ifname: BVI1
ipAddress: 1.2.3.4
ipv4:
static:
address: 1.2.3.4
netmask: '25'
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/bridgegroupinterfaces/bridgegroupinterfaceUUID1
managementOnly: false
metadata:
domain:
id: domainUUID
name: Global
timestamp: 1462814174120.0
mode: NONE
name: BVI1
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
selectedInterfaces:
- id: interface UUID
name: GigabitEthernet0/1
type: PhysicalInterface
type: BridgeGroupInterface
- MTU: 1500
applicationMonitoring:
enable: true
bridgeGroupId: 2
enabled: true
id: bridgegroupinterfaceUUID2
ifname: BVI2
ipAddress: 1.2.3.4
ipv4:
static:
address: 1.2.3.4
netmask: '25'
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/bridgegroupinterfaces/bridgegroupinterfaceUUID2
managementOnly: false
metadata:
domain:
id: domainUUID
name: Global
timestamp: 1462814174120.0
mode: NONE
name: BVI2
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
selectedInterfaces:
- id: interface UUID
name: GigabitEthernet0/2
type: PhysicalInterface
type: BridgeGroupInterface
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/bridgegroupinterfaces/bridgegroupinterfaceUUID?offset=0&limit=2
schema:
$ref: '#/components/schemas/FTDBridgeGroupInterfaceListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**Create a bridge group interface. _Check the response section for applicable examples (if any)._**'
operationId: createFTDBridgeGroupInterface
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FTDBridgeGroupInterface'
type: object
description: The input bridge group interface model.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/FTDBridgeGroupInterface'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/bridgegroupinterfaces/{objectId}:
delete:
deprecated: false
description: '**Delete the bridge group interface associated with the specified NGFW device ID and interface ID. _Check
the response section for applicable examples (if any)._**'
operationId: deleteFTDBridgeGroupInterface
parameters:
- description: Unique identifier of a bridge group interface.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/bridgegroupinterfaces/bridgeGroupIntfUUID
( Success: Test DELETE method for bridge group interface )'
: value:
MTU: 1500
bridgeGroupId: 39
enabled: true
id: bridgeGroupIntfUUID
ifname: bridgeGroupIntf1
ipAddress: 1.2.3.5
ipv4:
static:
address: 1.2.3.5
netmask: '25'
ipv6:
addresses:
- address: '9090::'
prefix: '12'
dadAttempts: 1
enableIPV6DadLoopbackDetect: true
nsInterval: 10000
reachableTime: 0
links:
self: :/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/bridgegroupinterfaces/bridgeGroupIntfUUID
managementOnly: false
metadata:
timestamp: 0
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
selectedInterfaces:
- id: interface UUID
name: GigabitEthernet0/0
type: PhysicalInterface
type: BridgeGroupInterface
schema:
$ref: '#/components/schemas/FTDBridgeGroupInterface'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
get:
deprecated: false
description: '**Get the bridge group interface associated with the specified NGFW device ID and interface ID.**'
operationId: getFTDBridgeGroupInterface
parameters:
- description: Unique identifier of a bridge group interface.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/bridgegroupinterfaces/bridgegroupinterfaceUUID
( Success: Test GET method for brdge group interface )'
: value:
MTU: 1500
applicationMonitoring:
enable: true
monitoredApplications:
- id: '2325'
name: 050plus
type: Application
- id: '1553'
name: 1&1 Internet
type: Application
bridgeGroupId: 39
enabled: true
id: bridgegroupinterfaceUUID
ifname: bridgeGroupIntf1
ipAddress: 1.2.3.4
ipv4:
static:
address: 1.2.3.4
netmask: '25'
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/bridgegroupinterfaces/bridgegroupinterfaceUUID
managementOnly: false
metadata:
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
readOnly:
state: false
timestamp: 1458597038.0
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
selectedInterfaces:
- id: interface UUID
name: GigabitEthernet0/1
type: PhysicalInterface
type: BridgeGroupInterface
schema:
$ref: '#/components/schemas/FTDBridgeGroupInterface'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**Modify the bridge group interface associated with the specified NGFW device ID and interface ID. _Check
the response section for applicable examples (if any)._**'
operationId: updateFTDBridgeGroupInterface
parameters:
- description: Unique identifier of a bridge group interface.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/bridgegroupinterfaces/bridgeGroupIntfUUID
( Success: Test PUT method for bridge group interface )'
: value:
MTU: 1500
bridgeGroupId: 39
enabled: true
id: bridgeGroupIntfUUID
ifname: bridgeGroupIntf1
ipAddress: 1.2.3.5
ipv4:
static:
address: 1.2.3.5
netmask: '25'
ipv6:
addresses:
- address: '9090::'
prefix: '12'
dadAttempts: 1
enableIPV6DadLoopbackDetect: true
nsInterval: 10000
reachableTime: 0
managementOnly: false
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
selectedInterfaces:
- id: interface UUID
name: GigabitEthernet0/0
type: PhysicalInterface
type: BridgeGroupInterface
schema:
$ref: '#/components/schemas/FTDBridgeGroupInterface'
type: object
description: Input representation of bridge group interface.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/bridgegroupinterfaces/bridgeGroupIntfUUID
( Success: Test PUT method for bridge group interface )'
: value:
MTU: 1500
applicationMonitoring:
enable: false
bridgeGroupId: 39
enabled: true
id: bridgeGroupIntfUUID
ifname: bridgeGroupIntf1
ipAddress: 1.2.3.5
ipv4:
static:
address: 1.2.3.5
netmask: '25'
ipv6:
addresses:
- address: '9090::'
prefix: '12'
dadAttempts: 1
enableIPV6DadLoopbackDetect: true
nsInterval: 10000
reachableTime: 0
links:
self: :/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/bridgegroupinterfaces/bridgeGroupIntfUUID
managementOnly: false
metadata:
timestamp: 0
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
selectedInterfaces:
- id: interface UUID
name: GigabitEthernet0/0
type: PhysicalInterface
type: BridgeGroupInterface
schema:
$ref: '#/components/schemas/FTDBridgeGroupInterface'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/dhcp/ddnssettings:
get:
deprecated: false
description: '**Get all DNS settings for a particular chassis platform settings policy.**'
operationId: getAllDeviceDDNSSettingModel
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceDDNSSettingModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/dhcp/ddnssettings/{objectId}:
get:
deprecated: false
description: '**Get the DNS setting associated with the specified ID for a particular chassis platform settings policy.**'
operationId: getDeviceDDNSSettingModel
parameters:
- description: Unique identifier of the DNS setting.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/dhcp/ddnssettings
( GET Device DDNSSettings )'
: value:
items:
- ddnsUpdateMethods:
- methodName: ddnsMethod
methodOption: DDNS
updateInterval:
day: '23'
hourOfTheDay: '23'
minute: '23'
second: '23'
updateRecords: BOTH_A_AND_PTR_RECORDS
dhcpClientIdInterfaces:
- id: 00505681-56C3-0ed3-0000-004294967652
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/PhysicalInterface/deviceId
name: gig0
type: PhysicalInterface
dhcpClientRequestType: NOT_SELECTED
dynamicDDNSUpdateType: NOT_SELECTED
enableDHCPClientBroadcast: false
id: deviceId
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/dhcp/ddnssettings/deviceId
overrideDHCPClientRequest: false
type: DDNSSettings
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/dhcp/ddnssettings?offset=0&limit=25&expanded=true
paging:
count: 1
limit: 25
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/DeviceDDNSSettingModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**Modify the DNS setting associated with the specified ID for a particular chassis platform settings policy.
_Check the response section for applicable examples (if any)._**'
operationId: updateDeviceDDNSSettingModel
parameters:
- description: Unique identifier of the DNS setting.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/dhcp/ddnssettings/deviceUUID
( PUT request to update DDNS Settings )'
: value:
ddnsUpdateMethods:
- methodName: ddnsMethod
methodOption: DDNS
updateInterval:
day: '23'
hourOfTheDay: '23'
minute: '23'
second: '23'
updateRecords: BOTH_A_AND_PTR_RECORDS
dhcpClientIdInterfaces:
- id: 00505681-56C3-0ed3-0000-004294967652
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/PhysicalInterface/deviceId
name: gig0
type: PhysicalInterface
dhcpClientRequestType: NOT_SELECTED
dynamicDDNSUpdateType: NOT_SELECTED
enableDHCPClientBroadcast: false
id: deviceId
overrideDHCPClientRequest: false
type: DDNSSettings
schema:
$ref: '#/components/schemas/DeviceDDNSSettingModel'
type: object
description: Input representation of dynamic DNS policy.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/dhcp/ddnssettings/deviceUUID
( PUT request to update DDNS Settings )'
: value:
ddnsUpdateMethods:
- methodName: ddnsMethod
methodOption: DDNS
updateInterval:
day: '23'
hourOfTheDay: '23'
minute: '23'
second: '23'
updateRecords: BOTH_A_AND_PTR_RECORDS
dhcpClientIdInterfaces:
- id: 00505681-56C3-0ed3-0000-004294967652
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/PhysicalInterface/deviceId
name: gig0
type: PhysicalInterface
dhcpClientRequestType: NOT_SELECTED
dynamicDDNSUpdateType: NOT_SELECTED
enableDHCPClientBroadcast: false
id: deviceId
overrideDHCPClientRequest: false
type: DDNSSettings
schema:
$ref: '#/components/schemas/DeviceDDNSSettingModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/dhcp/dhcprelaysettings:
get:
deprecated: false
description: '**Get a list of DHCP relay settings.**'
operationId: getAllDeviceDHCPRelaySettings
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceDHCPRelaySettingsListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/dhcp/dhcprelaysettings/{objectId}:
get:
deprecated: false
description: '**Get the DHCP relay settings associated with the specified device.**'
operationId: getDeviceDHCPRelaySettings
parameters:
- description: Unique identifier of Device. Same as container UUID.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/dhcp/dhcprelaysettings/deviceUUID
( GET Device DHCPRelaySettings by Device ID )'
: value:
items:
- dhcpRelayAgent:
- enableDHCPIPv4Relay: true
enableDHCPIPv6Relay: false
interface:
id: 00505681-56C3-0ed3-0000-004294967652
name: gig0
type: PhysicalInterface
setRoute: true
dhcpRelayServers:
- interface:
id: 00505681-56C3-0ed3-0000-004294967652
name: gig1
type: PhysicalInterface
server:
id: 00505681-56C3-0ed3-0000-004294967652
name: Server
type: Host
id: deviceId
ipv4TimeoutInSec: 100
ipv6TimeoutInSec: 200
isTrustAllInformation: 'true'
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/dhcp/dhcprelaysettings/deviceId
type: DHCPRelaySettings
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/dhcp/dhcprelaysettings/deviceUUID?offset=0&limit=25&expanded=true
paging:
count: 1
limit: 25
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/dhcp/dhcprelaysettings
( GET Device DHCP Relay Settings )'
: value:
items:
- dhcpRelayAgent:
- enableDHCPIPv4Relay: true
enableDHCPIPv6Relay: false
interface:
id: 00505681-56C3-0ed3-0000-004294967652
name: gig0
type: PhysicalInterface
setRoute: true
dhcpRelayServers:
- interface:
id: 00505681-56C3-0ed3-0000-004294967652
name: gig1
type: PhysicalInterface
server:
id: 00505681-56C3-0ed3-0000-004294967652
name: Server
type: Host
id: deviceId
ipv4TimeoutInSec: 100
ipv6TimeoutInSec: 200
isTrustAllInformation: 'true'
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/dhcp/dhcprelaysettings/deviceId
type: DHCPRelaySettings
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/dhcp/dhcprelaysettings?offset=0&limit=25&expanded=true
paging:
count: 1
limit: 25
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/DeviceDHCPRelaySettings'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**Modify the specified DHCP relay settings. _Check the response section for applicable examples (if any)._**'
operationId: updateDeviceDHCPRelaySettings
parameters:
- description: Unique identifier of Device. Same as container UUID.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/dhcp/dhcprelaysettings/deviceUUID
( PUT request to update DHCP relay Settings )'
: value:
dhcpRelayAgent:
- enableIPv4Relay: true
enableIPv6Relay: false
interfaces:
id: 00505681-5A11-0ed3-0000-008589934657
name: basic
type: PhysicalInterface
setRoute: true
dhcpRelayServers:
- interface:
id: 00505681-56C3-0ed3-0000-004294967652
name: gig1
type: PhysicalInterface
server:
id: 00505681-56C3-0ed3-0000-004294967652
name: Server
type: Host
id: deviceId
ipv4TimeoutInSec: 100
ipv6TimeoutInSec: 200
isTrustAllInformation: 'true'
type: DHCPRelaySettings
schema:
$ref: '#/components/schemas/DeviceDHCPRelaySettings'
type: object
description: Input representation of Device DHCP Relay policy object.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/dhcp/dhcprelaysettings/deviceUUID
( PUT request to update DHCP relay Settings )'
: value:
items:
- dhcpRelayAgent:
- enableDHCPIPv4Relay: true
enableDHCPIPv6Relay: false
interface:
id: 00505681-56C3-0ed3-0000-004294967652
name: gig0
type: PhysicalInterface
setRoute: true
dhcpRelayServers:
- interface:
id: 00505681-56C3-0ed3-0000-004294967652
name: gig0
type: PhysicalInterface
server:
id: 00505681-56C3-0ed3-0000-004294967652
name: host122
type: Host
id: deviceId
ipv4TimeoutInSec: 100
ipv6TimeoutInSec: 200
isTrustAllInformation: 'true'
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/dhcp/dhcprelaysettings/deviceId
type: DHCPRelaySettings
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/dhcp/dhcprelaysettings?offset=0&limit=25&expanded=true
paging:
count: 1
limit: 25
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/DeviceDHCPRelaySettings'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/dhcp/dhcpserver:
get:
deprecated: false
description: '**Get a list of DHCP server policies.**'
operationId: getAllDeviceDHCPServerSettings
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceDHCPServerSettingsListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/dhcp/dhcpserver/{objectId}:
get:
deprecated: false
description: '**Get the specified DHCP server policy.**'
operationId: getDeviceDHCPServerSettings
parameters:
- description: Unique identifier of Device. Same as container UUID.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/dhcp/dhcpserver/deviceUUID
( GET Device DHCPServerSettings by Device ID )'
: value:
items:
- autoConfigInterface:
id: 00505681-C6C9-0ed3-0000-012884902618
name: TEstInt
type: PHYSICAL
dhcpOptions:
- firstIpAddress:
id: 00505681-C6C9-0ed3-0000-055834574898
name: PDNS
type: Host
optionCode: '10'
optionType: IP
secondIpAddress:
id: 00505681-C6C9-0ed3-0000-055834574916
name: SDNS
type: Host
- ascii: abcd
optionCode: '20'
optionType: ASCII
- hex: FF
optionCode: '30'
optionType: HEX
dhcpServers:
- addressPool: 10.10.5.74-10.10.5.75
enableDHCP: true
interface:
id: 00505681-C6C9-0ed3-0000-073014444254
name: GE2
type: PHYSICAL
id: d24f056a-1efc-11ed-9dfa-f49d3d5fe4e6
leaseLengthInSec: '2000'
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/dhcp/dhcpserver/deviceId
pingTimeoutInMs: '100'
primaryDNSServer:
id: 00505681-C6C9-0ed3-0000-055834574898
name: PDNS
type: Host
primaryWINSServer:
id: 00505681-C6C9-0ed3-0000-068719476786
name: PWINS
type: Host
searchDomain: myDomain
secondaryDNSServer:
id: 00505681-C6C9-0ed3-0000-055834574916
name: SDNS
type: Host
secondaryWINSServer:
id: 00505681-C6C9-0ed3-0000-068719476804
name: SWINS
type: Host
type: DHCPServer
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/dhcp/dhcpserver/deviceUUID?offset=0&limit=25&expanded=true
? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/dhcp/dhcpserver/deviceUUID
( GET Device DHCPServerSettings by Device ID with address pool as template variable )'
: value:
items:
- autoConfigInterface:
id: 00505681-C6C9-0ed3-0000-012884902618
name: TEstInt
type: PHYSICAL
dhcpOptions:
- firstIpAddress:
id: 00505681-C6C9-0ed3-0000-055834574898
name: PDNS
type: Host
optionCode: '10'
optionType: IP
secondIpAddress:
id: 00505681-C6C9-0ed3-0000-055834574916
name: SDNS
type: Host
- ascii: abcd
optionCode: '20'
optionType: ASCII
- hex: FF
optionCode: '30'
optionType: HEX
dhcpServers:
- addressPoolVariable:
id: 0050568A-86DE-0ed3-0000-064424511316
name: ipv4_range_variable
type: Variable
enableDHCP: true
interface:
id: 00505681-C6C9-0ed3-0000-073014444254
name: GE2
type: PHYSICAL
id: d24f056a-1efc-11ed-9dfa-f49d3d5fe4e6
leaseLengthInSec: '2000'
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/dhcp/dhcpserver/deviceId
pingTimeoutInMs: '100'
primaryDNSServer:
id: 00505681-C6C9-0ed3-0000-055834574898
name: PDNS
type: Host
primaryWINSServer:
id: 00505681-C6C9-0ed3-0000-068719476786
name: PWINS
type: Host
searchDomain: myDomain
secondaryDNSServer:
id: 00505681-C6C9-0ed3-0000-055834574916
name: SDNS
type: Host
secondaryWINSServer:
id: 00505681-C6C9-0ed3-0000-068719476804
name: SWINS
type: Host
type: DHCPServer
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/dhcp/dhcpserver/deviceUUID?offset=0&limit=25&expanded=true
? 'Example 3 : GET /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/dhcp/dhcpserver (
GET Device DHCPServerSettings )'
: value:
items:
- autoConfigInterface:
id: 00505681-C6C9-0ed3-0000-012884902618
name: TEstInt
type: PHYSICAL
dhcpOptions:
- firstIpAddress:
id: 00505681-C6C9-0ed3-0000-055834574898
name: PDNS
type: Host
optionCode: '10'
optionType: IP
secondIpAddress:
id: 00505681-C6C9-0ed3-0000-055834574916
name: SDNS
type: Host
- ascii: abcd
optionCode: '20'
optionType: ASCII
- hex: FF
optionCode: '30'
optionType: HEX
dhcpServers:
- addressPool: 10.10.5.74-10.10.5.75
enableDHCP: true
interface:
id: 00505681-C6C9-0ed3-0000-073014444254
name: GE2
type: PHYSICAL
id: d24f056a-1efc-11ed-9dfa-f49d3d5fe4e6
leaseLengthInSec: '2000'
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/dhcp/dhcpserver/deviceId
pingTimeoutInMs: '100'
primaryDNSServer:
id: 00505681-C6C9-0ed3-0000-055834574898
name: PDNS
type: Host
primaryWINSServer:
id: 00505681-C6C9-0ed3-0000-068719476786
name: PWINS
type: Host
searchDomain: myDomain
secondaryDNSServer:
id: 00505681-C6C9-0ed3-0000-055834574916
name: SDNS
type: Host
secondaryWINSServer:
id: 00505681-C6C9-0ed3-0000-068719476804
name: SWINS
type: Host
type: DHCPServer
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/dhcp/dhcpserver?offset=0&limit=25&expanded=true
paging:
count: 1
limit: 25
offset: 0
pages: 1
? 'Example 4 : GET /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/dhcp/dhcpserver (
GET Device DHCPServerSettings with address pool as template variable )'
: value:
items:
- autoConfigInterface:
id: 00505681-C6C9-0ed3-0000-012884902618
name: TEstInt
type: PHYSICAL
dhcpOptions:
- firstIpAddress:
id: 00505681-C6C9-0ed3-0000-055834574898
name: PDNS
type: Host
optionCode: '10'
optionType: IP
secondIpAddress:
id: 00505681-C6C9-0ed3-0000-055834574916
name: SDNS
type: Host
- ascii: abcd
optionCode: '20'
optionType: ASCII
- hex: FF
optionCode: '30'
optionType: HEX
dhcpServers:
- addressPoolVariable:
id: 0050568A-86DE-0ed3-0000-064424511316
name: ipv4_range_variable
type: Variable
enableDHCP: true
interface:
id: 00505681-C6C9-0ed3-0000-073014444254
name: GE2
type: PHYSICAL
id: 357d166c-7c6d-11ee-8d26-a5ad0d3ce5d1
leaseLengthInSec: '2000'
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/dhcp/dhcpserver/deviceId
pingTimeoutInMs: '100'
primaryDNSServer:
id: 00505681-C6C9-0ed3-0000-055834574898
name: PDNS
type: Host
primaryWINSServer:
id: 00505681-C6C9-0ed3-0000-068719476786
name: PWINS
type: Host
searchDomain: myDomain
secondaryDNSServer:
id: 00505681-C6C9-0ed3-0000-055834574916
name: SDNS
type: Host
secondaryWINSServer:
id: 00505681-C6C9-0ed3-0000-068719476804
name: SWINS
type: Host
type: DHCPServer
links:
self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/dhcp/dhcpserver?offset=0&limit=25&expanded=true
paging:
count: 1
limit: 25
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/DeviceDHCPServerSettings'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**Modify the specified DHCP server policy. _Check the response section for applicable examples (if any)._**'
operationId: updateDeviceDHCPServerSettings
parameters:
- description: Unique identifier of Device. Same as container UUID.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/dhcp/dhcpserver/deviceUUID
( PUT request to update DHCP Server Settings )'
: value:
autoConfigInterface:
id: 00505681-C6C9-0ed3-0000-012884902618
name: TEstInt
type: PHYSICAL
dhcpOptions:
- firstIpAddress:
id: 00505681-C6C9-0ed3-0000-055834574898
name: PDNS
type: Host
optionCode: '10'
optionType: IP
secondIpAddress:
id: 00505681-C6C9-0ed3-0000-055834574916
name: SDNS
type: Host
- ascii: abcd
optionCode: '20'
optionType: ASCII
- hex: FF
optionCode: '30'
optionType: HEX
dhcpServers:
- addressPool: 10.10.5.74-10.10.5.75
enableDHCP: true
interface:
id: 00505681-C6C9-0ed3-0000-073014444254
name: GE2
type: PHYSICAL
id: deviceId
leaseLengthInSec: '2000'
pingTimeoutInMs: '100'
primaryDNSServer:
id: 00505681-C6C9-0ed3-0000-055834574898
name: PDNS
type: Host
primaryWINSServer:
id: 00505681-C6C9-0ed3-0000-068719476786
name: PWINS
type: Host
searchDomain: myDomain
secondaryDNSServer:
id: 00505681-C6C9-0ed3-0000-055834574916
name: SDNS
type: Host
secondaryWINSServer:
id: 00505681-C6C9-0ed3-0000-068719476804
name: SWINS
type: Host
type: DHCPServer
? 'Example 2 : PUT https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/dhcp/dhcpserver/deviceUUID
( PUT request to update DHCP Server Settings with address pool as template variable )'
: value:
autoConfigInterface:
id: 00505681-C6C9-0ed3-0000-012884902618
name: TEstInt
type: PHYSICAL
dhcpOptions:
- firstIpAddress:
id: 00505681-C6C9-0ed3-0000-055834574898
name: PDNS
type: Host
optionCode: '10'
optionType: IP
secondIpAddress:
id: 00505681-C6C9-0ed3-0000-055834574916
name: SDNS
type: Host
- ascii: abcd
optionCode: '20'
optionType: ASCII
- hex: FF
optionCode: '30'
optionType: HEX
dhcpServers:
- addressPoolVariable:
id: 0050568A-86DE-0ed3-0000-064424511316
name: ipv4_range_variable
type: Variable
enableDHCP: true
interface:
id: 00505681-C6C9-0ed3-0000-073014444254
name: GE2
type: PHYSICAL
id: deviceId
leaseLengthInSec: '2000'
pingTimeoutInMs: '100'
primaryDNSServer:
id: 00505681-C6C9-0ed3-0000-055834574898
name: PDNS
type: Host
primaryWINSServer:
id: 00505681-C6C9-0ed3-0000-068719476786
name: PWINS
type: Host
searchDomain: myDomain
secondaryDNSServer:
id: 00505681-C6C9-0ed3-0000-055834574916
name: SDNS
type: Host
secondaryWINSServer:
id: 00505681-C6C9-0ed3-0000-068719476804
name: SWINS
type: Host
type: DHCPServer
schema:
$ref: '#/components/schemas/DeviceDHCPServerSettings'
type: object
description: Input representation of Device DHCP Server policy object.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/dhcp/dhcpserver/deviceUUID
( PUT request to update DHCP Server Settings )'
: value:
autoConfigInterface:
id: 00505681-C6C9-0ed3-0000-012884902618
name: TEstInt
type: PHYSICAL
dhcpOptions:
- firstIpAddress:
id: 00505681-C6C9-0ed3-0000-055834574898
name: PDNS
type: Host
optionCode: '10'
optionType: IP
secondIpAddress:
id: 00505681-C6C9-0ed3-0000-055834574916
name: SDNS
type: Host
- ascii: abcd
optionCode: '20'
optionType: ASCII
- hex: FF
optionCode: '30'
optionType: HEX
dhcpServers:
- addressPool: 10.10.5.74-10.10.5.75
enableDHCP: true
interface:
id: 00505681-C6C9-0ed3-0000-073014444254
name: GE2
type: PHYSICAL
id: deviceId
leaseLengthInSec: '2000'
pingTimeoutInMs: '100'
primaryDNSServer:
id: 00505681-C6C9-0ed3-0000-055834574898
name: PDNS
type: Host
primaryWINSServer:
id: 00505681-C6C9-0ed3-0000-068719476786
name: PWINS
type: Host
searchDomain: myDomain
secondaryDNSServer:
id: 00505681-C6C9-0ed3-0000-055834574916
name: SDNS
type: Host
secondaryWINSServer:
id: 00505681-C6C9-0ed3-0000-068719476804
name: SWINS
type: Host
type: DHCPServer
? 'Example 2 : PUT https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/dhcp/dhcpserver/deviceUUID
( PUT request to update DHCP Server Settings with address pool as template variable )'
: value:
autoConfigInterface:
id: 00505681-C6C9-0ed3-0000-012884902618
name: TEstInt
type: PHYSICAL
dhcpOptions:
- firstIpAddress:
id: 00505681-C6C9-0ed3-0000-055834574898
name: PDNS
type: Host
optionCode: '10'
optionType: IP
secondIpAddress:
id: 00505681-C6C9-0ed3-0000-055834574916
name: SDNS
type: Host
- ascii: abcd
optionCode: '20'
optionType: ASCII
- hex: FF
optionCode: '30'
optionType: HEX
dhcpServers:
- addressPool: 10.10.5.74-10.10.5.75
enableDHCP: true
interface:
id: 00505681-C6C9-0ed3-0000-073014444254
name: GE2
type: PHYSICAL
id: deviceId
leaseLengthInSec: '2000'
pingTimeoutInMs: '100'
primaryDNSServer:
id: 00505681-C6C9-0ed3-0000-055834574898
name: PDNS
type: Host
primaryWINSServer:
id: 00505681-C6C9-0ed3-0000-068719476786
name: PWINS
type: Host
searchDomain: myDomain
secondaryDNSServer:
id: 00505681-C6C9-0ed3-0000-055834574916
name: SDNS
type: Host
secondaryWINSServer:
id: 00505681-C6C9-0ed3-0000-068719476804
name: SWINS
type: Host
type: DHCPServer
schema:
$ref: '#/components/schemas/DeviceDHCPServerSettings'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/etherchannelinterfaces:
get:
deprecated: false
description: '**Get the list of all ethernet channel interfaces associated with the specified NGFW device ID. More details on netmod events(out of sync interfaces): GET /interfaceevents
.**'
operationId: getAllFTDEtherChannelInterface
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/etherchannelinterfaces
( Success: Test GET ALL success )'
: value:
items:
- id: etherChannelIntfUUID2
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/etherchannelinterfaces/etherChannelIntfUUID2
name: Port-channel2
- id: etherChannelIntfUUID1
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/etherchannelinterfaces/etherChannelIntfUUID1
name: Port-channel1
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/etherchannelinterfaces?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/etherchannelinterfaces?expanded=true
( Success: Test GET ALL success with expanded=true )'
: value:
items:
- LLDP:
receive: false
transmit: false
MTU: 1500
applicationMonitoring:
enable: true
enableAntiSpoofing: false
enableSGTPropagate: true
enabled: true
etherChannelId: 2
hardware:
autoNegState: false
duplex: FULL
flowControlSend: 'OFF'
speed: THOUSAND
id: etherChannelIntfUUID2
ifname: TestEtherChannel
ipv4:
static: {}
ipv6:
dadAttempts: 1
enableAutoConfig: false
enableDHCPAddrConfig: false
enableDHCPNonAddrConfig: false
enableIPV6: false
enableIPV6DadLoopbackDetect: false
enableRA: true
enforceEUI64: false
nsInterval: 1000
raInterval: 200
raLifeTime: 1800
reachableTime: 0
lacpMode: ACTIVE
lacpRate: DEFAULT
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/etherchannelinterfaces/etherChannelIntfUUID2
loadBalancing: SRC_DST_IP
managementOnly: false
maxActivePhysicalInterface: 8
metadata:
domain:
id: domainUUID
name: Global
timestamp: 1462814174120.0
minActivePhysicalInterface: 1
mode: NONE
name: Port-channel2
nveOnly: false
overrideDefaultFragmentSetting: {}
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
priority: 10
securityZone:
id: securityZoneUUID
type: SecurityZone
selectedInterfaces:
- id: interface UUID
name: GigabitEthernet1/4
type: PhysicalInterface
- id: interface UUID
name: GigabitEthernet1/5
type: PhysicalInterface
type: EtherChannelInterface
- LLDP:
receive: false
transmit: false
MTU: 1500
applicationMonitoring:
enable: true
enableAntiSpoofing: false
enableSGTPropagate: true
enabled: true
etherChannelId: 1
hardware:
autoNegState: false
duplex: FULL
flowControlSend: 'OFF'
speed: THOUSAND
id: etherChannelIntfUUID1
ifname: NewEthChannel
ipv4:
static:
address: 10.20.25.10
netmask: '24'
ipv6:
addresses:
- address: 2002::/128
enforceEUI64: true
dadAttempts: 1
enableAutoConfig: true
enableDHCPAddrConfig: true
enableDHCPNonAddrConfig: true
enableIPV6: true
enableIPV6DadLoopbackDetect: true
enableRA: true
enforceEUI64: true
nsInterval: 1000
prefixes:
- default:
autoConfig: true
offlink: false
preferLifeTime:
duration:
preferLifeTime: 604800
validLifeTime: 2592000.0
preferLifeTime: {}
raInterval: 26
raLifeTime: 1800
reachableTime: 13
lacpMode: ACTIVE
lacpRate: DEFAULT
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/etherchannelinterfaces/etherChannelIntfUUID1
loadBalancing: SRC_IP_PORT
managementOnly: false
maxActivePhysicalInterface: 8
metadata:
domain:
id: domainUUID
name: Global
timestamp: 1462814173120.0
minActivePhysicalInterface: 1
mode: NONE
name: Port-channel1
nveOnly: false
overrideDefaultFragmentSetting: {}
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
priority: 10
securityZone:
id: securityZoneUUID
type: SecurityZone
selectedInterfaces:
- id: interface UUID
name: GigabitEthernet1/4
type: PhysicalInterface
- id: interface UUID
name: GigabitEthernet1/5
type: PhysicalInterface
type: EtherChannelInterface
- LLDP:
receive: false
transmit: false
MTU: 1500
applicationMonitoring:
enable: true
enableAntiSpoofing: false
enableSGTPropagate: true
enabled: true
etherChannelId: 1
hardware:
autoNegState: true
duplex: FULL
flowControlSend: 'OFF'
speed: THOUSAND
id: etherChannelIntfUUID1
ifname: NewEthChannel
ipv4: {}
ipv6: {}
lacpMode: ACTIVE
lacpRate: DEFAULT
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/etherchannelinterfaces/etherChannelIntfUUID1
managementOnly: false
metadata:
domain:
id: domainUUID
name: Global
timestamp: 1462814173120.0
mode: PASSIVE
name: Port-channel1
nveOnly: false
overrideDefaultFragmentSetting: {}
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
priority: 10
securityZone:
id: securityZoneUUID
type: SecurityZone
selectedInterfaces:
- id: interface UUID
name: GigabitEthernet1/4
type: PhysicalInterface
- id: interface UUID
name: GigabitEthernet1/5
type: PhysicalInterface
type: EtherChannelInterface
- LLDP:
receive: false
transmit: false
MTU: 1500
applicationMonitoring:
enable: true
enableAntiSpoofing: false
enableSGTPropagate: true
enabled: true
erspanFlowId: 1
erspanSourceIP: 10.20.30.50
etherChannelId: 1
hardware:
autoNegState: false
duplex: FULL
flowControlSend: 'OFF'
speed: THOUSAND
id: etherChannelIntfUUID1
ifname: NewEthChannel
ipv4:
static:
address: 10.20.30.40
netmask: '24'
ipv6: {}
lacpMode: ACTIVE
lacpRate: DEFAULT
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/etherchannelinterfaces/etherChannelIntfUUID1
managementOnly: false
metadata:
domain:
id: domainUUID
name: Global
timestamp: 1462814173120.0
mode: ERSPAN
name: Port-channel1
nveOnly: false
overrideDefaultFragmentSetting: {}
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
priority: 10
securityZone:
id: securityZoneUUID
type: SecurityZone
selectedInterfaces:
- id: interface UUID
name: GigabitEthernet1/4
type: PhysicalInterface
- id: interface UUID
name: GigabitEthernet1/5
type: PhysicalInterface
type: EtherChannelInterface
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/etherchannelinterfaces?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/FTDEtherChannelInterfaceListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**Create an ethernet channel interface. _Check the response section for applicable examples (if any)._**'
operationId: createFTDEtherChannelInterface
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/etherchannelinterfaces
( Success: Test POST method for ether channel interface )'
: value:
LLDP:
receive: false
transmit: false
MTU: 1500
applicationMonitoring:
enable: true
enableAntiSpoofing: false
enableSGTPropagate: true
enabled: true
etherChannelId: 1
hardware:
autoNegState: true
duplex: FULL
flowControlSend: 'OFF'
speed: THOUSAND
ifname: NewEthChannel
ipv4:
static:
address: 1.2.3.5
netmask: '25'
ipv6:
addresses:
- address: '9090::'
prefix: '12'
dadAttempts: 1
nsInterval: 10000
reachableTime: 0
lacpMode: ACTIVE
lacpRate: DEFAULT
loadBalancing: SRC_IP_PORT
managementOnly: false
maxActivePhysicalInterface: 8
minActivePhysicalInterface: 1
mode: NONE
nveOnly: false
overrideDefaultFragmentSetting: {}
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
priority: 10
securityZone:
id: securityZoneUUID
type: SecurityZone
selectedInterfaces:
- id: interface UUID
name: GigabitEthernet0/0
type: PhysicalInterface
type: EtherChannelInterface
schema:
$ref: '#/components/schemas/FTDEtherChannelInterface'
type: object
description: The input ethernet channel interface model.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/etherchannelinterfaces
( Success: Test POST method for ether channel interface )'
: value:
LLDP:
receive: false
transmit: false
MTU: 1500
applicationMonitoring:
enable: true
enableAntiSpoofing: false
enableAutoConfig: true
enableSGTPropagate: true
enabled: true
enforceEUI64: true
etherChannelId: 1
hardware:
autoNegState: false
duplex: FULL
flowControlSend: 'OFF'
speed: THOUSAND
ifname: NewEthChannel
ipv4:
static:
address: 1.2.3.5
netmask: '25'
ipv6:
addresses:
- address: '9090::'
prefix: '12'
dadAttempts: 1
enableIPV6DadLoopbackDetect: true
nsInterval: 10000
reachableTime: 0
lacpMode: ACTIVE
lacpRate: DEFAULT
links:
self: :/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/etherchannelinterfaces/etherchannelIntfUUID
loadBalancing: SRC_IP_PORT
managementOnly: false
maxActivePhysicalInterface: 8
metadata:
timestamp: 0
minActivePhysicalInterface: 1
mode: PASSIVE
name: Port-channel1
nveOnly: false
overrideDefaultFragmentSetting: {}
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
priority: 10
securityZone:
id: securityZoneUUID
type: SecurityZone
selectedInterfaces:
- id: interface UUID
name: GigabitEthernet0/0
type: PhysicalInterface
type: EtherChannelInterface
schema:
$ref: '#/components/schemas/FTDEtherChannelInterface'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/etherchannelinterfaces/{objectId}:
delete:
deprecated: false
description: '**Delete the specified ethernet channel interface. _Check the response section for applicable examples
(if any)._**'
operationId: deleteFTDEtherChannelInterface
parameters:
- description: Unique identifier of a ethernet channel interface.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/etherchannelinterfaces/etherchannelIntfUUID
( Success: Test DELETE method for ether channel interface )'
: value:
LLDP:
receive: false
transmit: false
MTU: 1500
applicationMonitoring:
enable: true
enableAntiSpoofing: false
enableSGTPropagate: true
enabled: true
etherChannelId: 1
hardware:
autoNegState: false
duplex: FULL
flowControlSend: 'OFF'
speed: THOUSAND
id: etherChannelIntfUUID1
ifname: NewEthChannel
ipv4:
static:
address: 1.2.3.5
netmask: '25'
ipv6:
addresses:
- address: '9090::'
prefix: '12'
dadAttempts: 1
enableIPV6DadLoopbackDetect: true
nsInterval: 10000
reachableTime: 0
lacpMode: ACTIVE
lacpRate: DEFAULT
loadBalancing: SRC_IP_PORT
managementOnly: false
maxActivePhysicalInterface: 8
minActivePhysicalInterface: 1
mode: NONE
name: Port-channel1
nveOnly: false
overrideDefaultFragmentSetting: {}
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
priority: 10
securityZone:
id: securityZoneUUID
type: SecurityZone
selectedInterfaces:
- id: interface UUID
name: GigabitEthernet0/0
type: PhysicalInterface
type: EtherChannelInterface
schema:
$ref: '#/components/schemas/FTDEtherChannelInterface'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
get:
deprecated: false
description: '**Get the specified ethernet channel interface.**'
operationId: getFTDEtherChannelInterface
parameters:
- description: Unique identifier of a ethernet channel interface.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/etherchannelinterfaces/etherChannelIntfUUID1
( Success: Test GET method for fp physical interface )'
: value:
LLDP:
receive: false
transmit: false
MTU: 1500
applicationMonitoring:
enable: true
monitoredApplications:
- id: '2325'
name: 050plus
type: Application
- id: '1553'
name: 1&1 Internet
type: Application
enableAntiSpoofing: false
enableSGTPropagate: true
enabled: true
etherChannelId: 1
hardware:
autoNegState: true
duplex: FULL
flowControlSend: 'OFF'
speed: THOUSAND
id: etherChannelIntfUUID1
ifname: NewEthChannel
ipv4:
static:
address: 10.20.25.10
netmask: '24'
ipv6:
addresses:
- address: 2002::/128
enforceEUI64: true
dadAttempts: 1
enableAutoConfig: true
enableDHCPAddrConfig: true
enableDHCPNonAddrConfig: true
enableIPV6: true
enableIPV6DadLoopbackDetect: true
enableRA: true
enforceEUI64: true
nsInterval: 1000
prefixes:
- advertisement:
autoConfig: true
offlink: false
preferLifeTime:
duration:
preferLifeTime: 604800
validLifeTime: 2592000.0
raInterval: 26
raLifeTime: 1800
reachableTime: 13
lacpMode: ACTIVE
lacpRate: DEFAULT
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/etherchannelinterfaces/etherChannelIntfUUID1
loadBalancing: SRC_IP_PORT
managementOnly: false
maxActivePhysicalInterface: 8
metadata:
domain:
id: domainUUID
name: Global
timestamp: 1462814173120.0
minActivePhysicalInterface: 1
mode: NONE
name: Port-channel1
nveOnly: false
overrideDefaultFragmentSetting: {}
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
priority: 10
securityZone:
id: securityZoneUUID
type: SecurityZone
selectedInterfaces:
- id: interface UUID
name: GigabitEthernet1/4
type: PhysicalInterface
- id: interface UUID
name: GigabitEthernet1/5
type: PhysicalInterface
type: EtherChannelInterface
schema:
$ref: '#/components/schemas/FTDEtherChannelInterface'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**Modify the specified ethernet channel interface. _Check the response section for applicable examples
(if any)._**'
operationId: updateFTDEtherChannelInterface
parameters:
- description: Unique identifier of a ethernet channel interface.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FTDEtherChannelInterface'
type: object
description: The input ethernet channel interface model.
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FTDEtherChannelInterface'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/fpinterfacestatistics:
get:
deprecated: false
description: '**Get list of statistics for all interfaces associated with the specified NGIPS device ID.**'
operationId: getFPInterfaceStatistics
parameters:
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fpinterfacestatistics
( Success: Test GET ALL success )'
: value:
items:
- name: s1p1
type: FPInterfaceStatistics
- name: s1p2
type: FPInterfaceStatistics
- name: s1p3
type: FPInterfaceStatistics
- name: s1p4
type: FPInterfaceStatistics
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fpinterfacestatistics?offset=0&limit=4
paging:
count: 4
limit: 4
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fpinterfacestatistics?expanded=true
( Success: Test GET ALL success with expanded=true )'
: value:
items:
- droppedPackets: 0
interfaceUuid: interfaceUUID
name: s1p2
rxBytes: 90194635.0
txBytes: 0
type: FPInterfaceStatistics
- droppedPackets: 0
interfaceUuid: interfaceUUID
name: s1p3
rxBytes: 0
txBytes: 0
type: FPInterfaceStatistics
- droppedPackets: 0
interfaceUuid: interfaceUUID
name: s1p1
rxBytes: 0
txBytes: 0
type: FPInterfaceStatistics
- droppedPackets: 0
interfaceUuid: interfaceUUID
name: s1p4
rxBytes: 462336
txBytes: 196
type: FPInterfaceStatistics
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fpinterfacestatistics?offset=0&limit=4
paging:
count: 4
limit: 4
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/FPInterfaceStatisticsListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/fplogicalinterfaces:
get:
deprecated: false
description: '**Get the list of all logical interfaces associated with the specified NGIPS device ID.**'
operationId: getAllFPLogicalInterface
parameters:
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fplogicalinterfaces
( Success: Test GET ALL success )'
: value:
items:
- id: '1'
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fplogicalinterfaces/fplogicalinterfaceUUID1
name: s1p3.1
type: FPLogicalInterface
- id: fplogicalinterfaceUUID2
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fplogicalinterfaces/fplogicalinterfaceUUID2
name: s1p4.2
type: FPLogicalInterface
- id: fplogicalinterfaceUUID3
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fplogicalinterfaces/fplogicalinterfaceUUID3
name: hybrid_1
type: FPLogicalInterface
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fplogicalinterfaces?offset=0&limit=3
paging:
count: 3
limit: 3
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fplogicalinterfaces?expanded=true
( Success: Test GET ALL success with expanded=true )'
: value:
items:
- enabled: 1
id: fplogicalinterfaceUUID3
interfaceType: SWITCHED
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fplogicalinterfaces/fplogicalinterfaceUUID3
mdi: auto
metadata:
activity: 0
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
link: 0
readOnly:
state: false
speed: -1
timestamp: 1458597038.0
mode: autoneg
mtu: 1518
name: s1p3.1
physicalInterface:
name: s1p3
type: FPLogicalInterface
vlanTag: 1
- enabled: 1
id: fplogicalinterfaceUUID2
interfaceType: ROUTED
ipAddresses:
- 10.2.2.2/13
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fplogicalinterfaces/fplogicalinterfaceUUID2
mdi: auto
metadata:
activity: 0
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
link: 1
readOnly:
state: false
speed: 1000
timestamp: 1458597048.0
mode: autoneg
mtu: 1518
name: s1p4.2
physicalInterface:
name: s1p4
staticArpEntries:
- ip: 10.1.20.30
mac: 12:83:53:49:a2:c2
type: FPLogicalInterface
vlanTag: 2
- enabled: 1
id: fplogicalinterfaceUUID3
interfaceType: VLAN
ipAddresses:
- 10.1.1.2/18
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fplogicalinterfaces/fplogicalinterfaceUUID3
metadata:
activity: 0
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
link: 0
readOnly:
state: false
speed: 0
timestamp: 1458595542.0
name: hybrid_1
type: FPLogicalInterface
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fplogicalinterfaces?offset=0&limit=4
paging:
count: 3
limit: 3
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/FPLogicalInterfaceListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**Create a logical interface. _Check the response section for applicable examples (if any)._**'
operationId: createFPLogicalInterface
parameters:
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FPLogicalInterface'
type: object
description: The input logical interface model.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/FPLogicalInterface'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/fplogicalinterfaces/{objectId}:
delete:
deprecated: false
description: '**Delete the logical interface associated with the specified NGIPS device ID and interface ID. _Check
the response section for applicable examples (if any)._**'
operationId: deleteFPLogicalInterface
parameters:
- description: Unique identifier of a logical interface.
in: path
name: objectId
required: true
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fplogicalinterfaces/fplogicalinterfaceUUID
( Test DELETE of FP Logical Interface to delete a record )'
: value:
enabled: 1
id: fplogicalinterfaceUUID
interfaceType: SWITCHED
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fplogicalinterfaces/fplogicalinterfaceUUID
mdi: auto
metadata:
activity: 0
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
link: 0
readOnly:
state: false
speed: -1
timestamp: 1458597038.0
mode: autoneg
name: s1p3.1
physicalInterface:
name: s1p3
type: FPLogicalInterface
vlanTag: 1
schema:
$ref: '#/components/schemas/FPLogicalInterface'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
get:
deprecated: false
description: '**Get the logical interface associated with the specified NGIPS device ID and interface ID.**'
operationId: getFPLogicalInterface
parameters:
- description: Unique identifier of a logical interface.
in: path
name: objectId
required: true
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fplogicalinterfaces/fplogicalinterfaceUUID
( Success: Test GET method for fp logical interface )'
: value:
enabled: 1
id: fplogicalinterfaceUUID
interfaceType: SWITCHED
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fplogicalinterfaces/fplogicalinterfaceUUID
mdi: auto
metadata:
activity: 0
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
link: 0
readOnly:
state: false
speed: -1
timestamp: 1458597038.0
mode: autoneg
name: s1p3.1
physicalInterface:
name: s1p3
type: FPLogicalInterface
vlanTag: 1
schema:
$ref: '#/components/schemas/FPLogicalInterface'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**Modify the logical interface associated with the specified NGIPS device ID and interface ID. _Check
the response section for applicable examples (if any)._**'
operationId: updateFPLogicalInterface
parameters:
- description: Unique identifier of a logical interface.
in: path
name: objectId
required: true
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fplogicalinterfaces/fplogicalinterfaceUUID3
( Test PUT of FP Logical Interface to update record )'
: value:
enabled: 0
id: fplogicalinterfaceUUID3
interfaceType: VLAN
ipAddresses:
- 10.1.1.2/18
- 10.11.12.13/19
name: hybrid_1
type: FPLogicalInterface
schema:
$ref: '#/components/schemas/FPLogicalInterface'
type: object
description: The input logical interface model.
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FPLogicalInterface'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/fpphysicalinterfaces:
get:
deprecated: false
description: '**Get the list of all physical interfaces associated with the specified NGIPS device ID.**'
operationId: getAllFPPhysicalInterface
parameters:
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fpphysicalinterfaces
( Success: Test GET ALL success )'
: value:
items:
- id: fpphysicalinterfaceUUID1
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fpphysicalinterfaces/fpphysicalinterfaceUUID1
name: s1p1
type: FPPhysicalInterface
- id: fpphysicalinterfaceUUID2
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fpphysicalinterfaces/fpphysicalinterfaceUUID2
name: s1p2
type: FPPhysicalInterface
- id: fpphysicalinterfaceUUID3
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fpphysicalinterfaces/fpphysicalinterfaceUUID3
name: s1p3
type: FPPhysicalInterface
- id: fpphysicalinterfaceUUID4
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fpphysicalinterfaces/fpphysicalinterfaceUUID4
name: s1p4
type: FPPhysicalInterface
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fpphysicalinterfaces?offset=0&limit=4
paging:
count: 4
limit: 4
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fpphysicalinterfaces?expanded=true
( Success: Test GET ALL success with expanded=true )'
: value:
items:
- enabled: 1
id: FPPhysicalInterfaceUUID1
interfaceType: INLINE
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fpphysicalinterfaces/FPPhysicalInterfaceUUID1
mdi: auto
metadata:
activity: 0
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
link: 0
readOnly:
state: false
speed: -1
timestamp: 1458595541.0
mode: autoneg
name: s1p1
type: FPPhysicalInterface
- enabled: 0
id: fpphysicalinterfaceUUID2
interfaceType: NONE
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fpphysicalinterfaces/fpphysicalinterfaceUUID2
metadata:
activity: 0
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
link: 1
readOnly:
state: false
speed: 1000
timestamp: 1458595541.0
name: s1p4
type: FPPhysicalInterface
- enabled: 0
id: fpphysicalinterfaceUUID3
interfaceType: NONE
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fpphysicalinterfaces/fpphysicalinterfaceUUID3
metadata:
activity: 0
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
link: 0
readOnly:
state: false
speed: -1
timestamp: 1458595541.0
name: s1p3
type: FPPhysicalInterface
- enabled: 1
id: fpphysicalinterfaceUUID4
interfaceType: INLINE
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fpphysicalinterfaces/fpphysicalinterfaceUUID4
mdi: auto
metadata:
activity: 0
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
link: 1
readOnly:
state: false
speed: 1000
timestamp: 1458595541.0
mode: autoneg
name: s1p2
type: FPPhysicalInterface
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fpphysicalinterfaces?offset=0&limit=4
paging:
count: 4
limit: 4
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/FPPhysicalInterfaceListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/fpphysicalinterfaces/{objectId}:
get:
deprecated: false
description: '**Get the physical interface associated with the specified NGIPS device ID and interface ID.**'
operationId: getFPPhysicalInterface
parameters:
- description: Unique identifier of a physical interface.
in: path
name: objectId
required: true
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fpphysicalinterfaces/fpphysicalinterfaceUUID
( Success: Test GET method for fp physical interface )'
: value:
enabled: 1
id: fpphysicalinterfaceUUID1
interfaceType: INLINE
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fpphysicalinterfaces/fpphysicalinterfaceUUID
mdi: auto
metadata:
activity: 0
domain:
id: DomainUUID
name: TestDomain
type: domain
lastUser:
id: UserUUID
name: admin
type: user
link: 0
readOnly:
state: true
speed: -1
timestamp: 1458595541.0
mode: autoneg
name: s1p1
type: FPPhysicalInterface
schema:
$ref: '#/components/schemas/FPPhysicalInterface'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**Modify the physical interface associated with the specified NGIPS device ID and interface ID. _Check
the response section for applicable examples (if any)._**'
operationId: updateFPPhysicalInterface
parameters:
- description: Unique identifier of a physical interface.
in: path
name: objectId
required: true
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/fpphysicalinterfaces/fpphysicalinterfaceUUID2
( Test PUT of FP Physical Interface to update record )'
: value:
enabled: 1
id: fpphysicalinterfaceUUID2
interfaceType: INLINE
name: s1p4
type: FPPhysicalInterface
schema:
$ref: '#/components/schemas/FPPhysicalInterface'
type: object
description: The input physical interface model.
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FPPhysicalInterface'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/ftdallinterfaces:
get:
deprecated: false
description: '**Get all types of interfaces.**'
operationId: getFTDAllInterfacesModel
parameters:
- description: 'This is a query parameter to fetch specific type of interfaces. Supported Filter Criteria are : cclEligibleInterface:{boolean};interfaceMode:{mode};virtualRouterId:{uuid};named:{boolean};clusterHealthCheckEligibleMonitorInterfaces:{boolean};s2sVpnApplicableInterfaces:{boolean};includeParentDomain:{boolean};name:{string};
cclEligibleInterface : Filter to get ccl eligible interface, filter value should always be
true.
interfaceMode : Filter using interface mode.Supported only for routed device.
Allowed value is ROUTED Cannot be used with cclEligibleInterface filter.
virtualRouterId
: Supported only for routed device. Cannot be used with cclEligibleInterface filter.
named
: Supported only for routed device. Cannot be used with cclEligibleInterface filter.
clusterHealthCheckEligibleMonitorInterfaces
: Filter to get eligible interfaces for cluster health check monitoring/ un-monitoring, filter value should
always be true . Cannot be used with cclEligibleInterface filter.
s2sVpnApplicableInterfaces
: Filter to get interfaces which are applicable in S2S VPN, filter value should always be true. Does not
include VTI interfaces. Supported only for routed device. Cannot be used with other filters.
includeParentDomain
: Filter to fetch interfaces of a device in a parent/ ancestral domain, filter value must always be true.
name : Filter to get interfaces with ifnames and hardware names that match the filter string passed.'
in: query
name: filter
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/FTDAllInterfacesModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/inlinesets:
get:
deprecated: false
description: '**Get the list of all inline sets associated with the specified NGIPS device ID.**'
operationId: getAllInlineSet
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/inlinesets ( Success:
Test GET ALL success )'
: value:
items:
- id: inlinesetUUID
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/inlinesets/inlinesetUUID
name: Default Inline Set
type: InlineSet
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/inlinesets?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/inlinesets?expanded=true
( Success: Test GET ALL success with expanded=true )'
: value:
items:
- failSafe: false
failopen: true
id: inlinesetUUID
inlinepairs:
- first:
id: FPPhysicalInterfaceUUID1
name: s1p1
type: FPPhysicalInterface
second:
id: FPPhysicalInterfaceUUID2
name: s1p2
type: FPPhysicalInterface
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/inlinesets/inlinesetUUID
loadBalancingMode: inner
loadBalancingModeVlan: inner
macFiltering: false
metadata:
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
readOnly:
state: false
timestamp: 1458595542.0
mtu: 1518
name: Default Inline Set
propogateLinkState: false
strictTCPEnforcement: false
type: InlineSet
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/inlinesets?offset=0&limit=1
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/InlineSetListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**Create an inline set on the specified NGIPS device. _Check the response section for applicable examples
(if any)._**'
operationId: createInlineSet
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/inlinesets ( Test POST
of Inlineset to add a record )'
: value:
bypass: true
failSafe: true
failopen: true
inlinepairs:
- first:
id: FPPhysicalInterfaceUUID3
name: s1p3
type: FPPhysicalInterface
second:
id: FPPhysicalInterfaceUUID4
name: s1p4
type: FPPhysicalInterface
loadBalancingMode: inner
loadBalancingModeVlan: inner
macFiltering: false
mtu: 1518
name: Inline_Set_1
propogateLinkState: true
standBy: true
strictTCPEnforcement: true
type: InlineSet
schema:
$ref: '#/components/schemas/InlineSet'
type: object
description: The input inline set model.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/InlineSet'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/inlinesets/{objectId}:
delete:
deprecated: false
description: '**Delete the inline set associated with the specified NGIPS device ID and inline set ID. _Check the response
section for applicable examples (if any)._**'
operationId: deleteInlineSet
parameters:
- description: Unique identifier of the inline set.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/inlinesets/inlinesetUUID
( Test DELETE of InlineSets )'
: value:
failSafe: false
failopen: true
id: inlinesetUUID
inlinepairs:
- first:
id: FPPhysicalInterfaceUUID1
name: s1p1
type: FPPhysicalInterface
second:
id: FPPhysicalInterfaceUUID2
name: s1p2
type: FPPhysicalInterface
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/inlinesets/inlinesetUUID
loadBalancingMode: inner
loadBalancingModeVlan: inner
macFiltering: false
metadata:
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
readOnly:
state: false
timestamp: 1458595542.0
mtu: 1518
name: Default Inline Set
propogateLinkState: false
strictTCPEnforcement: false
type: InlineSet
? 'Example 2 : DELETE /fmc_config/v1/domain/DomainUUID/devices/devicerecords/FTDcontainerUUID/inlinesets/FTDinlinesetUUID
( Test DELETE of FTD InlineSets )'
: value:
failSafe: false
id: inlinesetUUID
inlinepairs:
- first:
id: FPPhysicalInterfaceUUID1
name: s1p1
type: PhysicalInterface
second:
id: FPPhysicalInterfaceUUID2
name: s1p2
type: PhysicalInterface
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/FTDcontainerUUID/inlinesets/FTDinlinesetUUID
metadata:
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
readOnly:
state: false
timestamp: 1458595542.0
mtu: 1518
name: Inline1
propogateLinkState: false
strictTCPEnforcement: false
tapMode: false
type: InlineSet
schema:
$ref: '#/components/schemas/InlineSet'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
get:
deprecated: false
description: '**Get the inline set associated with the specified NGIPS device ID and inline set ID.**'
operationId: getInlineSet
parameters:
- description: Unique identifier of the inline set.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/inlinesets/inlinesetUUID
( Success: Test GET method for inlinesets )'
: value:
failSafe: false
failopen: true
id: inlinesetUUID
inlinepairs:
- first:
id: FPPhysicalInterfaceUUID1
name: s1p1
type: FPPhysicalInterface
second:
id: FPPhysicalInterfaceUUID2
name: s1p2
type: FPPhysicalInterface
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/inlinesets/inlinesetUUID
loadBalancingMode: inner
loadBalancingModeVlan: inner
macFiltering: false
metadata:
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
readOnly:
state: false
timestamp: 1458595542.0
mtu: 1518
name: Default Inline Set
propogateLinkState: false
strictTCPEnforcement: false
type: InlineSet
schema:
$ref: '#/components/schemas/InlineSet'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**Modify the inline set associated with the specified NGIPS device ID and inline set ID. _Check the response
section for applicable examples (if any)._**'
operationId: updateInlineSet
parameters:
- description: Unique identifier of the inline set.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/inlinesets/inlinesetUUID
( Test PUT of Inline set to update record )'
: value:
bypass: true
failSafe: true
failopen: true
id: inlinesetUUID
inlinepairs:
- first:
id: FPPhysicalInterfaceUUID1
name: s1p1
type: FPPhysicalInterface
second:
id: FPPhysicalInterfaceUUID2
name: s1p2
type: FPPhysicalInterface
loadBalancingMode: inner
loadBalancingModeVlan: inner
macFiltering: false
mtu: 1518
name: Default Inline Set
propogateLinkState: true
standBy: true
strictTCPEnforcement: true
type: InlineSet
? 'Example 2 : PUT /fmc_config/v1/domain/DomainUUID/devices/devicerecords/FTDcontainerUUID/inlinesets/FTDinlinesetUUID
( Test PUT of FTD Inline set to update record )'
: value:
bypass: true
failOpenSnortBusy: false
failOpenSnortDown: true
id: FTDinlinesetUUID
inlinepairs:
- first:
id: PhysicalInterfaceUUID1
name: phy1
type: PhysicalInterface
second:
id: PhysicalInterfaceUUID2
name: phy2
type: PhysicalInterface
mtu: 1518
name: FTDInline1
propogateLinkState: true
standBy: false
strictTCPEnforcement: true
type: InlineSet
schema:
$ref: '#/components/schemas/InlineSet'
type: object
description: The input inline set model.
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/InlineSet'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/interfaceevents:
get:
deprecated: false
description: '**Get the list of all netmod events on the device.**'
operationId: getInterfaceEvent
parameters:
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/interfaceevents (
Example payload for listing netmods. )'
: value:
items:
- change: Interface is associated
name: Port-channel1.100
state: ASSOCIATED
type: SubInterface
- change: Interface is disassociated
name: Port-channel8.65
state: DISASSOCIATED
type: SubInterface
- change: 'Properties changed : Vlan id changed to (62)
'
name: Port-channel8.66
state: MODIFIED
type: SubInterface
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devices/devicerecords/b06b03c0-801f-11e8-9809-ad31f7542647/interfaceevents?offset=0&limit=3
paging:
count: 3
limit: 3
offset: 0
pages: 1
? 'Example 2 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/interfaceevents (
Example payload for listing netmods on MultiInstance device. )'
: value:
items:
- change: Interface is associated
name: Port-channel1.100
state: ASSOCIATED
type: SubInterface
- change: Interface is disassociated
name: Port-channel8.65
state: DISASSOCIATED
type: SubInterface
- change: 'Properties changed : Vlan id changed to (62)
'
name: Port-channel8.66
state: MODIFIED
type: SubInterface
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devices/devicerecords/b06b03c0-801f-11e8-9809-ad31f7542647/interfaceevents?offset=0&limit=3
paging:
count: 3
limit: 3
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/InterfaceEventListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**Create a netmod event on the device. _Check the response section for applicable examples (if any)._**'
operationId: createInterfaceEvent
parameters:
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/interfaceevents (
Accept netmod events )'
: value:
action: SYNC_WITH_DEVICE
? 'Example 2 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/interfaceevents (
Accept netmod events )'
: value:
action: ACCEPT_CHANGES
schema:
$ref: '#/components/schemas/InterfaceEvent'
type: object
description: The input representing action to be performed on netmod events.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/interfaceevents
( Accept netmod events )'
: value:
action: SYNC_WITH_DEVICE
hasPendingChanges: false
? 'Example 2 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/interfaceevents
( Accept netmod events )'
: value:
action: ACCEPT_CHANGES
schema:
$ref: '#/components/schemas/InterfaceEvent'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/loopbackinterfaces:
get:
deprecated: false
description: '**Get the list of all loopback interfaces on the NGFW device.**'
operationId: getAllFTDLoopbackInterface
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/loopbackinterfaces
( Success: Test GET ALL success )'
: value:
items:
- id: loopbackinterfaceuuid1
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/loopbackinterfaces/loopbackinterfaceuuid1
name: loopback-1
type: LoopbackInterface
- id: loopbackinterfaceuuid2
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/loopbackinterfaces/loopbackinterfaceuuid2
name: loopback-2
type: LoopbackInterface
- id: loopbackinterfaceuuid3
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/loopbackinterfaces/loopbackinterfaceuuid3
name: loopback-3
type: LoopbackInterface
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/loopbackinterfaces?offset=0&limit=3
paging:
count: 3
limit: 3
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/loopbackinterfaces/loopbackinterfaceUUID?expanded=true
( Success: Test GET ALL success with expanded=true )'
: value:
items:
- enabled: true
id: 00000000-0000-0ed3-0000-206158430258
ifname: loopback-4
ipv4:
static:
address: 2.2.2.2
netmask: 255.255.255.0
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/loopbackinterfaces/loopbackinterfaceUUID1
loopbackId: 4
metadata:
domain:
id: domainUUID
name: Global
timestamp: 1462814174120.0
name: Loopback4
type: LoopbackInterface
- enabled: true
id: 00000000-0000-0ed3-0000-206158430258
ifname: loopback-5
ipv4:
static:
address: 2.2.2.2
netmask: 255.255.255.0
ipv6:
addresses:
- address: ee::11
prefix: '64'
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/loopbackinterfaces/loopbackinterfaceUUID2
loopbackId: 5
metadata:
domain:
id: domainUUID
name: Global
timestamp: 1462814174120.0
name: Loopback5
type: LoopbackInterface
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/loopbackinterfaces/loopbackinterfaceUUID?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/FTDLoopbackInterfaceListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**Create a loopback interface on the specified NGFW device. _Check the response section for applicable
examples (if any)._**'
operationId: createFTDLoopbackInterface
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/loopbackinterfaces
( Success: Test POST method for FTD loopback interface )'
: value:
enabled: true
ifname: loopback-5
ipv4:
static:
address: 169.254.100.1
netmask: 255.255.255.252
ipv6:
addresses:
- address: ee::11
prefix: '64'
loopbackId: 5
type: LoopbackInterface
schema:
$ref: '#/components/schemas/FTDLoopbackInterface'
type: object
description: The input loopback interface model.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/loopbackinterfaces
( Success: Test POST method for FTD loopback interface )'
: value:
enabled: true
id: 00000000-0000-0ed3-0000-206158430258
ifname: loopback-5
ipv4:
static:
address: 169.254.100.1
netmask: 255.255.255.252
ipv6:
addresses:
- address: ee::11
prefix: '64'
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/loopbackinterfaces/loopbackinterfaceUUID
loopbackId: 5
metadata:
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
readOnly:
state: false
timestamp: 1458597038.0
name: Loopback5
type: LoopbackInterface
schema:
$ref: '#/components/schemas/FTDLoopbackInterface'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/loopbackinterfaces/{objectId}:
delete:
deprecated: false
description: '**Delete the specified loopback interface. _Check the response section for applicable examples (if any)._**'
operationId: deleteFTDLoopbackInterface
parameters:
- description: Unique identifier of a loopback interface.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/loopbackinterfaces/loopbackinterfaceUUID
( Success: Test DELETE method for loopback interface )'
: value:
enabled: true
id: 00000000-0000-0ed3-0000-206158430258
ifname: loopback-5
ipv4:
static:
address: 2.2.2.2
netmask: 255.255.255.0
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/loopbackinterfaces/loopbackinterfaceUUID
loopbackId: 5
metadata:
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
readOnly:
state: false
timestamp: 1458597038.0
name: Loopback5
type: LoopbackInterface
schema:
$ref: '#/components/schemas/FTDLoopbackInterface'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
get:
deprecated: false
description: '**Get the specified loopback interface.**'
operationId: getFTDLoopbackInterface
parameters:
- description: Unique identifier of a loopback interface.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/loopbackinterfaces/loopbackinterfaceUUID
( Success: Test GET method for loopback interface )'
: value:
enabled: true
id: 00000000-0000-0ed3-0000-206158430258
ifname: loopback-4
ipv4:
static:
address: 2.2.2.2
netmask: 255.255.255.0
ipv6:
addresses:
- address: ee::11
prefix: '64'
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/loopbackinterfaces/loopbackinterfaceUUID
loopbackId: 4
metadata:
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
readOnly:
state: false
timestamp: 1458597038.0
name: Loopback4
type: LoopbackInterface
schema:
$ref: '#/components/schemas/FTDLoopbackInterface'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**Modify the specified loopback interface. _Check the response section for applicable examples (if any)._**'
operationId: updateFTDLoopbackInterface
parameters:
- description: Unique identifier of a loopback interface.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/loopbackinterfaces/loopbackinterfaceUUID
( Success: Test PUT method for loopback interface )'
: value:
enabled: true
id: 00000000-0000-0ed3-0000-206158430258
ifname: loopback-5
ipv4:
static:
address: 2.2.2.2
netmask: 255.255.255.0
loopbackId: 5
name: Loopback5
type: LoopbackInterface
schema:
$ref: '#/components/schemas/FTDLoopbackInterface'
type: object
description: The input loopback interface model.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/loopbackinterfaces/loopbackinterfaceUUID
( Success: Test PUT method for loopback interface )'
: value:
enabled: true
id: 00000000-0000-0ed3-0000-206158430258
ifname: loopback-5
ipv4:
static:
address: 2.2.2.2
netmask: 255.255.255.0
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/loopbackinterfaces/loopbackinterfaceUUID
loopbackId: 5
metadata:
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
readOnly:
state: false
timestamp: 1458597038.0
name: Loopback5
type: LoopbackInterface
schema:
$ref: '#/components/schemas/FTDLoopbackInterface'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/managementconvergencemode:
get:
deprecated: false
description: '**Get the convergence state of the device.**'
operationId: getManagementInterfaceConvergence
parameters:
- description: Boolean indicating to list all the usages of the Management interface when the device is non converged.
in: query
name: checkConvergenceReadiness
required: false
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/managementconvergencemode
( Success: Test GET success )'
: value:
items:
- metadata:
managementinterface:
id: 00505686-A949-0ed3-0000-008589934811
name: Diagnostic0/0
type: PhysicalInterface
mode: NON_CONVERGED
type: ManagementConvergenceMode
links:
self: /fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devices/devicerecords/containerUUID/managementconvergencemode?offset=0&limit=1&expanded=true
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/ManagementInterfaceConvergenceListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**Modify the convergence state of the device. _Check the response section for applicable examples (if
any)._**'
operationId: createManagementInterfaceConvergence
parameters:
- description: Boolean indicationg to merge the management interface even if there are warnings.
in: query
name: ignoreWarning
required: false
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ManagementInterfaceConvergence'
type: object
description: The input management interface convergence model.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ManagementInterfaceConvergence'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/operational/commands:
get:
deprecated: false
description: '**Get the show command output from the device. Only one request can be handled concurrently per device,
with a maximum of ten devices. The devices must be running version 6.6.0 or higher.**'
operationId: getCommands
parameters:
- description: 'The command filter query parameter should have value of show commands. The maximum word size of this
field is 2. For eg: show failover, show snmp-server, show logging etc.
Note:- This API endpoint retrieves
outputs from devices by executing specific CLIs which return small configurations. This endpoint should not be used
to retrieve large configurations as this may not work as desired or impact performance. Specific CLI commands which
should not be used include "show running-config all", "show running-config access-list", and similar commands which
will provide large outputs.
Supported CLIs:- show version, show version -option>, show
failover, show failover -option>, show dhcpd state, show ip, show ip -option>, show aaa-server, show aaa-server
-option>, show logging, show logging -some_option_only>, show snmp-server -option>, show ssl, show ssl -option>,
show firewall, show logging, show logging -some_option_only>, show route, show route -option>, show vpn-sessiondb,
show vpn-sessiondb -option>, show crypto -option>, show rule -option>, show access-list -option>, show network,
show ntp, show banner, show snort3 status'
in: query
name: command
required: true
schema:
type: string
- description: 'The parameters filter query parameter should have values containing command values exceeding word size
of 2 should be given as part of parameters field. For eg: history details, engineID, setting etc.'
in: query
name: parameters
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CommandsListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/operational/metrics:
get:
deprecated: false
description: '**Get HealthMonitor metrics for the device.**'
operationId: getHealthMonitorModel
parameters:
- description: The metric filter query parameter should have healthmonitor name.Currently supports only metric:memory
& metric:cpu
in: query
name: filter
required: true
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/HealthMonitorModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/operational/outofbandchanges:
get:
deprecated: false
description: '**Get out of band changes on the device.**'
operationId: getOutOfBandChanges
parameters:
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OutOfBandChangesListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**Trigger and acknowledge out of band changes on the device. _Check the response section for applicable
examples (if any)._**'
operationId: createOutOfBandChanges
parameters:
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/operational/outofbandchanges
( Initiate process to detect out of band changes )'
: value:
oobaction: DETECT_OUT_OF_BAND_CHANGES
? 'Example 2 : POST /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/operational/outofbandchanges
( Acknowledge the out of band changes )'
: value:
oobaction: ACKNOWLEDGE_OUT_OF_BAND_CHANGES
schema:
$ref: '#/components/schemas/OutOfBandChanges'
type: object
description: The input representation of out of band changes.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/operational/outofbandchanges
( Initiate process to detect out of band changes )'
: value:
metadata:
task:
description: Out of bound changes detection request task queued
id: taskId
links:
self: selflink
taskType: OOB_CHANGES_REQUEST
oobaction: DETECT_OUT_OF_BAND_CHANGES
? 'Example 2 : POST /api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/operational/outofbandchanges
( Acknowledge the out of band changes )'
: value:
oobaction: ACKNOWLEDGE_OUT_OF_BAND_CHANGES
status: SUCCESS
schema:
$ref: '#/components/schemas/OutOfBandChanges'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/operational/virtualaccessinterfaces:
get:
deprecated: false
description: '**Get the Virtual Access Interfaces on all the managed Firewall Threat Defense devices.**'
operationId: getAllVirtualAccessInterface
parameters:
- description: Filter access interfaces according to their parent DVTI using the format dvtiId:{Uuid}.
in: query
name: filter
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/VirtualAccessInterfaceListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/physicalinterfaces:
get:
deprecated: false
description: '**Get the list of all physical interfaces associated with the specified NGFW device ID. More details on netmod events(out of sync interfaces): GET /interfaceevents
.**'
operationId: getAllFTDPhysicalInterface
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/physicalinterfaces (
GET ALL for FTD physicalinterface without any query parameters )'
: value:
items:
- id: PhyIntfId1
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/deviceUUID/physicalinterfaces/PhyIntfId1
name: GigabitEthernet1/1
- id: PhyIntfId2
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/deviceUUID/physicalinterfaces/PhyIntfId2
name: GigabitEthernet1/2
- id: PhyIntfId3
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/deviceUUID/physicalinterfaces/PhyIntfId3
name: GigabitEthernet1/3
- id: PhyIntfId4
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/deviceUUID/physicalinterfaces/PhyIntfId4
name: GigabitEthernet1/4
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/deviceUUID/physicalinterfaces?offset=0&limit=4
paging:
count: 4
limit: 4
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/physicalinterfaces?expanded=true
( GET ALL for FTD physicalinterface with expanded=true )'
: value:
items:
- LLDP:
receive: false
transmit: false
MTU: 1500
applicationMonitoring:
enable: true
description: Interface description
enableAntiSpoofing: false
enableSGTPropagate: true
enabled: false
hardware:
autoNegState: true
duplex: FULL
flowControlSend: 'OFF'
speed: THOUSAND
id: PhyIntfId1
ifname: Intf1
ipv4: {}
ipv6: {}
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/deviceUUID/physicalinterfaces/PhyIntfId1
managementAccess: false
managementOnly: false
metadata:
_comment: Supported speed will be available only for 2100 series devices
domain:
id: Global_UUID
name: Global
supportedSpeed: HUNDRED,TEN,THOUSAND,AUTO
timestamp: 1467048332483.0
mode: INLINE
name: GigabitEthernet1/1
nveOnly: false
overrideDefaultFragmentSetting: {}
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
powerOverEthernet:
consumptionWattage: 0
state: true
priority: 10
securityZone:
id: SecZoneUUID1
type: SecurityZone
type: PhysicalInterface
- LLDP:
receive: false
transmit: false
MTU: 1500
applicationMonitoring:
enable: true
description: Interface description
enableAntiSpoofing: false
enableSGTPropagate: true
enabled: false
hardware:
autoNegState: false
duplex: FULL
flowControlSend: 'OFF'
speed: THOUSAND
id: PhyIntfId2
ifname: Intf2
ipv4: {}
ipv6: {}
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/deviceUUID/physicalinterfaces/PhyIntfId2
managementAccess: false
managementOnly: false
metadata:
_comment: Supported speed will be available only for 2100 series devices
domain:
id: Global_UUID
name: Global
supportedSpeed: HUNDRED,TEN,THOUSAND,AUTO
timestamp: 1467048332483.0
mode: INLINE
name: GigabitEthernet1/2
nveOnly: false
overrideDefaultFragmentSetting: {}
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
powerOverEthernet:
consumptionWattage: 0
state: true
priority: 10
securityZone:
id: SecZoneUUID2
type: SecurityZone
type: PhysicalInterface
- LLDP:
receive: false
transmit: false
MTU: 1500
applicationMonitoring:
enable: true
description: Interface description
enableAntiSpoofing: false
enableSGTPropagate: true
enabled: true
hardware:
autoNegState: true
duplex: FULL
flowControlSend: 'OFF'
speed: THOUSAND
id: PhyIntfId3
ifname: PassiveIntf
ipv4: {}
ipv6: {}
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/deviceUUID/physicalinterfaces/PhyIntfId3
managementAccess: false
managementOnly: false
metadata:
_comment: Supported speed will be available only for 2100 series devices
domain:
id: Global_UUID
name: Global
supportedSpeed: HUNDRED,TEN,THOUSAND,AUTO
timestamp: 1467048332483.0
mode: PASSIVE
name: GigabitEthernet1/3
nveOnly: false
overrideDefaultFragmentSetting: {}
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
powerOverEthernet:
consumptionWattage: 0
state: true
priority: 10
securityZone:
id: SecZoneUUID3
type: SecurityZone
type: PhysicalInterface
- LLDP:
receive: false
transmit: false
MTU: 1500
applicationMonitoring:
enable: true
description: Interface description
enableAntiSpoofing: false
enableSGTPropagate: true
enabled: false
erspanFlowId: 1
erspanSourceIP: 10.20.30.50
hardware:
autoNegState: true
duplex: FULL
flowControlSend: 'OFF'
speed: THOUSAND
id: PhyIntfId4
ifname: ErspanTest
ipv4:
static:
address: 10.20.30.40
netmask: '24'
ipv6: {}
isRedundantMember: false
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/deviceUUID/physicalinterfaces/PhyIntfId4
managementAccess: false
managementOnly: false
metadata:
_comment: Supported speed will be available only for 2100 series devices
domain:
id: Global_UUID
name: Global
supportedSpeed: HUNDRED,TEN,THOUSAND,AUTO
timestamp: 1467048408466.0
mode: ERSPAN
name: GigabitEthernet1/4
nveOnly: false
overrideDefaultFragmentSetting: {}
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
powerOverEthernet:
consumptionWattage: 0
state: true
priority: 10
securityZone:
id: SecZoneUUID4
type: SecurityZone
type: PhysicalInterface
- description: Interface description
enabled: false
id: InterfaceUUID
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/deviceUUID/physicalinterfaces/PhyIntfId5
metadata:
domain:
id: Global_UUID
name: Global
isSupervisorProvisioned: 'false'
timestamp: '1467048332483'
mode: SWITCHPORT
name: GigabitEthernet0/5
nveOnly: false
powerOverEthernet:
consumptionWattage: 0
state: true
switchPortConfig:
accessModeVlanId: 2
portMode: ACCESS
protectedEnabled: true
type: PhysicalInterface
- description: Interface description
enabled: false
id: InterfaceUUID
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/deviceUUID/physicalinterfaces/PhyIntfId6
metadata:
domain:
id: Global_UUID
name: Global
isSupervisorProvisioned: 'false'
timestamp: '1467048332483'
mode: SWITCHPORT
name: GigabitEthernet0/1
nveOnly: false
powerOverEthernet:
consumptionWattage: 0
state: true
switchPortConfig:
portMode: TRUNK
protectedEnabled: true
trunkModeAllowedVlanIds: 2-10
trunkModeNativeVlanId: 1
type: PhysicalInterface
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/deviceUUID/physicalinterfaces?offset=0&limit=4
paging:
count: 4
limit: 4
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/FTDPhysicalInterfaceListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/physicalinterfaces/{objectId}:
get:
deprecated: false
description: '**Get the physical interface associated with the specified NGFW device ID and interface ID.**'
operationId: getFTDPhysicalInterface
parameters:
- description: Unique identifier of the NGFW physical interface.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/physicalinterfaces/PhyIntfId1
( GET method for FTD physical interface of a FEC supported device for a given UUID )'
: value:
LLDP:
receive: false
transmit: false
MTU: 1500
applicationMonitoring:
enable: true
monitoredApplications:
- id: '2325'
name: 050plus
type: Application
- id: '1553'
name: 1&1 Internet
type: Application
description: Interface description
enableAntiSpoofing: false
enableSGTPropagate: true
enabled: false
hardware:
autoNegState: true
duplex: FULL
fecMode: CL108RS
flowControlSend: 'OFF'
speed: THOUSAND
id: PhyIntfId1
ifname: Intf1
ipv4: {}
ipv6: {}
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/deviceUUID/physicalinterfaces/PhyIntfId1
managementAccess: false
managementOnly: false
metadata:
_comment: Supported speed will be available only for 3100 series devices
domain:
id: Global_UUID
name: Global
supportedSpeed: HUNDRED,TEN,THOUSAND,AUTO,TWENTY_FIVE_THOUSAND
timestamp: 1467048332483.0
mode: INLINE
name: Ethernet1/14
nveOnly: false
overrideDefaultFragmentSetting: {}
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
powerOverEthernet:
consumptionWattage: 0
state: true
priority: 10
securityZone:
id: SecZoneUUID1
type: SecurityZone
type: PhysicalInterface
? 'Example 2 : GET /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/physicalinterfaces/PhyIntfId1
( GET method for FTD physical interface for a given UUID )'
: value:
LLDP:
receive: false
transmit: false
MTU: 1500
applicationMonitoring:
enable: true
description: Interface description
enableAntiSpoofing: false
enableSGTPropagate: true
enabled: false
hardware:
autoNegState: true
duplex: FULL
fecMode: AUTO
flowControlSend: 'OFF'
speed: THOUSAND
id: PhyIntfId1
ifname: Intf1
ipv4: {}
ipv6: {}
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/deviceUUID/physicalinterfaces/PhyIntfId1
managementAccess: false
managementOnly: false
metadata:
_comment: Supported speed will be available only for 2100 series devices
domain:
id: Global_UUID
name: Global
supportedSpeed: HUNDRED,TEN,THOUSAND,AUTO
timestamp: 1467048332483.0
mode: INLINE
name: GigabitEthernet1/1
nveOnly: false
overrideDefaultFragmentSetting: {}
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
powerOverEthernet:
consumptionWattage: 0
state: true
priority: 10
securityZone:
id: SecZoneUUID1
type: SecurityZone
type: PhysicalInterface
? 'Example 3 : GET /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/physicalinterfaces/PhyIntfId1
( GET method for FTD physical interface for a given UUID on a FMC Access enabled device (6.7.0 or later)
)'
: value:
LLDP:
receive: false
transmit: false
MTU: 1500
applicationMonitoring:
enable: true
description: Interface description
enableAntiSpoofing: false
enableSGTPropagate: true
enabled: false
fmcAccessConfig:
allowedNetworks:
- id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
enableAccess: true
hardware:
autoNegState: false
duplex: FULL
flowControlSend: 'OFF'
speed: THOUSAND
id: PhyIntfId1
ifname: outside
ipv4:
dhcp:
dhcpRouteMetric: 1
enableDefaultRouteDHCP: 'true'
ipv6: {}
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/deviceUUID/physicalinterfaces/PhyIntfId1
managementAccess: false
managementOnly: false
metadata:
_comment: Supported speed will be available only for 2100 series devices
domain:
id: Global_UUID
name: Global
supportedSpeed: HUNDRED,TEN,THOUSAND,AUTO
timestamp: 1467048332483.0
mode: INLINE
name: GigabitEthernet1/1
nveOnly: false
overrideDefaultFragmentSetting: {}
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
powerOverEthernet:
consumptionWattage: 0
state: true
priority: 10
securityZone:
id: SecZoneUUID1
type: SecurityZone
type: PhysicalInterface
? 'Example 4 : GET /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/physicalinterfaces/PhyIntfId1
( GET method for FTD physical interface for a given UUID: SSP provisioned Instance device''s interface )'
: value:
MTU: '1500'
applicationMonitoring:
enable: true
description: Interface description
enableAntiSpoofing: 'false'
enableSGTPropagate: true
enabled: 'true'
fragmentReassembly: 'false'
id: 005056A9-6FB0-0ed3-0000-064424510716
ifname: diagnostic
ipv6:
enableRA: 'true'
raInterval: '200'
raLifeTime: '1800'
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/deviceUUID/physicalinterfaces/PhyIntfId1
managementAccess: false
managementOnly: 'true'
metadata:
domain:
id: Global_UUID
name: Global
isSupervisorProvisioned: 'true'
timestamp: '1467048332483'
mode: NONE
name: Ethernet1/1
nveOnly: false
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
priority: 10
type: PhysicalInterface
? 'Example 5 : GET /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/physicalinterfaces/PhyIntfIds
( GET method for FTD physical interface for a given UUID: TRUNK mode Interface in L2 Switching Enabled Device
)'
: value:
description: Interface description
enabled: false
id: InterfaceUUID
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/deviceUUID/physicalinterfaces/PhyIntfId2
metadata:
domain:
id: Global_UUID
name: Global
isSupervisorProvisioned: 'false'
timestamp: '1467048332483'
mode: SWITCHPORT
name: GigabitEthernet0/1
nveOnly: false
powerOverEthernet:
consumptionWattage: 0
state: true
switchPortConfig:
portMode: TRUNK
protectedEnabled: true
trunkModeAllowedVlanIds: 2-10
trunkModeNativeVlanId: 1
type: PhysicalInterface
? 'Example 6 : GET /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/physicalinterfaces/PhyIntfId3
( GET method for FTD physical interface for a given UUID: ACCESS mode Interface in L2 Switching Enabled
Device )'
: value:
description: Interface description
enabled: false
id: InterfaceUUID
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/deviceUUID/physicalinterfaces/PhyIntfId3
metadata:
domain:
id: Global_UUID
name: Global
isSupervisorProvisioned: 'false'
timestamp: '1467048332483'
mode: SWITCHPORT
name: GigabitEthernet0/1
nveOnly: false
powerOverEthernet:
consumptionWattage: 0
state: true
switchPortConfig:
accessModeVlanId: 2
portMode: ACCESS
protectedEnabled: true
type: PhysicalInterface
schema:
$ref: '#/components/schemas/FTDPhysicalInterface'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**Modify the physical interface associated with the specified NGFW device ID and interface ID. _Check
the response section for applicable examples (if any)._**'
operationId: updateFTDPhysicalInterface
parameters:
- description: Unique identifier of the NGFW physical interface.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/physicalinterfaces/PhyIntfId
( PUT method for FEC Supported FTD physical interface for a given UUID )'
: value:
LLDP:
receive: false
transmit: false
MTU: 1500
enableSGTPropagate: false
enabled: false
hardware:
autoNegState: true
duplex: FULL
fecMode: CL108RS
flowControlSend: 'OFF'
speed: TWENTY_FIVE_THOUSAND
id: PhyIntfId
ipv6:
enableIPV6: false
managementOnly: false
mode: NONE
name: Ethernet1/16
nveOnly: false
type: PhysicalInterface
? 'Example 2 : PUT /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/physicalinterfaces/PhyIntfId1
( PUT method for FTD physical interface for a given UUID )'
: value:
LLDP:
receive: false
transmit: false
MTU: 1500
applicationMonitoring:
enable: true
arpConfig:
- enableAlias: false
ipAddress: 101.101.101.101/25
macAddress: 03DC.1234.2323
description: Interface description
enableAntiSpoofing: false
enableSGTPropagate: true
enabled: false
hardware:
autoNegState: true
duplex: FULL
flowControlSend: 'OFF'
speed: THOUSAND
id: PhyIntfId1
ifname: Intf1
ipv4:
dhcp:
dhcpRouteMetric: 1
enableDefaultRouteDHCP: 'true'
pppoe:
enableRouteSettings: true
ipAddress: 1.2.3.4/25
pppAuth: < PAP | CHAP | MSCHAP>
pppoePassword: User_password
pppoeRouteMetric: 1
pppoeUser: User_name
storeCredsInFlash: false
vpdnGroupName: VPDN_group_name
static:
address: 1.2.3.4
netmask: '25'
ipv6:
addresses:
- address: '2001'
enforceEUI64: false
prefix: '124'
- address: '8080'
enforceEUI64: true
prefix: '12'
dadAttempts: 1
enableAutoConfig: true
enableDHCPAddrConfig: true
enableDHCPNonAddrConfig: false
enableIPV6: true
enableIPV6DadLoopbackDetect: true
enableRA: false
enforceEUI64: false
linkLocalAddress: 'FE80::'
nsInterval: 10000
prefixes:
- address: 2001::/124
advertisement:
autoConfig: false
offlink: false
preferLifeTime:
duration:
preferLifetime: 604800
validLifeTime: 2592300.0
expirationLifeTime:
preferDateTime: '2016-11-05T08:15:30.000Z'
validDateTime: '2016-12-05T08:15:30.000Z'
default: false
raInterval: 200
raLifeTime: 1800
reachableTime: 0
managementAccess: false
managementOnly: false
mode: INLINE
name: GigabitEthernet1/1
nveOnly: false
overrideDefaultFragmentSetting:
chain: 24
size: 200
timeout: 5
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
powerOverEthernet:
consumptionWattage: 0
state: true
priority: 10
securityZone:
id: SecZoneUUID1
type: SecurityZone
type: PhysicalInterface
? 'Example 3 : PUT /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/physicalinterfaces/fmcAccessPhyIntfId1
( PUT method for FTD physical interface for a given UUID on a FMC Access supported device )'
: value:
LLDP:
receive: false
transmit: false
MTU: 1500
arpConfig:
- enableAlias: false
ipAddress: 101.101.101.101/25
macAddress: 03DC.1234.2323
description: Interface description
enableAntiSpoofing: false
enableSGTPropagate: true
enabled: false
fmcAccessConfig:
allowedNetworks:
- id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
enableAccess: true
hardware:
autoNegState: true
duplex: FULL
flowControlSend: 'OFF'
speed: THOUSAND
id: fmcAccessPhyIntfId1
ifname: Intf1
ipv4:
dhcp:
dhcpRouteMetric: 1
enableDefaultRouteDHCP: 'true'
pppoe:
enableRouteSettings: true
ipAddress: 1.2.3.4/25
pppAuth: < PAP | CHAP | MSCHAP>
pppoePassword: User_password
pppoeRouteMetric: 1
pppoeUser: User_name
storeCredsInFlash: false
vpdnGroupName: VPDN_group_name
static:
address: 1.2.3.4
netmask: '25'
ipv6:
addresses:
- address: '2001'
enforceEUI64: false
prefix: '124'
- address: '8080'
enforceEUI64: true
prefix: '12'
dadAttempts: 1
enableAutoConfig: true
enableDHCPAddrConfig: true
enableDHCPNonAddrConfig: false
enableIPV6: true
enableIPV6DadLoopbackDetect: true
enableRA: false
enforceEUI64: false
linkLocalAddress: 'FE80::'
nsInterval: 10000
prefixes:
- address: 2001::/124
advertisement:
autoConfig: false
offlink: false
preferLifeTime:
duration:
preferLifetime: 604800
validLifeTime: 2592300.0
expirationLifeTime:
preferDateTime: '2016-11-05T08:15:30.000Z'
validDateTime: '2016-12-05T08:15:30.000Z'
default: false
raInterval: 200
raLifeTime: 1800
reachableTime: 0
managementAccess: false
managementOnly: false
mode: INLINE
name: GigabitEthernet1/1
nveOnly: false
overrideDefaultFragmentSetting:
chain: 24
size: 200
timeout: 5
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
powerOverEthernet:
consumptionWattage: 0
state: true
priority: 10
securityZone:
id: SecZoneUUID1
type: SecurityZone
type: PhysicalInterface
? 'Example 4 : PUT /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/physicalinterfaces/PhyIntfId1
( PUT method for FTD physical interface for a given UUID: TRUNK mode Interface in L2 Switching Enabled Device
)'
: value:
LLDP:
receive: false
transmit: false
description: Interface description
enabled: false
id: InterfaceUUID
mode: SWITCHPORT
name: GigabitEthernet0/1
nveOnly: false
powerOverEthernet:
consumptionWattage: 0
state: true
switchPortConfig:
portMode: TRUNK
protectedEnabled: true
trunkModeAllowedVlanIds: 2-10
trunkModeNativeVlanId: 1
type: PhysicalInterface
? 'Example 5 : PUT /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/physicalinterfaces/PhyIntfId1
( PUT method for FTD physical interface for a given UUID: ACCESS mode Interface in L2 Switching Enabled Device
)'
: value:
LLDP:
receive: false
transmit: false
description: Interface description
enabled: false
id: InterfaceUUID
mode: SWITCHPORT
name: GigabitEthernet0/1
nveOnly: false
powerOverEthernet:
consumptionWattage: 0
state: true
switchPortConfig:
accessModeVlanId: 2
portMode: ACCESS
protectedEnabled: true
type: PhysicalInterface
schema:
$ref: '#/components/schemas/FTDPhysicalInterface'
type: object
description: The input NGFW physical interface model.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/physicalinterfaces/PhyIntfId
( PUT method for FEC Supported FTD physical interface for a given UUID )'
: value:
MTU: 1500
enableSGTPropagate: false
enabled: false
hardware:
autoNegState: true
duplex: FULL
fecMode: CL108RS
flowControlSend: 'OFF'
speed: TWENTY_FIVE_THOUSAND
id: PhyIntfId
ipv6:
enableIPV6: false
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/physicalinterfaces/PhyIntfId
managementOnly: false
metadata:
state: COMMITTED
supportedSpeed: TEN_THOUSAND,THOUSAND,TWENTY_FIVE_THOUSAND,AUTO,SFPDETECT
timestamp: 0
mode: NONE
name: Ethernet1/16
nveOnly: false
type: PhysicalInterface
? 'Example 2 : PUT /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/physicalinterfaces/PhyIntfId1
( PUT method for FTD physical interface for a given UUID )'
: value:
LLDP:
receive: false
transmit: false
MTU: 1500
applicationMonitoring:
enable: true
arpConfig:
- enableAlias: false
ipAddress: 101.101.101.101/25
macAddress: 03DC.1234.2323
description: Interface description
enableAntiSpoofing: false
enableSGTPropagate: true
enabled: false
hardware:
autoNegState: true
duplex: FULL
flowControlSend: 'OFF'
speed: THOUSAND
id: PhyIntfId1
ifname: Intf1
ipv4:
dhcp:
dhcpRouteMetric: 1
enableDefaultRouteDHCP: 'true'
pppoe:
enableRouteSettings: true
ipAddress: 1.2.3.4/25
pppAuth: < PAP | CHAP | MSCHAP>
pppoePassword: User_password
pppoeRouteMetric: 1
pppoeUser: User_name
storeCredsInFlash: false
vpdnGroupName: VPDN_group_name
static:
address: 1.2.3.4
netmask: '25'
ipv6:
addresses:
- address: '2001'
enforceEUI64: false
prefix: '124'
- address: '8080'
enforceEUI64: true
prefix: '12'
dadAttempts: 1
enableAutoConfig: true
enableDHCPAddrConfig: true
enableDHCPNonAddrConfig: false
enableIPV6: true
enableIPV6DadLoopbackDetect: true
enableRA: false
enforceEUI64: false
linkLocalAddress: 'FE80::'
nsInterval: 10000
prefixes:
- address: 2001::/124
advertisement:
autoConfig: false
offlink: false
preferLifeTime:
duration:
preferLifetime: 604800
validLifeTime: 2592300.0
expirationLifeTime:
preferDateTime: '2016-11-05T08:15:30.000Z'
validDateTime: '2016-12-05T08:15:30.000Z'
default: false
raInterval: 200
raLifeTime: 1800
reachableTime: 0
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/deviceUUID/physicalinterfaces/PhyIntfId1
managementAccess: false
managementOnly: false
metadata:
_comment: Supported speed will be available only for 2100 series devices
domain:
id: Global_UUID
name: Global
supportedSpeed: HUNDRED,TEN,THOUSAND,AUTO
timestamp: 1467048332483.0
mode: INLINE
name: GigabitEthernet1/1
nveOnly: false
overrideDefaultFragmentSetting:
chain: 24
size: 200
timeout: 5
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
powerOverEthernet:
consumptionWattage: 0
state: true
priority: 10
securityZone:
id: SecZoneUUID1
type: SecurityZone
type: PhysicalInterface
? 'Example 3 : PUT /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/physicalinterfaces/fmcAccessPhyIntfId1
( PUT method for FTD physical interface for a given UUID on a FMC Access supported device )'
: value:
LLDP:
receive: false
transmit: false
MTU: 1500
applicationMonitoring:
enable: true
arpConfig:
- enableAlias: false
ipAddress: 101.101.101.101/25
macAddress: 03DC.1234.2323
description: Interface description
enableAntiSpoofing: false
enableSGTPropagate: true
enabled: false
fmcAccessConfig:
allowedNetworks:
- id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
enableAccess: true
hardware:
autoNegState: false
duplex: FULL
flowControlSend: 'OFF'
speed: THOUSAND
id: fmcAccessPhyIntfId1
ifname: Intf1
ipv4:
dhcp:
dhcpRouteMetric: 1
enableDefaultRouteDHCP: 'true'
pppoe:
enableRouteSettings: true
ipAddress: 1.2.3.4/25
pppAuth: < PAP | CHAP | MSCHAP>
pppoePassword: User_password
pppoeRouteMetric: 1
pppoeUser: User_name
storeCredsInFlash: false
vpdnGroupName: VPDN_group_name
static:
address: 1.2.3.4
netmask: '25'
ipv6:
addresses:
- address: '2001'
enforceEUI64: false
prefix: '124'
- address: '8080'
enforceEUI64: true
prefix: '12'
dadAttempts: 1
enableAutoConfig: true
enableDHCPAddrConfig: true
enableDHCPNonAddrConfig: false
enableIPV6: true
enableIPV6DadLoopbackDetect: true
enableRA: false
enforceEUI64: false
linkLocalAddress: 'FE80::'
nsInterval: 10000
prefixes:
- address: 2001::/124
advertisement:
autoConfig: false
offlink: false
preferLifeTime:
duration:
preferLifetime: 604800
validLifeTime: 2592300.0
expirationLifeTime:
preferDateTime: '2016-11-05T08:15:30.000Z'
validDateTime: '2016-12-05T08:15:30.000Z'
default: false
raInterval: 200
raLifeTime: 1800
reachableTime: 0
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/deviceUUID/physicalinterfaces/PhyIntfId1
managementAccess: false
managementOnly: false
metadata:
_comment: Supported speed will be available only for 2100 series devices
domain:
id: Global_UUID
name: Global
supportedSpeed: HUNDRED,TEN,THOUSAND,AUTO
timestamp: 1467048332483.0
mode: INLINE
name: GigabitEthernet1/1
nveOnly: false
overrideDefaultFragmentSetting:
chain: 24
size: 200
timeout: 5
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
powerOverEthernet:
consumptionWattage: 0
state: true
priority: 10
securityZone:
id: SecZoneUUID1
type: SecurityZone
type: PhysicalInterface
? 'Example 4 : PUT /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/physicalinterfaces/PhyIntfId1
( PUT method for FTD physical interface for a given UUID: TRUNK mode Interface in L2 Switching Enabled Device
)'
: value:
LLDP:
receive: false
transmit: false
description: Interface description
enabled: false
id: InterfaceUUID
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/deviceUUID/physicalinterfaces/PhyIntfId1
metadata:
domain:
id: Global_UUID
name: Global
isSupervisorProvisioned: 'false'
timestamp: '1467048332483'
mode: SWITCHPORT
name: GigabitEthernet0/1
nveOnly: false
powerOverEthernet:
consumptionWattage: 0
state: true
switchPortConfig:
portMode: TRUNK
protectedEnabled: true
trunkModeAllowedVlanIds: 2-10
trunkModeNativeVlanId: 1
type: PhysicalInterface
? 'Example 5 : PUT /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/physicalinterfaces/PhyIntfId1
( PUT method for FTD physical interface for a given UUID: ACCESS mode Interface in L2 Switching Enabled
Device )'
: value:
LLDP:
receive: false
transmit: false
description: Interface description
enabled: false
id: InterfaceUUID
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/deviceUUID/physicalinterfaces/PhyIntfId1
metadata:
domain:
id: Global_UUID
name: Global
isSupervisorProvisioned: 'false'
timestamp: '1467048332483'
mode: SWITCHPORT
name: GigabitEthernet0/1
nveOnly: false
powerOverEthernet:
consumptionWattage: 0
state: true
switchPortConfig:
accessModeVlanId: 2
portMode: ACCESS
protectedEnabled: true
type: PhysicalInterface
schema:
$ref: '#/components/schemas/FTDPhysicalInterface'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/redundantinterfaces:
get:
deprecated: false
description: '**Get the list of all redundant interfaces associated with the specified NGFW device ID. More details on netmod events(out of sync interfaces): GET /interfaceevents
.**'
operationId: getAllFTDRedundantInterface
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/redundantinterfaces
( Success: Test GET ALL success )'
: value:
items:
- id: '1'
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/redundantinterfaces/redundantinterfaceUUID1
name: s1p3.1
type: RedundantInterface
- id: redundantinterfaceUUID2
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/redundantinterfaces/redundantinterfaceUUID2
name: s1p4.2
type: RedundantInterface
- id: redundantinterfaceUUID3
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/redundantinterfaces/redundantinterfaceUUID3
name: hybrid_1
type: RedundantInterface
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/redundantinterfaces?offset=0&limit=3
paging:
count: 3
limit: 3
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/redundantinterfaces/redundantinterfaceUUID?expanded=true
( Success: Test GET ALL success with expanded=true )'
: value:
items:
- MTU: 1500
applicationMonitoring: object
enableAntiSpoofing: false
enableSGTPropagate: true
enabled: true
id: redundant interface UUID
ifname: redInter1
ipv4:
static: {}
ipv6:
dadAttempts: 1
enableAutoConfig: false
enableDHCPAddrConfig: true
enableDHCPNonAddrConfig: false
enableIPV6: false
enableIPV6DadLoopbackDetect: true
enableRA: true
enforceEUI64: false
nsInterval: 1000
raInterval: 200
raLifeTime: 1800
reachableTime: 0
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/redundantinterfaces/redundantinterfaceUUID1
managementOnly: false
metadata:
domain:
id: domainUUID
name: Global
timestamp: 1462814174120.0
name: Redundant1
nveOnly: false
overrideDefaultFragmentSetting: {}
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
primaryInterface:
id: interface UUID
name: GigabitEthernet0/0
type: PhysicalInterface
priority: 10
redundantId: 1
secondaryInterface:
id: interface UUID
name: GigabitEthernet0/1
type: PhysicalInterface
type: RedundantInterface
- MTU: 1500
applicationMonitoring:
enable: true
enableAntiSpoofing: false
enableSGTPropagate: true
enabled: true
id: redundant interface UUID
ifname: redInter2
ipv4:
static: {}
ipv6:
dadAttempts: 1
enableAutoConfig: false
enableDHCPAddrConfig: true
enableDHCPNonAddrConfig: false
enableIPV6: false
enableIPV6DadLoopbackDetect: true
enableRA: true
enforceEUI64: false
nsInterval: 1000
raInterval: 200
raLifeTime: 1800
reachableTime: 0
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/redundantinterfaces/redundantinterfaceUUID2
managementOnly: false
metadata:
domain:
id: domainUUID
name: Global
timestamp: 1462814174120.0
name: Redundant2
nveOnly: false
overrideDefaultFragmentSetting: {}
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
primaryInterface:
id: interface UUID
name: GigabitEthernet0/2
type: PhysicalInterface
priority: 10
redundantId: 2
secondaryInterface:
id: interface UUID
name: GigabitEthernet0/3
type: PhysicalInterface
type: RedundantInterface
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/redundantinterfaces/redundantinterfaceUUID?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/FTDRedundantInterfaceListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**Create a redundant interface on the NGFW device. _Check the response section for applicable examples
(if any)._**'
operationId: createFTDRedundantInterface
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/FTDRedundantInterface'
type: object
description: The input redundant interface model.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/FTDRedundantInterface'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/redundantinterfaces/{objectId}:
delete:
deprecated: false
description: '**Delete the redundant interface associated with the specified NGFW device ID and interface ID. _Check
the response section for applicable examples (if any)._**'
operationId: deleteFTDRedundantInterface
parameters:
- description: Unique identifier of a redundant interface.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/redundantinterfaces/redundantinterfaceUUID
( Success: Test DELETE method for FTD redundant interface )'
: value:
MTU: 1500
applicationMonitoring: object
arpConfig:
- enableAlias: false
ipAddress: 101.101.101.101/25
macAddress: 03DC.1234.2323
enableAntiSpoofing: true
enableSGTPropagate: true
enabled: true
id: redundantInterfaceUUID
ifname: Intf_name
ipv4:
dhcp:
dhcpRouteMetric: 1
enableDefaultRouteDHCP: 'true'
pppoe:
enableRouteSettings: true
ipAddress: 1.2.3.4/25
pppAuth: < PAP | CHAP | MSCHAP>
pppoePassword: User_password
pppoeRouteMetric: 1
pppoeUser: User_name
storeCredsInFlash: false
vpdnGroupName: VPDN_group_name
static:
address: 1.2.3.4
netmask: '25'
ipv6:
addresses:
- address: '2001::'
enforceEUI64: false
prefix: '124'
- address: '8080::'
enforceEUI64: true
prefix: '12'
dadAttempts: 1
enableAutoConfig: true
enableDHCPAddrConfig: true
enableDHCPNonAddrConfig: false
enableIPV6: true
enableIPV6DadLoopbackDetect: true
enableRA: false
enforceEUI64: false
linkLocalAddress: 'FE80::'
nsInterval: 10000
prefixes:
- address: 2001::/124
advertisement:
autoConfig: false
offlink: false
preferLifeTime:
duration:
preferLifeTime: 604800
validLifeTime: 2592300.0
expirationLifeTime:
preferDateTime: '2016-11-05T08:15:30.000Z'
validDateTime: '2016-12-05T08:15:30.000Z'
default: false
raInterval: 200
raLifeTime: 1800
reachableTime: 0
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/redundantinterfaces/redundantinterfaceUUID
managementOnly: true
metadata:
activity: 0
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
link: 0
readOnly:
state: false
speed: -1
timestamp: 1458597038.0
name: Redundant1
nveOnly: false
overrideDefaultFragmentSetting:
chain: 24
size: 200
timeout: 5
pathMonitoring: object
primaryInterface:
id: primary_intf_id
name: GigabitEthernet0/0
type: PhysicalInterface
priority: 10
redundantId: 1
secondaryInterface:
id: secondary_intf_id
name: GigabitEthernet0/1
type: SecondaryInterface
securityZone:
id: sec_zone_id
type: SecurityZone
type: RedundantInterface
schema:
$ref: '#/components/schemas/FTDRedundantInterface'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
get:
deprecated: false
description: '**Get the redundant interface associated with the specified NGFW device ID and interface ID.**'
operationId: getFTDRedundantInterface
parameters:
- description: Unique identifier of a redundant interface.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/redundantinterfaces/redundantinterfaceUUID
( Success: Test GET method for fp logical interface )'
: value:
MTU: 1500
applicationMonitoring:
enable: true
monitoredApplications:
- id: '2325'
name: 050plus
type: Application
- id: '1553'
name: 1&1 Internet
type: Application
enableAntiSpoofing: false
enableSGTPropagate: true
enabled: true
id: 00000000-0000-0ed3-0000-206158430258
ifname: redInter
ipv4:
static: {}
ipv6:
dadAttempts: 1
enableAutoConfig: false
enableDHCPAddrConfig: true
enableDHCPNonAddrConfig: false
enableIPV6: false
enableIPV6DadLoopbackDetect: true
enableRA: true
enforceEUI64: false
nsInterval: 1000
raInterval: 200
raLifeTime: 1800
reachableTime: 0
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/redundantinterfaces/redundantinterfaceUUID
managementOnly: false
metadata:
activity: 0
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
link: 0
readOnly:
state: false
speed: -1
timestamp: 1458597038.0
name: Redundant4
nveOnly: false
overrideDefaultFragmentSetting: {}
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
primaryInterface:
id: interface UUID
name: GigabitEthernet0/0
type: PhysicalInterface
priority: 10
redundantId: 4
secondaryInterface:
id: interface UUID
name: GigabitEthernet0/1
type: PhysicalInterface
type: RedundantInterface
schema:
$ref: '#/components/schemas/FTDRedundantInterface'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**Modify the redundant interface associated with the specified NGFW device ID and interface ID. _Check
the response section for applicable examples (if any)._**'
operationId: updateFTDRedundantInterface
parameters:
- description: Unique identifier of a redundant interface.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/redundantinterfaces/redundantinterfaceUUID
( Success: Test PUT method for FTD redundant interface )'
: value:
MTU: 1500
arpConfig:
- enableAlias: false
ipAddress: 101.101.101.101/25
macAddress: 03DC.1234.2323
enableAntiSpoofing: true
enableSGTPropagate: true
enabled: true
id: redundantInterfaceUUID
ifname: Intf_name
ipv4:
dhcp:
dhcpRouteMetric: 1
enableDefaultRouteDHCP: 'true'
pppoe:
enableRouteSettings: true
ipAddress: 1.2.3.4/25
pppAuth: < PAP | CHAP | MSCHAP>
pppoePassword: User_password
pppoeRouteMetric: 1
pppoeUser: User_name
storeCredsInFlash: false
vpdnGroupName: VPDN_group_name
static:
address: 1.2.3.4
netmask: '25'
ipv6:
addresses:
- address: '2001::'
enforceEUI64: false
prefix: '124'
- address: '8080::'
enforceEUI64: true
prefix: '12'
dadAttempts: 1
enableAutoConfig: true
enableDHCPAddrConfig: true
enableDHCPNonAddrConfig: false
enableIPV6: true
enableIPV6DadLoopbackDetect: true
enableRA: false
enforceEUI64: false
linkLocalAddress: 'FE80::'
nsInterval: 10000
prefixes:
- address: 2001::/124
advertisement:
autoConfig: false
offlink: false
preferLifeTime:
duration:
preferLifeTime: 604800
validLifeTime: 2592300.0
expirationLifeTime:
preferDateTime: '2016-11-05T08:15:30.000Z'
validDateTime: '2016-12-05T08:15:30.000Z'
default: false
raInterval: 200
raLifeTime: 1800
reachableTime: 0
managementOnly: true
name: Redundant1
nveOnly: false
overrideDefaultFragmentSetting:
chain: 24
size: 200
timeout: 5
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
primaryInterface:
id: primary_intf_id
name: GigabitEthernet0/0
type: PhysicalInterface
priority: 10
redundantId: 1
secondaryInterface:
id: secondary_intf_id
name: GigabitEthernet0/1
type: SecondaryInterface
securityZone:
id: sec_zone_id
type: SecurityZone
type: RedundantInterface
schema:
$ref: '#/components/schemas/FTDRedundantInterface'
type: object
description: The input redundant interface model.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/redundantinterfaces/redundantinterfaceUUID
( Success: Test PUT method for FTD redundant interface )'
: value:
MTU: 1500
arpConfig:
- enableAlias: false
ipAddress: 101.101.101.101/25
macAddress: 03DC.1234.2323
enableAntiSpoofing: true
enableSGTPropagate: true
enabled: true
id: redundantInterfaceUUID
ifname: Intf_name
ipv4:
dhcp:
dhcpRouteMetric: 1
enableDefaultRouteDHCP: 'true'
pppoe:
enableRouteSettings: true
ipAddress: 1.2.3.4/25
pppAuth: < PAP | CHAP | MSCHAP>
pppoePassword: User_password
pppoeRouteMetric: 1
pppoeUser: User_name
storeCredsInFlash: false
vpdnGroupName: VPDN_group_name
static:
address: 1.2.3.4
netmask: '25'
ipv6:
addresses:
- address: '2001::'
enforceEUI64: false
prefix: '124'
- address: '8080::'
enforceEUI64: true
prefix: '12'
dadAttempts: 1
enableAutoConfig: true
enableDHCPAddrConfig: true
enableDHCPNonAddrConfig: false
enableIPV6: true
enableIPV6DadLoopbackDetect: true
enableRA: false
enforceEUI64: false
linkLocalAddress: 'FE80::'
nsInterval: 10000
prefixes:
- address: 2001::/124
advertisement:
autoConfig: false
offlink: false
preferLifeTime:
duration:
preferLifeTime: 604800
validLifeTime: 2592300.0
expirationLifeTime:
preferDateTime: '2016-11-05T08:15:30.000Z'
validDateTime: '2016-12-05T08:15:30.000Z'
default: false
raInterval: 200
raLifeTime: 1800
reachableTime: 0
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/redundantinterfaces/redundantinterfaceUUID
managementOnly: true
metadata:
activity: 0
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
link: 0
readOnly:
state: false
speed: -1
timestamp: 1458597038.0
name: Redundant1
nveOnly: false
overrideDefaultFragmentSetting:
chain: 24
size: 200
timeout: 5
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
primaryInterface:
id: primary_intf_id
name: GigabitEthernet0/0
type: PhysicalInterface
priority: 10
redundantId: 1
secondaryInterface:
id: secondary_intf_id
name: GigabitEthernet0/1
type: SecondaryInterface
securityZone:
id: sec_zone_id
type: SecurityZone
type: RedundantInterface
schema:
$ref: '#/components/schemas/FTDRedundantInterface'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/bfdpolicies:
get:
deprecated: false
description: '**Get the list of all BFD policies.**'
operationId: getAllBFDPolicyModel
parameters:
- description: To filter BFD policies based on hop type, use hopType:{hopType}. Supported hop types are
Single-Hop and Multi-Hop.
To filter BFD policies objects based on IP type, use ipType:{ipType}.
Supported ip types are v4 and v6.
in: query
name: filter
required: false
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bfdpolicies?offset=0&limit=25
( Example payload for GET ALL on BFD )'
: value:
items:
- hopType: SINGLE_HOP
id: bfdPolicyUUid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bfdpolicies/bfdPolicyUUid
type: BFDPolicy
- destinationAddress:
id: network_object_uuid
name: IPv4-Benchmark-Tests2
type: Network
hopType: MULTI_HOP
id: bfdPolicyUUid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bfdpolicies/bfdPolicyUUid
sourceAddress:
id: network_object_uuid
name: IPv4-Benchmark-Tests1
type: Network
type: BFDPolicy
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bfdpolicies?offset=0&limit=25
paging:
count: 2
limit: 25
offset: 0
pages: 1
? 'Example 2 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bfdpolicies?expanded=true
( GET All BFD with ?expanded=true )'
: value:
items:
- hopType: SINGLE_HOP
id: bfdPolicyUUid
interface:
id: interface_uuid
name: GigabitEthernet1/1
type: PhysicalInterface
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bfdpolicies/bfdPolicyUUid
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
timestamp: 1657286461000.0
template:
id: template_uuid
name: SingleHopTemplate1
type: BFDTemplate
type: BFDPolicy
- destinationAddress:
id: network_object_uuid
name: IPv4-Benchmark-Tests2
type: Network
hopType: MULTI_HOP
id: bfdPolicyUUid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bfdpolicies/bfdPolicyUUid
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
ipType: V_4
timestamp: 1657286461000.0
sourceAddress:
id: network_object_uuid
name: IPv4-Benchmark-Tests1
type: Network
template:
id: template_uuid
name: MultiHopTemplate1
type: BFDTemplate
type: BFDPolicy
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bfdpolicies?expanded=true
paging:
count: 2
limit: 25
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/BFDPolicyModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**Create a BFD policy. _Check the response section for applicable examples (if any)._**'
operationId: createBFDPolicyModel
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bfdpolicies
( Example payload for POST SINGLE_HOP Policy on BFD. )'
: value:
hopType: SINGLE_HOP
interface:
id: interface_uuid
name: GigabitEthernet1/1
type: PhysicalInterface
template:
id: template_uuid
name: SingleHopTemplate1
type: BFDTemplate
type: BFDPolicy
? 'Example 2 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bfdpolicies
( Example payload for POST SINGLE_HOP Policy on BFD. )'
: value:
destinationAddress:
id: network_object_uuid
name: IPv4-Benchmark-Tests2
type: Network
hopType: MULTI_HOP
sourceAddress:
id: network_object_uuid
name: IPv4-Benchmark-Tests1
type: Network
template:
id: template_uuid
name: MultiHopTemplate1
type: BFDTemplate
type: BFDPolicy
schema:
$ref: '#/components/schemas/BFDPolicyModel'
type: object
description: The input BFD policy model.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bfdpolicies
( Example payload for POST SINGLE_HOP Policy on BFD. )'
: value:
hopType: SINGLE_HOP
id: bfdPolicyUUid
interface:
id: interface_uuid
name: GigabitEthernet1/1
type: PhysicalInterface
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bfdpolicies/bfdPolicyUUid
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
timestamp: 1657286461000.0
template:
id: template_uuid
name: SingleHopTemplate1
type: BFDTemplate
type: BFDPolicy
? 'Example 2 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bfdpolicies
( Example payload for POST SINGLE_HOP Policy on BFD. )'
: value:
destinationAddress:
id: network_object_uuid
name: IPv4-Benchmark-Tests2
type: Network
hopType: MULTI_HOP
id: bfdPolicyUUid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bfdpolicies/bfdPolicyUUid
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
ipType: V_4
timestamp: 1657286461000.0
sourceAddress:
id: network_object_uuid
name: IPv4-Benchmark-Tests1
type: Network
template:
id: template_uuid
name: MultiHopTemplate1
type: BFDTemplate
type: BFDPolicy
schema:
$ref: '#/components/schemas/BFDPolicyModel'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/bfdpolicies/{objectId}:
delete:
deprecated: false
description: '**Delete the BFD policy associated with the specified ID. _Check the response section for applicable examples
(if any)._**'
operationId: deleteBFDPolicyModel
parameters:
- description: Unique identifier of a BFD policy.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bfdpolicies/bfdPolicyUUid
( Example payload for DELETE SINGLE_HOP on BFD. )'
: value:
hopType: SINGLE_HOP
id: bfdPolicyUUid
interface:
id: interface_uuid
name: GigabitEthernet1/1
type: PhysicalInterface
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bfdpolicies/bfdPolicyUUid
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
timestamp: 1657286461000.0
template:
id: template_uuid
name: SingleHopTemplate1
type: BFDTemplate
type: BFDPolicy
? 'Example 2 : DELETE /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bfdpolicies/bfdPolicyUUid
( Example payload for DELETE MULTI_HOP on BFD. )'
: value:
destinationAddress:
id: network_object_uuid
name: IPv4-Benchmark-Tests2
type: Network
hopType: MULTI_HOP
id: bfdPolicyUUid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bfdpolicies/bfdPolicyUUid
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
ipType: V_4
timestamp: 1657286461000.0
sourceAddress:
id: network_object_uuid
name: IPv4-Benchmark-Tests1
type: Network
template:
id: template_uuid
name: MultiHopTemplate1
type: BFDTemplate
type: BFDPolicy
schema:
$ref: '#/components/schemas/BFDPolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
get:
deprecated: false
description: '**Get the BFD policy associated with the specified ID.**'
operationId: getBFDPolicyModel
parameters:
- description: Unique identifier of a BFD policy.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bfdpolicies/bfdPolicyUUid
( Example payload for GET SINGLE_HOP Policy on BFD )'
: value:
hopType: SINGLE_HOP
id: bfdPolicyUUid
interface:
id: interface_uuid
name: GigabitEthernet1/1
type: PhysicalInterface
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bfdpolicies/bfdPolicyUUid
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
timestamp: 1657286461000.0
template:
id: template_uuid
name: SingleHopTemplate1
type: BFDTemplate
type: BFDPolicy
? 'Example 2 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bfdpolicies/bfdPolicyUUid
( Example payload for GET MULTI_HOP Policy on BFD )'
: value:
destinationAddress:
id: network_object_uuid
name: IPv4-Benchmark-Tests2
type: Network
hopType: MULTI_HOP
id: bfdPolicyUUid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bfdpolicies/bfdPolicyUUid
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
ipType: V_4
timestamp: 1657286461000.0
sourceAddress:
id: network_object_uuid
name: IPv4-Benchmark-Tests1
type: Network
template:
id: template_uuid
name: MultiHopTemplate1
type: BFDTemplate
type: BFDPolicy
schema:
$ref: '#/components/schemas/BFDPolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**Modify the BFD policy associated with the specified ID. _Check the response section for applicable examples
(if any)._**'
operationId: updateBFDPolicyModel
parameters:
- description: Unique identifier of a BFD policy.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bfdpolicies/bfdPolicyUUid
( Example payload for PUT SINGLE_HOP on BFD. )'
: value:
hopType: SINGLE_HOP
id: bfdPolicyUUid
interface:
id: interface_uuid
name: GigabitEthernet1/1
type: PhysicalInterface
template:
id: template_uuid
name: SingleHopTemplate1
type: BFDTemplate
type: BFDPolicy
? 'Example 2 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bfdpolicies/bfdPolicyUUid
( Example payload for PUT MULTI_HOP on BFD. )'
: value:
destinationAddress:
id: network_object_uuid
name: IPv4-Benchmark-Tests2
type: Network
hopType: MULTI_HOP
id: bfdPolicyUUid
sourceAddress:
id: network_object_uuid
name: IPv4-Benchmark-Tests1
type: Network
template:
id: template_uuid
name: MultiHopTemplate1
type: BFDTemplate
type: BFDPolicy
schema:
$ref: '#/components/schemas/BFDPolicyModel'
type: object
description: The input BFD policy model.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bfdpolicies/bfdPolicyUUid
( Example payload for PUT SINGLE_HOP on BFD. )'
: value:
hopType: SINGLE_HOP
id: bfdPolicyUUid
interface:
id: interface_uuid
name: GigabitEthernet1/1
type: PhysicalInterface
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bfdpolicies/bfdPolicyUUid
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
timestamp: 1657286461000.0
template:
id: template_uuid
name: SingleHopTemplate1
type: BFDTemplate
type: BFDPolicy
? 'Example 2 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bfdpolicies/bfdPolicyUUid
( Example payload for PUT MULTI_HOP on BFD. )'
: value:
destinationAddress:
id: network_object_uuid
name: IPv4-Benchmark-Tests2
type: Network
hopType: MULTI_HOP
id: bfdPolicyUUid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bfdpolicies/bfdPolicyUUid
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
ipType: V_4
timestamp: 1657286461000.0
sourceAddress:
id: network_object_uuid
name: IPv4-Benchmark-Tests1
type: Network
template:
id: template_uuid
name: MultiHopTemplate1
type: BFDTemplate
type: BFDPolicy
schema:
$ref: '#/components/schemas/BFDPolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/bgp:
get:
deprecated: false
description: '**Get the list of all BGP (ipv4 and ipv6) associated with the specified device. When device is in multi
virtual router mode, this API is applicable to Global Virtual Router.**'
operationId: getAllBGPIPvAddressFamilyModel
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BGPIPvAddressFamilyModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**Create a BGP model. _Check the response section for applicable examples (if any)._**'
operationId: createBGPIPvAddressFamilyModel
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bgp ( Example
payload for POST on bgp. )'
: value:
addressFamilyIPv4:
aftableMap: RouteMap
aggregateTimer: Integer
bgpNextHopTriggerDelay: Integer
bgpNextHopTriggerEnable: boolean
bgpRedistributeInternal: boolean
bgpSupressInactive: boolean
defaultInformationOrginate: boolean
distance:
externalDistance: Integer
internalDistance: Integer
localDistance: Integer
type: afbgpdistance
distributeLists:
- accessList: StandardAccessList
type: incomingroutefilter
- accessList: StandardAccessList
protocol: FilterProtocol Object
type: outgoingroutefilter
maximumPaths:
- ibgp: boolean
type: afmaximumpaths
value: Integer
neighbors:
- ipv4Address: String
neighborAdvanced:
neighborHops:
disableConnectedCheck: boolean
maxHopCount: Integer
neighborTtlSecurityHops: Integer
type: neighborebgpmultihop or neighborttlsecurityhops
neighborSecret: Secret
neighborTransportConnectionMode:
establishTCPSession: boolean
type: neighbortransportconnectionmode
neighborTransportPathMTUDiscovery:
disable: boolean
type: neighbortransportpathmtudiscovery
neighborVersion: Integer
neighborWeight: Integer
nextHopSelf: boolean
sendCommunity: boolean
type: neighboradvanced
neighborFiltering:
ipv4PrefixListFilter:
- filterUpdateAction: '[IN/OUT]'
ipv4PrefixList: IPV4PrefixList
type: neighborprefixlist
neighborDefaultOriginate:
routeMap: RouteMap
type: neighbordefaultoriginate
neighborDistributeLists:
- accessList: AccessList
filterUpdateAction: '[IN/OUT]'
id: uuid of accessList
type: neighbordistributelist
neighborFilterList:
- asPathList: asPath
filterUpdateAction: '[IN/OUT]'
type: neighborfilterlist
neighborMaximumPrefix:
maxPrefixLimit: long
restartInterval: Integer
thresholdValue: Integer
type: neighbormaximumprefix
warningOnly: boolean
neighborRouteMap:
- filterUpdateAction: '[IN/OUT]'
routeMap: RouteMap
type: neighborroutemap
neighborGeneral:
description: 'String '
fallOverBFD: SINGLE_HOP | MULTI_HOP | AUTO_DETECT_HOP | NONE
shutdown: boolean
type: neighborgeneral
updateSource:
id: interfacePolicyUUID
name: String
type: LoopbackInterface
neighborHaMode:
disable: boolean
type: neighborhamode
neighborLocalAs:
asNumber: String
dualAs: boolean
noPrepend: boolean
replaceAs: boolean
type: neighborlocalas
neighborRoutes:
advertisementInterval: Integer
neighborAdvertiseMaps:
- existMap: boolean
existRouteMap: RouteMap
routeMap: RouteMap
type: neighboradvertisemap
removePrivateAs: boolean
neighborTimers:
holdTime: Integer
keepAliveInterval: Integer
minimumHoldTime: Integer
type: neighbortimers
remoteAs: String
type: neighboripv4
redistributeProtocols:
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributestatic
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributeconnected
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributerip
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributebgp
- matchExternal1: boolean
matchExternal2: boolean
matchInternal: boolean
matchNssaExternal1: boolean
matchNssaExternal2: boolean
processId: string
routeMap: routemap
routeMetric:
metricValue: long
type: redistributeospf
scanTime: Integer
synchronization: boolean
type: afipv4
addressFamilyIPv6:
aftableMap: RouteMap
aggregateTimer: Integer
bgpNextHopTriggerDelay: Integer
bgpNextHopTriggerEnable: boolean
bgpRedistributeInternal: boolean
bgpSupressInactive: boolean
defaultInformationOrginate: boolean
distance:
externalDistance: Integer
internalDistance: Integer
localDistance: Integer
type: afbgpdistance
maximumPaths:
- ibgp: boolean
type: afmaximumpaths
value: Integer
neighbors:
- ipv6Address: String
ipv6Prefix: String
linkLocalInterface: interface
neighborAdvanced:
neighborHops:
disableConnectedCheck: boolean
maxHopCount: Integer
neighborTtlSecurityHops: Integer
type: neighborebgpmultihop or neighborttlsecurityhops
neighborSecret: Secret
neighborTransportConnectionMode:
establishTCPSession: boolean
type: neighbortransportconnectionmode
neighborTransportPathMTUDiscovery:
disable: boolean
type: neighbortransportpathmtudiscovery
neighborVersion: Integer
neighborWeight: Integer
nextHopSelf: boolean
sendCommunity: boolean
type: neighboradvanced
neighborFiltering:
ipv4PrefixListFilter:
- filterUpdateAction: '[IN/OUT]'
ipv4PrefixList: IPV4PrefixList
type: neighborprefixlist
neighborDefaultOriginate:
routeMap: RouteMap
type: neighbordefaultoriginate
neighborDistributeLists:
- accessList: AccessList
filterUpdateAction: '[IN/OUT]'
id: uuid of accessList
type: neighbordistributelist
neighborFilterList:
- asPathList: asPath
filterUpdateAction: '[IN/OUT]'
type: neighborfilterlist
neighborMaximumPrefix:
maxPrefixLimit: long
restartInterval: Integer
thresholdValue: Integer
type: neighbormaximumprefix
warningOnly: boolean
neighborRouteMap:
- filterUpdateAction: '[IN/OUT]'
routeMap: RouteMap
type: neighborroutemap
neighborGeneral:
description: 'String '
fallOverBFD: SINGLE_HOP | MULTI_HOP | AUTO_DETECT_HOP | NONE
shutdown: boolean
type: neighborgeneral
updateSource:
id: interfacePolicyUUID
name: String
type: LoopbackInterface
neighborHaMode:
disable: boolean
type: neighborhamode
neighborLocalAs:
asNumber: String
dualAs: boolean
noPrepend: boolean
replaceAs: boolean
type: neighborlocalas
neighborRoutes:
advertisementInterval: Integer
neighborAdvertiseMaps:
- existMap: boolean
existRouteMap: RouteMap
routeMap: RouteMap
type: neighboradvertisemap
removePrivateAs: boolean
neighborTimers:
holdTime: Integer
keepAliveInterval: Integer
minimumHoldTime: Integer
type: neighbortimers
remoteAs: String
type: neighboripv6
redistributeProtocols:
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributestatic
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributeconnected
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributerip
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributebgp
- matchExternal1: boolean
matchExternal2: boolean
matchInternal: boolean
matchNssaExternal1: boolean
matchNssaExternal2: boolean
processId: string
routeMap: routemap
routeMetric:
metricValue: long
type: redistributeospf
scanTime: Integer
synchronization: boolean
type: afipv6
asNumber: String
name: String
routerId: String
type: bgp
schema:
$ref: '#/components/schemas/BGPIPvAddressFamilyModel'
type: object
description: The input BGP (ipv4 and ipv6) model.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bgp ( Example
payload for POST on bgp. )'
: value:
addressFamilyIPv4:
aftableMap: RouteMap
aggregateTimer: Integer
bgpNextHopTriggerDelay: Integer
bgpNextHopTriggerEnable: boolean
bgpRedistributeInternal: boolean
bgpSupressInactive: boolean
defaultInformationOrginate: boolean
distance:
externalDistance: Integer
internalDistance: Integer
localDistance: Integer
type: afbgpdistance
distributeLists:
- accessList: StandardAccessList
type: incomingroutefilter
- accessList: StandardAccessList
protocol: FilterProtocol Object
type: outgoingroutefilter
id: uuid of ipv4 general settings
maximumPaths:
- ibgp: boolean
type: afmaximumpaths
value: Integer
neighbors:
- ipv4Address: String
neighborAdvanced:
neighborHops:
disableConnectedCheck: boolean
maxHopCount: Integer
neighborTtlSecurityHops: Integer
type: neighborebgpmultihop or neighborttlsecurityhops
neighborSecret: Secret
neighborTransportConnectionMode:
establishTCPSession: boolean
type: neighbortransportconnectionmode
neighborTransportPathMTUDiscovery:
disable: boolean
type: neighbortransportpathmtudiscovery
neighborVersion: Integer
neighborWeight: Integer
nextHopSelf: boolean
sendCommunity: boolean
type: neighboradvanced
neighborFiltering:
ipv4PrefixListFilter:
- filterUpdateAction: '[IN/OUT]'
ipv4PrefixList: IPV4PrefixList
type: neighborprefixlist
neighborDefaultOriginate:
routeMap: RouteMap
type: neighbordefaultoriginate
neighborDistributeLists:
- accessList: AccessList
filterUpdateAction: '[IN/OUT]'
id: uuid of accessList
type: neighbordistributelist
neighborFilterList:
- asPathList: asPath
filterUpdateAction: '[IN/OUT]'
type: neighborfilterlist
neighborMaximumPrefix:
maxPrefixLimit: long
restartInterval: Integer
thresholdValue: Integer
type: neighbormaximumprefix
warningOnly: boolean
neighborRouteMap:
- filterUpdateAction: '[IN/OUT]'
routeMap: RouteMap
type: neighborroutemap
neighborGeneral:
description: 'String '
fallOverBFD: SINGLE_HOP | MULTI_HOP | AUTO_DETECT_HOP | NONE
shutdown: boolean
type: neighborgeneral
updateSource:
id: interfacePolicyUUID
name: String
type: LoopbackInterface
neighborHaMode:
disable: boolean
type: neighborhamode
neighborLocalAs:
asNumber: String
dualAs: boolean
noPrepend: boolean
replaceAs: boolean
type: neighborlocalas
neighborRoutes:
advertisementInterval: Integer
neighborAdvertiseMaps:
- existMap: boolean
existRouteMap: RouteMap
routeMap: RouteMap
type: neighboradvertisemap
removePrivateAs: boolean
neighborTimers:
holdTime: Integer
keepAliveInterval: Integer
minimumHoldTime: Integer
type: neighbortimers
remoteAs: String
type: neighboripv4
redistributeProtocols:
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributestatic
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributeconnected
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributerip
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributebgp
- matchExternal1: boolean
matchExternal2: boolean
matchInternal: boolean
matchNssaExternal1: boolean
matchNssaExternal2: boolean
processId: string
routeMap: routemap
routeMetric:
metricValue: long
type: redistributeospf
scanTime: Integer
synchronization: boolean
type: afipv4
addressFamilyIPv6:
aftableMap: RouteMap
aggregateTimer: Integer
bgpNextHopTriggerDelay: Integer
bgpNextHopTriggerEnable: boolean
bgpRedistributeInternal: boolean
bgpSupressInactive: boolean
defaultInformationOrginate: boolean
distance:
externalDistance: Integer
internalDistance: Integer
localDistance: Integer
type: afbgpdistance
id: uuid of ipv6 general settings
maximumPaths:
- ibgp: boolean
type: afmaximumpaths
value: Integer
neighbors:
- ipv6Address: String
ipv6Prefix: String
linkLocalInterface: interface
neighborAdvanced:
neighborHops:
disableConnectedCheck: boolean
maxHopCount: Integer
neighborTtlSecurityHops: Integer
type: neighborebgpmultihop or neighborttlsecurityhops
neighborSecret: Secret
neighborTransportConnectionMode:
establishTCPSession: boolean
type: neighbortransportconnectionmode
neighborTransportPathMTUDiscovery:
disable: boolean
type: neighbortransportpathmtudiscovery
neighborVersion: Integer
neighborWeight: Integer
nextHopSelf: boolean
sendCommunity: boolean
type: neighboradvanced
neighborFiltering:
ipv4PrefixListFilter:
- filterUpdateAction: '[IN/OUT]'
ipv4PrefixList: IPV4PrefixList
type: neighborprefixlist
neighborDefaultOriginate:
routeMap: RouteMap
type: neighbordefaultoriginate
neighborDistributeLists:
- accessList: AccessList
filterUpdateAction: '[IN/OUT]'
id: uuid of accessList
type: neighbordistributelist
neighborFilterList:
- asPathList: asPath
filterUpdateAction: '[IN/OUT]'
type: neighborfilterlist
neighborMaximumPrefix:
maxPrefixLimit: long
restartInterval: Integer
thresholdValue: Integer
type: neighbormaximumprefix
warningOnly: boolean
neighborRouteMap:
- filterUpdateAction: '[IN/OUT]'
routeMap: RouteMap
type: neighborroutemap
neighborGeneral:
description: 'String '
fallOverBFD: SINGLE_HOP | MULTI_HOP | AUTO_DETECT_HOP | NONE
shutdown: boolean
type: neighborgeneral
updateSource:
id: interfacePolicyUUID
name: String
type: LoopbackInterface
neighborHaMode:
disable: boolean
type: neighborhamode
neighborLocalAs:
asNumber: String
dualAs: boolean
noPrepend: boolean
replaceAs: boolean
type: neighborlocalas
neighborRoutes:
advertisementInterval: Integer
neighborAdvertiseMaps:
- existMap: boolean
existRouteMap: RouteMap
routeMap: RouteMap
type: neighboradvertisemap
removePrivateAs: boolean
neighborTimers:
holdTime: Integer
keepAliveInterval: Integer
minimumHoldTime: Integer
type: neighbortimers
remoteAs: String
type: neighboripv6
redistributeProtocols:
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributestatic
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributeconnected
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributerip
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributebgp
- matchExternal1: boolean
matchExternal2: boolean
matchInternal: boolean
matchNssaExternal1: boolean
matchNssaExternal2: boolean
processId: string
routeMap: routemap
routeMetric:
metricValue: long
type: redistributeospf
scanTime: Integer
synchronization: boolean
type: afipv6
asNumber: String
id: bgpUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bgp/bgpUUID
name: String
routerId: String
type: bgp
schema:
$ref: '#/components/schemas/BGPIPvAddressFamilyModel'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/bgp/{objectId}:
delete:
deprecated: false
description: '**Delete the specified BGP model. _Check the response section for applicable examples (if any)._**'
operationId: deleteBGPIPvAddressFamilyModel
parameters:
- description: Unique identifier of a BGP (ipv4 or ipv6) model.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/virtualrouters/routing/bgp/bgpUUID
( Example payload for DELETE on bgp. )'
: value:
addressFamilyIPv4:
aftableMap: RouteMap
aggregateTimer: Integer
bgpNextHopTriggerDelay: Integer
bgpNextHopTriggerEnable: boolean
bgpRedistributeInternal: boolean
bgpSupressInactive: boolean
defaultInformationOrginate: boolean
distance:
externalDistance: Integer
internalDistance: Integer
localDistance: Integer
type: afbgpdistance
distributeLists:
- accessList: StandardAccessList
type: incomingroutefilter
- accessList: StandardAccessList
protocol: FilterProtocol Object
type: outgoingroutefilter
id: uuid of ipv4 general settings
maximumPaths:
- ibgp: boolean
type: afmaximumpaths
value: Integer
neighbors:
- ipv4Address: String
neighborAdvanced:
neighborHops:
disableConnectedCheck: boolean
maxHopCount: Integer
neighborTtlSecurityHops: Integer
type: neighborebgpmultihop or neighborttlsecurityhops
neighborSecret: Secret
neighborTransportConnectionMode:
establishTCPSession: boolean
type: neighbortransportconnectionmode
neighborTransportPathMTUDiscovery:
disable: boolean
type: neighbortransportpathmtudiscovery
neighborVersion: Integer
neighborWeight: Integer
nextHopSelf: boolean
sendCommunity: boolean
type: neighboradvanced
neighborFiltering:
ipv4PrefixListFilter:
- filterUpdateAction: '[IN/OUT]'
ipv4PrefixList: IPV4PrefixList
type: neighborprefixlist
neighborDefaultOriginate:
routeMap: RouteMap
type: neighbordefaultoriginate
neighborDistributeLists:
- accessList: AccessList
filterUpdateAction: '[IN/OUT]'
id: uuid of accessList
type: neighbordistributelist
neighborFilterList:
- asPathList: asPath
filterUpdateAction: '[IN/OUT]'
type: neighborfilterlist
neighborMaximumPrefix:
maxPrefixLimit: long
restartInterval: Integer
thresholdValue: Integer
type: neighbormaximumprefix
warningOnly: boolean
neighborRouteMap:
- filterUpdateAction: '[IN/OUT]'
routeMap: RouteMap
type: neighborroutemap
neighborGeneral:
description: 'String '
fallOverBFD: SINGLE_HOP | MULTI_HOP | AUTO_DETECT_HOP | NONE
shutdown: boolean
type: neighborgeneral
updateSource:
id: interfacePolicyUUID
name: String
type: LoopbackInterface
neighborHaMode:
disable: boolean
type: neighborhamode
neighborLocalAs:
asNumber: String
dualAs: boolean
noPrepend: boolean
replaceAs: boolean
type: neighborlocalas
neighborRoutes:
advertisementInterval: Integer
neighborAdvertiseMaps:
- existMap: boolean
existRouteMap: RouteMap
routeMap: RouteMap
type: neighboradvertisemap
removePrivateAs: boolean
neighborTimers:
holdTime: Integer
keepAliveInterval: Integer
minimumHoldTime: Integer
type: neighbortimers
remoteAs: String
type: neighboripv4
redistributeProtocols:
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributestatic
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributeconnected
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributerip
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributebgp
- matchExternal1: boolean
matchExternal2: boolean
matchInternal: boolean
matchNssaExternal1: boolean
matchNssaExternal2: boolean
processId: string
routeMap: routemap
routeMetric:
metricValue: long
type: redistributeospf
scanTime: Integer
synchronization: boolean
type: afipv4
addressFamilyIPv6:
aftableMap: RouteMap
aggregateTimer: Integer
bgpNextHopTriggerDelay: Integer
bgpNextHopTriggerEnable: boolean
bgpRedistributeInternal: boolean
bgpSupressInactive: boolean
defaultInformationOrginate: boolean
distance:
externalDistance: Integer
internalDistance: Integer
localDistance: Integer
type: afbgpdistance
id: uuid of ipv6 general settings
maximumPaths:
- ibgp: boolean
type: afmaximumpaths
value: Integer
neighbors:
- ipv6Address: String
ipv6Prefix: String
linkLocalInterface: interface
neighborAdvanced:
neighborHops:
disableConnectedCheck: boolean
maxHopCount: Integer
neighborTtlSecurityHops: Integer
type: neighborebgpmultihop or neighborttlsecurityhops
neighborSecret: Secret
neighborTransportConnectionMode:
establishTCPSession: boolean
type: neighbortransportconnectionmode
neighborTransportPathMTUDiscovery:
disable: boolean
type: neighbortransportpathmtudiscovery
neighborVersion: Integer
neighborWeight: Integer
nextHopSelf: boolean
sendCommunity: boolean
type: neighboradvanced
neighborFiltering:
ipv4PrefixListFilter:
- filterUpdateAction: '[IN/OUT]'
ipv4PrefixList: IPV4PrefixList
type: neighborprefixlist
neighborDefaultOriginate:
routeMap: RouteMap
type: neighbordefaultoriginate
neighborDistributeLists:
- accessList: AccessList
filterUpdateAction: '[IN/OUT]'
id: uuid of accessList
type: neighbordistributelist
neighborFilterList:
- asPathList: asPath
filterUpdateAction: '[IN/OUT]'
type: neighborfilterlist
neighborMaximumPrefix:
maxPrefixLimit: long
restartInterval: Integer
thresholdValue: Integer
type: neighbormaximumprefix
warningOnly: boolean
neighborRouteMap:
- filterUpdateAction: '[IN/OUT]'
routeMap: RouteMap
type: neighborroutemap
neighborGeneral:
description: 'String '
fallOverBFD: SINGLE_HOP | MULTI_HOP | AUTO_DETECT_HOP | NONE
shutdown: boolean
type: neighborgeneral
updateSource:
id: interfacePolicyUUID
name: String
type: LoopbackInterface
neighborHaMode:
disable: boolean
type: neighborhamode
neighborLocalAs:
asNumber: String
dualAs: boolean
noPrepend: boolean
replaceAs: boolean
type: neighborlocalas
neighborRoutes:
advertisementInterval: Integer
neighborAdvertiseMaps:
- existMap: boolean
existRouteMap: RouteMap
routeMap: RouteMap
type: neighboradvertisemap
removePrivateAs: boolean
neighborTimers:
holdTime: Integer
keepAliveInterval: Integer
minimumHoldTime: Integer
type: neighbortimers
remoteAs: String
type: neighboripv6
redistributeProtocols:
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributestatic
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributeconnected
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributerip
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributebgp
- matchExternal1: boolean
matchExternal2: boolean
matchInternal: boolean
matchNssaExternal1: boolean
matchNssaExternal2: boolean
processId: string
routeMap: routemap
routeMetric:
metricValue: long
type: redistributeospf
scanTime: Integer
synchronization: boolean
type: afipv6
asNumber: String
id: bgpUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bgp/bgpUUID
name: String
routerId: String
type: bgp
schema:
$ref: '#/components/schemas/BGPIPvAddressFamilyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
get:
deprecated: false
description: '**Get the specified BGP model.**'
operationId: getBGPIPvAddressFamilyModel
parameters:
- description: Unique identifier of a BGP (ipv4 or ipv6) model.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bgp?expanded=true
( Example payload for GET on bgp with expanded=true. )'
: value:
items:
- addressFamilyIPv4:
aftableMap: RouteMap
aggregateTimer: Integer
bgpNextHopTriggerDelay: Integer
bgpNextHopTriggerEnable: boolean
bgpRedistributeInternal: boolean
bgpSupressInactive: boolean
defaultInformationOrginate: boolean
distance:
externalDistance: Integer
internalDistance: Integer
localDistance: Integer
type: afbgpdistance
distributeLists:
- accessList: StandardAccessList
type: incomingroutefilter
- accessList: StandardAccessList
protocol: FilterProtocol Object
type: outgoingroutefilter
id: uuid of ipv4 general settings
maximumPaths:
- ibgp: boolean
type: afmaximumpaths
value: Integer
neighbors:
- ipv4Address: String
neighborAdvanced:
neighborHops:
disableConnectedCheck: boolean
maxHopCount: Integer
neighborTtlSecurityHops: Integer
type: neighborebgpmultihop or neighborttlsecurityhops
neighborSecret: Secret
neighborTransportConnectionMode:
establishTCPSession: boolean
type: neighbortransportconnectionmode
neighborTransportPathMTUDiscovery:
disable: boolean
type: neighbortransportpathmtudiscovery
neighborVersion: Integer
neighborWeight: Integer
nextHopSelf: boolean
sendCommunity: boolean
type: neighboradvanced
neighborFiltering:
ipv4PrefixListFilter:
- filterUpdateAction: '[IN/OUT]'
ipv4PrefixList: IPV4PrefixList
type: neighborprefixlist
neighborDefaultOriginate:
routeMap: RouteMap
type: neighbordefaultoriginate
neighborDistributeLists:
- accessList: accessList
filterUpdateAction: '[IN/OUT]'
type: neighbordistributelist
neighborFilterList:
- asPathList: asPath
filterUpdateAction: '[IN/OUT]'
type: neighborfilterlist
neighborMaximumPrefix:
maxPrefixLimit: long
restartInterval: Integer
thresholdValue: Integer
type: neighbormaximumprefix
warningOnly: boolean
neighborRouteMap:
- filterUpdateAction: '[IN/OUT]'
routeMap: RouteMap
type: neighborroutemap
neighborGeneral:
description: 'String '
fallOverBFD: SINGLE_HOP | MULTI_HOP | AUTO_DETECT_HOP | NONE
shutdown: boolean
type: neighborgeneral
updateSource:
id: interfacePolicyUUID
name: String
type: LoopbackInterface
neighborHaMode:
disable: boolean
type: neighborhamode
neighborLocalAs:
asNumber: String
dualAs: boolean
noPrepend: boolean
replaceAs: boolean
type: neighborlocalas
neighborRoutes:
advertisementInterval: Integer
neighborAdvertiseMaps:
- existMap: boolean
existRouteMap: RouteMap
routeMap: RouteMap
type: neighboradvertisemap
removePrivateAs: boolean
neighborTimers:
holdTime: Integer
keepAliveInterval: Integer
minimumHoldTime: Integer
type: neighbortimers
remoteAs: String
type: neighboripv4
redistributeProtocols:
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributestatic
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributeconnected
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributerip
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributebgp
- matchExternal1: boolean
matchExternal2: boolean
matchInternal: boolean
matchNssaExternal1: boolean
matchNssaExternal2: boolean
processId: string
routeMap: routemap
routeMetric:
metricValue: long
type: redistributeospf
scanTime: Integer
synchronization: boolean
type: afipv4
addressFamilyIPv6:
aftableMap: RouteMap
aggregateTimer: Integer
bgpNextHopTriggerDelay: Integer
bgpNextHopTriggerEnable: boolean
bgpRedistributeInternal: boolean
bgpSupressInactive: boolean
defaultInformationOrginate: boolean
distance:
externalDistance: Integer
internalDistance: Integer
localDistance: Integer
type: afbgpdistance
id: uuid of ipv6 general settings
maximumPaths:
- ibgp: boolean
type: afmaximumpaths
value: Integer
neighbors:
- ipv6Address: String
ipv6Prefix: String
linkLocalInterface: interface
neighborAdvanced:
neighborHops:
disableConnectedCheck: boolean
maxHopCount: Integer
neighborTtlSecurityHops: Integer
type: neighborebgpmultihop or neighborttlsecurityhops
neighborSecret: Secret
neighborTransportConnectionMode:
establishTCPSession: boolean
type: neighbortransportconnectionmode
neighborTransportPathMTUDiscovery:
disable: boolean
type: neighbortransportpathmtudiscovery
neighborVersion: Integer
neighborWeight: Integer
nextHopSelf: boolean
sendCommunity: boolean
type: neighboradvanced
neighborFiltering:
ipv4PrefixListFilter:
- filterUpdateAction: '[IN/OUT]'
ipv4PrefixList: IPV4PrefixList
type: neighborprefixlist
neighborDefaultOriginate:
routeMap: RouteMap
type: neighbordefaultoriginate
neighborDistributeLists:
- accessList: AccessList
filterUpdateAction: '[IN/OUT]'
id: uuid of accessList
type: neighbordistributelist
neighborFilterList:
- asPathList: asPath
filterUpdateAction: '[IN/OUT]'
type: neighborfilterlist
neighborMaximumPrefix:
maxPrefixLimit: long
restartInterval: Integer
thresholdValue: Integer
type: neighbormaximumprefix
warningOnly: boolean
neighborRouteMap:
- filterUpdateAction: '[IN/OUT]'
routeMap: RouteMap
type: neighborroutemap
neighborGeneral:
description: 'String '
fallOverBFD: SINGLE_HOP | MULTI_HOP | AUTO_DETECT_HOP | NONE
shutdown: boolean
type: neighborgeneral
updateSource:
id: interfacePolicyUUID
name: String
type: LoopbackInterface
neighborHaMode:
disable: boolean
type: neighborhamode
neighborLocalAs:
asNumber: String
dualAs: boolean
noPrepend: boolean
replaceAs: boolean
type: neighborlocalas
neighborRoutes:
advertisementInterval: Integer
neighborAdvertiseMaps:
- existMap: boolean
existRouteMap: RouteMap
routeMap: RouteMap
type: neighboradvertisemap
removePrivateAs: boolean
neighborTimers:
holdTime: Integer
keepAliveInterval: Integer
minimumHoldTime: Integer
type: neighbortimers
remoteAs: String
type: neighboripv6
redistributeProtocols:
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributestatic
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributeconnected
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributerip
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributebgp
- matchExternal1: boolean
matchExternal2: boolean
matchInternal: boolean
matchNssaExternal1: boolean
matchNssaExternal2: boolean
processId: string
routeMap: routemap
routeMetric:
metricValue: long
type: redistributeospf
scanTime: Integer
synchronization: boolean
type: afipv6
asNumber: String
id: bgpUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bgp/bgpUUID
name: String
routerId: String
type: bgp
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bgp?offset=0&limit=2&expanded=true
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/BGPIPvAddressFamilyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**Modify the specified BGP model. _Check the response section for applicable examples (if any)._**'
operationId: updateBGPIPvAddressFamilyModel
parameters:
- description: Unique identifier of a BGP (ipv4 or ipv6) model.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/virtualrouters/routing/bgp/bgpUUID
( Example payload for PUT on bgp general settings. )'
: value:
addressFamilyIPv4:
aftableMap: RouteMap
aggregateTimer: Integer
bgpNextHopTriggerDelay: Integer
bgpNextHopTriggerEnable: boolean
bgpRedistributeInternal: boolean
bgpSupressInactive: boolean
defaultInformationOrginate: boolean
distance:
externalDistance: Integer
internalDistance: Integer
localDistance: Integer
type: afbgpdistance
distributeLists:
- accessList: StandardAccessList
type: incomingroutefilter
- accessList: StandardAccessList
protocol: FilterProtocol Object
type: outgoingroutefilter
id: uuid of ipv4 general settings
maximumPaths:
- ibgp: boolean
type: afmaximumpaths
value: Integer
neighbors:
- ipv4Address: String
neighborAdvanced:
neighborHops:
disableConnectedCheck: boolean
maxHopCount: Integer
neighborTtlSecurityHops: Integer
type: neighborebgpmultihop or neighborttlsecurityhops
neighborSecret: Secret
neighborTransportConnectionMode:
establishTCPSession: boolean
type: neighbortransportconnectionmode
neighborTransportPathMTUDiscovery:
disable: boolean
type: neighbortransportpathmtudiscovery
neighborVersion: Integer
neighborWeight: Integer
nextHopSelf: boolean
sendCommunity: boolean
type: neighboradvanced
neighborFiltering:
ipv4PrefixListFilter:
- filterUpdateAction: '[IN/OUT]'
ipv4PrefixList: IPV4PrefixList
type: neighborprefixlist
neighborDefaultOriginate:
routeMap: RouteMap
type: neighbordefaultoriginate
neighborDistributeLists:
- accessList: AccessList
filterUpdateAction: '[IN/OUT]'
id: uuid of accessList
type: neighbordistributelist
neighborFilterList:
- asPathList: asPath
filterUpdateAction: '[IN/OUT]'
type: neighborfilterlist
neighborMaximumPrefix:
maxPrefixLimit: long
restartInterval: Integer
thresholdValue: Integer
type: neighbormaximumprefix
warningOnly: boolean
neighborRouteMap:
- filterUpdateAction: '[IN/OUT]'
routeMap: RouteMap
type: neighborroutemap
neighborGeneral:
description: 'String '
fallOverBFD: SINGLE_HOP | MULTI_HOP | AUTO_DETECT_HOP | NONE
shutdown: boolean
type: neighborgeneral
updateSource:
id: interfacePolicyUUID
name: String
type: LoopbackInterface
neighborHaMode:
disable: boolean
type: neighborhamode
neighborLocalAs:
asNumber: String
dualAs: boolean
noPrepend: boolean
replaceAs: boolean
type: neighborlocalas
neighborRoutes:
advertisementInterval: Integer
neighborAdvertiseMaps:
- existMap: boolean
existRouteMap: RouteMap
routeMap: RouteMap
type: neighboradvertisemap
removePrivateAs: boolean
neighborTimers:
holdTime: Integer
keepAliveInterval: Integer
minimumHoldTime: Integer
type: neighbortimers
remoteAs: String
type: neighboripv4
redistributeProtocols:
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributestatic
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributeconnected
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributerip
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributebgp
- matchExternal1: boolean
matchExternal2: boolean
matchInternal: boolean
matchNssaExternal1: boolean
matchNssaExternal2: boolean
processId: string
routeMap: routemap
routeMetric:
metricValue: long
type: redistributeospf
scanTime: Integer
synchronization: boolean
type: afipv4
addressFamilyIPv6:
aftableMap: RouteMap
aggregateTimer: Integer
bgpNextHopTriggerDelay: Integer
bgpNextHopTriggerEnable: boolean
bgpRedistributeInternal: boolean
bgpSupressInactive: boolean
defaultInformationOrginate: boolean
distance:
externalDistance: Integer
internalDistance: Integer
localDistance: Integer
type: afbgpdistance
id: uuid of ipv6 general settings
maximumPaths:
- ibgp: boolean
type: afmaximumpaths
value: Integer
neighbors:
- ipv6Address: String
ipv6Prefix: String
linkLocalInterface: interface
neighborAdvanced:
neighborHops:
disableConnectedCheck: boolean
maxHopCount: Integer
neighborTtlSecurityHops: Integer
type: neighborebgpmultihop or neighborttlsecurityhops
neighborSecret: Secret
neighborTransportConnectionMode:
establishTCPSession: boolean
type: neighbortransportconnectionmode
neighborTransportPathMTUDiscovery:
disable: boolean
type: neighbortransportpathmtudiscovery
neighborVersion: Integer
neighborWeight: Integer
nextHopSelf: boolean
sendCommunity: boolean
type: neighboradvanced
neighborFiltering:
ipv4PrefixListFilter:
- filterUpdateAction: '[IN/OUT]'
ipv4PrefixList: IPV4PrefixList
type: neighborprefixlist
neighborDefaultOriginate:
routeMap: RouteMap
type: neighbordefaultoriginate
neighborDistributeLists:
- accessList: AccessList
filterUpdateAction: '[IN/OUT]'
id: uuid of accessList
type: neighbordistributelist
neighborFilterList:
- asPathList: asPath
filterUpdateAction: '[IN/OUT]'
type: neighborfilterlist
neighborMaximumPrefix:
maxPrefixLimit: long
restartInterval: Integer
thresholdValue: Integer
type: neighbormaximumprefix
warningOnly: boolean
neighborRouteMap:
- filterUpdateAction: '[IN/OUT]'
routeMap: RouteMap
type: neighborroutemap
neighborGeneral:
description: 'String '
fallOverBFD: SINGLE_HOP | MULTI_HOP | AUTO_DETECT_HOP | NONE
shutdown: boolean
type: neighborgeneral
updateSource:
id: interfacePolicyUUID
name: String
type: LoopbackInterface
neighborHaMode:
disable: boolean
type: neighborhamode
neighborLocalAs:
asNumber: String
dualAs: boolean
noPrepend: boolean
replaceAs: boolean
type: neighborlocalas
neighborRoutes:
advertisementInterval: Integer
neighborAdvertiseMaps:
- existMap: boolean
existRouteMap: RouteMap
routeMap: RouteMap
type: neighboradvertisemap
removePrivateAs: boolean
neighborTimers:
holdTime: Integer
keepAliveInterval: Integer
minimumHoldTime: Integer
type: neighbortimers
remoteAs: String
type: neighboripv6
redistributeProtocols:
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributestatic
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributeconnected
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributerip
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributebgp
- matchExternal1: boolean
matchExternal2: boolean
matchInternal: boolean
matchNssaExternal1: boolean
matchNssaExternal2: boolean
processId: string
routeMap: routemap
routeMetric:
metricValue: long
type: redistributeospf
scanTime: Integer
synchronization: boolean
type: afipv6
asNumber: String
id: bgpUUID
name: String
routerId: String
type: bgp
schema:
$ref: '#/components/schemas/BGPIPvAddressFamilyModel'
type: object
description: The input BGP (ipv4 and ipv6) model.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/virtualrouters/routing/bgp/bgpUUID
( Example payload for PUT on bgp general settings. )'
: value:
addressFamilyIPv4:
aftableMap: RouteMap
aggregateTimer: Integer
bgpNextHopTriggerDelay: Integer
bgpNextHopTriggerEnable: boolean
bgpRedistributeInternal: boolean
bgpSupressInactive: boolean
defaultInformationOrginate: boolean
distance:
externalDistance: Integer
internalDistance: Integer
localDistance: Integer
type: afbgpdistance
distributeLists:
- accessList: StandardAccessList
type: incomingroutefilter
- accessList: StandardAccessList
protocol: FilterProtocol Object
type: outgoingroutefilter
id: uuid of ipv4 general settings
maximumPaths:
- ibgp: boolean
type: afmaximumpaths
value: Integer
neighbors:
- ipv4Address: String
neighborAdvanced:
neighborHops:
disableConnectedCheck: boolean
maxHopCount: Integer
neighborTtlSecurityHops: Integer
type: neighborebgpmultihop or neighborttlsecurityhops
neighborSecret: Secret
neighborTransportConnectionMode:
establishTCPSession: boolean
type: neighbortransportconnectionmode
neighborTransportPathMTUDiscovery:
disable: boolean
type: neighbortransportpathmtudiscovery
neighborVersion: Integer
neighborWeight: Integer
nextHopSelf: boolean
sendCommunity: boolean
type: neighboradvanced
neighborFiltering:
ipv4PrefixListFilter:
- filterUpdateAction: '[IN/OUT]'
ipv4PrefixList: IPV4PrefixList
type: neighborprefixlist
neighborDefaultOriginate:
routeMap: RouteMap
type: neighbordefaultoriginate
neighborDistributeLists:
- accessList: AccessList
filterUpdateAction: '[IN/OUT]'
id: uuid of accessList
type: neighbordistributelist
neighborFilterList:
- asPathList: asPath
filterUpdateAction: '[IN/OUT]'
type: neighborfilterlist
neighborMaximumPrefix:
maxPrefixLimit: long
restartInterval: Integer
thresholdValue: Integer
type: neighbormaximumprefix
warningOnly: boolean
neighborRouteMap:
- filterUpdateAction: '[IN/OUT]'
routeMap: RouteMap
type: neighborroutemap
neighborGeneral:
description: 'String '
fallOverBFD: SINGLE_HOP | MULTI_HOP | AUTO_DETECT_HOP | NONE
shutdown: boolean
type: neighborgeneral
updateSource:
id: interfacePolicyUUID
name: String
type: LoopbackInterface
neighborHaMode:
disable: boolean
type: neighborhamode
neighborLocalAs:
asNumber: String
dualAs: boolean
noPrepend: boolean
replaceAs: boolean
type: neighborlocalas
neighborRoutes:
advertisementInterval: Integer
neighborAdvertiseMaps:
- existMap: boolean
existRouteMap: RouteMap
routeMap: RouteMap
type: neighboradvertisemap
removePrivateAs: boolean
neighborTimers:
holdTime: Integer
keepAliveInterval: Integer
minimumHoldTime: Integer
type: neighbortimers
remoteAs: String
type: neighboripv4
redistributeProtocols:
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributestatic
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributeconnected
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributerip
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributebgp
- matchExternal1: boolean
matchExternal2: boolean
matchInternal: boolean
matchNssaExternal1: boolean
matchNssaExternal2: boolean
processId: string
routeMap: routemap
routeMetric:
metricValue: long
type: redistributeospf
scanTime: Integer
synchronization: boolean
type: afipv4
addressFamilyIPv6:
aftableMap: RouteMap
aggregateTimer: Integer
bgpNextHopTriggerDelay: Integer
bgpNextHopTriggerEnable: boolean
bgpRedistributeInternal: boolean
bgpSupressInactive: boolean
defaultInformationOrginate: boolean
distance:
externalDistance: Integer
internalDistance: Integer
localDistance: Integer
type: afbgpdistance
id: uuid of ipv6 general settings
maximumPaths:
- ibgp: boolean
type: afmaximumpaths
value: Integer
neighbors:
- ipv6Address: String
ipv6Prefix: String
linkLocalInterface: interface
neighborAdvanced:
neighborHops:
disableConnectedCheck: boolean
maxHopCount: Integer
neighborTtlSecurityHops: Integer
type: neighborebgpmultihop or neighborttlsecurityhops
neighborSecret: Secret
neighborTransportConnectionMode:
establishTCPSession: boolean
type: neighbortransportconnectionmode
neighborTransportPathMTUDiscovery:
disable: boolean
type: neighbortransportpathmtudiscovery
neighborVersion: Integer
neighborWeight: Integer
nextHopSelf: boolean
sendCommunity: boolean
type: neighboradvanced
neighborFiltering:
ipv4PrefixListFilter:
- filterUpdateAction: '[IN/OUT]'
ipv4PrefixList: IPV4PrefixList
type: neighborprefixlist
neighborDefaultOriginate:
routeMap: RouteMap
type: neighbordefaultoriginate
neighborDistributeLists:
- accessList: AccessList
filterUpdateAction: '[IN/OUT]'
id: uuid of accessList
type: neighbordistributelist
neighborFilterList:
- asPathList: asPath
filterUpdateAction: '[IN/OUT]'
type: neighborfilterlist
neighborMaximumPrefix:
maxPrefixLimit: long
restartInterval: Integer
thresholdValue: Integer
type: neighbormaximumprefix
warningOnly: boolean
neighborRouteMap:
- filterUpdateAction: '[IN/OUT]'
routeMap: RouteMap
type: neighborroutemap
neighborGeneral:
description: 'String '
fallOverBFD: SINGLE_HOP | MULTI_HOP | AUTO_DETECT_HOP | NONE
shutdown: boolean
type: neighborgeneral
updateSource:
id: interfacePolicyUUID
name: String
type: LoopbackInterface
neighborHaMode:
disable: boolean
type: neighborhamode
neighborLocalAs:
asNumber: String
dualAs: boolean
noPrepend: boolean
replaceAs: boolean
type: neighborlocalas
neighborRoutes:
advertisementInterval: Integer
neighborAdvertiseMaps:
- existMap: boolean
existRouteMap: RouteMap
routeMap: RouteMap
type: neighboradvertisemap
removePrivateAs: boolean
neighborTimers:
holdTime: Integer
keepAliveInterval: Integer
minimumHoldTime: Integer
type: neighbortimers
remoteAs: String
type: neighboripv6
redistributeProtocols:
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributestatic
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributeconnected
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributerip
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributebgp
- matchExternal1: boolean
matchExternal2: boolean
matchInternal: boolean
matchNssaExternal1: boolean
matchNssaExternal2: boolean
processId: string
routeMap: routemap
routeMetric:
metricValue: long
type: redistributeospf
scanTime: Integer
synchronization: boolean
type: afipv6
asNumber: String
id: bgpUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bgp/bgpUUID
name: String
routerId: String
type: bgp
schema:
$ref: '#/components/schemas/BGPIPvAddressFamilyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/bgpgeneralsettings:
get:
deprecated: false
description: '**Get BGP general settings associated with the specified device.**'
operationId: getAllBGPGeneralSettingModel
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BGPGeneralSettingModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**Create a BGP General Setting. _Check the response section for applicable examples (if any)._**'
operationId: createBGPGeneralSettingModel
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bgpgeneralsettings
( Example payload for POST on bgp general settings. )'
: value:
asNumber: String
asnotationDot: boolean
bestPath:
alwaysCompareMed: boolean
bestPathCompareRouterId: boolean
bestPathMedMissingAsWorst: boolean
defaultLocalPreferenceValue: Long
deterministicMed: boolean
type: bgpbestpath
bgpGracefulRestart:
gracefulRestart: boolean
gracefulRestartRestartTime: Integer
gracefulRestartStalePathTime: Integer
type: bgpgracefulrestart
bgptimers:
holdTime: Integer
keepAlive: Integer
minHoldTime: Integer
type: bgptimers
enforceFirstAs: boolean
fastExternalFallOver: boolean
logNeighborChanges: boolean
maxasLimit: Integer
name: String
transportPathMtuDiscovery: boolean
schema:
$ref: '#/components/schemas/BGPGeneralSettingModel'
type: object
description: The input BGP general settings model.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bgpgeneralsettings
( Example payload for POST on bgp general settings. )'
: value:
asNumber: String
asnotationDot: boolean
bestPath:
alwaysCompareMed: boolean
bestPathCompareRouterId: boolean
bestPathMedMissingAsWorst: boolean
defaultLocalPreferenceValue: Long
deterministicMed: boolean
type: bgpbestpath
bgpGracefulRestart:
gracefulRestart: boolean
gracefulRestartRestartTime: Integer
gracefulRestartStalePathTime: Integer
type: bgpgracefulrestart
bgptimers:
holdTime: Integer
keepAlive: Integer
minHoldTime: Integer
type: bgptimers
enforceFirstAs: boolean
fastExternalFallOver: boolean
id: bgpGeneralSettingsUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bgpgeneralsettings/bgpGeneralSettingsUUID
logNeighborChanges: boolean
maxasLimit: Integer
name: String
transportPathMtuDiscovery: boolean
schema:
$ref: '#/components/schemas/BGPGeneralSettingModel'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/bgpgeneralsettings/{objectId}
: delete:
deprecated: false
description: '**Delete the specified BGP General Setting. _Check the response section for applicable examples (if any)._**'
operationId: deleteBGPGeneralSettingModel
parameters:
- description: Unique identifier of a BGP general settings.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/virtualrouters/routing/bgpgeneralsettings/bgpGeneralSettingsUUID
( Example payload for DELETE on bgp general settings. )'
: value:
asNumber: String
asnotationDot: boolean
bestPath:
alwaysCompareMed: boolean
bestPathCompareRouterId: boolean
bestPathMedMissingAsWorst: boolean
defaultLocalPreferenceValue: Long
deterministicMed: boolean
type: bgpbestpath
bgpGracefulRestart:
gracefulRestart: boolean
gracefulRestartRestartTime: Integer
gracefulRestartStalePathTime: Integer
type: bgpgracefulrestart
bgptimers:
holdTime: Integer
keepAlive: Integer
minHoldTime: Integer
type: bgptimers
enforceFirstAs: boolean
fastExternalFallOver: boolean
id: bgpGeneralSettingsUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bgpgeneralsettings/bgpGeneralSettingsUUID
logNeighborChanges: boolean
maxasLimit: Integer
name: String
transportPathMtuDiscovery: boolean
schema:
$ref: '#/components/schemas/BGPGeneralSettingModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
get:
deprecated: false
description: '**Get the specified BGP General Setting.**'
operationId: getBGPGeneralSettingModel
parameters:
- description: Unique identifier of a BGP general settings.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bgpgeneralsettings
( Example payload for GET on bgp general settings. )'
: value:
items:
- id: bgpGeneralSettingsUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bgpgeneralsettings/bgpGeneralSettingsUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bgpgeneralsettings?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
? 'Example 2 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bgpgeneralsettings?expanded=true
( Example payload for GET on bgp general settings with ?expanded=true. )'
: value:
items:
- asNumber: String
asnotationDot: boolean
bestPath:
alwaysCompareMed: boolean
bestPathCompareRouterId: boolean
bestPathMedMissingAsWorst: boolean
defaultLocalPreferenceValue: Long
deterministicMed: boolean
type: bgpbestpath
bgpGracefulRestart:
gracefulRestart: boolean
gracefulRestartRestartTime: Integer
gracefulRestartStalePathTime: Integer
type: bgpgracefulrestart
bgptimers:
holdTime: Integer
keepAlive: Integer
minHoldTime: Integer
type: bgptimers
enforceFirstAs: boolean
fastExternalFallOver: boolean
id: bgpGeneralSettingsUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bgpgeneralsettings/bgpGeneralSettingsUUID
logNeighborChanges: boolean
maxasLimit: Integer
name: String
transportPathMtuDiscovery: boolean
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bgpgeneralsettings?offset=0&limit=2&expanded=true
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/BGPGeneralSettingModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**Modify the specified BGP General Setting. _Check the response section for applicable examples (if any)._**'
operationId: updateBGPGeneralSettingModel
parameters:
- description: Unique identifier of a BGP general settings.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/virtualrouters/routing/bgpgeneralsettings/bgpGeneralSettingsUUID
( Example payload for PUT on bgp general settings. )'
: value:
asNumber: String
asnotationDot: boolean
bestPath:
alwaysCompareMed: boolean
bestPathCompareRouterId: boolean
bestPathMedMissingAsWorst: boolean
defaultLocalPreferenceValue: Long
deterministicMed: boolean
type: bgpbestpath
bgpGracefulRestart:
gracefulRestart: boolean
gracefulRestartRestartTime: Integer
gracefulRestartStalePathTime: Integer
type: bgpgracefulrestart
bgptimers:
holdTime: Integer
keepAlive: Integer
minHoldTime: Integer
type: bgptimers
enforceFirstAs: boolean
fastExternalFallOver: boolean
id: bgpGeneralSettingsUUID
logNeighborChanges: boolean
maxasLimit: Integer
name: String
transportPathMtuDiscovery: boolean
schema:
$ref: '#/components/schemas/BGPGeneralSettingModel'
type: object
description: The input BGP general settings model.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/virtualrouters/routing/bgpgeneralsettings/bgpGeneralSettingsUUID
( Example payload for PUT on bgp general settings. )'
: value:
asNumber: String
asnotationDot: boolean
bestPath:
alwaysCompareMed: boolean
bestPathCompareRouterId: boolean
bestPathMedMissingAsWorst: boolean
defaultLocalPreferenceValue: Long
deterministicMed: boolean
type: bgpbestpath
bgpGracefulRestart:
gracefulRestart: boolean
gracefulRestartRestartTime: Integer
gracefulRestartStalePathTime: Integer
type: bgpgracefulrestart
bgptimers:
holdTime: Integer
keepAlive: Integer
minHoldTime: Integer
type: bgptimers
enforceFirstAs: boolean
fastExternalFallOver: boolean
id: bgpGeneralSettingsUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/bgpgeneralsettings/bgpGeneralSettingsUUID
logNeighborChanges: boolean
maxasLimit: Integer
name: String
transportPathMtuDiscovery: boolean
schema:
$ref: '#/components/schemas/BGPGeneralSettingModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ecmpzones:
get:
deprecated: false
description: '**Get the list of all ECMP Zones.**'
operationId: getAllECMPZoneModel
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ecmpzones?offset=0&limit=25
( Example payload for GET ALL on ECMP Zone )'
: value:
items:
- id: zoneUUid
interfaces:
- id: interface_uuid1
ifname: GigEth1
name: GigabitEthernet1/1
type: PhysicalInterface
- id: interface_uuid2
ifname: GigEth2
name: GigabitEthernet1/2
type: PhysicalInterface
links:
self: /api/fmc_config/v1/domain//devices/devicerecords//routing/ecmpzones/
name: zone_name
type: ecmpzones
links:
self: /api/fmc_config/v1/domain//devices/devicerecords/DeviceUUID/routing/ecmpzones?offset=0&limit=25
paging:
count: 2
limit: 25
offset: 0
pages: 1
? 'Example 2 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ecmpzones?expanded=true
( GET All ECMP Zone with ?expanded=true )'
: value:
items:
- description: ECMP Zone Alpha Description
id: ecmpZoneUuid
interfaces:
- id: interface_uuid1
ifname: GigEth1
name: GigabitEthernet1/1
type: PhysicalInterface
- id: interface_uuid2
ifname: GigEth2
name: GigabitEthernet1/2
type: PhysicalInterface
links:
self: /api/fmc_config/v1/domain//devices/devicerecords//routing/ecmpzones?offset=0&limit=25&expanded=true
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
timestamp: 1529431113943.0
name: ECMPZoneAlpha
type: ecmpzones
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ecmpzones?offset=0&limit=2&expanded=true
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/ECMPZoneModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**Creates an ECMP Zone. _Check the response section for applicable examples (if any)._**'
operationId: createECMPZoneModel
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ecmpzones
( Example payload for POST on ECMP Zone. )'
: value:
description: ECMP Zone Beta
interfaces:
- id: interface_uuid1
name: GigabitEthernet1/1
type: PhysicalInterface
- id: interface_uuid2
name: GigabitEthernet1/2
type: PhysicalInterface
name: ECMPZoneBeta
type: ecmpzones
schema:
$ref: '#/components/schemas/ECMPZoneModel'
type: object
description: The input ECMP Zone model.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ecmpzones
( Example payload for POST on ECMP Zone. )'
: value:
description: 'ECMP Zone '
id: ecmpzoneUuid
interfaces:
- id: interface_uuid1
ifname: GigEth1
name: GigabitEthernet1/1
type: PhysicalInterface
- id: interface_uuid2
ifname: GigEth2
name: GigabitEthernet1/2
type: PhysicalInterface
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ecmpzones/ecmpzoneUuid
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
timestamp: 1529431113943.0
name: ECMPZoneBeta
type: ecmpzones
schema:
$ref: '#/components/schemas/ECMPZoneModel'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ecmpzones/{objectId}:
delete:
deprecated: false
description: '**Delete the ECMP Zone associated with the specified ID. _Check the response section for applicable examples
(if any)._**'
operationId: deleteECMPZoneModel
parameters:
- description: Unique identifier of the ECMP Zone.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ecmpzones/ecmpZoneUuid
( Example payload for DELETE on ECMP Zone. )'
: value:
description: ECMP Zone Beta description
id: ecmpZoneUuid
interfaces:
- id: interface_uuid1
ifname: GigEth1
name: GigabitEthernet1/1
type: PhysicalInterface
- id: interface_uuid2
ifname: GigEth2
name: GigabitEthernet1/2
type: PhysicalInterface
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ecmpzones/ecmpZoneUuid
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
timestamp: 1529431113943.0
name: ECMPZoneBeta
type: ecmpzones
schema:
$ref: '#/components/schemas/ECMPZoneModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
get:
deprecated: false
description: '**Get the ECMP Zone associated with the specified ID.**'
operationId: getECMPZoneModel
parameters:
- description: Unique identifier of the ECMP Zone.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ecmpzones/zoneUUid
( Example payload for GET on ECMP Zone )'
: value:
id: zoneUUid
interfaces:
- id: interface_uuid1
ifname: GigEth1
name: GigabitEthernet1/1
type: PhysicalInterface
- id: interface_uuid2
ifname: GigEth2
name: GigabitEthernet1/2
type: PhysicalInterface
links:
self: /api/fmc_config/v1/domain//devices/devicerecords/DeviceUUID/routing/ecmpzones/zoneUUid
name: zone_name
type: ecmpzones
schema:
$ref: '#/components/schemas/ECMPZoneModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**Modify the ECMP Zone associated with the specified ID. _Check the response section for applicable examples
(if any)._**'
operationId: updateECMPZoneModel
parameters:
- description: Unique identifier of the ECMP Zone.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ecmpzones/ecmpZoneUuid
( Example payload for PUT on ECMP Zones. )'
: value:
description: ECMP Zone Beta description
id: ecmpZoneUuid
interfaces:
- id: interface_uuid1
name: GigabitEthernet1/1
type: PhysicalInterface
- id: interface_uuid2
name: GigabitEthernet1/2
type: PhysicalInterface
name: ECMPZoneBeta
type: ecmpzones
schema:
$ref: '#/components/schemas/ECMPZoneModel'
type: object
description: The input ECMP Zone model.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ecmpzones/ecmpZoneUuid
( Example payload for PUT on ECMP Zones. )'
: value:
description: ECMP Zone Beta description
id: ecmpZoneUuid
interfaces:
- id: interface_uuid1
ifname: GigEth1
name: GigabitEthernet1/1
type: PhysicalInterface
- id: interface_uuid2
ifname: GigEth2
name: GigabitEthernet1/2
type: PhysicalInterface
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ecmpzones/ecmpZoneUuid
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
timestamp: 1529431113943.0
name: ECMPZoneBeta
type: ecmpzones
schema:
$ref: '#/components/schemas/ECMPZoneModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/eigrproutes:
get:
deprecated: false
description: '**Get the list of all EIGRP entries.**'
operationId: getAllEigrpPolicyModel
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/eigrproutes?offset=0&limit=25
( Example payload for GET ALL on Eigrp )'
: value:
items:
- asNumber: '1'
id: eigrpUUid
links:
self: /api/fmc_config/v1/domain//devices/devicerecords//routing/eigrproutes
type: EigrpRoute
links:
self: /api/fmc_config/v1/domain//devices/devicerecords/DeviceUUID/routing/eigrproutes?offset=0&limit=25
paging:
count: 1
limit: 25
offset: 0
pages: 1
? 'Example 2 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/eigrproutes?expanded=true
( GET All Eigrp with expanded=true )'
: value:
items:
- advancedConfiguration:
administrativeDistance:
external: 1
internal: 1
clusterPool:
id: 00505686-13CC-0ed3-0000-042949673419
name: IPv4Pool
type: PoolObjectIPv4
defaultRouteDistributionIn:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
defaultRouteDistributionOut:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
enableLogNeighborWarnings: true
logNeighborChanges: true
logNeighborWarningInterval: 1
routeMetric:
bandwidth: 1
delay: 1
effectiveBandwidth: 1
pathMTU: 1
reliability: 1
routerId: 1.1.1.1
stub:
receiveOnly: true
asNumber: '1'
basicConfiguration:
autoSummary: false
networks:
- id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
passiveInterfaces:
allInterfaces: false
selectedInterfaces:
- id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
distributionList:
- accessList:
id: access_list_obj_uuid
name: AcessListObject
type: ACL
deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
filterDirection: INBOUND
eigrpInterfaces:
- deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
eigrpProtocolConfiguration:
authentication:
keyId: 2
md5auth: true
password: '1234'
pwdEncryption: ENCRYPTED
splitHorizon: false
timers:
delay: 1
helloInterval: 1
holdTime: 1
id: eigrp_uuid
links:
self: /api/fmc_config/v1/domain//devices/devicerecords//routing/eigrproutes?offset=0&limit=25&expanded=true
neighbors:
- neighborAddress:
id: network_obj_uuid
name: networkObject1
type: Network
neighborInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
redistributeProtocols:
- matchExternal1: false
matchExternal2: false
matchInternal: false
matchNssaExternal1: false
matchNssaExternal2: false
protocol: RIP
routeMap:
id: route_map_obj_uuid
name: routeMapObject
type: RouteMapObject
routeMetric:
bandwidth: 1
delay: 1
effectiveBandwidth: 1
pathMTU: 1
reliability: 1
summaryAddressList:
- adminDistance: 1
deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
summaryAddress:
id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
type: EigrpRoute
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/eigrproutes?offset=0&limit=2&expanded=true
paging:
count: 1
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/EigrpPolicyModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**Create an EIGRP entry. _Check the response section for applicable examples (if any)._**'
operationId: createEigrpPolicyModel
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/eigrproutes
( Example payload for POST on Eigrp. )'
: value:
advancedConfiguration:
administrativeDistance:
external: 1
internal: 1
clusterPool:
id: 00505686-13CC-0ed3-0000-042949673419
name: IPv4Pool
type: PoolObjectIPv4
defaultRouteDistributionIn:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
defaultRouteDistributionOut:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
enableLogNeighborWarnings: true
logNeighborChanges: true
logNeighborWarningInterval: 1
routeMetric:
bandwidth: 1
delay: 1
effectiveBandwidth: 1
pathMTU: 1
reliability: 1
routerId: 1.1.1.1
stub:
receiveOnly: true
asNumber: '1'
basicConfiguration:
autoSummary: false
networks:
- id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
passiveInterfaces:
allInterfaces: false
selectedInterfaces:
- id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
distributionList:
- accessList:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
filterDirection: INBOUND
eigrpInterfaces:
- deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
eigrpProtocolConfiguration:
authentication:
keyId: 2
md5auth: true
password: '1234'
pwdEncryption: ENCRYPTED
splitHorizon: false
timers:
delay: 1
helloInterval: 1
holdTime: 1
neighbors:
- neighborAddress:
id: network_object_uuid
name: networkObject1
type: Network
neighborInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
redistributeProtocols:
- matchExternal1: false
matchExternal2: false
matchInternal: false
matchNssaExternal1: false
matchNssaExternal2: false
protocol: RIP
routeMap:
id: 00505686-13CC-0ed3-0000-042949673437
name: routeMapObject
type: RouteMapObject
routeMetric:
bandwidth: 1
delay: 1
effectiveBandwidth: 1
pathMTU: 1
reliability: 1
summaryAddressList:
- adminDistance: 1
deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
summaryAddress:
id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
type: EigrpRoute
schema:
$ref: '#/components/schemas/EigrpPolicyModel'
type: object
description: The input EIGRP model.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/eigrproutes
( Example payload for POST on Eigrp. )'
: value:
advancedConfiguration:
administrativeDistance:
external: 1
internal: 1
clusterPool:
id: 00505686-13CC-0ed3-0000-042949673419
name: IPv4Pool
type: PoolObjectIPv4
defaultRouteDistributionIn:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
defaultRouteDistributionOut:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
enableLogNeighborWarnings: true
logNeighborChanges: true
logNeighborWarningInterval: 1
routeMetric:
bandwidth: 1
delay: 1
effectiveBandwidth: 1
pathMTU: 1
reliability: 1
routerId: 1.1.1.1
stub:
receiveOnly: true
asNumber: '1'
basicConfiguration:
autoSummary: false
networks:
- id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
passiveInterfaces:
allInterfaces: false
selectedInterfaces:
- id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
distributionList:
- accessList:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
filterDirection: INBOUND
eigrpInterfaces:
- deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
eigrpProtocolConfiguration:
authentication:
keyId: 2
md5auth: true
password: '1234'
pwdEncryption: ENCRYPTED
splitHorizon: false
timers:
delay: 1
helloInterval: 1
holdTime: 1
id: eigrpUuid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/eigrproutes/eigrpUuid
neighbors:
- neighborAddress:
id: 00505686-13CC-0ed3-0000-042949673303
name: networkObject1
type: Network
neighborInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
redistributeProtocols:
- matchExternal1: false
matchExternal2: false
matchInternal: false
matchNssaExternal1: false
matchNssaExternal2: false
protocol: RIP
routeMap:
id: 00505686-13CC-0ed3-0000-042949673437
name: routeMapObject
type: RouteMapObject
routeMetric:
bandwidth: 1
delay: 1
effectiveBandwidth: 1
pathMTU: 1
reliability: 1
summaryAddressList:
- adminDistance: 1
deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
summaryAddress:
id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
type: EigrpRoute
schema:
$ref: '#/components/schemas/EigrpPolicyModel'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/eigrproutes/{objectId}:
delete:
deprecated: false
description: '**Delete the EIGRP entry associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteEigrpPolicyModel
parameters:
- description: Unique identifier of a EIGRP.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/eigrproutes/eigrpUuid
( Example payload for DELETE on Eigrp. )'
: value:
advancedConfiguration:
administrativeDistance:
external: 1
internal: 1
clusterPool:
id: 00505686-13CC-0ed3-0000-042949673419
name: IPv4Pool
type: PoolObjectIPv4
defaultRouteDistributionIn:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
defaultRouteDistributionOut:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
enableLogNeighborWarnings: true
logNeighborChanges: true
logNeighborWarningInterval: 1
routeMetric:
bandwidth: 1
delay: 1
effectiveBandwidth: 1
pathMTU: 1
reliability: 1
routerId: 1.1.1.1
stub:
receiveOnly: true
asNumber: '2'
basicConfiguration:
autoSummary: false
networks:
- id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
passiveInterfaces:
allInterfaces: false
selectedInterfaces:
- id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
distributionList:
- accessList:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
deviceInterface:
id: 00505686-13CC-0ed3-0000-008589934807
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
filterDirection: INBOUND
eigrpInterfaces:
- deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
eigrpProtocolConfiguration:
authentication:
keyId: 2
md5auth: true
password: '1234'
pwdEncryption: ENCRYPTED
splitHorizon: false
timers:
delay: 1
helloInterval: 1
holdTime: 1
id: eigrpUuid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/eigrproutes/eigrpUuid
neighbors:
- neighborAddress:
id: 00505686-13CC-0ed3-0000-042949673303
name: networkObject1
type: Network
neighborInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
redistributeProtocols:
- matchExternal1: false
matchExternal2: false
matchInternal: false
matchNssaExternal1: false
matchNssaExternal2: false
protocol: RIP
routeMap:
id: 00505686-13CC-0ed3-0000-042949673437
name: routeMapObject
type: RouteMapObject
routeMetric:
bandwidth: 1
delay: 1
effectiveBandwidth: 1
pathMTU: 1
reliability: 1
summaryAddressList:
- adminDistance: 1
deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
summaryAddress:
id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
type: EigrpRoute
schema:
$ref: '#/components/schemas/EigrpPolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
get:
deprecated: false
description: '**Get the EIGRP entry associated with the specified ID.**'
operationId: getEigrpPolicyModel
parameters:
- description: Unique identifier of a EIGRP.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/eigrproutes/eigrpUUid
( Example payload for GET on Eigrp )'
: value:
advancedConfiguration:
administrativeDistance:
external: 1
internal: 1
clusterPool:
id: 00505686-13CC-0ed3-0000-042949673419
name: IPv4Pool
type: PoolObjectIPv4
defaultRouteDistributionIn:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
defaultRouteDistributionOut:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
enableLogNeighborWarnings: true
logNeighborChanges: true
logNeighborWarningInterval: 1
routeMetric:
bandwidth: 1
delay: 1
effectiveBandwidth: 1
pathMTU: 1
reliability: 1
routerId: 1.1.1.1
stub:
receiveOnly: true
asNumber: '2'
basicConfiguration:
autoSummary: false
networks:
- id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
passiveInterfaces:
allInterfaces: false
selectedInterfaces:
- id: 00505686-13CC-0ed3-0000-008589934807
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
distributionList:
- accessList:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
deviceInterface:
id: 00505686-13CC-0ed3-0000-008589934807
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
filterDirection: INBOUND
eigrpInterfaces:
- deviceInterface:
id: 00505686-13CC-0ed3-0000-008589934807
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
eigrpProtocolConfiguration:
authentication:
keyId: 2
md5auth: true
password: '1234'
pwdEncryption: ENCRYPTED
splitHorizon: false
timers:
delay: 1
helloInterval: 1
holdTime: 1
id: 00505686-13CC-0ed3-0001-642075126197
links:
self: /api/fmc_config/v1/domain//devices/devicerecords/DeviceUUID/routing/eigrproutes/eigrpUUid
neighbors:
- neighborAddress:
id: 00505686-13CC-0ed3-0000-042949673303
name: networkObject1
type: Network
neighborInterface:
id: 00505686-13CC-0ed3-0000-008589934807
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
redistributeProtocols:
- matchExternal1: false
matchExternal2: false
matchInternal: false
matchNssaExternal1: false
matchNssaExternal2: false
protocol: RIP
routeMap:
id: 00505686-13CC-0ed3-0000-042949673437
name: routeMapObject
type: RouteMapObject
routeMetric:
bandwidth: 1
delay: 1
effectiveBandwidth: 1
pathMTU: 1
reliability: 1
summaryAddressList:
- adminDistance: 1
deviceInterface:
id: 00505686-13CC-0ed3-0000-008589934807
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
summaryAddress:
id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
type: EigrpRoute
schema:
$ref: '#/components/schemas/EigrpPolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**Modify the EIGRP entry associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateEigrpPolicyModel
parameters:
- description: Unique identifier of a EIGRP.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/eigrproutes/eigrpUuid
( Example payload for PUT on Eigrp. )'
: value:
advancedConfiguration:
administrativeDistance:
external: 1
internal: 1
clusterPool:
id: 00505686-13CC-0ed3-0000-042949673419
name: IPv4Pool
type: PoolObjectIPv4
defaultRouteDistributionIn:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
defaultRouteDistributionOut:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
enableLogNeighborWarnings: true
logNeighborChanges: true
logNeighborWarningInterval: 1
routeMetric:
bandwidth: 1
delay: 1
effectiveBandwidth: 1
pathMTU: 1
reliability: 1
routerId: 1.1.1.1
stub:
receiveOnly: true
asNumber: '1'
basicConfiguration:
autoSummary: false
networks:
- id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
passiveInterfaces:
allInterfaces: false
selectedInterfaces:
- id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
distributionList:
- accessList:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
filterDirection: INBOUND
eigrpInterfaces:
- deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
eigrpProtocolConfiguration:
authentication:
keyId: 2
md5auth: true
password: '1234'
pwdEncryption: ENCRYPTED
splitHorizon: false
timers:
delay: 1
helloInterval: 1
holdTime: 1
id: eigrpUuid
neighbors:
- neighborAddress:
id: network_object_uuid
name: networkObject1
type: Network
neighborInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
redistributeProtocols:
- matchExternal1: false
matchExternal2: false
matchInternal: false
matchNssaExternal1: false
matchNssaExternal2: false
protocol: RIP
routeMap:
id: 00505686-13CC-0ed3-0000-042949673437
name: routeMapObject
type: RouteMapObject
routeMetric:
bandwidth: 1
delay: 1
effectiveBandwidth: 1
pathMTU: 1
reliability: 1
summaryAddressList:
- adminDistance: 1
deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
summaryAddress:
id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
type: EigrpRoute
schema:
$ref: '#/components/schemas/EigrpPolicyModel'
type: object
description: The input EIGRP model.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/eigrproutes/eigrpUuid
( Example payload for PUT on Eigrp. )'
: value:
advancedConfiguration:
administrativeDistance:
external: 1
internal: 1
clusterPool:
id: 00505686-13CC-0ed3-0000-042949673419
name: IPv4Pool
type: PoolObjectIPv4
defaultRouteDistributionIn:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
defaultRouteDistributionOut:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
enableLogNeighborWarnings: true
logNeighborChanges: true
logNeighborWarningInterval: 1
routeMetric:
bandwidth: 1
delay: 1
effectiveBandwidth: 1
pathMTU: 1
reliability: 1
routerId: 1.1.1.1
stub:
receiveOnly: true
asNumber: '1'
basicConfiguration:
autoSummary: false
networks:
- id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
passiveInterfaces:
allInterfaces: false
selectedInterfaces:
- id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
distributionList:
- accessList:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
filterDirection: INBOUND
eigrpInterfaces:
- deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
eigrpProtocolConfiguration:
authentication:
keyId: 2
md5auth: true
password: '1234'
pwdEncryption: ENCRYPTED
splitHorizon: false
timers:
delay: 1
helloInterval: 1
holdTime: 1
id: 00505686-13CC-0ed3-0001-642075126197
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/eigrproutes/eigrpUuid
neighbors:
- neighborAddress:
id: network_object_uuid
name: networkObject1
type: Network
neighborInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
redistributeProtocols:
- matchExternal1: false
matchExternal2: false
matchInternal: false
matchNssaExternal1: false
matchNssaExternal2: false
protocol: RIP
routeMap:
id: 00505686-13CC-0ed3-0000-042949673437
name: routeMapObject
type: RouteMapObject
routeMetric:
bandwidth: 1
delay: 1
effectiveBandwidth: 1
pathMTU: 1
reliability: 1
summaryAddressList:
- adminDistance: 1
deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
summaryAddress:
id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
type: EigrpRoute
schema:
$ref: '#/components/schemas/EigrpPolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ipv4staticroutes:
get:
deprecated: false
description: '**Get the list of all IPv4 Static routes. When device is in multi virtual router mode, this API is applicable
to Global Virtual Router.**'
operationId: getAllIPv4StaticRouteModel
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/IPv4StaticRouteModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**Create an IPv4 Static route. _Check the response section for applicable examples (if any)._**'
operationId: createMultipleIPv4StaticRouteModel
parameters:
- description: Boolean value indicating whether this is performed as a bulk operation.
in: query
name: bulk
required: false
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv4staticroutes
( Example payload for POST on IPv4 Static Routes. )'
: value:
gateway:
object:
id: networkHostUuid
name: Host2
type: Host
interfaceName: InterfaceLogicalName
isTunneled: false
metricValue: 22
routeTracking:
id: sla_monitor_id
name: sla1
type: SLAMonitor
selectedNetworks:
- id: networkHostUuid
name: Host1
type: Host
type: IPv4StaticRoute
? 'Example 2 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv4staticroutes
( Example payload for POST on IPv4 Static Routes with NULL0 interface. )'
: value:
interfaceName: Null0
isTunneled: false
metricValue: 1
selectedNetworks:
- id: networkHostUuid
name: Host1
type: Host
type: IPv4StaticRoute
schema:
$ref: '#/components/schemas/IPv4StaticRouteModel'
type: object
description: The input IPv4 Static Route model.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv4staticroutes
( Example payload for POST on IPv4 Static Routes. )'
: value:
gateway:
object:
id: networkHostUuid
name: Host2
type: Host
id: ipv4StaticRouteUuid
interfaceName: InterfaceLogicalName
isTunneled: false
links:
parent: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/staticroutes
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv4staticroutes/ipv4StaticRouteUuid
metricValue: 22
routeTracking:
id: sla_monitor_id
name: sla1
type: SLAMonitor
selectedNetworks:
- id: networkHostUuid
name: Host1
type: Host
type: IPv4StaticRoute
? 'Example 2 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv4staticroutes
( Example payload for POST on IPv4 Static Routes with NULL0 interface. )'
: value:
id: ipv4StaticRouteUuid
interfaceName: Null0
isTunneled: false
links:
parent: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/staticroutes
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv4staticroutes/ipv4StaticRouteUuid
metricValue: 1
selectedNetworks:
- id: networkHostUuid
name: Host1
type: Host
type: IPv4StaticRoute
schema:
$ref: '#/components/schemas/IPv4StaticRouteModel'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ipv4staticroutes/{objectId}:
delete:
deprecated: false
description: '**Delete the IPv4 Static Route associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteIPv4StaticRouteModel
parameters:
- description: Unique identifier of a IPv4 Static Route.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv4staticroutes/ipv4StaticRouteUuid
( Example payload for DELETE on IPv4 Static Routes. )'
: value:
gateway:
object:
id: networkHostUuid
name: Host2
type: Host
id: ipv4StaticRouteUuid
interfaceName: InterfaceLogicalName
isTunneled: false
links:
parent: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/staticroutes
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv4staticroutes/ipv4StaticRouteUuid
metricValue: 22
routeTracking:
id: sla_monitor_id
name: sla1
type: SLAMonitor
selectedNetworks:
- id: networkHostUuid
name: Host1
type: Host
type: IPv4StaticRoute
schema:
$ref: '#/components/schemas/IPv4StaticRouteModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
get:
deprecated: false
description: '**Get the IPv4 Static Route associated with the specified ID.**'
operationId: getIPv4StaticRouteModel
parameters:
- description: Unique identifier of a IPv4 Static Route.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv4staticroutes/ipv4StaticRouteUuid
( Example payload for GET on IPv4 Static Routes. )'
: value:
gateway:
literal:
type: Host
value: 5.5.5.5
id: ipv4StaticRouteUuid
interfaceName: InterfaceLogicalName
isTunneled: false
links:
parent: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/staticroutes
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv4staticroutes/ipv4StaticRouteUuid
metricValue: 1
routeTracking:
id: sla_monitor_id
name: sla1
type: SLAMonitor
selectedNetworks:
- id: networkObjUuid
name: any
type: Network
type: IPv4StaticRoute
? 'Example 2 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv4staticroutes
( Example payload for GET on IPv4 Static Routes. )'
: value:
items:
- id: ipv4StaticRouteUuid
links:
parent: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/staticroutes
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv4staticroutes/ipv4StaticRouteUuid
type: IPv4StaticRoute
- id: ipv4StaticRouteUuid
links:
parent: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/staticroutes
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv4staticroutes/ipv4StaticRouteUuid
type: IPv4StaticRoute
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv4staticroutes?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
? 'Example 3 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv4staticroutes?expanded=true
( Example payload for GET on IPv4 Static Routes with ?expanded=true )'
: value:
items:
- gateway:
literal:
type: Host
value: 5.5.5.5
id: ipv4StaticRouteUuid
interfaceName: InterfaceLogicalName
isTunneled: false
links:
parent: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/staticroutes
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv4staticroutes/ipv4StaticRouteUuid
metricValue: 1
routeTracking:
id: sla_monitor_id
name: sla1
type: SLAMonitor
selectedNetworks:
- id: networkObjUuid
name: any
type: Network
type: IPv4StaticRoute
- gateway:
object:
id: networkHostUuid
name: networkHostName
type: Host
id: ipv4StaticRouteUuid
interfaceName: InterfaceLogicalName
isTunneled: false
links:
parent: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/staticroutes
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv4staticroutes/ipv4StaticRouteUuid
metricValue: 1
selectedNetworks:
- id: networkObjUuid
name: any
type: Network
type: IPv4StaticRoute
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv4staticroutes?offset=0&limit=2&expanded=true
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/IPv4StaticRouteModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**Modify the IPv4 Static Route associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateIPv4StaticRouteModel
parameters:
- description: Unique identifier of a IPv4 Static Route.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv4staticroutes/ipv4StaticRouteUuid
( Example payload for PUT on IPv4 Static Routes. )'
: value:
gateway:
object:
id: networkHostUuid
name: Host2
type: Host
id: ipv4StaticRouteUuid
interfaceName: InterfaceLogicalName
isTunneled: false
metricValue: 50
routeTracking:
id: sla_monitor_id
name: sla1
type: SLAMonitor
selectedNetworks:
- id: networkHostUuid
name: Host1
type: Host
type: IPv4StaticRoute
schema:
$ref: '#/components/schemas/IPv4StaticRouteModel'
type: object
description: The input IPv4 Static Route model.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv4staticroutes/ipv4StaticRouteUuid
( Example payload for PUT on IPv4 Static Routes. )'
: value:
gateway:
object:
id: networkHostUuid
name: Host2
type: Host
id: ipv4StaticRouteUuid
interfaceName: InterfaceLogicalName
isTunneled: false
links:
parent: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/staticroutes
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv4staticroutes/ipv4StaticRouteUuid
metricValue: 50
routeTracking:
id: sla_monitor_id
name: sla1
type: SLAMonitor
selectedNetworks:
- id: networkHostUuid
name: Host1
type: Host
type: IPv4StaticRoute
schema:
$ref: '#/components/schemas/IPv4StaticRouteModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ipv6staticroutes:
get:
deprecated: false
description: '**Get the list of all IPv6 Static routes. When device is in multi virtual router mode, this API is applicable
to Global Virtual Router.**'
operationId: getAllIPv6StaticRouteModel
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/IPv6StaticRouteModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**Create an IPv6 Static route. _Check the response section for applicable examples (if any)._**'
operationId: createMultipleIPv6StaticRouteModel
parameters:
- description: Boolean value indicating whether this is performed as a bulk operation.
in: query
name: bulk
required: false
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv6staticroutes
( Example payload for POST on IPv6 Static Routes. )'
: value:
gateway:
object:
id: networkHostUuid
name: Host2
type: Host
interfaceName: InterfaceLogicalName
isTunneled: false
metricValue: 22
selectedNetworks:
- id: networkHostUuid
name: Host1
type: Host
type: IPv6StaticRoute
? 'Example 2 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv6staticroutes
( Example payload for POST on IPv6 Static Routes with NULL0 Interface. )'
: value:
interfaceName: Null0
selectedNetworks:
- id: networkHostUuid
name: Host1
type: Host
type: IPv6StaticRoute
schema:
$ref: '#/components/schemas/IPv6StaticRouteModel'
type: object
description: The input IPv6 Static Route model.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv6staticroutes
( Example payload for POST on IPv6 Static Routes. )'
: value:
gateway:
object:
id: networkHostUuid
name: Host2
type: Host
id: ipv6StaticRouteUuid
interfaceName: InterfaceLogicalName
isTunneled: false
links:
parent: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/staticroutes
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv6staticroutes/ipv6StaticRouteUuid
metricValue: 22
selectedNetworks:
- id: networkHostUuid
name: Host1
type: Host
type: IPv6StaticRoute
? 'Example 2 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv6staticroutes
( Example payload for POST on IPv6 Static Routes with NULL0 Interface. )'
: value:
id: ipv6StaticRouteUuid
interfaceName: Null0
links:
parent: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/staticroutes
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv6staticroutes/ipv6StaticRouteUuid
selectedNetworks:
- id: networkHostUuid
name: Host1
type: Host
type: IPv6StaticRoute
schema:
$ref: '#/components/schemas/IPv6StaticRouteModel'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ipv6staticroutes/{objectId}:
delete:
deprecated: false
description: '**Delete the IPv6 Static Route associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deleteIPv6StaticRouteModel
parameters:
- description: Unique identifier of a IPv6 Static Route.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv6staticroutes/ipv6StaticRouteUuid
( Example payload for DELETE on IPv6 Static Routes. )'
: value:
gateway:
object:
id: networkHostUuid
name: Host2
type: Host
id: ipv6StaticRouteUuid
interfaceName: InterfaceLogicalName
isTunneled: false
links:
parent: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/staticroutes
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv6staticroutes/ipv6StaticRouteUuid
metricValue: 22
selectedNetworks:
- id: networkHostUuid
name: Host1
type: Host
type: IPv6StaticRoute
schema:
$ref: '#/components/schemas/IPv6StaticRouteModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
get:
deprecated: false
description: '**Get the IPv6 Static Route associated with the specified ID.**'
operationId: getIPv6StaticRouteModel
parameters:
- description: Unique identifier of a IPv6 Static Route.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv6staticroutes/ipv6StaticRouteUuid
( Example payload for GET on IPv6 Static Routes. )'
: value:
gateway:
literal:
type: Host
value: 'fe::'
id: ipv6StaticRouteUuid
interfaceName: InterfaceLogicalName
isTunneled: false
links:
parent: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/staticroutes
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv6staticroutes/ipv6StaticRouteUuid
metricValue: 1
selectedNetworks:
- id: networkObjUuid
name: any
type: Network
type: IPv6StaticRoute
? 'Example 2 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv6staticroutes
( Example payload for GET on IPv6 Static Routes. )'
: value:
items:
- id: ipv6StaticRouteUuid
links:
parent: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/staticroutes
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv6staticroutes/ipv6StaticRouteUuid
type: IPv6StaticRoute
- id: ipv6StaticRouteUuid
links:
parent: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/staticroutes
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv6staticroutes/ipv6StaticRouteUuid
type: IPv6StaticRoute
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv6staticroutes?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
? 'Example 3 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv6staticroutes?expanded=true
( Example payload for GET on IPv6 Static Routes with ?expanded=true )'
: value:
items:
- gateway:
literal:
type: Host
value: 5.5.5.5
id: ipv6StaticRouteUuid
interfaceName: InterfaceLogicalName
isTunneled: false
links:
parent: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/staticroutes
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv6staticroutes/ipv6StaticRouteUuid
metricValue: 1
selectedNetworks:
- id: networkObjUuid
name: any
type: Network
type: IPv6StaticRoute
- gateway:
object:
id: networkHostUuid
name: networkHostName
type: Host
id: ipv6StaticRouteUuid
interfaceName: InterfaceLogicalName
isTunneled: false
links:
parent: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/staticroutes
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv6staticroutes/ipv6StaticRouteUuid
metricValue: 1
selectedNetworks:
- id: networkObjUuid
name: any
type: Network
type: IPv6StaticRoute
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv6staticroutes?offset=0&limit=2&expanded=true
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/IPv6StaticRouteModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**Modify the IPv6 Static Route associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updateIPv6StaticRouteModel
parameters:
- description: Unique identifier of a IPv6 Static Route.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv6staticroutes/ipv6StaticRouteUuid
( Example payload for PUT on IPv6 Static Routes. )'
: value:
gateway:
object:
id: networkHostUuid
name: Host2
type: Host
id: ipv6StaticRouteUuid
interfaceName: InterfaceLogicalName
isTunneled: false
metricValue: 50
selectedNetworks:
- id: networkHostUuid
name: Host1
type: Host
type: IPv6StaticRoute
schema:
$ref: '#/components/schemas/IPv6StaticRouteModel'
type: object
description: The input IPv6 Static Route model.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv6staticroutes/ipv6StaticRouteUuid
( Example payload for PUT on IPv6 Static Routes. )'
: value:
gateway:
object:
id: networkHostUuid
name: Host2
type: Host
id: ipv6StaticRouteUuid
interfaceName: InterfaceLogicalName
isTunneled: false
links:
parent: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/staticroutes
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv6staticroutes/ipv6StaticRouteUuid
metricValue: 50
selectedNetworks:
- id: networkHostUuid
name: Host1
type: Host
type: IPv6StaticRoute
schema:
$ref: '#/components/schemas/IPv6StaticRouteModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ospfinterface:
get:
deprecated: false
description: '**Get the list of all OSPF interfaces. When device is in multi virtual router mode, this API is applicable
to Global Virtual Router.**'
operationId: getAllOspfInterfacePolicyModel
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OspfInterfacePolicyModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**[DEV ERROR: Missing description] _Check the response section for applicable examples (if any)._**'
operationId: createOspfInterfacePolicyModel
parameters:
- description: '[DEV ERROR: Missing description]'
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfinterface
( Example payload for POST on ospf interface. )'
: value:
deviceInterface:
id: uuid
name: Interface name
type: Interface
id: ospfinterfaceuuid
ospfProtocolConfiguration:
enableBFD: boolean
filterOutgoingLSA: boolean
ignoreMtuMismatch: boolean
ospfAuthentication:
md5AuthList:
- authType: md5authentication
md5Key: String
md5KeyId: short
ospfInterval:
helloInterval:
deadInterval: integer
helloInterval: integer
neighborDetectionType: ospfdeadintervalmechanism
helloMultiplier:
helloMultiplier: integer
packetCost: short
priority: short
ptpNonBroadcast: boolean
retransmitInterval: short
transmitDelay: short
type: OspfInterface
schema:
$ref: '#/components/schemas/OspfInterfacePolicyModel'
type: object
description: '[DEV ERROR: Missing description]'
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfinterface
( Example payload for POST on ospf interface. )'
: value:
deviceInterface:
id: uuid
name: Interface name
type: Interface
id: ospfinterfaceuuid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfinterface/ospfinterfaceuuid
ospfProtocolConfiguration:
enableBFD: boolean
filterOutgoingLSA: boolean
ignoreMtuMismatch: boolean
ospfAuthentication:
md5AuthList:
- authType: md5authentication
md5Key: String
md5KeyId: short
ospfInterval:
helloInterval:
deadInterval: integer
helloInterval: integer
neighborDetectionType: ospfdeadintervalmechanism
helloMultiplier:
helloMultiplier: integer
packetCost: short
priority: short
ptpNonBroadcast: boolean
retransmitInterval: short
transmitDelay: short
type: OspfInterface
schema:
$ref: '#/components/schemas/OspfInterfacePolicyModel'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ospfinterface/{objectId}:
delete:
deprecated: false
description: '**[DEV ERROR: Missing description] _Check the response section for applicable examples (if any)._**'
operationId: deleteOspfInterfacePolicyModel
parameters:
- description: '[DEV ERROR: Missing description]'
in: path
name: objectId
required: true
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfinterface/ospfinterfaceuuid
( Example payload for DELETE on ospf interface. )'
: value:
deviceInterface:
id: uuid
name: Interface name
type: Interface
id: ospfinterfaceuuid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfinterface/ospfinterfaceuuid
ospfProtocolConfiguration:
enableBFD: boolean
filterOutgoingLSA: boolean
ignoreMtuMismatch: boolean
ospfAuthentication:
keyChain:
authKey:
id: uuid
name: String
overridable: boolean
authType: keychainauthentication
ospfInterval:
helloInterval:
deadInterval: integer
helloInterval: integer
neighborDetectionType: ospfdeadintervalmechanism
helloMultiplier:
helloMultiplier: integer
packetCost: short
priority: short
ptpNonBroadcast: boolean
retransmitInterval: short
transmitDelay: short
type: OspfInterface
schema:
$ref: '#/components/schemas/OspfInterfacePolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
get:
deprecated: false
description: '**Get the OSPF interface associated with the specified ID.**'
operationId: getOspfInterfacePolicyModel
parameters:
- description: Unique identifier of a OSPF Interface.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfinterface?expanded=true
( Example payload for GET on ospf interface with expanded flag as true. )'
: value:
items:
- deviceInterface:
id: uuid
name: Interface name
type: Interface
id: ospfinterfaceuuid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfinterface/ospfinterfaceuuid
ospfProtocolConfiguration:
enableBFD: boolean
filterOutgoingLSA: boolean
ignoreMtuMismatch: boolean
ospfAuthentication:
areaAuth:
authType: areaauthentication
md5AuthList:
- md5Key: String
md5KeyId: short
passwdAuth:
authKey: String
ospfInterval:
helloInterval:
deadInterval: integer
helloInterval: integer
neighborDetectionType: ospfdeadintervalmechanism
packetCost: short
priority: short
ptpNonBroadcast: boolean
retransmitInterval: short
transmitDelay: short
type: OspfInterface
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfinterface?offset=0&limit=2&expanded=true
paging:
count: 1
limit: 1
offset: 0
pages: 1
? 'Example 2 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfinterface/ospfinterfaceuuid
( Example payload for GET on ospf interface with specified id )'
: value:
deviceInterface:
id: uuid
name: Interface name
type: Interface
id: ospfinterfaceuuid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfinterface/ospfinterfaceuuid
ospfProtocolConfiguration:
enableBFD: boolean
filterOutgoingLSA: boolean
ignoreMtuMismatch: boolean
ospfAuthentication:
areaAuth:
authType: areaauthentication
md5AuthList:
- md5Key: String
md5KeyId: short
passwdAuth:
authKey: String
ospfInterval:
helloInterval:
deadInterval: integer
helloInterval: integer
neighborDetectionType: ospfdeadintervalmechanism
packetCost: short
priority: short
ptpNonBroadcast: boolean
retransmitInterval: short
transmitDelay: short
type: OspfInterface
schema:
$ref: '#/components/schemas/OspfInterfacePolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**[DEV ERROR: Missing description] _Check the response section for applicable examples (if any)._**'
operationId: updateOspfInterfacePolicyModel
parameters:
- description: '[DEV ERROR: Missing description]'
in: path
name: objectId
required: true
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfinterface/ospfinterfaceuuid
( Example payload for PUT on ospf interface. )'
: value:
deviceInterface:
id: uuid
name: Interface name
type: Interface
id: ospfinterfaceuuid
ospfProtocolConfiguration:
enableBFD: boolean
filterOutgoingLSA: boolean
ignoreMtuMismatch: boolean
ospfAuthentication:
passwdAuth:
authKey: String
authType: passwordauthentication
ospfInterval:
helloInterval:
deadInterval: integer
helloInterval: integer
neighborDetectionType: ospfdeadintervalmechanism
packetCost: short
priority: short
ptpNonBroadcast: boolean
retransmitInterval: short
transmitDelay: short
type: OspfInterface
schema:
$ref: '#/components/schemas/OspfInterfacePolicyModel'
type: object
description: '[DEV ERROR: Missing description]'
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfinterface/ospfinterfaceuuid
( Example payload for PUT on ospf interface. )'
: value:
deviceInterface:
id: uuid
name: Interface name
type: Interface
id: ospfinterfaceuuid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfinterface/ospfinterfaceuuid
ospfProtocolConfiguration:
enableBFD: boolean
filterOutgoingLSA: boolean
ignoreMtuMismatch: boolean
ospfAuthentication:
passwdAuth:
authKey: String
authType: passwordauthentication
ospfInterval:
helloInterval:
deadInterval: integer
helloInterval: integer
neighborDetectionType: ospfdeadintervalmechanism
packetCost: short
priority: short
ptpNonBroadcast: boolean
retransmitInterval: short
transmitDelay: short
type: OspfInterface
schema:
$ref: '#/components/schemas/OspfInterfacePolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ospfv2routes:
get:
deprecated: false
description: '**Get the list of all OSPFv2 routes. When device is in multi virtual router mode, this API is applicable
to Global Virtual Router.**'
operationId: getAllOspfPolicyModel
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/OspfPolicyModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**[DEV ERROR: Missing description] _Check the response section for applicable examples (if any)._**'
operationId: createOspfPolicyModel
parameters:
- description: '[DEV ERROR: Missing description]'
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv2routes
( Example payload for POST on OSPFv2 routes. )'
: value:
areas:
- areaId: string
areaNetworks:
- id: uuid
name: any-ipv4
overridable: boolean
type: Network
areaRanges:
- addressNetwork:
id: uuid
name: any
overridable: boolean
type: Network
advertise: boolean
areaType:
type: normal
defaultCost: long
filterList:
- filterDirection: IN|OUT
prefixList:
id: uuid
name: prefix name
virtualLinks:
- deadInterval: short
helloInterval: short
retransmitInterval: short
routerId: uuid
transmitDelay: short
type: virtuallink
enableProcess: PROCESS_1|PROCESS_2
filterRules:
- accessList:
id: accessList uuid
name: accessList name
overridable: boolean
type: StandardAccessList
protocol: CONNECTED | STATIC | RIP | OSPF | EIGRP | NONE | BGP
type: outgoingroutefilter
logAdjacencyChanges:
logType: DETAILED|DEFAULT
processConfiguration:
administrativeDistance:
external: short
interArea: short
intraArea: short
defaultInformationOriginate:
alwaysAdvertise: boolean
routeMap:
id: uuid
name: Object name
overridable: boolean
type: RouteMap
routeMetric:
metricType: TYPE_1|TYPE_2
metricValue: long
ignoreLsaMospf: boolean
rfc1583Compatible: boolean
timers:
lsaGroup: Integer
processId: 1|2
redistributeProtocols:
- routeMap:
id: uuid
name: Object name
overridable: boolean
type: RouteMap
routeMetric:
metricType: TYPE_1|TYPE_2
metricValue: long
subnets: boolean
tagNumber: long
type: RedistributeStatic
summaryAddresses:
- advertise: boolean
summaryNetwork:
- id: network uuid
name: network name
overridable: boolean
type: Network
type: OspfRoute
schema:
$ref: '#/components/schemas/OspfPolicyModel'
type: object
description: '[DEV ERROR: Missing description]'
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv2routes
( Example payload for POST on OSPFv2 routes. )'
: value:
areas:
- areaId: string
areaNetworks:
- id: uuid
name: any-ipv4
overridable: boolean
type: Network
areaRanges:
- addressNetwork:
id: uuid
name: any
overridable: boolean
type: Network
advertise: boolean
areaType:
type: normal
defaultCost: long
filterList:
- filterDirection: IN|OUT
prefixList:
id: uuid
name: prefix name
virtualLinks:
- deadInterval: short
helloInterval: short
retransmitInterval: short
routerId: uuid
transmitDelay: short
type: virtuallink
enableProcess: PROCESS_1|PROCESS_2
filterRules:
- accessList:
id: accessList uuid
name: accessList name
overridable: boolean
type: StandardAccessList
protocol: CONNECTED | STATIC | RIP | OSPF | EIGRP | NONE | BGP
type: outgoingroutefilter
id: ospfv2routesuuid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv2routes/ospfv2routesuuid
logAdjacencyChanges:
logType: DETAILED|DEFAULT
processConfiguration:
administrativeDistance:
external: short
interArea: short
intraArea: short
defaultInformationOriginate:
alwaysAdvertise: boolean
routeMap:
id: uuid
name: Object name
overridable: boolean
type: RouteMap
routeMetric:
metricType: TYPE_1|TYPE_2
metricValue: long
ignoreLsaMospf: boolean
rfc1583Compatible: boolean
timers:
lsaGroup: Integer
processId: 1|2
redistributeProtocols:
- routeMap:
id: uuid
name: Object name
overridable: boolean
type: RouteMap
routeMetric:
metricType: TYPE_1|TYPE_2
metricValue: long
subnets: boolean
tagNumber: long
type: RedistributeStatic
summaryAddresses:
- advertise: boolean
summaryNetwork:
- id: network uuid
name: network name
overridable: boolean
type: Network
type: OspfRoute
schema:
$ref: '#/components/schemas/OspfPolicyModel'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ospfv2routes/{objectId}:
delete:
deprecated: false
description: '**[DEV ERROR: Missing description] _Check the response section for applicable examples (if any)._**'
operationId: deleteOspfPolicyModel
parameters:
- description: '[DEV ERROR: Missing description]'
in: path
name: objectId
required: true
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv2routes/ospfv2routesuuid
( Example payload for DELETE on OSPFv2 routes. )'
: value:
areas:
- areaId: string
areaNetworks:
- id: uuid
name: any-ipv4
overridable: boolean
type: Network
areaRanges:
- addressNetwork:
id: uuid
name: any
overridable: boolean
type: Network
advertise: boolean
areaType:
type: normal
defaultCost: long
filterList:
- filterDirection: IN|OUT
prefixList:
id: uuid
name: prefix name
virtualLinks:
- deadInterval: short
helloInterval: short
retransmitInterval: short
routerId: uuid
transmitDelay: short
type: virtuallink
enableProcess: PROCESS_1|PROCESS_2
filterRules:
- accessList:
id: accessList uuid
name: accessList name
overridable: boolean
type: StandardAccessList
protocol: CONNECTED | STATIC | RIP | OSPF | EIGRP | NONE | BGP
type: outgoingroutefilter
id: ospfv2routesuuid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv2routes/ospfv2routesuuid
logAdjacencyChanges:
logType: DETAILED|DEFAULT
processConfiguration:
administrativeDistance:
external: short
interArea: short
intraArea: short
defaultInformationOriginate:
alwaysAdvertise: boolean
routeMap:
id: uuid
name: Object name
overridable: boolean
type: RouteMap
routeMetric:
metricType: TYPE_1|TYPE_2
metricValue: long
ignoreLsaMospf: boolean
rfc1583Compatible: boolean
timers:
lsaGroup: Integer
processId: 1|2
redistributeProtocols:
- routeMap:
id: uuid
name: Object name
overridable: boolean
type: RouteMap
routeMetric:
metricType: TYPE_1|TYPE_2
metricValue: long
subnets: boolean
tagNumber: long
type: RedistributeStatic
summaryAddresses:
- advertise: boolean
summaryNetwork:
- id: network uuid
name: network name
overridable: boolean
type: Network
type: OspfRoute
schema:
$ref: '#/components/schemas/OspfPolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
get:
deprecated: false
description: '**Get the OSPFv2 route associated with the specified ID.**'
operationId: getOspfPolicyModel
parameters:
- description: Unique identifier of a OSPFv2 route.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv2routes?expanded=true
( Example payload for GET on ospfv2 routes with expanded flag as true. )'
: value:
items:
- areas:
- areaId: string
areaNetworks:
- id: uuid
name: any-ipv4
overridable: boolean
type: Network
areaRanges:
- addressNetwork:
id: uuid
name: any
overridable: boolean
type: Network
advertise: boolean
areaType:
type: normal
defaultCost: long
filterList:
- filterDirection: IN|OUT
prefixList:
id: uuid
name: prefix name
virtualLinks:
- deadInterval: short
helloInterval: short
retransmitInterval: short
routerId: uuid
transmitDelay: short
type: virtuallink
enableProcess: PROCESS_1|PROCESS_2
filterRules:
- accessList:
id: accessList uuid
name: accessList name
overridable: boolean
type: StandardAccessList
inInterface:
id: uuid
name: Interface name
type: Interface
type: incomingroutefilter
id: ospfv2routesuuid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv2routes/ospfv2routesuuid
logAdjacencyChanges:
logType: DETAILED|DEFAULT
processConfiguration:
administrativeDistance:
external: short
interArea: short
intraArea: short
defaultInformationOriginate:
alwaysAdvertise: boolean
routeMap:
id: uuid
name: Object name
overridable: boolean
type: RouteMap
routeMetric:
metricType: TYPE_1|TYPE_2
metricValue: long
ignoreLsaMospf: boolean
rfc1583Compatible: boolean
timers:
lsaGroup: Integer
processId: 1|2
redistributeProtocols:
- routeMap:
id: uuid
name: Object name
overridable: boolean
type: RouteMap
routeMetric:
metricType: TYPE_1|TYPE_2
metricValue: long
subnets: boolean
tagNumber: long
type: RedistributeStatic
summaryAddresses:
- advertise: boolean
summaryNetwork:
- id: network uuid
name: network name
overridable: boolean
type: Network
type: OspfRoute
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv2routes?offset=0&limit=2&expanded=true
paging:
count: 1
limit: 1
offset: 0
pages: 1
? 'Example 2 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv2routes/ospfv2routesuuid
( Example payload for GET on ospfv2 routes with specified id )'
: value:
areas:
- areaId: string
areaNetworks:
- id: uuid
name: any-ipv4
overridable: boolean
type: Network
areaRanges:
- addressNetwork:
id: uuid
name: any
overridable: boolean
type: Network
advertise: boolean
areaType:
type: normal
defaultCost: long
filterList:
- filterDirection: IN|OUT
prefixList:
id: uuid
name: prefix name
virtualLinks:
- deadInterval: short
helloInterval: short
retransmitInterval: short
routerId: uuid
transmitDelay: short
type: virtuallink
enableProcess: PROCESS_1|PROCESS_2
filterRules:
- accessList:
id: accessList uuid
name: accessList name
overridable: boolean
type: StandardAccessList
inInterface:
id: uuid
name: Interface name
type: Interface
type: incomingroutefilter
id: ospfv2routesuuid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv2routes/ospfv2routesuuid
logAdjacencyChanges:
logType: DETAILED|DEFAULT
processConfiguration:
administrativeDistance:
external: short
interArea: short
intraArea: short
defaultInformationOriginate:
alwaysAdvertise: boolean
routeMap:
id: uuid
name: Object name
overridable: boolean
type: RouteMap
routeMetric:
metricType: TYPE_1|TYPE_2
metricValue: long
ignoreLsaMospf: boolean
rfc1583Compatible: boolean
timers:
lsaGroup: Integer
processId: 1|2
redistributeProtocols:
- routeMap:
id: uuid
name: Object name
overridable: boolean
type: RouteMap
routeMetric:
metricType: TYPE_1|TYPE_2
metricValue: long
subnets: boolean
tagNumber: long
type: RedistributeStatic
summaryAddresses:
- advertise: boolean
summaryNetwork:
- id: network uuid
name: network name
overridable: boolean
type: Network
type: OspfRoute
schema:
$ref: '#/components/schemas/OspfPolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**[DEV ERROR: Missing description] _Check the response section for applicable examples (if any)._**'
operationId: updateOspfPolicyModel
parameters:
- description: '[DEV ERROR: Missing description]'
in: path
name: objectId
required: true
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv2routes/ospfv2routesuuid
( Example payload for PUT on OSPFv2 routes. )'
: value:
areas:
- areaId: string
areaNetworks:
- id: uuid
name: any-ipv4
overridable: boolean
type: Network
areaRanges:
- addressNetwork:
id: uuid
name: any
overridable: boolean
type: Network
advertise: boolean
areaType:
type: normal
defaultCost: long
filterList:
- filterDirection: IN|OUT
prefixList:
id: uuid
name: prefix name
virtualLinks:
- deadInterval: short
helloInterval: short
retransmitInterval: short
routerId: uuid
transmitDelay: short
type: virtuallink
enableProcess: PROCESS_1|PROCESS_2
filterRules:
- accessList:
id: accessList uuid
name: accessList name
overridable: boolean
type: StandardAccessList
protocol: CONNECTED | STATIC | RIP | OSPF | EIGRP | NONE | BGP
type: outgoingroutefilter
id: ospfv2routesuuid
logAdjacencyChanges:
logType: DETAILED|DEFAULT
neighbors:
- ipAddress:
id: network uuid
name: network name
overridable: boolean
type: Network
neighborInterface:
id: uuid
name: Interface name/0
type: Interface
processConfiguration:
administrativeDistance:
external: short
interArea: short
intraArea: short
defaultInformationOriginate:
alwaysAdvertise: boolean
routeMap:
id: uuid
name: Object name
overridable: boolean
type: RouteMap
routeMetric:
metricType: TYPE_1|TYPE_2
metricValue: long
ignoreLsaMospf: boolean
rfc1583Compatible: boolean
timers:
lsaGroup: Integer
processId: 1|2
redistributeProtocols:
- routeMap:
id: uuid
name: Object name
overridable: boolean
type: RouteMap
routeMetric:
metricType: TYPE_1|TYPE_2
metricValue: long
subnets: boolean
tagNumber: long
type: RedistributeStatic
summaryAddresses:
- advertise: boolean
summaryNetwork:
- id: network uuid
name: network name
overridable: boolean
type: Network
type: OspfRoute
schema:
$ref: '#/components/schemas/OspfPolicyModel'
type: object
description: '[DEV ERROR: Missing description]'
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv2routes/ospfv2routesuuid
( Example payload for PUT on OSPFv2 routes. )'
: value:
areas:
- areaId: string
areaNetworks:
- id: uuid
name: any-ipv4
overridable: boolean
type: Network
areaRanges:
- addressNetwork:
id: uuid
name: any
overridable: boolean
type: Network
advertise: boolean
areaType:
type: normal
defaultCost: long
filterList:
- filterDirection: IN|OUT
prefixList:
id: uuid
name: prefix name
virtualLinks:
- deadInterval: short
helloInterval: short
retransmitInterval: short
routerId: uuid
transmitDelay: short
type: virtuallink
enableProcess: PROCESS_1|PROCESS_2
filterRules:
- accessList:
id: accessList uuid
name: accessList name
overridable: boolean
type: StandardAccessList
protocol: 'CONNECTED | STATIC | RIP | OSPF | EIGRP | NONE | BGP '
type: outgoingroutefilter
id: ospfv2routesuuid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv2routes/ospfv2routesuuid
logAdjacencyChanges:
logType: DETAILED|DEFAULT
neighbors:
- ipAddress:
id: network uuid
name: network name
overridable: boolean
type: Network
neighborInterface:
id: uuid
name: Interface name/0
type: Interface
processConfiguration:
administrativeDistance:
external: short
interArea: short
intraArea: short
defaultInformationOriginate:
alwaysAdvertise: boolean
routeMap:
id: uuid
name: Object name
overridable: boolean
type: RouteMap
routeMetric:
metricType: TYPE_1|TYPE_2
metricValue: long
ignoreLsaMospf: boolean
rfc1583Compatible: boolean
timers:
lsaGroup: Integer
processId: 1|2
redistributeProtocols:
- routeMap:
id: uuid
name: Object name
overridable: boolean
type: RouteMap
routeMetric:
metricType: TYPE_1|TYPE_2
metricValue: long
subnets: boolean
tagNumber: long
type: RedistributeStatic
summaryAddresses:
- advertise: boolean
summaryNetwork:
- id: network uuid
name: network name
overridable: boolean
type: Network
type: OspfRoute
schema:
$ref: '#/components/schemas/OspfPolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ospfv3interfaces:
get:
deprecated: false
description: '**Get the list of all OSPFv3 interfaces. When device is in multi virtual router mode, this API is applicable
to Global Virtual Router.**'
operationId: getAllOspfv3InterfacePolicyModel
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Ospfv3InterfacePolicyModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**[DEV ERROR: Missing description] _Check the response section for applicable examples (if any)._**'
operationId: createOspfv3InterfacePolicyModel
parameters:
- description: '[DEV ERROR: Missing description]'
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv3interfaces
( Example payload for POST on ospfv3 interfaces. )'
: value:
areaId: String
authentication:
type: AREA
deviceInterface:
id: uuid
name: Interface name
type: Interface
id: ospfv3interfacesuuid
instance: integer
neighbor:
configurations:
- linkLocalAddress: String
properties:
neighborCost:
cost: integer
filterOutgoingLSA: boolean
deviceInterface:
id: uuid
name: Interface name
type: Interface
processId: integer
properties:
cost: integer
deadInterval: integer
filterOutgoingLSA: boolean
floodReduction: boolean
helloInterval: integer
ignoreMtuMismatch: boolean
priority: integer
ptpNonBroadcast: boolean
retransmitInterval: integer
transmitDelay: integer
type: ospfv3interface
schema:
$ref: '#/components/schemas/Ospfv3InterfacePolicyModel'
type: object
description: '[DEV ERROR: Missing description]'
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv3interfaces
( Example payload for POST on ospfv3 interfaces. )'
: value:
areaId: String
authentication:
type: AREA
deviceInterface:
id: uuid
name: Interface name
type: Interface
id: ospfv3interfacesuuid
instance: integer
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv3interfaces/ospfv3interfacesuuid
neighbor:
configurations:
- linkLocalAddress: String
properties:
neighborCost:
cost: integer
filterOutgoingLSA: boolean
deviceInterface:
id: uuid
name: Interface name
type: Interface
processId: integer
properties:
cost: integer
deadInterval: integer
filterOutgoingLSA: boolean
floodReduction: boolean
helloInterval: integer
ignoreMtuMismatch: boolean
priority: integer
ptpNonBroadcast: boolean
retransmitInterval: integer
transmitDelay: integer
type: ospfv3interface
schema:
$ref: '#/components/schemas/Ospfv3InterfacePolicyModel'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ospfv3interfaces/{objectId}:
delete:
deprecated: false
description: '**[DEV ERROR: Missing description] _Check the response section for applicable examples (if any)._**'
operationId: deleteOspfv3InterfacePolicyModel
parameters:
- description: '[DEV ERROR: Missing description]'
in: path
name: objectId
required: true
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv3interfaces/ospfv3interfacesuuid
( Example payload for DELETE on ospfv3 interfaces. )'
: value:
areaId: String
authentication:
type: AREA
deviceInterface:
id: uuid
name: Interface name
type: Interface
id: ospfv3interfacesuuid
instance: integer
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv3interfaces/ospfv3interfacesuuid
processId: integer
properties:
cost: integer
deadInterval: integer
filterOutgoingLSA: boolean
floodReduction: boolean
helloInterval: integer
ignoreMtuMismatch: boolean
priority: integer
ptpNonBroadcast: boolean
retransmitInterval: integer
transmitDelay: integer
type: ospfv3interface
schema:
$ref: '#/components/schemas/Ospfv3InterfacePolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
get:
deprecated: false
description: '**Get the OSPFv3 interface associated with the specified ID.**'
operationId: getOspfv3InterfacePolicyModel
parameters:
- description: Unique identifier of a OSPFv3 Interface.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv3interfaces?expanded=true
( Example payload for GET on ospfv3 interfaces with expanded flag as true. )'
: value:
items:
- areaId: String
authentication:
authKey: String
authentication: MD_5 | SHA_1
encryptAuthKey: boolean
encryption:
algorithm: TRIPLE_DES | AES_CBC | DES
encryptionKey: String
keyEncrypted: boolean
keyType: AES_128 | AES_192 | AES_256
securityIndex: String
type: INTERFACE
deviceInterface:
id: uuid
name: Interface name
type: Interface
id: ospfv3interfacesuuid
instance: integer
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv3interfaces/ospfv3interfacesuuid
processId: integer
properties:
cost: integer
deadInterval: integer
filterOutgoingLSA: boolean
floodReduction: boolean
helloInterval: integer
ignoreMtuMismatch: boolean
priority: integer
ptpNonBroadcast: boolean
retransmitInterval: integer
transmitDelay: integer
type: ospfv3interface
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv3interfaces?offset=0&limit=2&expanded=true
paging:
count: 1
limit: 1
offset: 0
pages: 1
? 'Example 2 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv3interfaces/ospfv3interfacesuuid
( Example payload for GET on ospfv3 interfaces with specified id )'
: value:
areaId: String
authentication:
authKey: String
authentication: MD_5 | SHA_1
encryptAuthKey: boolean
encryption:
algorithm: TRIPLE_DES | AES_CBC | DES
encryptionKey: String
keyEncrypted: boolean
keyType: AES_128 | AES_192 | AES_256
securityIndex: String
type: INTERFACE
deviceInterface:
id: uuid
name: Interface name
type: Interface
id: ospfv3interfacesuuid
instance: integer
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv3interfaces/ospfv3interfacesuuid
processId: integer
properties:
cost: integer
deadInterval: integer
filterOutgoingLSA: boolean
floodReduction: boolean
helloInterval: integer
ignoreMtuMismatch: boolean
priority: integer
ptpNonBroadcast: boolean
retransmitInterval: integer
transmitDelay: integer
type: ospfv3interface
schema:
$ref: '#/components/schemas/Ospfv3InterfacePolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**[DEV ERROR: Missing description] _Check the response section for applicable examples (if any)._**'
operationId: updateOspfv3InterfacePolicyModel
parameters:
- description: '[DEV ERROR: Missing description]'
in: path
name: objectId
required: true
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv3interfaces/ospfv3interfacesuuid
( Example payload for PUT on ospfv3 interfaces. )'
: value:
areaId: String
authentication:
authKey: String
authentication: MD_5 | SHA_1
encryptAuthKey: boolean
encryption:
algorithm: TRIPLE_DES | AES_CBC | DES
encryptionKey: String
keyEncrypted: boolean
keyType: AES_128 | AES_192 | AES_256
securityIndex: String
type: INTERFACE
deviceInterface:
id: uuid
name: Interface name
type: Interface
id: ospfv3interfacesuuid
instance: integer
neighbor:
configurations:
- linkLocalAddress: String
properties:
neighborCost:
cost: integer
filterOutgoingLSA: boolean
deviceInterface:
id: uuid
name: Interface name
type: Interface
processId: integer
properties:
cost: integer
deadInterval: integer
filterOutgoingLSA: boolean
floodReduction: boolean
helloInterval: integer
ignoreMtuMismatch: boolean
priority: integer
ptpNonBroadcast: boolean
retransmitInterval: integer
transmitDelay: integer
type: ospfv3interface
schema:
$ref: '#/components/schemas/Ospfv3InterfacePolicyModel'
type: object
description: '[DEV ERROR: Missing description]'
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv3interfaces/ospfv3interfacesuuid
( Example payload for PUT on ospfv3 interfaces. )'
: value:
areaId: String
authentication:
authKey: String
authentication: MD_5 | SHA_1
encryptAuthKey: boolean
encryption:
algorithm: TRIPLE_DES | AES_CBC | DES
encryptionKey: String
keyEncrypted: boolean
keyType: AES_128 | AES_192 | AES_256
securityIndex: String
type: INTERFACE
deviceInterface:
id: uuid
name: Interface name
type: Interface
id: ospfv3interfacesuuid
instance: integer
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv3interfaces/ospfv3interfacesuuid
neighbor:
configurations:
- linkLocalAddress: String
properties:
neighborCost:
cost: integer
filterOutgoingLSA: boolean
deviceInterface:
id: uuid
name: Interface name
type: Interface
processId: integer
properties:
cost: integer
deadInterval: integer
filterOutgoingLSA: boolean
floodReduction: boolean
helloInterval: integer
ignoreMtuMismatch: boolean
priority: integer
ptpNonBroadcast: boolean
retransmitInterval: integer
transmitDelay: integer
type: ospfv3interface
schema:
$ref: '#/components/schemas/Ospfv3InterfacePolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ospfv3routes:
get:
deprecated: false
description: '**Get the list of all OSPFv3 routes. When device is in multi virtual router mode, this API is applicable
to Global Virtual Router.**'
operationId: getAllOspfv3PolicyModel
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Ospfv3PolicyModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**[DEV ERROR: Missing description] _Check the response section for applicable examples (if any)._**'
operationId: createOspfv3PolicyModel
parameters:
- description: '[DEV ERROR: Missing description]'
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv3routes
( Example payload for POST on OSPFv3 routes. )'
: value:
areas:
- areaId: string
areaType:
type: normal
defaultCost: long
routeSummary:
- advertise: boolean
cost: long
ipv6Prefix:
id: uuid
name: ipv6 prefix object name
overridable: boolean
type: ipv6prefixlist
virtualLinks:
- deadInterval: short
helloInterval: short
retransmitInterval: short
routerId: string
transmitDelay: short
ttlSecurity: short
- areaId: string
areaType:
noSummary: boolean
type: stub
defaultCost: long
- areaId: string
areaType:
noRedistribution: boolean
noSummary: boolean
routeMetric:
metricType: TYPE_1|TYPE_2
metricValue: long
type: nssa
defaultCost: long
enableOspfv3: boolean
ospfv3Role: abr and asbr
processConfiguration:
administrativeDistance:
external: short
interArea: short
intraArea: short
defaultInformationOriginate:
always: boolean
routeMap:
id: uuid
name: Object name
type: RouteMap
routeMetric:
metricType: TYPE_1|TYPE_2
metricValue: long
ignoreLsaMospf: boolean
logAdjacencyChanges:
includeDetails: boolean
nsfGracefulRestart:
gracefulRestart:
gracefulRestartInterval: Integer
gracefulRestartHelper:
enableLSA: boolean
passiveInterfaces:
- id: uuid
name: Interface name
type: Interface
routerId: string
timers:
floodPacing: integer
lsaArrival: integer
lsaGroup: integer
lsaThrottleTimer:
initialDelay: integer
maximumDelay: integer
minimumDelay: integer
retransmission: integer
spfThrottleTimer:
initialDelay: integer
maximumWaitTime: integer
minimumHoldTime: integer
processId: Integer
redistributeProtocols:
- routeMap:
id: uuid
name: RouteMap name
overridable: boolean
type: RouteMap
routeMetric:
metricType: NONE|TYPE_1|TYPE_2
metricValue: long
tagNumber: long
type: RedistributeConnected
- includeConnected: boolean
matchExternal1: boolean
matchExternal2: boolean
matchInternal: boolean
matchNssaExternal1: boolean
matchNssaExternal2: boolean
processId: string
routeMap:
id: uuid
name: RouteMap name
overridable: boolean
type: RouteMap
routeMetric:
metricType: NONE|TYPE_1|TYPE_2
metricValue: long
tagNumber: long
type: RedistributeOSPF
- routeMap:
id: uuid
name: RouteMap name
overridable: boolean
type: RouteMap
routeMetric:
metricType: NONE|TYPE_1|TYPE_2
metricValue: long
tagNumber: long
type: RedistributeStatic
- asNumber: String
includeConnected: boolean
routeMap:
id: uuid
name: RouteMap name
overridable: boolean
type: RouteMap
routeMetric:
metricType: NONE|TYPE_1|TYPE_2
metricValue: long
tagNumber: long
type: RedistributeBGP
summaryPrefix:
- advertise: boolean
ipv6Prefix:
id: uuid
name: IPV6 prefix object name
overridable: boolean
type: ipv6prefixlist
tag: string
type: ospfv3policy
schema:
$ref: '#/components/schemas/Ospfv3PolicyModel'
type: object
description: '[DEV ERROR: Missing description]'
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv3routes
( Example payload for POST on OSPFv3 routes. )'
: value:
areas:
- areaId: string
areaType:
type: normal
defaultCost: long
routeSummary:
- advertise: boolean
cost: long
ipv6Prefix:
id: uuid
name: ipv6 prefix object name
overridable: boolean
type: ipv6prefixlist
virtualLinks:
- deadInterval: short
helloInterval: short
retransmitInterval: short
routerId: string
transmitDelay: short
ttlSecurity: short
- areaId: string
areaType:
noSummary: boolean
type: stub
defaultCost: long
- areaId: string
areaType:
noRedistribution: boolean
noSummary: boolean
routeMetric:
metricType: TYPE_1|TYPE_2
metricValue: long
type: nssa
defaultCost: long
enableOspfv3: boolean
id: ospfv3routesuuid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv3routes/ospfv3routesuuid
ospfv3Role: abr and asbr
processConfiguration:
administrativeDistance:
external: short
interArea: short
intraArea: short
defaultInformationOriginate:
always: boolean
routeMap:
id: uuid
name: Object name
type: RouteMap
routeMetric:
metricType: TYPE_1|TYPE_2
metricValue: long
ignoreLsaMospf: boolean
logAdjacencyChanges:
includeDetails: boolean
nsfGracefulRestart:
gracefulRestart:
gracefulRestartInterval: Integer
gracefulRestartHelper:
enableLSA: boolean
passiveInterfaces:
- id: uuid
name: Interface name
type: Interface
routerId: string
timers:
floodPacing: integer
lsaArrival: integer
lsaGroup: integer
lsaThrottleTimer:
initialDelay: integer
maximumDelay: integer
minimumDelay: integer
retransmission: integer
spfThrottleTimer:
initialDelay: integer
maximumWaitTime: integer
minimumHoldTime: integer
processId: Integer
redistributeProtocols:
- routeMap:
id: uuid
name: RouteMap name
overridable: boolean
type: RouteMap
routeMetric:
metricType: NONE|TYPE_1|TYPE_2
metricValue: long
tagNumber: long
type: RedistributeConnected
- includeConnected: boolean
matchExternal1: boolean
matchExternal2: boolean
matchInternal: boolean
matchNssaExternal1: boolean
matchNssaExternal2: boolean
processId: string
routeMap:
id: uuid
name: RouteMap name
overridable: boolean
type: RouteMap
routeMetric:
metricType: NONE|TYPE_1|TYPE_2
metricValue: long
tagNumber: long
type: RedistributeOSPF
- routeMap:
id: uuid
name: RouteMap name
overridable: boolean
type: RouteMap
routeMetric:
metricType: NONE|TYPE_1|TYPE_2
metricValue: long
tagNumber: long
type: RedistributeStatic
- asNumber: String
includeConnected: boolean
routeMap:
id: uuid
name: RouteMap name
overridable: boolean
type: RouteMap
routeMetric:
metricType: NONE|TYPE_1|TYPE_2
metricValue: long
tagNumber: long
type: RedistributeBGP
summaryPrefix:
- advertise: boolean
ipv6Prefix:
id: uuid
name: IPV6 prefix object name
overridable: boolean
type: ipv6prefixlist
tag: string
type: ospfv3policy
schema:
$ref: '#/components/schemas/Ospfv3PolicyModel'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/ospfv3routes/{objectId}:
delete:
deprecated: false
description: '**[DEV ERROR: Missing description] _Check the response section for applicable examples (if any)._**'
operationId: deleteOspfv3PolicyModel
parameters:
- description: '[DEV ERROR: Missing description]'
in: path
name: objectId
required: true
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv3routes/ospfv3routesuuid
( Example payload for DELETE on OSPFv3 routes. )'
: value:
areas:
- areaId: string
areaType:
type: normal
defaultCost: long
routeSummary:
- advertise: boolean
cost: long
ipv6Prefix:
id: uuid
name: ipv6 prefix object name
overridable: boolean
type: ipv6prefixlist
virtualLinks:
- deadInterval: short
helloInterval: short
retransmitInterval: short
routerId: string
transmitDelay: short
ttlSecurity: short
- areaId: string
areaType:
noSummary: boolean
type: stub
defaultCost: long
- areaId: string
areaType:
noRedistribution: boolean
noSummary: boolean
routeMetric:
metricType: TYPE_1|TYPE_2
metricValue: long
type: nssa
defaultCost: long
enableOspfv3: boolean
id: ospfv3routesuuid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv3routes/ospfv3routesuuid
ospfv3Role: abr and asbr
processConfiguration:
administrativeDistance:
external: short
interArea: short
intraArea: short
defaultInformationOriginate:
always: boolean
routeMap:
id: uuid
name: Object name
type: RouteMap
routeMetric:
metricType: TYPE_1|TYPE_2
metricValue: long
ignoreLsaMospf: boolean
logAdjacencyChanges:
includeDetails: boolean
nsfGracefulRestart:
gracefulRestart:
gracefulRestartInterval: Integer
gracefulRestartHelper:
enableLSA: boolean
passiveInterfaces:
- id: uuid
name: Interface name
type: Interface
routerId: string
timers:
floodPacing: integer
lsaArrival: integer
lsaGroup: integer
lsaThrottleTimer:
initialDelay: integer
maximumDelay: integer
minimumDelay: integer
retransmission: integer
spfThrottleTimer:
initialDelay: integer
maximumWaitTime: integer
minimumHoldTime: integer
processId: Integer
redistributeProtocols:
- routeMap:
id: uuid
name: RouteMap name
overridable: boolean
type: RouteMap
routeMetric:
metricType: NONE|TYPE_1|TYPE_2
metricValue: long
tagNumber: long
type: RedistributeConnected
- includeConnected: boolean
matchExternal1: boolean
matchExternal2: boolean
matchInternal: boolean
matchNssaExternal1: boolean
matchNssaExternal2: boolean
processId: string
routeMap:
id: uuid
name: RouteMap name
overridable: boolean
type: RouteMap
routeMetric:
metricType: NONE|TYPE_1|TYPE_2
metricValue: long
tagNumber: long
type: RedistributeOSPF
- routeMap:
id: uuid
name: RouteMap name
overridable: boolean
type: RouteMap
routeMetric:
metricType: NONE|TYPE_1|TYPE_2
metricValue: long
tagNumber: long
type: RedistributeStatic
- asNumber: String
includeConnected: boolean
routeMap:
id: uuid
name: RouteMap name
overridable: boolean
type: RouteMap
routeMetric:
metricType: NONE|TYPE_1|TYPE_2
metricValue: long
tagNumber: long
type: RedistributeBGP
summaryPrefix:
- advertise: boolean
ipv6Prefix:
id: uuid
name: IPV6 prefix object name
overridable: boolean
type: ipv6prefixlist
tag: string
type: ospfv3policy
schema:
$ref: '#/components/schemas/Ospfv3PolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
get:
deprecated: false
description: '**Get the OSPFv3 route associated with the specified ID.**'
operationId: getOspfv3PolicyModel
parameters:
- description: Unique identifier of a OSPFv3 route.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv3routes?expanded=true
( Example payload for GET on ospfv3 routes with expanded flag as true. )'
: value:
items:
- areas:
- areaId: string
areaType:
type: normal
defaultCost: long
routeSummary:
- advertise: boolean
cost: long
ipv6Prefix:
id: uuid
name: ipv6 prefix object name
overridable: boolean
type: ipv6prefixlist
virtualLinks:
- deadInterval: short
helloInterval: short
retransmitInterval: short
routerId: string
transmitDelay: short
ttlSecurity: short
- areaId: string
areaType:
noSummary: boolean
type: stub
defaultCost: long
- areaId: string
areaType:
noRedistribution: boolean
noSummary: boolean
routeMetric:
metricType: TYPE_1|TYPE_2
metricValue: long
type: nssa
defaultCost: long
enableOspfv3: boolean
id: ospfv3routesuuid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv3routes/ospfv3routesuuid
ospfv3Role: abr and asbr
processConfiguration:
administrativeDistance:
external: short
interArea: short
intraArea: short
defaultInformationOriginate:
always: boolean
routeMap:
id: uuid
name: Object name
type: RouteMap
routeMetric:
metricType: TYPE_1|TYPE_2
metricValue: long
ignoreLsaMospf: boolean
logAdjacencyChanges:
includeDetails: boolean
nsfGracefulRestart:
gracefulRestart:
gracefulRestartInterval: Integer
gracefulRestartHelper:
enableLSA: boolean
passiveInterfaces:
- id: uuid
name: Interface name
type: Interface
routerId: string
timers:
floodPacing: integer
lsaArrival: integer
lsaGroup: integer
lsaThrottleTimer:
initialDelay: integer
maximumDelay: integer
minimumDelay: integer
retransmission: integer
spfThrottleTimer:
initialDelay: integer
maximumWaitTime: integer
minimumHoldTime: integer
processId: Integer
redistributeProtocols:
- routeMap:
id: uuid
name: RouteMap name
overridable: boolean
type: RouteMap
routeMetric:
metricType: NONE|TYPE_1|TYPE_2
metricValue: long
tagNumber: long
type: RedistributeConnected
- includeConnected: boolean
matchExternal1: boolean
matchExternal2: boolean
matchInternal: boolean
matchNssaExternal1: boolean
matchNssaExternal2: boolean
processId: string
routeMap:
id: uuid
name: RouteMap name
overridable: boolean
type: RouteMap
routeMetric:
metricType: NONE|TYPE_1|TYPE_2
metricValue: long
tagNumber: long
type: RedistributeOSPF
- routeMap:
id: uuid
name: RouteMap name
overridable: boolean
type: RouteMap
routeMetric:
metricType: NONE|TYPE_1|TYPE_2
metricValue: long
tagNumber: long
type: RedistributeStatic
- asNumber: String
includeConnected: boolean
routeMap:
id: uuid
name: RouteMap name
overridable: boolean
type: RouteMap
routeMetric:
metricType: NONE|TYPE_1|TYPE_2
metricValue: long
tagNumber: long
type: RedistributeBGP
summaryPrefix:
- advertise: boolean
ipv6Prefix:
id: uuid
name: IPV6 prefix object name
overridable: boolean
type: ipv6prefixlist
tag: string
type: ospfv3policy
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv3routes?offset=0&limit=2&expanded=true
paging:
count: 1
limit: 1
offset: 0
pages: 1
? 'Example 2 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv3routes/ospfv3routesuuid
( Example payload for GET on ospfv3 routes with specified id )'
: value:
areas:
- areaId: string
areaType:
type: normal
defaultCost: long
routeSummary:
- advertise: boolean
cost: long
ipv6Prefix:
id: uuid
name: ipv6 prefix object name
overridable: boolean
type: ipv6prefixlist
virtualLinks:
- deadInterval: short
helloInterval: short
retransmitInterval: short
routerId: string
transmitDelay: short
ttlSecurity: short
- areaId: string
areaType:
noSummary: boolean
type: stub
defaultCost: long
- areaId: string
areaType:
noRedistribution: boolean
noSummary: boolean
routeMetric:
metricType: TYPE_1|TYPE_2
metricValue: long
type: nssa
defaultCost: long
enableOspfv3: boolean
id: ospfv3routesuuid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv3routes/ospfv3routesuuid
ospfv3Role: abr and asbr
processConfiguration:
administrativeDistance:
external: short
interArea: short
intraArea: short
defaultInformationOriginate:
always: boolean
routeMap:
id: uuid
name: Object name
type: RouteMap
routeMetric:
metricType: TYPE_1|TYPE_2
metricValue: long
ignoreLsaMospf: boolean
logAdjacencyChanges:
includeDetails: boolean
nsfGracefulRestart:
gracefulRestart:
gracefulRestartInterval: Integer
gracefulRestartHelper:
enableLSA: boolean
passiveInterfaces:
- id: uuid
name: Interface name
type: Interface
routerId: string
timers:
floodPacing: integer
lsaArrival: integer
lsaGroup: integer
lsaThrottleTimer:
initialDelay: integer
maximumDelay: integer
minimumDelay: integer
retransmission: integer
spfThrottleTimer:
initialDelay: integer
maximumWaitTime: integer
minimumHoldTime: integer
processId: Integer
redistributeProtocols:
- routeMap:
id: uuid
name: RouteMap name
overridable: boolean
type: RouteMap
routeMetric:
metricType: NONE|TYPE_1|TYPE_2
metricValue: long
tagNumber: long
type: RedistributeConnected
- includeConnected: boolean
matchExternal1: boolean
matchExternal2: boolean
matchInternal: boolean
matchNssaExternal1: boolean
matchNssaExternal2: boolean
processId: string
routeMap:
id: uuid
name: RouteMap name
overridable: boolean
type: RouteMap
routeMetric:
metricType: NONE|TYPE_1|TYPE_2
metricValue: long
tagNumber: long
type: RedistributeOSPF
- routeMap:
id: uuid
name: RouteMap name
overridable: boolean
type: RouteMap
routeMetric:
metricType: NONE|TYPE_1|TYPE_2
metricValue: long
tagNumber: long
type: RedistributeStatic
- asNumber: String
includeConnected: boolean
routeMap:
id: uuid
name: RouteMap name
overridable: boolean
type: RouteMap
routeMetric:
metricType: NONE|TYPE_1|TYPE_2
metricValue: long
tagNumber: long
type: RedistributeBGP
summaryPrefix:
- advertise: boolean
ipv6Prefix:
id: uuid
name: IPV6 prefix object name
overridable: boolean
type: ipv6prefixlist
tag: string
type: ospfv3policy
schema:
$ref: '#/components/schemas/Ospfv3PolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**[DEV ERROR: Missing description] _Check the response section for applicable examples (if any)._**'
operationId: updateOspfv3PolicyModel
parameters:
- description: '[DEV ERROR: Missing description]'
in: path
name: objectId
required: true
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv3routes/ospfv3routesuuid
( Example payload for PUT on OSPFv3 routes. )'
: value:
areas:
- areaId: string
areaType:
type: normal
defaultCost: long
routeSummary:
- advertise: boolean
cost: long
ipv6Prefix:
id: uuid
name: ipv6 prefix object name
overridable: boolean
type: ipv6prefixlist
virtualLinks:
- deadInterval: short
helloInterval: short
retransmitInterval: short
routerId: string
transmitDelay: short
ttlSecurity: short
- areaId: string
areaType:
noSummary: boolean
type: stub
defaultCost: long
- areaId: string
areaType:
noRedistribution: boolean
noSummary: boolean
routeMetric:
metricType: TYPE_1|TYPE_2
metricValue: long
type: nssa
defaultCost: long
enableOspfv3: boolean
id: ospfv3routesuuid
ospfv3Role: abr and asbr
processConfiguration:
administrativeDistance:
external: short
interArea: short
intraArea: short
defaultInformationOriginate:
always: boolean
routeMap:
id: uuid
name: Object name
type: RouteMap
routeMetric:
metricType: TYPE_1|TYPE_2
metricValue: long
ignoreLsaMospf: boolean
logAdjacencyChanges:
includeDetails: boolean
nsfGracefulRestart:
gracefulRestart:
gracefulRestartInterval: Integer
gracefulRestartHelper:
enableLSA: boolean
passiveInterfaces:
- id: uuid
name: Interface name
type: Interface
routerId: string
timers:
floodPacing: integer
lsaArrival: integer
lsaGroup: integer
lsaThrottleTimer:
initialDelay: integer
maximumDelay: integer
minimumDelay: integer
retransmission: integer
spfThrottleTimer:
initialDelay: integer
maximumWaitTime: integer
minimumHoldTime: integer
processId: Integer
redistributeProtocols:
- routeMap:
id: uuid
name: RouteMap name
overridable: boolean
type: RouteMap
routeMetric:
metricType: NONE|TYPE_1|TYPE_2
metricValue: long
tagNumber: long
type: RedistributeConnected
- includeConnected: boolean
matchExternal1: boolean
matchExternal2: boolean
matchInternal: boolean
matchNssaExternal1: boolean
matchNssaExternal2: boolean
processId: string
routeMap:
id: uuid
name: RouteMap name
overridable: boolean
type: RouteMap
routeMetric:
metricType: NONE|TYPE_1|TYPE_2
metricValue: long
tagNumber: long
type: RedistributeOSPF
- routeMap:
id: uuid
name: RouteMap name
overridable: boolean
type: RouteMap
routeMetric:
metricType: NONE|TYPE_1|TYPE_2
metricValue: long
tagNumber: long
type: RedistributeStatic
- asNumber: String
includeConnected: boolean
routeMap:
id: uuid
name: RouteMap name
overridable: boolean
type: RouteMap
routeMetric:
metricType: NONE|TYPE_1|TYPE_2
metricValue: long
tagNumber: long
type: RedistributeBGP
summaryPrefix:
- advertise: boolean
ipv6Prefix:
id: uuid
name: IPV6 prefix object name
overridable: boolean
type: ipv6prefixlist
tag: string
type: ospfv3policy
schema:
$ref: '#/components/schemas/Ospfv3PolicyModel'
type: object
description: '[DEV ERROR: Missing description]'
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv3routes/ospfv3routesuuid
( Example payload for PUT on OSPFv3 routes. )'
: value:
areas:
- areaId: string
areaType:
type: normal
defaultCost: long
routeSummary:
- advertise: boolean
cost: long
ipv6Prefix:
id: uuid
name: ipv6 prefix object name
overridable: boolean
type: ipv6prefixlist
virtualLinks:
- deadInterval: short
helloInterval: short
retransmitInterval: short
routerId: string
transmitDelay: short
ttlSecurity: short
- areaId: string
areaType:
noSummary: boolean
type: stub
defaultCost: long
- areaId: string
areaType:
noRedistribution: boolean
noSummary: boolean
routeMetric:
metricType: TYPE_1|TYPE_2
metricValue: long
type: nssa
defaultCost: long
enableOspfv3: boolean
id: ospfv3routesuuid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ospfv3routes/ospfv3routesuuid
ospfv3Role: abr and asbr
processConfiguration:
administrativeDistance:
external: short
interArea: short
intraArea: short
defaultInformationOriginate:
always: boolean
routeMap:
id: uuid
name: Object name
type: RouteMap
routeMetric:
metricType: TYPE_1|TYPE_2
metricValue: long
ignoreLsaMospf: boolean
logAdjacencyChanges:
includeDetails: boolean
nsfGracefulRestart:
gracefulRestart:
gracefulRestartInterval: Integer
gracefulRestartHelper:
enableLSA: boolean
passiveInterfaces:
- id: uuid
name: Interface name
type: Interface
routerId: string
timers:
floodPacing: integer
lsaArrival: integer
lsaGroup: integer
lsaThrottleTimer:
initialDelay: integer
maximumDelay: integer
minimumDelay: integer
retransmission: integer
spfThrottleTimer:
initialDelay: integer
maximumWaitTime: integer
minimumHoldTime: integer
processId: Integer
redistributeProtocols:
- routeMap:
id: uuid
name: RouteMap name
overridable: boolean
type: RouteMap
routeMetric:
metricType: NONE|TYPE_1|TYPE_2
metricValue: long
tagNumber: long
type: RedistributeConnected
- includeConnected: boolean
matchExternal1: boolean
matchExternal2: boolean
matchInternal: boolean
matchNssaExternal1: boolean
matchNssaExternal2: boolean
processId: string
routeMap:
id: uuid
name: RouteMap name
overridable: boolean
type: RouteMap
routeMetric:
metricType: NONE|TYPE_1|TYPE_2
metricValue: long
tagNumber: long
type: RedistributeOSPF
- routeMap:
id: uuid
name: RouteMap name
overridable: boolean
type: RouteMap
routeMetric:
metricType: NONE|TYPE_1|TYPE_2
metricValue: long
tagNumber: long
type: RedistributeStatic
- asNumber: String
includeConnected: boolean
routeMap:
id: uuid
name: RouteMap name
overridable: boolean
type: RouteMap
routeMetric:
metricType: NONE|TYPE_1|TYPE_2
metricValue: long
tagNumber: long
type: RedistributeBGP
summaryPrefix:
- advertise: boolean
ipv6Prefix:
id: uuid
name: IPV6 prefix object name
overridable: boolean
type: ipv6prefixlist
tag: string
type: ospfv3policy
schema:
$ref: '#/components/schemas/Ospfv3PolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/policybasedroutes:
get:
deprecated: false
description: '**Get the list of all policy-based routes.**'
operationId: getAllPBRPolicyModel
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PBRPolicyModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**Creates a policy-based route. _Check the response section for applicable examples (if any)._**'
operationId: createMultiplePBRPolicyModel
parameters:
- description: Boolean value indicating whether this is performed as a bulk operation.
in: query
name: bulk
required: false
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PBRPolicyModel'
type: object
description: The input policy-based route model.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PBRPolicyModel'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/policybasedroutes/{objectId}:
delete:
deprecated: false
description: '**Delete the policy-based route associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: deletePBRPolicyModel
parameters:
- description: Unique identifier of a policy-based route.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PBRPolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
get:
deprecated: false
description: '**Get the policy-based route associated with the specified ID.**'
operationId: getPBRPolicyModel
parameters:
- description: Unique identifier of a policy-based route.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PBRPolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**Modify the policy-based route associated with the specified ID. _Check the response section for applicable
examples (if any)._**'
operationId: updatePBRPolicyModel
parameters:
- description: Unique identifier of a policy-based route.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PBRPolicyModel'
type: object
description: The input policy-based route model.
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PBRPolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/staticroutes:
get:
deprecated: false
description: '**Get list of all Static routes (ipv4 and ipv6) associated with the specified device. When device is in
multi virtual router mode, this API is applicable to Global Virtual Router.**'
operationId: getAllStaticRouteModel
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/StaticRouteModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/staticroutes/{objectId}:
get:
deprecated: false
description: '**Get the static route associated with the specified ID.**'
operationId: getStaticRouteModel
parameters:
- description: Unique identifier of a Static Route.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/staticroutes
( Example payload for GET on static routes )'
: value:
items:
- id: ipv4StaticRouteUuid
links:
parent: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/staticroutes
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv4staticroutes/ipv4StaticRouteUuid
type: IPv4StaticRoute
- id: ipv6StaticRouteUuid
links:
parent: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/staticroutes
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv6staticroutes/ipv6StaticRouteUuid
type: IPv6StaticRoute
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/staticroutes?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
? 'Example 2 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/staticroutes?expanded=true
( Example payload for GET on static routes with ?expanded=true )'
: value:
items:
- gateway:
literal:
type: Host
value: 5.5.5.5
id: ipv4StaticRouteUuid
interfaceName: InterfaceLogicalName
isTunneled: false
links:
parent: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/staticroutes
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv4staticroutes/ipv4StaticRouteUuid
metricValue: 1
selectedNetworks:
- id: networkObjUuid
name: any
type: Network
type: IPv4StaticRoute
- gateway:
object:
id: networkHostUuid
name: networkHostName
type: Host
id: ipv6StaticRouteUuid
interfaceName: InterfaceLogicalName
isTunneled: false
links:
parent: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/staticroutes
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ipv6staticroutes/ipv6StaticRouteUuid
metricValue: 1
selectedNetworks:
- id: networkObjUuid
name: any
type: Network
type: IPv6StaticRoute
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/staticroutes?offset=0&limit=2&expanded=true
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/StaticRouteModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters:
get:
deprecated: false
description: '**Get the list of all virtual routers created in the specified device.**'
operationId: getAllVirtualRouterModel
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/VirtualRouterModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**Create a virtual router on the specified device. _Check the response section for applicable examples
(if any)._**'
operationId: createVirtualRouterModel
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters
( Example payload for POST on Virtual Router. )'
: value:
description: Human Resource Department Virtual Router
interfaces:
- id: interface_uuid1
name: OUTSIDE
type: PhysicalInterface
- id: interface_uuid2
name: OUTSIDE-SUB
type: SubInterface
name: Beta
type: VirtualRouter
schema:
$ref: '#/components/schemas/VirtualRouterModel'
type: object
description: The input virtual router model.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters
( Example payload for POST on Virtual Router. )'
: value:
description: Human Resource Department Virtual Router
id: virtualrouterUuid
interfaces:
- id: interface_uuid1
name: OUTSIDE
type: PhysicalInterface
- id: interface_uuid2
name: OUTSIDE-SUB
type: SubInterface
links:
parent: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/virtualrouterUuid
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
timestamp: 1529431113943.0
name: Beta
type: VirtualRouter
schema:
$ref: '#/components/schemas/VirtualRouterModel'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{objectId}:
delete:
deprecated: false
description: '**Delete the specified virtual router. _Check the response section for applicable examples (if any)._**'
operationId: deleteVirtualRouterModel
parameters:
- description: Unique identifier of a virtual router.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/virtualrouters/routing/virtualrouters/virtualrouterUuid
( Example payload for DELETE on Virtual Router. )'
: value:
description: Human Resource Department Virtual Router
id: virtualrouterUuid
interfaces:
- id: interface_uuid1
name: OUTSIDE
type: PhysicalInterface
- id: interface_uuid2
name: OUTSIDE-SUB
type: SubInterface
links:
parent: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/virtualrouterUuid
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
timestamp: 1529431113943.0
name: Beta
type: VirtualRouter
schema:
$ref: '#/components/schemas/VirtualRouterModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
get:
deprecated: false
description: '**Get the specified virtual router.**'
operationId: getVirtualRouterModel
parameters:
- description: Unique identifier of a virtual router.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters?offset=0&limit=2
( Example payload for GET on virtual routers )'
: value:
items:
- id: virtualrouterUuid
links:
parent: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/virtualrouterUuid
type: VirtualRouter
- id: virtualrouterUuid
links:
parent: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/virtualrouterUuid
type: VirtualRouter
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
? 'Example 2 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters?expanded=true
( Example payload for GET on static routes with ?expanded=true )'
: value:
items:
- description: Finance Department Virtual Router
id: virtualrouterUuid
interfaces:
- id: interface_uuid1
name: INSIDE
type: PhysicalInterface
- id: interface_uuid2
name: INSIDE-SUB
type: SubInterface
links:
parent: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/virtualrouterUuid
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
timestamp: 1529431113943.0
name: Alpha
type: VirtualRouter
- description: Human Resource Department Virtual Router
id: virtualrouterUuid
interfaces:
- id: interface_uuid1
name: OUTSIDE
type: PhysicalInterface
- id: interface_uuid2
name: OUTSIDE-SUB
type: SubInterface
links:
parent: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/virtualrouterUuid
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
timestamp: 1529431113943.0
name: Beta
type: VirtualRouter
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters?offset=0&limit=2&expanded=true
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/VirtualRouterModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**Modify the specified virtual router. _Check the response section for applicable examples (if any)._**'
operationId: updateVirtualRouterModel
parameters:
- description: Unique identifier of a virtual router.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/virtualrouters/routing/virtualrouters/virtualrouterUuid
( Example payload for PUT on Virtual Router. )'
: value:
description: Human Resource Department Virtual Router
id: virtualrouterUuid
interfaces:
- id: interface_uuid1
name: OUTSIDE
type: PhysicalInterface
- id: interface_uuid2
name: OUTSIDE-SUB
type: SubInterface
name: Beta
type: VirtualRouter
schema:
$ref: '#/components/schemas/VirtualRouterModel'
type: object
description: The input virtual router model.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/virtualrouters/routing/virtualrouters/virtualrouterUuid
( Example payload for PUT on Virtual Router. )'
: value:
description: Human Resource Department Virtual Router
id: virtualrouterUuid
interfaces:
- id: interface_uuid1
name: OUTSIDE
type: PhysicalInterface
- id: interface_uuid2
name: OUTSIDE-SUB
type: SubInterface
links:
parent: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/virtualrouterUuid
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
timestamp: 1529431113943.0
name: Beta
type: VirtualRouter
schema:
$ref: '#/components/schemas/VirtualRouterModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/bfdpolicies
: get:
deprecated: false
description: '**Get the list of all BFD policies on the specified virtual router.**'
operationId: getAllVrfBFDPolicyModel
parameters:
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/bfdpolicies?offset=0&limit=25
( Example payload for GET ALL on BFD )'
: value:
items:
- hopType: SINGLE_HOP
id: bfdPolicyUUid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/bfdpolicies/bfdPolicyUUid
type: BFDPolicy
- destinationAddress:
id: network_object_uuid
name: IPv4-Benchmark-Tests2
type: Network
hopType: MULTI_HOP
id: bfdPolicyUUid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/bfdpolicies/bfdPolicyUUid
sourceAddress:
id: network_object_uuid
name: IPv4-Benchmark-Tests1
type: Network
type: BFDPolicy
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/bfdpolicies?offset=0&limit=25
paging:
count: 2
limit: 25
offset: 0
pages: 1
? 'Example 2 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/bfdpolicies?expanded=true
( GET All BFD with ?expanded=true )'
: value:
items:
- hopType: SINGLE_HOP
id: bfdPolicyUUid
interface:
id: interface_uuid
name: GigabitEthernet1/1
type: PhysicalInterface
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/bfdpolicies/bfdPolicyUUid
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
timestamp: 1657286461000.0
template:
id: template_uuid
name: SingleHopTemplate1
type: BFDTemplate
type: BFDPolicy
- destinationAddress:
id: network_object_uuid
name: IPv4-Benchmark-Tests2
type: Network
hopType: MULTI_HOP
id: bfdPolicyUUid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/bfdpolicies/bfdPolicyUUid
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
ipType: V_4
timestamp: 1657286461000.0
sourceAddress:
id: network_object_uuid
name: IPv4-Benchmark-Tests1
type: Network
template:
id: template_uuid
name: MultiHopTemplate1
type: BFDTemplate
type: BFDPolicy
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/bfdpoliciese?xpanded=true
paging:
count: 2
limit: 25
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/VrfBFDPolicyModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**Create a BFD policy on the specified virtual router. _Check the response section for applicable examples
(if any)._**'
operationId: createVrfBFDPolicyModel
parameters:
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/bfdpolicies
( Example payload for POST SINGLE_HOP Policy on BFD. )'
: value:
hopType: SINGLE_HOP
interface:
id: interface_uuid
name: GigabitEthernet1/1
type: PhysicalInterface
template:
id: template_uuid
name: SingleHopTemplate1
type: BFDTemplate
type: BFDPolicy
? 'Example 2 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/bfdpolicies
( Example payload for POST SINGLE_HOP Policy on BFD. )'
: value:
destinationAddress:
id: network_object_uuid
name: IPv4-Benchmark-Tests2
type: Network
hopType: MULTI_HOP
sourceAddress:
id: network_object_uuid
name: IPv4-Benchmark-Tests1
type: Network
template:
id: template_uuid
name: MultiHopTemplate1
type: BFDTemplate
type: BFDPolicy
schema:
$ref: '#/components/schemas/VrfBFDPolicyModel'
type: object
description: The input BFD policy model.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/bfdpolicies
( Example payload for POST SINGLE_HOP Policy on BFD. )'
: value:
hopType: SINGLE_HOP
id: bfdPolicyUUid
interface:
id: interface_uuid
name: GigabitEthernet1/1
type: PhysicalInterface
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/bfdpolicies/bfdPolicyUUid
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
timestamp: 1657286461000.0
template:
id: template_uuid
name: SingleHopTemplate1
type: BFDTemplate
type: BFDPolicy
? 'Example 2 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/bfdpolicies
( Example payload for POST SINGLE_HOP Policy on BFD. )'
: value:
destinationAddress:
id: network_object_uuid
name: IPv4-Benchmark-Tests2
type: Network
hopType: MULTI_HOP
id: bfdPolicyUUid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/bfdpolicies/bfdPolicyUUid
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
ipType: V_4
timestamp: 1657286461000.0
sourceAddress:
id: network_object_uuid
name: IPv4-Benchmark-Tests1
type: Network
template:
id: template_uuid
name: MultiHopTemplate1
type: BFDTemplate
type: BFDPolicy
schema:
$ref: '#/components/schemas/VrfBFDPolicyModel'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/bfdpolicies/{objectId}
: delete:
deprecated: false
description: '**Delete the BFD policy with the specified ID on the specified virtual router. _Check the response section
for applicable examples (if any)._**'
operationId: deleteVrfBFDPolicyModel
parameters:
- description: Unique identifier of a BFD policy.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/bfdpolicies/bfdPolicyUUid
( Example payload for DELETE SINGLE_HOP on BFD. )'
: value:
hopType: SINGLE_HOP
id: bfdPolicyUUid
interface:
id: interface_uuid
name: GigabitEthernet1/1
type: PhysicalInterface
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/bfdpolicies/bfdPolicyUUid
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
timestamp: 1657286461000.0
template:
id: template_uuid
name: SingleHopTemplate1
type: BFDTemplate
type: BFDPolicy
? 'Example 2 : DELETE /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/bfdpolicies/bfdPolicyUUid
( Example payload for DELETE MULTI_HOP on BFD. )'
: value:
destinationAddress:
id: network_object_uuid
name: IPv4-Benchmark-Tests2
type: Network
hopType: MULTI_HOP
id: bfdPolicyUUid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/bfdpolicies/bfdPolicyUUid
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
ipType: V_4
timestamp: 1657286461000.0
sourceAddress:
id: network_object_uuid
name: IPv4-Benchmark-Tests1
type: Network
template:
id: template_uuid
name: MultiHopTemplate1
type: BFDTemplate
type: BFDPolicy
schema:
$ref: '#/components/schemas/VrfBFDPolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
get:
deprecated: false
description: '**Get the BFD policy with the specified ID on the specified virtual router.**'
operationId: getVrfBFDPolicyModel
parameters:
- description: Unique identifier of a BFD policy.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/bfdpolicies/bfdPolicyUUid
( Example payload for GET SINGLE_HOP Policy on BFD )'
: value:
hopType: SINGLE_HOP
id: bfdPolicyUUid
interface:
id: interface_uuid
name: GigabitEthernet1/1
type: PhysicalInterface
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/bfdpolicies/bfdPolicyUUid
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
timestamp: 1657286461000.0
template:
id: template_uuid
name: SingleHopTemplate1
type: BFDTemplate
type: BFDPolicy
? 'Example 2 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/bfdpolicies/bfdPolicyUUid
( Example payload for GET MULTI_HOP Policy on BFD )'
: value:
destinationAddress:
id: network_object_uuid
name: IPv4-Benchmark-Tests2
type: Network
hopType: MULTI_HOP
id: bfdPolicyUUid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/bfdpolicies/bfdPolicyUUid
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
ipType: V_4
timestamp: 1657286461000.0
sourceAddress:
id: network_object_uuid
name: IPv4-Benchmark-Tests1
type: Network
template:
id: template_uuid
name: MultiHopTemplate1
type: BFDTemplate
type: BFDPolicy
schema:
$ref: '#/components/schemas/VrfBFDPolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**Modify the BFD policy with the specified ID on the specified virtual router. _Check the response section
for applicable examples (if any)._**'
operationId: updateVrfBFDPolicyModel
parameters:
- description: Unique identifier of a BFD policy.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/bfdpolicies/bfdPolicyUUid
( Example payload for PUT SINGLE_HOP on BFD. )'
: value:
hopType: SINGLE_HOP
id: bfdPolicyUUid
interface:
id: interface_uuid
name: GigabitEthernet1/1
type: PhysicalInterface
template:
id: template_uuid
name: SingleHopTemplate1
type: BFDTemplate
type: BFDPolicy
? 'Example 2 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/bfdpolicies/bfdPolicyUUid
( Example payload for PUT MULTI_HOP on BFD. )'
: value:
destinationAddress:
id: network_object_uuid
name: IPv4-Benchmark-Tests2
type: Network
hopType: MULTI_HOP
id: bfdPolicyUUid
sourceAddress:
id: network_object_uuid
name: IPv4-Benchmark-Tests1
type: Network
template:
id: template_uuid
name: MultiHopTemplate1
type: BFDTemplate
type: BFDPolicy
schema:
$ref: '#/components/schemas/VrfBFDPolicyModel'
type: object
description: The input BFD policy model.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/bfdpolicies/bfdPolicyUUid
( Example payload for PUT SINGLE_HOP on BFD. )'
: value:
hopType: SINGLE_HOP
id: bfdPolicyUUid
interface:
id: interface_uuid
name: GigabitEthernet1/1
type: PhysicalInterface
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/bfdpolicies/bfdPolicyUUid
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
timestamp: 1657286461000.0
template:
id: template_uuid
name: SingleHopTemplate1
type: BFDTemplate
type: BFDPolicy
? 'Example 2 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/bfdpolicies/bfdPolicyUUid
( Example payload for PUT MULTI_HOP on BFD. )'
: value:
destinationAddress:
id: network_object_uuid
name: IPv4-Benchmark-Tests2
type: Network
hopType: MULTI_HOP
id: bfdPolicyUUid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/bfdpolicies/bfdPolicyUUid
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
ipType: V_4
timestamp: 1657286461000.0
sourceAddress:
id: network_object_uuid
name: IPv4-Benchmark-Tests1
type: Network
template:
id: template_uuid
name: MultiHopTemplate1
type: BFDTemplate
type: BFDPolicy
schema:
$ref: '#/components/schemas/VrfBFDPolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/bgp
: get:
deprecated: false
description: '**Get the list of all BGP (ipv4 and ipv6) on the specified virtual router.**'
operationId: getAllVrfBGPIPvAddressFamilyModel
parameters:
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/VrfBGPIPvAddressFamilyModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**Create a BGP model on the specified virtual router. _Check the response section for applicable examples
(if any)._**'
operationId: createVrfBGPIPvAddressFamilyModel
parameters:
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/virtualrouterUUID/bgp
( Example payload for POST on vrf bgp. )'
: value:
addressFamilyIPv4:
aftableMap: RouteMap
aggregateTimer: Integer
bgpNextHopTriggerDelay: Integer
bgpNextHopTriggerEnable: boolean
bgpRedistributeInternal: boolean
bgpSupressInactive: boolean
defaultInformationOrginate: boolean
distance:
externalDistance: Integer
internalDistance: Integer
localDistance: Integer
type: afbgpdistance
distributeLists:
- accessList: StandardAccessList
type: incomingroutefilter
- accessList: StandardAccessList
protocol: FilterProtocol Object
type: outgoingroutefilter
maximumPaths:
- ibgp: boolean
type: afmaximumpaths
value: Integer
neighbors:
- ipv4Address: String
neighborAdvanced:
neighborHops:
disableConnectedCheck: boolean
maxHopCount: Integer
neighborTtlSecurityHops: Integer
type: neighborebgpmultihop or neighborttlsecurityhops
neighborSecret: Secret
neighborTransportConnectionMode:
establishTCPSession: boolean
type: neighbortransportconnectionmode
neighborTransportPathMTUDiscovery:
disable: boolean
type: neighbortransportpathmtudiscovery
neighborVersion: Integer
neighborWeight: Integer
nextHopSelf: boolean
sendCommunity: boolean
type: neighboradvanced
neighborFiltering:
ipv4PrefixListFilter:
- filterUpdateAction: '[IN/OUT]'
ipv4PrefixList: IPV4PrefixList
type: neighborprefixlist
neighborDefaultOriginate:
routeMap: RouteMap
type: neighbordefaultoriginate
neighborDistributeLists:
- accessList: AccessList
filterUpdateAction: '[IN/OUT]'
id: uuid of accessList
type: neighbordistributelist
neighborFilterList:
- asPathList: asPath
filterUpdateAction: '[IN/OUT]'
type: neighborfilterlist
neighborMaximumPrefix:
maxPrefixLimit: long
restartInterval: Integer
thresholdValue: Integer
type: neighbormaximumprefix
warningOnly: boolean
neighborRouteMap:
- filterUpdateAction: '[IN/OUT]'
routeMap: RouteMap
type: neighborroutemap
neighborGeneral:
description: 'String '
fallOverBFD: SINGLE_HOP | MULTI_HOP | AUTO_DETECT_HOP | NONE
shutdown: boolean
type: neighborgeneral
updateSource:
id: interfacePolicyUUID
name: String
type: LoopbackInterface
neighborHaMode:
disable: boolean
type: neighborhamode
neighborLocalAs:
asNumber: String
dualAs: boolean
noPrepend: boolean
replaceAs: boolean
type: neighborlocalas
neighborRoutes:
advertisementInterval: Integer
neighborAdvertiseMaps:
- existMap: boolean
existRouteMap: RouteMap
routeMap: RouteMap
type: neighboradvertisemap
removePrivateAs: boolean
neighborTimers:
holdTime: Integer
keepAliveInterval: Integer
minimumHoldTime: Integer
type: neighbortimers
remoteAs: String
type: neighboripv4
redistributeProtocols:
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributestatic
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributeconnected
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributerip
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributebgp
- matchExternal1: boolean
matchExternal2: boolean
matchInternal: boolean
matchNssaExternal1: boolean
matchNssaExternal2: boolean
processId: string
routeMap: routemap
routeMetric:
metricValue: long
type: redistributeospf
routeImportExport:
exportRouteTargets:
- ASN:NN
- ASN:NN
globalVrfExportRouteMap:
id: String
name: String
type: RouteMap
globalVrfImportRouteMap:
id: String
name: String
type: RouteMap
importRouteTargets:
- ASN:NN
- ASN:NN
userVrfExportRouteMap:
id: String
name: String
type: RouteMap
userVrfImportRouteMap:
id: String
name: String
type: RouteMap
scanTime: Integer
synchronization: boolean
type: afipv4
addressFamilyIPv6:
aftableMap: RouteMap
aggregateTimer: Integer
bgpNextHopTriggerDelay: Integer
bgpNextHopTriggerEnable: boolean
bgpRedistributeInternal: boolean
bgpSupressInactive: boolean
defaultInformationOrginate: boolean
distance:
externalDistance: Integer
internalDistance: Integer
localDistance: Integer
type: afbgpdistance
maximumPaths:
- ibgp: boolean
type: afmaximumpaths
value: Integer
neighbors:
- ipv6Address: String
ipv6Prefix: String
linkLocalInterface: interface
neighborAdvanced:
neighborHops:
disableConnectedCheck: boolean
maxHopCount: Integer
neighborTtlSecurityHops: Integer
type: neighborebgpmultihop or neighborttlsecurityhops
neighborSecret: Secret
neighborTransportConnectionMode:
establishTCPSession: boolean
type: neighbortransportconnectionmode
neighborTransportPathMTUDiscovery:
disable: boolean
type: neighbortransportpathmtudiscovery
neighborVersion: Integer
neighborWeight: Integer
nextHopSelf: boolean
sendCommunity: boolean
type: neighboradvanced
neighborFiltering:
ipv4PrefixListFilter:
- filterUpdateAction: '[IN/OUT]'
ipv4PrefixList: IPV4PrefixList
type: neighborprefixlist
neighborDefaultOriginate:
routeMap: RouteMap
type: neighbordefaultoriginate
neighborDistributeLists:
- accessList: AccessList
filterUpdateAction: '[IN/OUT]'
id: uuid of accessList
type: neighbordistributelist
neighborFilterList:
- asPathList: asPath
filterUpdateAction: '[IN/OUT]'
type: neighborfilterlist
neighborMaximumPrefix:
maxPrefixLimit: long
restartInterval: Integer
thresholdValue: Integer
type: neighbormaximumprefix
warningOnly: boolean
neighborRouteMap:
- filterUpdateAction: '[IN/OUT]'
routeMap: RouteMap
type: neighborroutemap
neighborGeneral:
description: 'String '
fallOverBFD: SINGLE_HOP | MULTI_HOP | AUTO_DETECT_HOP | NONE
shutdown: boolean
type: neighborgeneral
updateSource:
id: interfacePolicyUUID
name: String
type: LoopbackInterface
neighborHaMode:
disable: boolean
type: neighborhamode
neighborLocalAs:
asNumber: String
dualAs: boolean
noPrepend: boolean
replaceAs: boolean
type: neighborlocalas
neighborRoutes:
advertisementInterval: Integer
neighborAdvertiseMaps:
- existMap: boolean
existRouteMap: RouteMap
routeMap: RouteMap
type: neighboradvertisemap
removePrivateAs: boolean
neighborTimers:
holdTime: Integer
keepAliveInterval: Integer
minimumHoldTime: Integer
type: neighbortimers
remoteAs: String
type: neighboripv6
redistributeProtocols:
- routeMap: routemap
routeMetric:
metricValue: long
type: RedistributeStatic
- routeMap: routemap
routeMetric:
metricValue: long
type: RedistributeConnected
routeImportExport:
exportRouteTargets:
- ASN:NN
- ASN:NN
globalVrfExportRouteMap:
id: String
name: String
type: RouteMap
globalVrfImportRouteMap:
id: String
name: String
type: RouteMap
importRouteTargets:
- ASN:NN
- ASN:NN
userVrfExportRouteMap:
id: String
name: String
type: RouteMap
userVrfImportRouteMap:
id: String
name: String
type: RouteMap
scanTime: Integer
synchronization: boolean
type: afipv6
asNumber: String
name: String
routerId: String
type: bgp
? 'Example 2 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/virtualrouterUUID/bgp
( Example payload for POST on global vrf bgp.IPv6 address family is allowed only for global vrf BGP. )'
: value:
addressFamilyIPv4:
aftableMap: RouteMap
aggregateTimer: Integer
bgpNextHopTriggerDelay: Integer
bgpNextHopTriggerEnable: boolean
bgpRedistributeInternal: boolean
bgpSupressInactive: boolean
defaultInformationOrginate: boolean
distance:
externalDistance: Integer
internalDistance: Integer
localDistance: Integer
type: afbgpdistance
distributeLists:
- accessList: StandardAccessList
type: incomingroutefilter
- accessList: StandardAccessList
protocol: FilterProtocol Object
type: outgoingroutefilter
maximumPaths:
- ibgp: boolean
type: afmaximumpaths
value: Integer
neighbors:
- ipv4Address: String
neighborAdvanced:
neighborHops:
disableConnectedCheck: boolean
maxHopCount: Integer
neighborTtlSecurityHops: Integer
type: neighborebgpmultihop or neighborttlsecurityhops
neighborSecret: Secret
neighborTransportConnectionMode:
establishTCPSession: boolean
type: neighbortransportconnectionmode
neighborTransportPathMTUDiscovery:
disable: boolean
type: neighbortransportpathmtudiscovery
neighborVersion: Integer
neighborWeight: Integer
nextHopSelf: boolean
sendCommunity: boolean
type: neighboradvanced
neighborFiltering:
ipv4PrefixListFilter:
- filterUpdateAction: '[IN/OUT]'
ipv4PrefixList: IPV4PrefixList
type: neighborprefixlist
neighborDefaultOriginate:
routeMap: RouteMap
type: neighbordefaultoriginate
neighborDistributeLists:
- accessList: AccessList
filterUpdateAction: '[IN/OUT]'
id: uuid of accessList
type: neighbordistributelist
neighborFilterList:
- asPathList: asPath
filterUpdateAction: '[IN/OUT]'
type: neighborfilterlist
neighborMaximumPrefix:
maxPrefixLimit: long
restartInterval: Integer
thresholdValue: Integer
type: neighbormaximumprefix
warningOnly: boolean
neighborRouteMap:
- filterUpdateAction: '[IN/OUT]'
routeMap: RouteMap
type: neighborroutemap
neighborGeneral:
description: 'String '
fallOverBFD: SINGLE_HOP | MULTI_HOP | AUTO_DETECT_HOP | NONE
shutdown: boolean
type: neighborgeneral
updateSource:
id: interfacePolicyUUID
name: String
type: LoopbackInterface
neighborHaMode:
disable: boolean
type: neighborhamode
neighborLocalAs:
asNumber: String
dualAs: boolean
noPrepend: boolean
replaceAs: boolean
type: neighborlocalas
neighborRoutes:
advertisementInterval: Integer
neighborAdvertiseMaps:
- existMap: boolean
existRouteMap: RouteMap
routeMap: RouteMap
type: neighboradvertisemap
removePrivateAs: boolean
neighborTimers:
holdTime: Integer
keepAliveInterval: Integer
minimumHoldTime: Integer
type: neighbortimers
remoteAs: String
type: neighboripv4
redistributeProtocols:
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributestatic
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributeconnected
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributerip
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributebgp
- matchExternal1: boolean
matchExternal2: boolean
matchInternal: boolean
matchNssaExternal1: boolean
matchNssaExternal2: boolean
processId: string
routeMap: routemap
routeMetric:
metricValue: long
type: redistributeospf
scanTime: Integer
synchronization: boolean
type: afipv4
addressFamilyIPv6:
aftableMap: RouteMap
aggregateTimer: Integer
bgpNextHopTriggerDelay: Integer
bgpNextHopTriggerEnable: boolean
bgpRedistributeInternal: boolean
bgpSupressInactive: boolean
defaultInformationOrginate: boolean
distance:
externalDistance: Integer
internalDistance: Integer
localDistance: Integer
type: afbgpdistance
maximumPaths:
- ibgp: boolean
type: afmaximumpaths
value: Integer
neighbors:
- ipv6Address: String
ipv6Prefix: String
linkLocalInterface: interface
neighborAdvanced:
neighborHops:
disableConnectedCheck: boolean
maxHopCount: Integer
neighborTtlSecurityHops: Integer
type: neighborebgpmultihop or neighborttlsecurityhops
neighborSecret: Secret
neighborTransportConnectionMode:
establishTCPSession: boolean
type: neighbortransportconnectionmode
neighborTransportPathMTUDiscovery:
disable: boolean
type: neighbortransportpathmtudiscovery
neighborVersion: Integer
neighborWeight: Integer
nextHopSelf: boolean
sendCommunity: boolean
type: neighboradvanced
neighborFiltering:
ipv4PrefixListFilter:
- filterUpdateAction: '[IN/OUT]'
ipv4PrefixList: IPV4PrefixList
type: neighborprefixlist
neighborDefaultOriginate:
routeMap: RouteMap
type: neighbordefaultoriginate
neighborDistributeLists:
- accessList: AccessList
filterUpdateAction: '[IN/OUT]'
id: uuid of accessList
type: neighbordistributelist
neighborFilterList:
- asPathList: asPath
filterUpdateAction: '[IN/OUT]'
type: neighborfilterlist
neighborMaximumPrefix:
maxPrefixLimit: long
restartInterval: Integer
thresholdValue: Integer
type: neighbormaximumprefix
warningOnly: boolean
neighborRouteMap:
- filterUpdateAction: '[IN/OUT]'
routeMap: RouteMap
type: neighborroutemap
neighborGeneral:
description: 'String '
fallOverBFD: SINGLE_HOP | MULTI_HOP | AUTO_DETECT_HOP | NONE
shutdown: boolean
type: neighborgeneral
updateSource:
id: interfacePolicyUUID
name: String
type: LoopbackInterface
neighborHaMode:
disable: boolean
type: neighborhamode
neighborLocalAs:
asNumber: String
dualAs: boolean
noPrepend: boolean
replaceAs: boolean
type: neighborlocalas
neighborRoutes:
advertisementInterval: Integer
neighborAdvertiseMaps:
- existMap: boolean
existRouteMap: RouteMap
routeMap: RouteMap
type: neighboradvertisemap
removePrivateAs: boolean
neighborTimers:
holdTime: Integer
keepAliveInterval: Integer
minimumHoldTime: Integer
type: neighbortimers
remoteAs: String
type: neighboripv6
redistributeProtocols:
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributestatic
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributeconnected
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributerip
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributebgp
- matchExternal1: boolean
matchExternal2: boolean
matchInternal: boolean
matchNssaExternal1: boolean
matchNssaExternal2: boolean
processId: string
routeMap: routemap
routeMetric:
metricValue: long
type: redistributeospf
scanTime: Integer
synchronization: boolean
type: afipv6
asNumber: String
name: String
routerId: String
type: bgp
schema:
$ref: '#/components/schemas/VrfBGPIPvAddressFamilyModel'
type: object
description: The input BGP (ipv4 and ipv6) model.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/virtualrouterUUID/bgp
( Example payload for POST on vrf bgp. )'
: value:
addressFamilyIPv4:
aftableMap: RouteMap
aggregateTimer: Integer
bgpNextHopTriggerDelay: Integer
bgpNextHopTriggerEnable: boolean
bgpRedistributeInternal: boolean
bgpSupressInactive: boolean
defaultInformationOrginate: boolean
distance:
externalDistance: Integer
internalDistance: Integer
localDistance: Integer
type: afbgpdistance
distributeLists:
- accessList: StandardAccessList
type: incomingroutefilter
- accessList: StandardAccessList
protocol: FilterProtocol Object
type: outgoingroutefilter
id: uuid of ipv4 general settings
maximumPaths:
- ibgp: boolean
type: afmaximumpaths
value: Integer
neighbors:
- ipv4Address: String
neighborAdvanced:
neighborHops:
disableConnectedCheck: boolean
maxHopCount: Integer
neighborTtlSecurityHops: Integer
type: neighborebgpmultihop or neighborttlsecurityhops
neighborSecret: Secret
neighborTransportConnectionMode:
establishTCPSession: boolean
type: neighbortransportconnectionmode
neighborTransportPathMTUDiscovery:
disable: boolean
type: neighbortransportpathmtudiscovery
neighborVersion: Integer
neighborWeight: Integer
nextHopSelf: boolean
sendCommunity: boolean
type: neighboradvanced
neighborFiltering:
ipv4PrefixListFilter:
- filterUpdateAction: '[IN/OUT]'
ipv4PrefixList: IPV4PrefixList
type: neighborprefixlist
neighborDefaultOriginate:
routeMap: RouteMap
type: neighbordefaultoriginate
neighborDistributeLists:
- accessList: AccessList
filterUpdateAction: '[IN/OUT]'
id: uuid of accessList
type: neighbordistributelist
neighborFilterList:
- asPathList: asPath
filterUpdateAction: '[IN/OUT]'
type: neighborfilterlist
neighborMaximumPrefix:
maxPrefixLimit: long
restartInterval: Integer
thresholdValue: Integer
type: neighbormaximumprefix
warningOnly: boolean
neighborRouteMap:
- filterUpdateAction: '[IN/OUT]'
routeMap: RouteMap
type: neighborroutemap
neighborGeneral:
description: 'String '
fallOverBFD: SINGLE_HOP | MULTI_HOP | AUTO_DETECT_HOP | NONE
shutdown: boolean
type: neighborgeneral
updateSource:
id: interfacePolicyUUID
name: String
type: LoopbackInterface
neighborHaMode:
disable: boolean
type: neighborhamode
neighborLocalAs:
asNumber: String
dualAs: boolean
noPrepend: boolean
replaceAs: boolean
type: neighborlocalas
neighborRoutes:
advertisementInterval: Integer
neighborAdvertiseMaps:
- existMap: boolean
existRouteMap: RouteMap
routeMap: RouteMap
type: neighboradvertisemap
removePrivateAs: boolean
neighborTimers:
holdTime: Integer
keepAliveInterval: Integer
minimumHoldTime: Integer
type: neighbortimers
remoteAs: String
type: neighboripv4
redistributeProtocols:
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributestatic
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributeconnected
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributerip
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributebgp
- matchExternal1: boolean
matchExternal2: boolean
matchInternal: boolean
matchNssaExternal1: boolean
matchNssaExternal2: boolean
processId: string
routeMap: routemap
routeMetric:
metricValue: long
type: redistributeospf
routeImportExport:
exportRouteTargets:
- ASN:NN
- ASN:NN
globalVrfExportRouteMap:
id: String
name: String
type: RouteMap
globalVrfImportRouteMap:
id: String
name: String
type: RouteMap
importRouteTargets:
- ASN:NN
- ASN:NN
userVrfExportRouteMap:
id: String
name: String
type: RouteMap
userVrfImportRouteMap:
id: String
name: String
type: RouteMap
scanTime: Integer
synchronization: boolean
type: afipv4
addressFamilyIPv6:
aftableMap: RouteMap
aggregateTimer: Integer
bgpNextHopTriggerDelay: Integer
bgpNextHopTriggerEnable: boolean
bgpRedistributeInternal: boolean
bgpSupressInactive: boolean
defaultInformationOrginate: boolean
distance:
externalDistance: Integer
internalDistance: Integer
localDistance: Integer
type: afbgpdistance
maximumPaths:
- ibgp: boolean
type: afmaximumpaths
value: Integer
neighbors:
- ipv6Address: String
ipv6Prefix: String
linkLocalInterface: interface
neighborAdvanced:
neighborHops:
disableConnectedCheck: boolean
maxHopCount: Integer
neighborTtlSecurityHops: Integer
type: neighborebgpmultihop or neighborttlsecurityhops
neighborSecret: Secret
neighborTransportConnectionMode:
establishTCPSession: boolean
type: neighbortransportconnectionmode
neighborTransportPathMTUDiscovery:
disable: boolean
type: neighbortransportpathmtudiscovery
neighborVersion: Integer
neighborWeight: Integer
nextHopSelf: boolean
sendCommunity: boolean
type: neighboradvanced
neighborFiltering:
ipv4PrefixListFilter:
- filterUpdateAction: '[IN/OUT]'
ipv4PrefixList: IPV4PrefixList
type: neighborprefixlist
neighborDefaultOriginate:
routeMap: RouteMap
type: neighbordefaultoriginate
neighborDistributeLists:
- accessList: AccessList
filterUpdateAction: '[IN/OUT]'
id: uuid of accessList
type: neighbordistributelist
neighborFilterList:
- asPathList: asPath
filterUpdateAction: '[IN/OUT]'
type: neighborfilterlist
neighborMaximumPrefix:
maxPrefixLimit: long
restartInterval: Integer
thresholdValue: Integer
type: neighbormaximumprefix
warningOnly: boolean
neighborRouteMap:
- filterUpdateAction: '[IN/OUT]'
routeMap: RouteMap
type: neighborroutemap
neighborGeneral:
description: 'String '
fallOverBFD: SINGLE_HOP | MULTI_HOP | AUTO_DETECT_HOP | NONE
shutdown: boolean
type: neighborgeneral
updateSource:
id: interfacePolicyUUID
name: String
type: LoopbackInterface
neighborHaMode:
disable: boolean
type: neighborhamode
neighborLocalAs:
asNumber: String
dualAs: boolean
noPrepend: boolean
replaceAs: boolean
type: neighborlocalas
neighborRoutes:
advertisementInterval: Integer
neighborAdvertiseMaps:
- existMap: boolean
existRouteMap: RouteMap
routeMap: RouteMap
type: neighboradvertisemap
removePrivateAs: boolean
neighborTimers:
holdTime: Integer
keepAliveInterval: Integer
minimumHoldTime: Integer
type: neighbortimers
remoteAs: String
type: neighboripv6
redistributeProtocols:
- routeMap: routemap
routeMetric:
metricValue: long
type: RedistributeStatic
- routeMap: routemap
routeMetric:
metricValue: long
type: RedistributeConnected
routeImportExport:
exportRouteTargets:
- ASN:NN
- ASN:NN
globalVrfExportRouteMap:
id: String
name: String
type: RouteMap
globalVrfImportRouteMap:
id: String
name: String
type: RouteMap
importRouteTargets:
- ASN:NN
- ASN:NN
userVrfExportRouteMap:
id: String
name: String
type: RouteMap
userVrfImportRouteMap:
id: String
name: String
type: RouteMap
scanTime: Integer
synchronization: boolean
type: afipv6
asNumber: String
id: bgpUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/virtualrouterUUID/bgp/bgpUUID
name: String
routerId: String
type: bgp
? 'Example 2 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/virtualrouterUUID/bgp
( Example payload for POST on global vrf bgp.IPv6 address family is allowed only for global vrf BGP. )'
: value:
addressFamilyIPv4:
aftableMap: RouteMap
aggregateTimer: Integer
bgpNextHopTriggerDelay: Integer
bgpNextHopTriggerEnable: boolean
bgpRedistributeInternal: boolean
bgpSupressInactive: boolean
defaultInformationOrginate: boolean
distance:
externalDistance: Integer
internalDistance: Integer
localDistance: Integer
type: afbgpdistance
distributeLists:
- accessList: StandardAccessList
type: incomingroutefilter
- accessList: StandardAccessList
protocol: FilterProtocol Object
type: outgoingroutefilter
id: uuid of ipv4 general settings
maximumPaths:
- ibgp: boolean
type: afmaximumpaths
value: Integer
neighbors:
- ipv4Address: String
neighborAdvanced:
neighborHops:
disableConnectedCheck: boolean
maxHopCount: Integer
neighborTtlSecurityHops: Integer
type: neighborebgpmultihop or neighborttlsecurityhops
neighborSecret: Secret
neighborTransportConnectionMode:
establishTCPSession: boolean
type: neighbortransportconnectionmode
neighborTransportPathMTUDiscovery:
disable: boolean
type: neighbortransportpathmtudiscovery
neighborVersion: Integer
neighborWeight: Integer
nextHopSelf: boolean
sendCommunity: boolean
type: neighboradvanced
neighborFiltering:
ipv4PrefixListFilter:
- filterUpdateAction: '[IN/OUT]'
ipv4PrefixList: IPV4PrefixList
type: neighborprefixlist
neighborDefaultOriginate:
routeMap: RouteMap
type: neighbordefaultoriginate
neighborDistributeLists:
- accessList: AccessList
filterUpdateAction: '[IN/OUT]'
id: uuid of accessList
type: neighbordistributelist
neighborFilterList:
- asPathList: asPath
filterUpdateAction: '[IN/OUT]'
type: neighborfilterlist
neighborMaximumPrefix:
maxPrefixLimit: long
restartInterval: Integer
thresholdValue: Integer
type: neighbormaximumprefix
warningOnly: boolean
neighborRouteMap:
- filterUpdateAction: '[IN/OUT]'
routeMap: RouteMap
type: neighborroutemap
neighborGeneral:
description: 'String '
fallOverBFD: SINGLE_HOP | MULTI_HOP | AUTO_DETECT_HOP | NONE
shutdown: boolean
type: neighborgeneral
updateSource:
id: interfacePolicyUUID
name: String
type: LoopbackInterface
neighborHaMode:
disable: boolean
type: neighborhamode
neighborLocalAs:
asNumber: String
dualAs: boolean
noPrepend: boolean
replaceAs: boolean
type: neighborlocalas
neighborRoutes:
advertisementInterval: Integer
neighborAdvertiseMaps:
- existMap: boolean
existRouteMap: RouteMap
routeMap: RouteMap
type: neighboradvertisemap
removePrivateAs: boolean
neighborTimers:
holdTime: Integer
keepAliveInterval: Integer
minimumHoldTime: Integer
type: neighbortimers
remoteAs: String
type: neighboripv4
redistributeProtocols:
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributestatic
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributeconnected
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributerip
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributebgp
- matchExternal1: boolean
matchExternal2: boolean
matchInternal: boolean
matchNssaExternal1: boolean
matchNssaExternal2: boolean
processId: string
routeMap: routemap
routeMetric:
metricValue: long
type: redistributeospf
scanTime: Integer
synchronization: boolean
type: afipv4
addressFamilyIPv6:
aftableMap: RouteMap
aggregateTimer: Integer
bgpNextHopTriggerDelay: Integer
bgpNextHopTriggerEnable: boolean
bgpRedistributeInternal: boolean
bgpSupressInactive: boolean
defaultInformationOrginate: boolean
distance:
externalDistance: Integer
internalDistance: Integer
localDistance: Integer
type: afbgpdistance
id: uuid of ipv6 general settings
maximumPaths:
- ibgp: boolean
type: afmaximumpaths
value: Integer
neighbors:
- ipv6Address: String
ipv6Prefix: String
linkLocalInterface: interface
neighborAdvanced:
neighborHops:
disableConnectedCheck: boolean
maxHopCount: Integer
neighborTtlSecurityHops: Integer
type: neighborebgpmultihop or neighborttlsecurityhops
neighborSecret: Secret
neighborTransportConnectionMode:
establishTCPSession: boolean
type: neighbortransportconnectionmode
neighborTransportPathMTUDiscovery:
disable: boolean
type: neighbortransportpathmtudiscovery
neighborVersion: Integer
neighborWeight: Integer
nextHopSelf: boolean
sendCommunity: boolean
type: neighboradvanced
neighborFiltering:
ipv4PrefixListFilter:
- filterUpdateAction: '[IN/OUT]'
ipv4PrefixList: IPV4PrefixList
type: neighborprefixlist
neighborDefaultOriginate:
routeMap: RouteMap
type: neighbordefaultoriginate
neighborDistributeLists:
- accessList: AccessList
filterUpdateAction: '[IN/OUT]'
id: uuid of accessList
type: neighbordistributelist
neighborFilterList:
- asPathList: asPath
filterUpdateAction: '[IN/OUT]'
type: neighborfilterlist
neighborMaximumPrefix:
maxPrefixLimit: long
restartInterval: Integer
thresholdValue: Integer
type: neighbormaximumprefix
warningOnly: boolean
neighborRouteMap:
- filterUpdateAction: '[IN/OUT]'
routeMap: RouteMap
type: neighborroutemap
neighborGeneral:
description: 'String '
fallOverBFD: SINGLE_HOP | MULTI_HOP | AUTO_DETECT_HOP | NONE
shutdown: boolean
type: neighborgeneral
updateSource:
id: interfacePolicyUUID
name: String
type: LoopbackInterface
neighborHaMode:
disable: boolean
type: neighborhamode
neighborLocalAs:
asNumber: String
dualAs: boolean
noPrepend: boolean
replaceAs: boolean
type: neighborlocalas
neighborRoutes:
advertisementInterval: Integer
neighborAdvertiseMaps:
- existMap: boolean
existRouteMap: RouteMap
routeMap: RouteMap
type: neighboradvertisemap
removePrivateAs: boolean
neighborTimers:
holdTime: Integer
keepAliveInterval: Integer
minimumHoldTime: Integer
type: neighbortimers
remoteAs: String
type: neighboripv6
redistributeProtocols:
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributestatic
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributeconnected
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributerip
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributebgp
- matchExternal1: boolean
matchExternal2: boolean
matchInternal: boolean
matchNssaExternal1: boolean
matchNssaExternal2: boolean
processId: string
routeMap: routemap
routeMetric:
metricValue: long
type: redistributeospf
scanTime: Integer
synchronization: boolean
type: afipv6
asNumber: String
id: bgpUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/virtualrouterUUID/bgp/bgpUUID
name: String
routerId: String
type: bgp
schema:
$ref: '#/components/schemas/VrfBGPIPvAddressFamilyModel'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/bgp/{objectId}
: delete:
deprecated: false
description: '**Delete the specified BGP model on the specified virtual router. _Check the response section for applicable
examples (if any)._**'
operationId: deleteVrfBGPIPvAddressFamilyModel
parameters:
- description: Unique identifier of a BGP (ipv4 or ipv6) model.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/virtualrouters/routing/virtualrouters/virtualrouterUUID/bgp/bgpUUID
( Example payload for DELETE on vrf bgp. )'
: value:
addressFamilyIPv4:
aftableMap: RouteMap
aggregateTimer: Integer
bgpNextHopTriggerDelay: Integer
bgpNextHopTriggerEnable: boolean
bgpRedistributeInternal: boolean
bgpSupressInactive: boolean
defaultInformationOrginate: boolean
distance:
externalDistance: Integer
internalDistance: Integer
localDistance: Integer
type: afbgpdistance
distributeLists:
- accessList: StandardAccessList
type: incomingroutefilter
- accessList: StandardAccessList
protocol: FilterProtocol Object
type: outgoingroutefilter
id: uuid of ipv4 general settings
maximumPaths:
- ibgp: boolean
type: afmaximumpaths
value: Integer
neighbors:
- ipv4Address: String
neighborAdvanced:
neighborHops:
disableConnectedCheck: boolean
maxHopCount: Integer
neighborTtlSecurityHops: Integer
type: neighborebgpmultihop or neighborttlsecurityhops
neighborSecret: Secret
neighborTransportConnectionMode:
establishTCPSession: boolean
type: neighbortransportconnectionmode
neighborTransportPathMTUDiscovery:
disable: boolean
type: neighbortransportpathmtudiscovery
neighborVersion: Integer
neighborWeight: Integer
nextHopSelf: boolean
sendCommunity: boolean
type: neighboradvanced
neighborFiltering:
ipv4PrefixListFilter:
- filterUpdateAction: '[IN/OUT]'
ipv4PrefixList: IPV4PrefixList
type: neighborprefixlist
neighborDefaultOriginate:
routeMap: RouteMap
type: neighbordefaultoriginate
neighborDistributeLists:
- accessList: AccessList
filterUpdateAction: '[IN/OUT]'
id: uuid of accessList
type: neighbordistributelist
neighborFilterList:
- asPathList: asPath
filterUpdateAction: '[IN/OUT]'
type: neighborfilterlist
neighborMaximumPrefix:
maxPrefixLimit: long
restartInterval: Integer
thresholdValue: Integer
type: neighbormaximumprefix
warningOnly: boolean
neighborRouteMap:
- filterUpdateAction: '[IN/OUT]'
routeMap: RouteMap
type: neighborroutemap
neighborGeneral:
description: 'String '
fallOverBFD: SINGLE_HOP | MULTI_HOP | AUTO_DETECT_HOP | NONE
shutdown: boolean
type: neighborgeneral
updateSource:
id: interfacePolicyUUID
name: String
type: LoopbackInterface
neighborHaMode:
disable: boolean
type: neighborhamode
neighborLocalAs:
asNumber: String
dualAs: boolean
noPrepend: boolean
replaceAs: boolean
type: neighborlocalas
neighborRoutes:
advertisementInterval: Integer
neighborAdvertiseMaps:
- existMap: boolean
existRouteMap: RouteMap
routeMap: RouteMap
type: neighboradvertisemap
removePrivateAs: boolean
neighborTimers:
holdTime: Integer
keepAliveInterval: Integer
minimumHoldTime: Integer
type: neighbortimers
remoteAs: String
type: neighboripv4
redistributeProtocols:
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributestatic
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributeconnected
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributerip
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributebgp
- matchExternal1: boolean
matchExternal2: boolean
matchInternal: boolean
matchNssaExternal1: boolean
matchNssaExternal2: boolean
processId: string
routeMap: routemap
routeMetric:
metricValue: long
type: redistributeospf
routeImportExport:
exportRouteTargets:
- ASN:NN
- ASN:NN
globalVrfExportRouteMap:
id: String
name: String
type: RouteMap
globalVrfImportRouteMap:
id: String
name: String
type: RouteMap
importRouteTargets:
- ASN:NN
- ASN:NN
userVrfExportRouteMap:
id: String
name: String
type: RouteMap
userVrfImportRouteMap:
id: String
name: String
type: RouteMap
scanTime: Integer
synchronization: boolean
type: afipv4
addressFamilyIPv6:
aftableMap: RouteMap
aggregateTimer: Integer
bgpNextHopTriggerDelay: Integer
bgpNextHopTriggerEnable: boolean
bgpRedistributeInternal: boolean
bgpSupressInactive: boolean
defaultInformationOrginate: boolean
distance:
externalDistance: Integer
internalDistance: Integer
localDistance: Integer
type: afbgpdistance
maximumPaths:
- ibgp: boolean
type: afmaximumpaths
value: Integer
neighbors:
- ipv6Address: String
ipv6Prefix: String
linkLocalInterface: interface
neighborAdvanced:
neighborHops:
disableConnectedCheck: boolean
maxHopCount: Integer
neighborTtlSecurityHops: Integer
type: neighborebgpmultihop or neighborttlsecurityhops
neighborSecret: Secret
neighborTransportConnectionMode:
establishTCPSession: boolean
type: neighbortransportconnectionmode
neighborTransportPathMTUDiscovery:
disable: boolean
type: neighbortransportpathmtudiscovery
neighborVersion: Integer
neighborWeight: Integer
nextHopSelf: boolean
sendCommunity: boolean
type: neighboradvanced
neighborFiltering:
ipv4PrefixListFilter:
- filterUpdateAction: '[IN/OUT]'
ipv4PrefixList: IPV4PrefixList
type: neighborprefixlist
neighborDefaultOriginate:
routeMap: RouteMap
type: neighbordefaultoriginate
neighborDistributeLists:
- accessList: AccessList
filterUpdateAction: '[IN/OUT]'
id: uuid of accessList
type: neighbordistributelist
neighborFilterList:
- asPathList: asPath
filterUpdateAction: '[IN/OUT]'
type: neighborfilterlist
neighborMaximumPrefix:
maxPrefixLimit: long
restartInterval: Integer
thresholdValue: Integer
type: neighbormaximumprefix
warningOnly: boolean
neighborRouteMap:
- filterUpdateAction: '[IN/OUT]'
routeMap: RouteMap
type: neighborroutemap
neighborGeneral:
description: 'String '
fallOverBFD: SINGLE_HOP | MULTI_HOP | AUTO_DETECT_HOP | NONE
shutdown: boolean
type: neighborgeneral
updateSource:
id: interfacePolicyUUID
name: String
type: LoopbackInterface
neighborHaMode:
disable: boolean
type: neighborhamode
neighborLocalAs:
asNumber: String
dualAs: boolean
noPrepend: boolean
replaceAs: boolean
type: neighborlocalas
neighborRoutes:
advertisementInterval: Integer
neighborAdvertiseMaps:
- existMap: boolean
existRouteMap: RouteMap
routeMap: RouteMap
type: neighboradvertisemap
removePrivateAs: boolean
neighborTimers:
holdTime: Integer
keepAliveInterval: Integer
minimumHoldTime: Integer
type: neighbortimers
remoteAs: String
type: neighboripv6
redistributeProtocols:
- routeMap: routemap
routeMetric:
metricValue: long
type: RedistributeStatic
- routeMap: routemap
routeMetric:
metricValue: long
type: RedistributeConnected
routeImportExport:
exportRouteTargets:
- ASN:NN
- ASN:NN
globalVrfExportRouteMap:
id: String
name: String
type: RouteMap
globalVrfImportRouteMap:
id: String
name: String
type: RouteMap
importRouteTargets:
- ASN:NN
- ASN:NN
userVrfExportRouteMap:
id: String
name: String
type: RouteMap
userVrfImportRouteMap:
id: String
name: String
type: RouteMap
scanTime: Integer
synchronization: boolean
type: afipv6
asNumber: String
id: bgpUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/virtualrouterUUID/bgp/bgpUUID
name: String
routerId: String
type: bgp
schema:
$ref: '#/components/schemas/VrfBGPIPvAddressFamilyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
get:
deprecated: false
description: '**Get the specified BGP model on the specified virtual router.**'
operationId: getVrfBGPIPvAddressFamilyModel
parameters:
- description: Unique identifier of a BGP (ipv4 or ipv6) model.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/virtualrouterUUID/bgp?expanded=true
( Example payload for GET on vrf bgp with expanded=true. )'
: value:
items:
- addressFamilyIPv4:
aftableMap: RouteMap
aggregateTimer: Integer
bgpNextHopTriggerDelay: Integer
bgpNextHopTriggerEnable: boolean
bgpRedistributeInternal: boolean
bgpSupressInactive: boolean
defaultInformationOrginate: boolean
distance:
externalDistance: Integer
internalDistance: Integer
localDistance: Integer
type: afbgpdistance
distributeLists:
- accessList: StandardAccessList
type: incomingroutefilter
- accessList: StandardAccessList
protocol: FilterProtocol Object
type: outgoingroutefilter
id: uuid of ipv4 general settings
maximumPaths:
- ibgp: boolean
type: afmaximumpaths
value: Integer
neighbors:
- ipv4Address: String
neighborAdvanced:
neighborHops:
disableConnectedCheck: boolean
maxHopCount: Integer
neighborTtlSecurityHops: Integer
type: neighborebgpmultihop or neighborttlsecurityhops
neighborSecret: Secret
neighborTransportConnectionMode:
establishTCPSession: boolean
type: neighbortransportconnectionmode
neighborTransportPathMTUDiscovery:
disable: boolean
type: neighbortransportpathmtudiscovery
neighborVersion: Integer
neighborWeight: Integer
nextHopSelf: boolean
sendCommunity: boolean
type: neighboradvanced
neighborFiltering:
ipv4PrefixListFilter:
- filterUpdateAction: '[IN/OUT]'
ipv4PrefixList: IPV4PrefixList
type: neighborprefixlist
neighborDefaultOriginate:
routeMap: RouteMap
type: neighbordefaultoriginate
neighborDistributeLists:
- accessList: accessList
filterUpdateAction: '[IN/OUT]'
type: neighbordistributelist
neighborFilterList:
- asPathList: asPath
filterUpdateAction: '[IN/OUT]'
type: neighborfilterlist
neighborMaximumPrefix:
maxPrefixLimit: long
restartInterval: Integer
thresholdValue: Integer
type: neighbormaximumprefix
warningOnly: boolean
neighborRouteMap:
- filterUpdateAction: '[IN/OUT]'
routeMap: RouteMap
type: neighborroutemap
neighborGeneral:
description: 'String '
fallOverBFD: SINGLE_HOP | MULTI_HOP | AUTO_DETECT_HOP | NONE
shutdown: boolean
type: neighborgeneral
updateSource:
id: interfacePolicyUUID
name: String
type: LoopbackInterface
neighborHaMode:
disable: boolean
type: neighborhamode
neighborLocalAs:
asNumber: String
dualAs: boolean
noPrepend: boolean
replaceAs: boolean
type: neighborlocalas
neighborRoutes:
advertisementInterval: Integer
neighborAdvertiseMaps:
- existMap: boolean
existRouteMap: RouteMap
routeMap: RouteMap
type: neighboradvertisemap
removePrivateAs: boolean
neighborTimers:
holdTime: Integer
keepAliveInterval: Integer
minimumHoldTime: Integer
type: neighbortimers
remoteAs: String
type: neighboripv4
redistributeProtocols:
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributestatic
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributeconnected
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributerip
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributebgp
- matchExternal1: boolean
matchExternal2: boolean
matchInternal: boolean
matchNssaExternal1: boolean
matchNssaExternal2: boolean
processId: string
routeMap: routemap
routeMetric:
metricValue: long
type: redistributeospf
routeImportExport:
exportRouteTargets:
- ASN:NN
- ASN:NN
globalVrfExportRouteMap:
id: String
name: String
type: RouteMap
globalVrfImportRouteMap:
id: String
name: String
type: RouteMap
importRouteTargets:
- ASN:NN
- ASN:NN
userVrfExportRouteMap:
id: String
name: String
type: RouteMap
userVrfImportRouteMap:
id: String
name: String
type: RouteMap
scanTime: Integer
synchronization: boolean
type: afipv4
addressFamilyIPv6:
aftableMap: RouteMap
aggregateTimer: Integer
bgpNextHopTriggerDelay: Integer
bgpNextHopTriggerEnable: boolean
bgpRedistributeInternal: boolean
bgpSupressInactive: boolean
defaultInformationOrginate: boolean
distance:
externalDistance: Integer
internalDistance: Integer
localDistance: Integer
type: afbgpdistance
maximumPaths:
- ibgp: boolean
type: afmaximumpaths
value: Integer
neighbors:
- ipv6Address: String
ipv6Prefix: String
linkLocalInterface: interface
neighborAdvanced:
neighborHops:
disableConnectedCheck: boolean
maxHopCount: Integer
neighborTtlSecurityHops: Integer
type: neighborebgpmultihop or neighborttlsecurityhops
neighborSecret: Secret
neighborTransportConnectionMode:
establishTCPSession: boolean
type: neighbortransportconnectionmode
neighborTransportPathMTUDiscovery:
disable: boolean
type: neighbortransportpathmtudiscovery
neighborVersion: Integer
neighborWeight: Integer
nextHopSelf: boolean
sendCommunity: boolean
type: neighboradvanced
neighborFiltering:
ipv4PrefixListFilter:
- filterUpdateAction: '[IN/OUT]'
ipv4PrefixList: IPV4PrefixList
type: neighborprefixlist
neighborDefaultOriginate:
routeMap: RouteMap
type: neighbordefaultoriginate
neighborDistributeLists:
- accessList: AccessList
filterUpdateAction: '[IN/OUT]'
id: uuid of accessList
type: neighbordistributelist
neighborFilterList:
- asPathList: asPath
filterUpdateAction: '[IN/OUT]'
type: neighborfilterlist
neighborMaximumPrefix:
maxPrefixLimit: long
restartInterval: Integer
thresholdValue: Integer
type: neighbormaximumprefix
warningOnly: boolean
neighborRouteMap:
- filterUpdateAction: '[IN/OUT]'
routeMap: RouteMap
type: neighborroutemap
neighborGeneral:
description: 'String '
fallOverBFD: SINGLE_HOP | MULTI_HOP | AUTO_DETECT_HOP | NONE
shutdown: boolean
type: neighborgeneral
updateSource:
id: interfacePolicyUUID
name: String
type: LoopbackInterface
neighborHaMode:
disable: boolean
type: neighborhamode
neighborLocalAs:
asNumber: String
dualAs: boolean
noPrepend: boolean
replaceAs: boolean
type: neighborlocalas
neighborRoutes:
advertisementInterval: Integer
neighborAdvertiseMaps:
- existMap: boolean
existRouteMap: RouteMap
routeMap: RouteMap
type: neighboradvertisemap
removePrivateAs: boolean
neighborTimers:
holdTime: Integer
keepAliveInterval: Integer
minimumHoldTime: Integer
type: neighbortimers
remoteAs: String
type: neighboripv6
redistributeProtocols:
- routeMap: routemap
routeMetric:
metricValue: long
type: RedistributeStatic
- routeMap: routemap
routeMetric:
metricValue: long
type: RedistributeConnected
routeImportExport:
exportRouteTargets:
- ASN:NN
- ASN:NN
globalVrfExportRouteMap:
id: String
name: String
type: RouteMap
globalVrfImportRouteMap:
id: String
name: String
type: RouteMap
importRouteTargets:
- ASN:NN
- ASN:NN
userVrfExportRouteMap:
id: String
name: String
type: RouteMap
userVrfImportRouteMap:
id: String
name: String
type: RouteMap
scanTime: Integer
synchronization: boolean
type: afipv6
asNumber: String
id: bgpUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/virtualrouterUUID/bgp/bgpUUID
name: String
routerId: String
type: bgp
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/virtualrouterUUID/bgp?offset=0&limit=2&expanded=true
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/VrfBGPIPvAddressFamilyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**Modify the specified BGP model on the specified virtual router. _Check the response section for applicable
examples (if any)._**'
operationId: updateVrfBGPIPvAddressFamilyModel
parameters:
- description: Unique identifier of a BGP (ipv4 or ipv6) model.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/virtualrouters/routing/virtualrouters/virtualrouterUUID/bgp/bgpUUID
( Example payload for PUT on bgp general settings. )'
: value:
addressFamilyIPv4:
aftableMap: RouteMap
aggregateTimer: Integer
bgpNextHopTriggerDelay: Integer
bgpNextHopTriggerEnable: boolean
bgpRedistributeInternal: boolean
bgpSupressInactive: boolean
defaultInformationOrginate: boolean
distance:
externalDistance: Integer
internalDistance: Integer
localDistance: Integer
type: afbgpdistance
distributeLists:
- accessList: StandardAccessList
type: incomingroutefilter
- accessList: StandardAccessList
protocol: FilterProtocol Object
type: outgoingroutefilter
id: uuid of ipv4 general settings
maximumPaths:
- ibgp: boolean
type: afmaximumpaths
value: Integer
neighbors:
- ipv4Address: String
neighborAdvanced:
neighborHops:
disableConnectedCheck: boolean
maxHopCount: Integer
neighborTtlSecurityHops: Integer
type: neighborebgpmultihop or neighborttlsecurityhops
neighborSecret: Secret
neighborTransportConnectionMode:
establishTCPSession: boolean
type: neighbortransportconnectionmode
neighborTransportPathMTUDiscovery:
disable: boolean
type: neighbortransportpathmtudiscovery
neighborVersion: Integer
neighborWeight: Integer
nextHopSelf: boolean
sendCommunity: boolean
type: neighboradvanced
neighborFiltering:
ipv4PrefixListFilter:
- filterUpdateAction: '[IN/OUT]'
ipv4PrefixList: IPV4PrefixList
type: neighborprefixlist
neighborDefaultOriginate:
routeMap: RouteMap
type: neighbordefaultoriginate
neighborDistributeLists:
- accessList: AccessList
filterUpdateAction: '[IN/OUT]'
id: uuid of accessList
type: neighbordistributelist
neighborFilterList:
- asPathList: asPath
filterUpdateAction: '[IN/OUT]'
type: neighborfilterlist
neighborMaximumPrefix:
maxPrefixLimit: long
restartInterval: Integer
thresholdValue: Integer
type: neighbormaximumprefix
warningOnly: boolean
neighborRouteMap:
- filterUpdateAction: '[IN/OUT]'
routeMap: RouteMap
type: neighborroutemap
neighborGeneral:
description: 'String '
fallOverBFD: SINGLE_HOP | MULTI_HOP | AUTO_DETECT_HOP | NONE
shutdown: boolean
type: neighborgeneral
updateSource:
id: interfacePolicyUUID
name: String
type: LoopbackInterface
neighborHaMode:
disable: boolean
type: neighborhamode
neighborLocalAs:
asNumber: String
dualAs: boolean
noPrepend: boolean
replaceAs: boolean
type: neighborlocalas
neighborRoutes:
advertisementInterval: Integer
neighborAdvertiseMaps:
- existMap: boolean
existRouteMap: RouteMap
routeMap: RouteMap
type: neighboradvertisemap
removePrivateAs: boolean
neighborTimers:
holdTime: Integer
keepAliveInterval: Integer
minimumHoldTime: Integer
type: neighbortimers
remoteAs: String
type: neighboripv4
redistributeProtocols:
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributestatic
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributeconnected
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributerip
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributebgp
- matchExternal1: boolean
matchExternal2: boolean
matchInternal: boolean
matchNssaExternal1: boolean
matchNssaExternal2: boolean
processId: string
routeMap: routemap
routeMetric:
metricValue: long
type: redistributeospf
routeImportExport:
exportRouteTargets:
- ASN:NN
- ASN:NN
globalVrfExportRouteMap:
id: String
name: String
type: RouteMap
globalVrfImportRouteMap:
id: String
name: String
type: RouteMap
importRouteTargets:
- ASN:NN
- ASN:NN
userVrfExportRouteMap:
id: String
name: String
type: RouteMap
userVrfImportRouteMap:
id: String
name: String
type: RouteMap
scanTime: Integer
synchronization: boolean
type: afipv4
addressFamilyIPv6:
aftableMap: RouteMap
aggregateTimer: Integer
bgpNextHopTriggerDelay: Integer
bgpNextHopTriggerEnable: boolean
bgpRedistributeInternal: boolean
bgpSupressInactive: boolean
defaultInformationOrginate: boolean
distance:
externalDistance: Integer
internalDistance: Integer
localDistance: Integer
type: afbgpdistance
maximumPaths:
- ibgp: boolean
type: afmaximumpaths
value: Integer
neighbors:
- ipv6Address: String
ipv6Prefix: String
linkLocalInterface: interface
neighborAdvanced:
neighborHops:
disableConnectedCheck: boolean
maxHopCount: Integer
neighborTtlSecurityHops: Integer
type: neighborebgpmultihop or neighborttlsecurityhops
neighborSecret: Secret
neighborTransportConnectionMode:
establishTCPSession: boolean
type: neighbortransportconnectionmode
neighborTransportPathMTUDiscovery:
disable: boolean
type: neighbortransportpathmtudiscovery
neighborVersion: Integer
neighborWeight: Integer
nextHopSelf: boolean
sendCommunity: boolean
type: neighboradvanced
neighborFiltering:
ipv4PrefixListFilter:
- filterUpdateAction: '[IN/OUT]'
ipv4PrefixList: IPV4PrefixList
type: neighborprefixlist
neighborDefaultOriginate:
routeMap: RouteMap
type: neighbordefaultoriginate
neighborDistributeLists:
- accessList: AccessList
filterUpdateAction: '[IN/OUT]'
id: uuid of accessList
type: neighbordistributelist
neighborFilterList:
- asPathList: asPath
filterUpdateAction: '[IN/OUT]'
type: neighborfilterlist
neighborMaximumPrefix:
maxPrefixLimit: long
restartInterval: Integer
thresholdValue: Integer
type: neighbormaximumprefix
warningOnly: boolean
neighborRouteMap:
- filterUpdateAction: '[IN/OUT]'
routeMap: RouteMap
type: neighborroutemap
neighborGeneral:
description: 'String '
fallOverBFD: SINGLE_HOP | MULTI_HOP | AUTO_DETECT_HOP | NONE
shutdown: boolean
type: neighborgeneral
updateSource:
id: interfacePolicyUUID
name: String
type: LoopbackInterface
neighborHaMode:
disable: boolean
type: neighborhamode
neighborLocalAs:
asNumber: String
dualAs: boolean
noPrepend: boolean
replaceAs: boolean
type: neighborlocalas
neighborRoutes:
advertisementInterval: Integer
neighborAdvertiseMaps:
- existMap: boolean
existRouteMap: RouteMap
routeMap: RouteMap
type: neighboradvertisemap
removePrivateAs: boolean
neighborTimers:
holdTime: Integer
keepAliveInterval: Integer
minimumHoldTime: Integer
type: neighbortimers
remoteAs: String
type: neighboripv6
redistributeProtocols:
- routeMap: routemap
routeMetric:
metricValue: long
type: RedistributeStatic
- routeMap: routemap
routeMetric:
metricValue: long
type: RedistributeConnected
routeImportExport:
exportRouteTargets:
- ASN:NN
- ASN:NN
globalVrfExportRouteMap:
id: String
name: String
type: RouteMap
globalVrfImportRouteMap:
id: String
name: String
type: RouteMap
importRouteTargets:
- ASN:NN
- ASN:NN
userVrfExportRouteMap:
id: String
name: String
type: RouteMap
userVrfImportRouteMap:
id: String
name: String
type: RouteMap
scanTime: Integer
synchronization: boolean
type: afipv6
asNumber: String
id: bgpUUID
name: String
routerId: String
type: bgp
schema:
$ref: '#/components/schemas/VrfBGPIPvAddressFamilyModel'
type: object
description: The input BGP (ipv4 and ipv6) model.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/virtualrouters/routing/virtualrouters/virtualrouterUUID/bgp/bgpUUID
( Example payload for PUT on bgp general settings. )'
: value:
addressFamilyIPv4:
aftableMap: RouteMap
aggregateTimer: Integer
bgpNextHopTriggerDelay: Integer
bgpNextHopTriggerEnable: boolean
bgpRedistributeInternal: boolean
bgpSupressInactive: boolean
defaultInformationOrginate: boolean
distance:
externalDistance: Integer
internalDistance: Integer
localDistance: Integer
type: afbgpdistance
distributeLists:
- accessList: StandardAccessList
type: incomingroutefilter
- accessList: StandardAccessList
protocol: FilterProtocol Object
type: outgoingroutefilter
id: uuid of ipv4 general settings
maximumPaths:
- ibgp: boolean
type: afmaximumpaths
value: Integer
neighbors:
- ipv4Address: String
neighborAdvanced:
neighborHops:
disableConnectedCheck: boolean
maxHopCount: Integer
neighborTtlSecurityHops: Integer
type: neighborebgpmultihop or neighborttlsecurityhops
neighborSecret: Secret
neighborTransportConnectionMode:
establishTCPSession: boolean
type: neighbortransportconnectionmode
neighborTransportPathMTUDiscovery:
disable: boolean
type: neighbortransportpathmtudiscovery
neighborVersion: Integer
neighborWeight: Integer
nextHopSelf: boolean
sendCommunity: boolean
type: neighboradvanced
neighborFiltering:
ipv4PrefixListFilter:
- filterUpdateAction: '[IN/OUT]'
ipv4PrefixList: IPV4PrefixList
type: neighborprefixlist
neighborDefaultOriginate:
routeMap: RouteMap
type: neighbordefaultoriginate
neighborDistributeLists:
- accessList: AccessList
filterUpdateAction: '[IN/OUT]'
id: uuid of accessList
type: neighbordistributelist
neighborFilterList:
- asPathList: asPath
filterUpdateAction: '[IN/OUT]'
type: neighborfilterlist
neighborMaximumPrefix:
maxPrefixLimit: long
restartInterval: Integer
thresholdValue: Integer
type: neighbormaximumprefix
warningOnly: boolean
neighborRouteMap:
- filterUpdateAction: '[IN/OUT]'
routeMap: RouteMap
type: neighborroutemap
neighborGeneral:
description: 'String '
fallOverBFD: SINGLE_HOP | MULTI_HOP | AUTO_DETECT_HOP | NONE
shutdown: boolean
type: neighborgeneral
updateSource:
id: interfacePolicyUUID
name: String
type: LoopbackInterface
neighborHaMode:
disable: boolean
type: neighborhamode
neighborLocalAs:
asNumber: String
dualAs: boolean
noPrepend: boolean
replaceAs: boolean
type: neighborlocalas
neighborRoutes:
advertisementInterval: Integer
neighborAdvertiseMaps:
- existMap: boolean
existRouteMap: RouteMap
routeMap: RouteMap
type: neighboradvertisemap
removePrivateAs: boolean
neighborTimers:
holdTime: Integer
keepAliveInterval: Integer
minimumHoldTime: Integer
type: neighbortimers
remoteAs: String
type: neighboripv4
redistributeProtocols:
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributestatic
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributeconnected
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributerip
- routeMap: routemap
routeMetric:
metricValue: long
type: redistributebgp
- matchExternal1: boolean
matchExternal2: boolean
matchInternal: boolean
matchNssaExternal1: boolean
matchNssaExternal2: boolean
processId: string
routeMap: routemap
routeMetric:
metricValue: long
type: redistributeospf
routeImportExport:
exportRouteTargets:
- ASN:NN
- ASN:NN
globalVrfExportRouteMap:
id: String
name: String
type: RouteMap
globalVrfImportRouteMap:
id: String
name: String
type: RouteMap
importRouteTargets:
- ASN:NN
- ASN:NN
userVrfExportRouteMap:
id: String
name: String
type: RouteMap
userVrfImportRouteMap:
id: String
name: String
type: RouteMap
scanTime: Integer
synchronization: boolean
type: afipv4
addressFamilyIPv6:
aftableMap: RouteMap
aggregateTimer: Integer
bgpNextHopTriggerDelay: Integer
bgpNextHopTriggerEnable: boolean
bgpRedistributeInternal: boolean
bgpSupressInactive: boolean
defaultInformationOrginate: boolean
distance:
externalDistance: Integer
internalDistance: Integer
localDistance: Integer
type: afbgpdistance
maximumPaths:
- ibgp: boolean
type: afmaximumpaths
value: Integer
neighbors:
- ipv6Address: String
ipv6Prefix: String
linkLocalInterface: interface
neighborAdvanced:
neighborHops:
disableConnectedCheck: boolean
maxHopCount: Integer
neighborTtlSecurityHops: Integer
type: neighborebgpmultihop or neighborttlsecurityhops
neighborSecret: Secret
neighborTransportConnectionMode:
establishTCPSession: boolean
type: neighbortransportconnectionmode
neighborTransportPathMTUDiscovery:
disable: boolean
type: neighbortransportpathmtudiscovery
neighborVersion: Integer
neighborWeight: Integer
nextHopSelf: boolean
sendCommunity: boolean
type: neighboradvanced
neighborFiltering:
ipv4PrefixListFilter:
- filterUpdateAction: '[IN/OUT]'
ipv4PrefixList: IPV4PrefixList
type: neighborprefixlist
neighborDefaultOriginate:
routeMap: RouteMap
type: neighbordefaultoriginate
neighborDistributeLists:
- accessList: AccessList
filterUpdateAction: '[IN/OUT]'
id: uuid of accessList
type: neighbordistributelist
neighborFilterList:
- asPathList: asPath
filterUpdateAction: '[IN/OUT]'
type: neighborfilterlist
neighborMaximumPrefix:
maxPrefixLimit: long
restartInterval: Integer
thresholdValue: Integer
type: neighbormaximumprefix
warningOnly: boolean
neighborRouteMap:
- filterUpdateAction: '[IN/OUT]'
routeMap: RouteMap
type: neighborroutemap
neighborGeneral:
description: 'String '
fallOverBFD: SINGLE_HOP | MULTI_HOP | AUTO_DETECT_HOP | NONE
shutdown: boolean
type: neighborgeneral
updateSource:
id: interfacePolicyUUID
name: String
type: LoopbackInterface
neighborHaMode:
disable: boolean
type: neighborhamode
neighborLocalAs:
asNumber: String
dualAs: boolean
noPrepend: boolean
replaceAs: boolean
type: neighborlocalas
neighborRoutes:
advertisementInterval: Integer
neighborAdvertiseMaps:
- existMap: boolean
existRouteMap: RouteMap
routeMap: RouteMap
type: neighboradvertisemap
removePrivateAs: boolean
neighborTimers:
holdTime: Integer
keepAliveInterval: Integer
minimumHoldTime: Integer
type: neighbortimers
remoteAs: String
type: neighboripv6
redistributeProtocols:
- routeMap: routemap
routeMetric:
metricValue: long
type: RedistributeStatic
- routeMap: routemap
routeMetric:
metricValue: long
type: RedistributeConnected
routeImportExport:
exportRouteTargets:
- ASN:NN
- ASN:NN
globalVrfExportRouteMap:
id: String
name: String
type: RouteMap
globalVrfImportRouteMap:
id: String
name: String
type: RouteMap
importRouteTargets:
- ASN:NN
- ASN:NN
userVrfExportRouteMap:
id: String
name: String
type: RouteMap
userVrfImportRouteMap:
id: String
name: String
type: RouteMap
scanTime: Integer
synchronization: boolean
type: afipv6
asNumber: String
id: bgpUUID
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/virtualrouterUUID/bgp/bgpUUID
name: String
routerId: String
type: bgp
schema:
$ref: '#/components/schemas/VrfBGPIPvAddressFamilyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/ecmpzones
: get:
deprecated: false
description: '**Get the list of all ECMP Zones on the specified virtual router.**'
operationId: getAllVrfECMPZoneModel
parameters:
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ecmpzones
( Example payload for GET ALL on ECMP Zone )'
: value:
items:
- id: zoneUUid
interfaces:
- id: interface_uuid1
ifname: GigEth1
name: GigabitEthernet1/1
type: PhysicalInterface
- id: interface_uuid2
ifname: GigEth2
name: GigabitEthernet1/2
type: PhysicalInterface
links:
self: /api/fmc_config/v1/domain//devices/devicerecords//routing/virtualrouters/VrfUUID/ecmpzones/
name: zone_name
type: ecmpzones
links:
self: /api/fmc_config/v1/domain//devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ecmpzones?offset=0&limit=25
paging:
count: 2
limit: 25
offset: 0
pages: 1
? 'Example 2 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ecmpzones?expanded=true
( GET All ECMP Zone with ?expanded=true )'
: value:
items:
- description: ECMP Zone Alpha Description
id: ecmpZoneUuid
interfaces:
- id: interface_uuid1
ifname: GigEth1
name: GigabitEthernet1/1
type: PhysicalInterface
- id: interface_uuid2
ifname: GigEth2
name: GigabitEthernet1/2
type: PhysicalInterface
links:
self: /api/fmc_config/v1/domain//devices/devicerecords//routing/virtualrouters/VrfUUID/ecmpzones?offset=0&limit=25&expanded=true
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
timestamp: 1529431113943.0
name: ECMPZoneAlpha
type: ecmpzoes
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ecmpzones?offset=0&limit=2&expanded=true
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/VrfECMPZoneModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**Creates an ECMP Zone on the specified virtual router. _Check the response section for applicable examples
(if any)._**'
operationId: createVrfECMPZoneModel
parameters:
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ecmpzones
( Example payload for POST on ECMP Zone. )'
: value:
description: ECMP Zone Beta
interfaces:
- id: interface_uuid1
name: GigabitEthernet1/1
type: PhysicalInterface
- id: interface_uuid2
name: GigabitEthernet1/2
type: PhysicalInterface
name: ECMPZoneBeta
type: ecmpzones
schema:
$ref: '#/components/schemas/VrfECMPZoneModel'
type: object
description: The input ECMP Zone model.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ecmpzones
( Example payload for POST on ECMP Zone. )'
: value:
description: 'ECMP Zone '
id: ecmpzoneUuid
interfaces:
- id: interface_uuid1
ifname: GigEth1
name: GigabitEthernet1/1
type: PhysicalInterface
- id: interface_uuid2
ifname: GigEth2
name: GigabitEthernet1/2
type: PhysicalInterface
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ecmpzones/ecmpzoneUuid
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
timestamp: 1529431113943.0
name: ECMPZoneBeta
type: ecmpzones
schema:
$ref: '#/components/schemas/VrfECMPZoneModel'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/ecmpzones/{objectId}
: delete:
deprecated: false
description: '**Delete the ECMP Zone associated with the specified ID on the specified virtual router. _Check the response
section for applicable examples (if any)._**'
operationId: deleteVrfECMPZoneModel
parameters:
- description: Unique identifier of the ECMP Zone.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ecmpzones/ecmpZoneUuid
( Example payload for DELETE on ECMP Zone. )'
: value:
description: ECMP Zone Beta description
id: ecmpZoneUuid
interfaces:
- id: interface_uuid1
ifname: GigEth1
name: GigabitEthernet1/1
type: PhysicalInterface
- id: interface_uuid2
ifname: GigEth2
name: GigabitEthernet1/2
type: PhysicalInterface
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ecmpzones/ecmpZoneUuid
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
timestamp: 1529431113943.0
name: ECMPZoneBeta
type: ecmpzones
schema:
$ref: '#/components/schemas/VrfECMPZoneModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
get:
deprecated: false
description: '**Get the ECMP Zone associated with the specified ID on the specified virtual router.**'
operationId: getVrfECMPZoneModel
parameters:
- description: Unique identifier of a ECMP Zone.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ecmpzones/zoneUUid
( Example payload for GET on ECMP Zone )'
: value:
id: zoneUUid
interfaces:
- id: interface_uuid1
ifname: GigEth1
name: GigabitEthernet1/1
type: PhysicalInterface
- id: interface_uuid2
ifname: GigEth2
name: GigabitEthernet1/2
type: PhysicalInterface
links:
self: /api/fmc_config/v1/domain//devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ecmpzones/zoneUUid
name: zone_name
type: ecmpzones
schema:
$ref: '#/components/schemas/VrfECMPZoneModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**Modify the ECMP Zone associated with the specified ID on the specified virtual router. _Check the response
section for applicable examples (if any)._**'
operationId: updateVrfECMPZoneModel
parameters:
- description: Unique identifier of a ECMP Zone.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ecmpzones/virtualrouters/VrfUUID/ecmpZoneUuid
( Example payload for PUT on ECMP Zones. )'
: value:
description: ECMP Zone Beta description
id: ecmpZoneUuid
interfaces:
- id: interface_uuid1
name: GigabitEthernet1/1
type: PhysicalInterface
- id: interface_uuid2
name: GigabitEthernet1/2
type: PhysicalInterface
name: ECMPZoneBeta
type: ecmpzones
schema:
$ref: '#/components/schemas/VrfECMPZoneModel'
type: object
description: The input ECMP Zone model.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ecmpzones/virtualrouters/VrfUUID/ecmpZoneUuid
( Example payload for PUT on ECMP Zones. )'
: value:
description: ECMP Zone Beta description
id: ecmpZoneUuid
interfaces:
- id: interface_uuid1
ifname: GigEth1
name: GigabitEthernet1/1
type: PhysicalInterface
- id: interface_uuid2
ifname: GigEth2
name: GigabitEthernet1/2
type: PhysicalInterface
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/ecmpzones/virtualrouters/VrfUUID/ecmpZoneUuid
metadata:
domain:
id: GlobalDomainUUID
name: Global
type: Domain
timestamp: 1529431113943.0
name: ECMPZoneBeta
type: ecmpzones
schema:
$ref: '#/components/schemas/VrfECMPZoneModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/eigrproutes
: get:
deprecated: false
description: '**Get the list of all EIGRP entries on the specified virtual router.**'
operationId: getAllVrfEigrpPolicyModel
parameters:
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/eigrproutes?offset=0&limit=25
( Example payload for GET ALL on Eigrp )'
: value:
items:
- asNumber: '1'
id: eigrpUUid
links:
self: /api/fmc_config/v1/domain//devices/devicerecords//routing/eigrproutes
type: EigrpRoute
links:
self: /api/fmc_config/v1/domain//devices/devicerecords/DeviceUUID/routing/eigrproutes?offset=0&limit=25
paging:
count: 1
limit: 25
offset: 0
pages: 1
? 'Example 2 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/eigrproutes?expanded=true
( GET All Eigrp with expanded=true )'
: value:
items:
- advancedConfiguration:
administrativeDistance:
external: 1
internal: 1
clusterPool:
id: 00505686-13CC-0ed3-0000-042949673419
name: IPv4Pool
type: PoolObjectIPv4
defaultRouteDistributionIn:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
defaultRouteDistributionOut:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
enableLogNeighborWarnings: true
logNeighborChanges: true
logNeighborWarningInterval: 1
routeMetric:
bandwidth: 1
delay: 1
effectiveBandwidth: 1
pathMTU: 1
reliability: 1
routerId: 1.1.1.1
stub:
receiveOnly: true
asNumber: '1'
basicConfiguration:
autoSummary: false
networks:
- id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
passiveInterfaces:
allInterfaces: false
selectedInterfaces:
- id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
distributionList:
- accessList:
id: access_list_obj_uuid
name: AcessListObject
type: ACL
deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
filterDirection: INBOUND
eigrpInterfaces:
- deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
eigrpProtocolConfiguration:
authentication:
keyId: 2
md5auth: true
password: '1234'
pwdEncryption: ENCRYPTED
splitHorizon: false
timers:
delay: 1
helloInterval: 1
holdTime: 1
id: eigrp_uuid
links:
self: /api/fmc_config/v1/domain//devices/devicerecords//routing/eigrproutes?offset=0&limit=25&expanded=true
neighbors:
- neighborAddress:
id: network_obj_uuid
name: networkObject1
type: Network
neighborInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
redistributeProtocols:
- matchExternal1: false
matchExternal2: false
matchInternal: false
matchNssaExternal1: false
matchNssaExternal2: false
protocol: RIP
routeMap:
id: route_map_obj_uuid
name: routeMapObject
type: RouteMapObject
routeMetric:
bandwidth: 1
delay: 1
effectiveBandwidth: 1
pathMTU: 1
reliability: 1
summaryAddressList:
- adminDistance: 1
deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
summaryAddress:
id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
type: EigrpRoute
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/eigrproutes?offset=0&limit=2&expanded=true
paging:
count: 1
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/VrfEigrpPolicyModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**Create an EIGRP entry on the specified virtual router. _Check the response section for applicable examples
(if any)._**'
operationId: createVrfEigrpPolicyModel
parameters:
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/eigrproutes
( Example payload for POST on Eigrp. )'
: value:
advancedConfiguration:
administrativeDistance:
external: 1
internal: 1
clusterPool:
id: 00505686-13CC-0ed3-0000-042949673419
name: IPv4Pool
type: PoolObjectIPv4
defaultRouteDistributionIn:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
defaultRouteDistributionOut:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
enableLogNeighborWarnings: true
logNeighborChanges: true
logNeighborWarningInterval: 1
routeMetric:
bandwidth: 1
delay: 1
effectiveBandwidth: 1
pathMTU: 1
reliability: 1
routerId: 1.1.1.1
stub:
receiveOnly: true
asNumber: '1'
basicConfiguration:
autoSummary: false
networks:
- id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
passiveInterfaces:
allInterfaces: false
selectedInterfaces:
- id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
distributionList:
- accessList:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
filterDirection: INBOUND
eigrpInterfaces:
- deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
eigrpProtocolConfiguration:
authentication:
keyId: 2
md5auth: true
password: '1234'
pwdEncryption: ENCRYPTED
splitHorizon: false
timers:
delay: 1
helloInterval: 1
holdTime: 1
neighbors:
- neighborAddress:
id: network_object_uuid
name: networkObject1
type: Network
neighborInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
redistributeProtocols:
- matchExternal1: false
matchExternal2: false
matchInternal: false
matchNssaExternal1: false
matchNssaExternal2: false
protocol: RIP
routeMap:
id: 00505686-13CC-0ed3-0000-042949673437
name: routeMapObject
type: RouteMapObject
routeMetric:
bandwidth: 1
delay: 1
effectiveBandwidth: 1
pathMTU: 1
reliability: 1
summaryAddressList:
- adminDistance: 1
deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
summaryAddress:
id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
type: EigrpRoute
schema:
$ref: '#/components/schemas/VrfEigrpPolicyModel'
type: object
description: The input EIGRP model.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/eigrproutes
( Example payload for POST on Eigrp. )'
: value:
advancedConfiguration:
administrativeDistance:
external: 1
internal: 1
clusterPool:
id: 00505686-13CC-0ed3-0000-042949673419
name: IPv4Pool
type: PoolObjectIPv4
defaultRouteDistributionIn:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
defaultRouteDistributionOut:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
enableLogNeighborWarnings: true
logNeighborChanges: true
logNeighborWarningInterval: 1
routeMetric:
bandwidth: 1
delay: 1
effectiveBandwidth: 1
pathMTU: 1
reliability: 1
routerId: 1.1.1.1
stub:
receiveOnly: true
asNumber: '1'
basicConfiguration:
autoSummary: false
networks:
- id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
passiveInterfaces:
allInterfaces: false
selectedInterfaces:
- id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
distributionList:
- accessList:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
filterDirection: INBOUND
eigrpInterfaces:
- deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
eigrpProtocolConfiguration:
authentication:
keyId: 2
md5auth: true
password: '1234'
pwdEncryption: ENCRYPTED
splitHorizon: false
timers:
delay: 1
helloInterval: 1
holdTime: 1
id: eigrpUuid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/eigrproutes/eigrpUuid
neighbors:
- neighborAddress:
id: 00505686-13CC-0ed3-0000-042949673303
name: networkObject1
type: Network
neighborInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
redistributeProtocols:
- matchExternal1: false
matchExternal2: false
matchInternal: false
matchNssaExternal1: false
matchNssaExternal2: false
protocol: RIP
routeMap:
id: 00505686-13CC-0ed3-0000-042949673437
name: routeMapObject
type: RouteMapObject
routeMetric:
bandwidth: 1
delay: 1
effectiveBandwidth: 1
pathMTU: 1
reliability: 1
summaryAddressList:
- adminDistance: 1
deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
summaryAddress:
id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
type: EigrpRoute
schema:
$ref: '#/components/schemas/VrfEigrpPolicyModel'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/eigrproutes/{objectId}
: delete:
deprecated: false
description: '**Delete the EIGRP entry associated with the specified ID on the specified virtual router. _Check the
response section for applicable examples (if any)._**'
operationId: deleteVrfEigrpPolicyModel
parameters:
- description: Unique identifier of a EIGRP.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/eigrproutes/eigrpUuid
( Example payload for DELETE on Eigrp. )'
: value:
advancedConfiguration:
administrativeDistance:
external: 1
internal: 1
clusterPool:
id: 00505686-13CC-0ed3-0000-042949673419
name: IPv4Pool
type: PoolObjectIPv4
defaultRouteDistributionIn:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
defaultRouteDistributionOut:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
enableLogNeighborWarnings: true
logNeighborChanges: true
logNeighborWarningInterval: 1
routeMetric:
bandwidth: 1
delay: 1
effectiveBandwidth: 1
pathMTU: 1
reliability: 1
routerId: 1.1.1.1
stub:
receiveOnly: true
asNumber: '2'
basicConfiguration:
autoSummary: false
networks:
- id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
passiveInterfaces:
allInterfaces: false
selectedInterfaces:
- id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
distributionList:
- accessList:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
deviceInterface:
id: 00505686-13CC-0ed3-0000-008589934807
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
filterDirection: INBOUND
eigrpInterfaces:
- deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
eigrpProtocolConfiguration:
authentication:
keyId: 2
md5auth: true
password: '1234'
pwdEncryption: ENCRYPTED
splitHorizon: false
timers:
delay: 1
helloInterval: 1
holdTime: 1
id: eigrpUuid
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/eigrproutes/eigrpUuid
neighbors:
- neighborAddress:
id: 00505686-13CC-0ed3-0000-042949673303
name: networkObject1
type: Network
neighborInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
redistributeProtocols:
- matchExternal1: false
matchExternal2: false
matchInternal: false
matchNssaExternal1: false
matchNssaExternal2: false
protocol: RIP
routeMap:
id: 00505686-13CC-0ed3-0000-042949673437
name: routeMapObject
type: RouteMapObject
routeMetric:
bandwidth: 1
delay: 1
effectiveBandwidth: 1
pathMTU: 1
reliability: 1
summaryAddressList:
- adminDistance: 1
deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
summaryAddress:
id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
type: EigrpRoute
schema:
$ref: '#/components/schemas/VrfEigrpPolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
get:
deprecated: false
description: '**Get the EIGRP entry associated with the specified ID on the specified virtual router.**'
operationId: getVrfEigrpPolicyModel
parameters:
- description: Unique identifier of a EIGRP.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/eigrproutes/eigrpUUid
( Example payload for GET on Eigrp )'
: value:
advancedConfiguration:
administrativeDistance:
external: 1
internal: 1
clusterPool:
id: 00505686-13CC-0ed3-0000-042949673419
name: IPv4Pool
type: PoolObjectIPv4
defaultRouteDistributionIn:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
defaultRouteDistributionOut:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
enableLogNeighborWarnings: true
logNeighborChanges: true
logNeighborWarningInterval: 1
routeMetric:
bandwidth: 1
delay: 1
effectiveBandwidth: 1
pathMTU: 1
reliability: 1
routerId: 1.1.1.1
stub:
receiveOnly: true
asNumber: '2'
basicConfiguration:
autoSummary: false
networks:
- id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
passiveInterfaces:
allInterfaces: false
selectedInterfaces:
- id: 00505686-13CC-0ed3-0000-008589934807
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
distributionList:
- accessList:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
deviceInterface:
id: 00505686-13CC-0ed3-0000-008589934807
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
filterDirection: INBOUND
eigrpInterfaces:
- deviceInterface:
id: 00505686-13CC-0ed3-0000-008589934807
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
eigrpProtocolConfiguration:
authentication:
keyId: 2
md5auth: true
password: '1234'
pwdEncryption: ENCRYPTED
splitHorizon: false
timers:
delay: 1
helloInterval: 1
holdTime: 1
id: 00505686-13CC-0ed3-0001-642075126197
links:
self: /api/fmc_config/v1/domain//devices/devicerecords/DeviceUUID/routing/eigrproutes/eigrpUUid
neighbors:
- neighborAddress:
id: 00505686-13CC-0ed3-0000-042949673303
name: networkObject1
type: Network
neighborInterface:
id: 00505686-13CC-0ed3-0000-008589934807
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
redistributeProtocols:
- matchExternal1: false
matchExternal2: false
matchInternal: false
matchNssaExternal1: false
matchNssaExternal2: false
protocol: RIP
routeMap:
id: 00505686-13CC-0ed3-0000-042949673437
name: routeMapObject
type: RouteMapObject
routeMetric:
bandwidth: 1
delay: 1
effectiveBandwidth: 1
pathMTU: 1
reliability: 1
summaryAddressList:
- adminDistance: 1
deviceInterface:
id: 00505686-13CC-0ed3-0000-008589934807
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
summaryAddress:
id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
type: EigrpRoute
schema:
$ref: '#/components/schemas/VrfEigrpPolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**Modify the EIGRP entry associated with the specified ID on the specified virtual router. _Check the
response section for applicable examples (if any)._**'
operationId: updateVrfEigrpPolicyModel
parameters:
- description: Unique identifier of a EIGRP.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/eigrproutes/eigrpUuid
( Example payload for PUT on Eigrp. )'
: value:
advancedConfiguration:
administrativeDistance:
external: 1
internal: 1
clusterPool:
id: 00505686-13CC-0ed3-0000-042949673419
name: IPv4Pool
type: PoolObjectIPv4
defaultRouteDistributionIn:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
defaultRouteDistributionOut:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
enableLogNeighborWarnings: true
logNeighborChanges: true
logNeighborWarningInterval: 1
routeMetric:
bandwidth: 1
delay: 1
effectiveBandwidth: 1
pathMTU: 1
reliability: 1
routerId: 1.1.1.1
stub:
receiveOnly: true
asNumber: '1'
basicConfiguration:
autoSummary: false
networks:
- id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
passiveInterfaces:
allInterfaces: false
selectedInterfaces:
- id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
distributionList:
- accessList:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
filterDirection: INBOUND
eigrpInterfaces:
- deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
eigrpProtocolConfiguration:
authentication:
keyId: 2
md5auth: true
password: '1234'
pwdEncryption: ENCRYPTED
splitHorizon: false
timers:
delay: 1
helloInterval: 1
holdTime: 1
id: eigrpUuid
neighbors:
- neighborAddress:
id: network_object_uuid
name: networkObject1
type: Network
neighborInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
redistributeProtocols:
- matchExternal1: false
matchExternal2: false
matchInternal: false
matchNssaExternal1: false
matchNssaExternal2: false
protocol: RIP
routeMap:
id: 00505686-13CC-0ed3-0000-042949673437
name: routeMapObject
type: RouteMapObject
routeMetric:
bandwidth: 1
delay: 1
effectiveBandwidth: 1
pathMTU: 1
reliability: 1
summaryAddressList:
- adminDistance: 1
deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
summaryAddress:
id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
type: EigrpRoute
schema:
$ref: '#/components/schemas/VrfEigrpPolicyModel'
type: object
description: The input EIGRP model.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/eigrproutes/eigrpUuid
( Example payload for PUT on Eigrp. )'
: value:
advancedConfiguration:
administrativeDistance:
external: 1
internal: 1
clusterPool:
id: 00505686-13CC-0ed3-0000-042949673419
name: IPv4Pool
type: PoolObjectIPv4
defaultRouteDistributionIn:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
defaultRouteDistributionOut:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
enableLogNeighborWarnings: true
logNeighborChanges: true
logNeighborWarningInterval: 1
routeMetric:
bandwidth: 1
delay: 1
effectiveBandwidth: 1
pathMTU: 1
reliability: 1
routerId: 1.1.1.1
stub:
receiveOnly: true
asNumber: '1'
basicConfiguration:
autoSummary: false
networks:
- id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
passiveInterfaces:
allInterfaces: false
selectedInterfaces:
- id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
distributionList:
- accessList:
id: 00505686-13CC-0ed3-0000-042949673419
name: AcessListObject
type: ACL
deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
filterDirection: INBOUND
eigrpInterfaces:
- deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
eigrpProtocolConfiguration:
authentication:
keyId: 2
md5auth: true
password: '1234'
pwdEncryption: ENCRYPTED
splitHorizon: false
timers:
delay: 1
helloInterval: 1
holdTime: 1
id: 00505686-13CC-0ed3-0001-642075126197
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/eigrproutes/eigrpUuid
neighbors:
- neighborAddress:
id: network_object_uuid
name: networkObject1
type: Network
neighborInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
redistributeProtocols:
- matchExternal1: false
matchExternal2: false
matchInternal: false
matchNssaExternal1: false
matchNssaExternal2: false
protocol: RIP
routeMap:
id: 00505686-13CC-0ed3-0000-042949673437
name: routeMapObject
type: RouteMapObject
routeMetric:
bandwidth: 1
delay: 1
effectiveBandwidth: 1
pathMTU: 1
reliability: 1
summaryAddressList:
- adminDistance: 1
deviceInterface:
id: interface_uuid
ifname: GigEth1
name: GigabitEthernet0/1
type: PhysicalInterface
summaryAddress:
id: cb7116e8-66a6-480b-8f9b-295191a0940a
name: any-ipv4
type: Network
type: EigrpRoute
schema:
$ref: '#/components/schemas/VrfEigrpPolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/ipv4staticroutes
: get:
deprecated: false
description: '**Get the list of all IPv4 Static routes on the specified virtual router.**'
operationId: getAllVrfIPv4StaticRouteModel
parameters:
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ipv4staticroutes
( Example payload for GET ALL on IPv4 Static Routes. )'
: value:
items:
- id: ipv4StaticRouteUuid
links:
parent: /api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/routing/virtualrouters/VrfUUID/staticroutes
self: /api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/routing/virtualrouters/VrfUUID/ipv4staticroutes/ipv4StaticRouteUuid
type: IPv4StaticRoute
links:
self: /api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/routing/virtualrouters/VrfUUID/ipv4staticroutes?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/VrfIPv4StaticRouteModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**Create an IPv4 Static route on the specified virtual router. _Check the response section for applicable
examples (if any)._**'
operationId: createVrfIPv4StaticRouteModel
parameters:
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ipv4staticroutes
( Example payload for POST on IPv4 Static Routes. )'
: value:
gateway:
object:
id: networkHostUuid
name: Host2
type: Host
interfaceName: InterfaceLogicalName
isTunneled: false
metricValue: 22
routeTracking:
id: sla_monitor_id
name: sla1
type: SLAMonitor
selectedNetworks:
- id: networkHostUuid
name: Host1
type: Host
type: IPv4StaticRoute
? 'Example 2 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ipv4staticroutes
( Example payload for POST on IPv4 Static Routes with NULL0 interface. )'
: value:
interfaceName: Null0
isTunneled: false
metricValue: 1
selectedNetworks:
- id: networkHostUuid
name: Host1
type: Host
type: IPv4StaticRoute
schema:
$ref: '#/components/schemas/VrfIPv4StaticRouteModel'
type: object
description: The input IPv4 Static Route model.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ipv4staticroutes
( Example payload for POST on IPv4 Static Routes. )'
: value:
gateway:
object:
id: networkHostUuid
name: Host2
type: Host
id: ipv4StaticRouteUuid
interfaceName: InterfaceLogicalName
isTunneled: false
links:
parent: /api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/routing/virtualrouters/VrfUUID/staticroutes
self: /api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/routing/virtualrouters/VrfUUID/ipv4staticroutes/ipv4StaticRouteUuid
metadata:
domain:
id: domainUUID
name: Global
type: Domain
timestamp: 1531761518045.0
metricValue: 22
routeTracking:
id: sla_monitor_id
name: sla1
type: SLAMonitor
selectedNetworks:
- id: networkHostUuid
name: Host1
type: Host
type: IPv4StaticRoute
? 'Example 2 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ipv4staticroutes
( Example payload for POST on IPv4 Static Routes with NULL0 interface. )'
: value:
id: ipv4StaticRouteUuid
interfaceName: Null0
isTunneled: false
links:
parent: /api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/routing/virtualrouters/VrfUUID/staticroutes
self: /api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/routing/virtualrouters/VrfUUID/ipv4staticroutes/ipv4StaticRouteUuid
metadata:
domain:
id: domainUUID
name: Global
type: Domain
timestamp: 1531761518045.0
metricValue: 1
selectedNetworks:
- id: networkHostUuid
name: Host1
type: Host
type: IPv4StaticRoute
schema:
$ref: '#/components/schemas/VrfIPv4StaticRouteModel'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/ipv4staticroutes/{objectId}
: delete:
deprecated: false
description: '**Delete the IPv4 Static Route associated with the specified ID on the specified virtual router. _Check
the response section for applicable examples (if any)._**'
operationId: deleteVrfIPv4StaticRouteModel
parameters:
- description: Unique identifier of a IPv4 Static Route.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ipv4staticroutes/ipv4StaticRouteUuid
( Example payload for DELETE on IPv4 Static Routes. )'
: value:
gateway:
literal:
type: Host
value: 1.2.3.5
id: ipv4StaticRouteUuid
interfaceName: OUTSIDE_INTF3
isTunneled: false
links:
parent: /api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/routing/virtualrouters/VrfUUID/staticroutes
self: /api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/routing/virtualrouters/VrfUUID/ipv4staticroutes/ipv4StaticRouteUuid
metadata:
domain:
id: domainUUID
name: Global
type: Domain
timestamp: 1531749882006.0
metricValue: 12
selectedNetworks:
- id: 86caab8a-9bdd-420d-858b-5690fde8ce58
name: IPv4-Benchmark-Tests
overridable: false
type: Network
type: IPv4StaticRoute
schema:
$ref: '#/components/schemas/VrfIPv4StaticRouteModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
get:
deprecated: false
description: '**Get the IPv4 Static Route associated with the specified ID on the specified virtual router.**'
operationId: getVrfIPv4StaticRouteModel
parameters:
- description: Unique identifier of a IPv4 Static Route.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ipv4staticroutes/ipv4StaticRouteUuid
( Example payload for GET on IPv4 Static Routes. )'
: value:
gateway:
literal:
type: Host
value: 1.2.3.5
id: ipv4StaticRouteUuid
interfaceName: OUTSIDE_INTF3
isTunneled: false
links:
parent: /api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/routing/virtualrouters/VrfUUID/staticroutes
self: /api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/routing/virtualrouters/VrfUUID/ipv4staticroutes/ipv4StaticRouteUuid
metadata:
domain:
id: domainUUID
name: Global
type: Domain
timestamp: 1531749882006.0
metricValue: 12
selectedNetworks:
- id: 86caab8a-9bdd-420d-858b-5690fde8ce58
name: IPv4-Benchmark-Tests
overridable: false
type: Network
type: IPv4StaticRoute
? 'Example 2 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ipv4staticroutes?expanded=true
( Example payload for GET on IPv4 Static Routes with ?expanded=true )'
: value:
items:
- gateway:
literal:
type: Host
value: 1.2.3.5
id: ipv4StaticRouteUuid
interfaceName: OUTSIDE_INTF3
isTunneled: false
links:
parent: /api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/routing/virtualrouters/VrfUUID/staticroutes
self: /api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/routing/virtualrouters/VrfUUID/ipv4staticroutes/ipv4StaticRouteUuid
metadata:
domain:
id: domainUUID
name: Global
type: Domain
timestamp: 1531749882006.0
metricValue: 12
selectedNetworks:
- id: 86caab8a-9bdd-420d-858b-5690fde8ce58
name: IPv4-Benchmark-Tests
overridable: false
type: Network
type: IPv4StaticRoute
links:
self: /api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/routing/virtualrouters/VrfUUID/ipv4staticroutes?offset=0&limit=1&expanded=true
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/VrfIPv4StaticRouteModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**Modify the IPv4 Static Route associated with the specified ID on the specified virtual router. _Check
the response section for applicable examples (if any)._**'
operationId: updateVrfIPv4StaticRouteModel
parameters:
- description: Unique identifier of a IPv4 Static Route.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ipv4staticroutes/ipv4StaticRouteUuid
( Example payload for PUT on IPv4 Static Routes. )'
: value:
gateway:
object:
id: networkHostUuid
name: Host2
type: Host
id: ipv4StaticRouteUuid
interfaceName: InterfaceLogicalName
isTunneled: false
metricValue: 50
routeTracking:
id: sla_monitor_id
name: sla1
type: SLAMonitor
selectedNetworks:
- id: networkHostUuid
name: Host1
type: Host
type: IPv4StaticRoute
schema:
$ref: '#/components/schemas/VrfIPv4StaticRouteModel'
type: object
description: The input IPv4 Static Route model.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ipv4staticroutes/ipv4StaticRouteUuid
( Example payload for PUT on IPv4 Static Routes. )'
: value:
gateway:
object:
id: networkHostUuid
name: Host2
type: Host
id: ipv4StaticRouteUuid
interfaceName: InterfaceLogicalName
isTunneled: false
links:
parent: /api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/routing/virtualrouters/VrfUUID/staticroutes
self: /api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/routing/virtualrouters/VrfUUID/ipv4staticroutes/ipv4StaticRouteUuid
metadata:
domain:
id: domainUUID
name: Global
type: Domain
timestamp: 1531749882006.0
metricValue: 50
routeTracking:
id: sla_monitor_id
name: sla1
type: SLAMonitor
selectedNetworks:
- id: networkHostUuid
name: Host1
type: Host
type: IPv4StaticRoute
schema:
$ref: '#/components/schemas/VrfIPv4StaticRouteModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/ipv6staticroutes
: get:
deprecated: false
description: '**Get the list of all IPv6 Static routes on the specified virtual router.**'
operationId: getAllVrfIPv6StaticRouteModel
parameters:
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/VrfIPv6StaticRouteModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**Create an IPv6 Static route on the specified virtual router. _Check the response section for applicable
examples (if any)._**'
operationId: createVrfIPv6StaticRouteModel
parameters:
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ipv6staticroutes
( Example payload for POST on IPv6 Static Routes. )'
: value:
gateway:
object:
id: networkHostUuid
name: Host2
type: Host
interfaceName: InterfaceLogicalName
isTunneled: false
metricValue: 22
selectedNetworks:
- id: networkHostUuid
name: Host1
type: Host
type: IPv6StaticRoute
? 'Example 2 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ipv6staticroutes
( Example payload for POST on IPv6 Static Routes with NULL0 Interface. )'
: value:
interfaceName: Null0
selectedNetworks:
- id: networkHostUuid
name: Host1
type: Host
type: IPv6StaticRoute
schema:
$ref: '#/components/schemas/VrfIPv6StaticRouteModel'
type: object
description: The input IPv6 Static Route model.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ipv6staticroutes
( Example payload for POST on IPv6 Static Routes. )'
: value:
gateway:
object:
id: networkHostUuid
name: Host2
type: Host
id: ipv6StaticRouteUuid
interfaceName: InterfaceLogicalName
isTunneled: false
links:
parent: /api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/routing/virtualrouters/VrfUUID/staticroutes
self: /api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/routing/virtualrouters/VrfUUID/ipv6staticroutes/ipv6StaticRouteUuid
metadata:
domain:
id: domainUUID
name: Global
type: Domain
timestamp: 1531749882006.0
metricValue: 22
selectedNetworks:
- id: networkHostUuid
name: Host1
type: Host
type: IPv6StaticRoute
? 'Example 2 : POST /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ipv6staticroutes
( Example payload for POST on IPv6 Static Routes with NULL0 Interface. )'
: value:
id: ipv6StaticRouteUuid
interfaceName: Null0
links:
parent: /api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/routing/virtualrouters/VrfUUID/staticroutes
self: /api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/routing/virtualrouters/VrfUUID/ipv6staticroutes/ipv6StaticRouteUuid
metadata:
domain:
id: domainUUID
name: Global
type: Domain
timestamp: 1531749882006.0
selectedNetworks:
- id: networkHostUuid
name: Host1
type: Host
type: IPv6StaticRoute
schema:
$ref: '#/components/schemas/VrfIPv6StaticRouteModel'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/ipv6staticroutes/{objectId}
: delete:
deprecated: false
description: '**Delete the IPv6 Static Route associated with the specified ID on the specified virtual router. _Check
the response section for applicable examples (if any)._**'
operationId: deleteVrfIPv6StaticRouteModel
parameters:
- description: Unique identifier of a IPv6 Static Route.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ipv6staticroutes/ipv6StaticRouteUuid
( Example payload for DELETE on IPv6 Static Routes. )'
: value:
gateway:
object:
id: networkHostUuid
name: Host2
type: Host
id: ipv6StaticRouteUuid
interfaceName: InterfaceLogicalName
isTunneled: false
links:
parent: /api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/routing/virtualrouters/VrfUUID/staticroutes
self: /api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/routing/virtualrouters/VrfUUID/ipv6staticroutes/ipv6StaticRouteUuid
metadata:
domain:
id: domainUUID
name: Global
type: Domain
timestamp: 1531749882006.0
metricValue: 22
selectedNetworks:
- id: networkHostUuid
name: Host1
type: Host
type: IPv6StaticRoute
schema:
$ref: '#/components/schemas/VrfIPv6StaticRouteModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
get:
deprecated: false
description: '**Get the IPv6 Static Route associated with the specified ID on the specified virtual router.**'
operationId: getVrfIPv6StaticRouteModel
parameters:
- description: Unique identifier of a IPv6 Static Route.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ipv6staticroutes/ipv6StaticRouteUuid
( Example payload for GET on IPv6 Static Routes. )'
: value:
gateway:
literal:
type: Host
value: 'fe::'
id: ipv6StaticRouteUuid
interfaceName: InterfaceLogicalName
isTunneled: false
links:
parent: /api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/routing/virtualrouters/VrfUUID/staticroutes
self: /api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/routing/virtualrouters/VrfUUID/ipv6staticroutes/ipv6StaticRouteUuid
metadata:
domain:
id: domainUUID
name: Global
type: Domain
timestamp: 1531749882006.0
metricValue: 1
selectedNetworks:
- id: networkObjUuid
name: any
type: Network
type: IPv6StaticRoute
? 'Example 2 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ipv6staticroutes
( Example payload for GET on IPv6 Static Routes. )'
: value:
items:
- id: ipv6StaticRouteUuid
links:
parent: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/staticroutes
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ipv6staticroutes/ipv6StaticRouteUuid
type: IPv6StaticRoute
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ipv6staticroutes?offset=0&limit=2
paging:
count: 1
limit: 1
offset: 0
pages: 1
? 'Example 3 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ipv6staticroutes?expanded=true
( Example payload for GET on IPv6 Static Routes with ?expanded=true )'
: value:
items:
- gateway:
literal:
type: Host
value: 5.5.5.5
id: ipv6StaticRouteUuid
interfaceName: InterfaceLogicalName
isTunneled: false
links:
parent: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/staticroutes
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ipv6staticroutes/ipv6StaticRouteUuid
metricValue: 1
selectedNetworks:
- id: networkObjUuid
name: any
type: Network
type: IPv6StaticRoute
links:
self: /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ipv6staticroutes?offset=0&limit=2&expanded=true
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/VrfIPv6StaticRouteModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**Modify the IPv6 Static Route associated with the specified ID on the specified virtual router. _Check
the response section for applicable examples (if any)._**'
operationId: updateVrfIPv6StaticRouteModel
parameters:
- description: Unique identifier of a IPv6 Static Route.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ipv6staticroutes/ipv6StaticRouteUuid
( Example payload for PUT on IPv6 Static Routes. )'
: value:
gateway:
object:
id: networkHostUuid
name: Host2
type: Host
id: ipv6StaticRouteUuid
interfaceName: InterfaceLogicalName
isTunneled: false
metricValue: 50
selectedNetworks:
- id: networkHostUuid
name: Host1
type: Host
type: IPv6StaticRoute
schema:
$ref: '#/components/schemas/VrfIPv6StaticRouteModel'
type: object
description: The input IPv6 Static Route model.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/ipv6staticroutes/ipv6StaticRouteUuid
( Example payload for PUT on IPv6 Static Routes. )'
: value:
gateway:
object:
id: networkHostUuid
name: Host2
type: Host
id: ipv6StaticRouteUuid
interfaceName: InterfaceLogicalName
isTunneled: false
links:
parent: /api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/routing/virtualrouters/VrfUUID/staticroutes
self: /api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/routing/virtualrouters/VrfUUID/ipv6staticroutes/ipv6StaticRouteUuid
metadata:
domain:
id: domainUUID
name: Global
type: Domain
timestamp: 1531749882006.0
metricValue: 50
selectedNetworks:
- id: networkHostUuid
name: Host1
type: Host
type: IPv6StaticRoute
schema:
$ref: '#/components/schemas/VrfIPv6StaticRouteModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/ospfinterface
: get:
deprecated: false
description: '**Get the list of all OSPF interfaces on the specified virtual router.**'
operationId: getAllVrfOspfInterfacePolicyModel
parameters:
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/{vrfId}/ospfinterface
( Example payload for GET ALL on OSPFve . )'
: {}
schema:
$ref: '#/components/schemas/VrfOspfInterfacePolicyModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**[DEV ERROR: Missing description] _Check the response section for applicable examples (if any)._**'
operationId: createVrfOspfInterfacePolicyModel
parameters:
- description: '[DEV ERROR: Missing description]'
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VrfOspfInterfacePolicyModel'
type: object
description: '[DEV ERROR: Missing description]'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/VrfOspfInterfacePolicyModel'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/ospfinterface/{objectId}
: delete:
deprecated: false
description: '**[DEV ERROR: Missing description] _Check the response section for applicable examples (if any)._**'
operationId: deleteVrfOspfInterfacePolicyModel
parameters:
- description: '[DEV ERROR: Missing description]'
in: path
name: objectId
required: true
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/VrfOspfInterfacePolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
get:
deprecated: false
description: '**Get the OSPF interface associated with the specified ID on the specified virtual router.**'
operationId: getVrfOspfInterfacePolicyModel
parameters:
- description: Unique identifier of a OSPF Interface Policy.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/VrfOspfInterfacePolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**[DEV ERROR: Missing description] _Check the response section for applicable examples (if any)._**'
operationId: updateVrfOspfInterfacePolicyModel
parameters:
- description: '[DEV ERROR: Missing description]'
in: path
name: objectId
required: true
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VrfOspfInterfacePolicyModel'
type: object
description: '[DEV ERROR: Missing description]'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/VrfOspfInterfacePolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/ospfv2routes
: get:
deprecated: false
description: '**Get the list of all OSPFv2 routes on the specified virtual router.**'
operationId: getAllVrfOspfPolicyModel
parameters:
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/{vrfId}/ospfv2routes
( Example payload for GET ALL on OSPFve . )'
: {}
schema:
$ref: '#/components/schemas/VrfOspfPolicyModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**[DEV ERROR: Missing description] _Check the response section for applicable examples (if any)._**'
operationId: createVrfOspfPolicyModel
parameters:
- description: '[DEV ERROR: Missing description]'
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VrfOspfPolicyModel'
type: object
description: '[DEV ERROR: Missing description]'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/VrfOspfPolicyModel'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/ospfv2routes/{objectId}
: delete:
deprecated: false
description: '**[DEV ERROR: Missing description] _Check the response section for applicable examples (if any)._**'
operationId: deleteVrfOspfPolicyModel
parameters:
- description: '[DEV ERROR: Missing description]'
in: path
name: objectId
required: true
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/VrfOspfPolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
get:
deprecated: false
description: '**Get the OSPFv2 route associated with the specified ID on the specified virtual router.**'
operationId: getVrfOspfPolicyModel
parameters:
- description: Unique identifier of a OSPFv2 route.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/VrfOspfPolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**[DEV ERROR: Missing description] _Check the response section for applicable examples (if any)._**'
operationId: updateVrfOspfPolicyModel
parameters:
- description: '[DEV ERROR: Missing description]'
in: path
name: objectId
required: true
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: '[DEV ERROR: Missing description]'
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VrfOspfPolicyModel'
type: object
description: '[DEV ERROR: Missing description]'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/VrfOspfPolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/policybasedroutes
: get:
deprecated: false
description: '**Get the list of all policy-based routes on the specified virtual router.**'
operationId: getAllVrfPBRPolicyModel
parameters:
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/VrfPBRPolicyModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**Create a policy-based route on the specified virtual router. _Check the response section for applicable
examples (if any)._**'
operationId: createVrfPBRPolicyModel
parameters:
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VrfPBRPolicyModel'
type: object
description: The input policy-based route model.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/VrfPBRPolicyModel'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/policybasedroutes/{objectId}
: delete:
deprecated: false
description: '**Delete the policy-based route associated with the specified ID on the specified virtual router. _Check
the response section for applicable examples (if any)._**'
operationId: deleteVrfPBRPolicyModel
parameters:
- description: Unique identifier of a policy-based route.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/VrfPBRPolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
get:
deprecated: false
description: '**Get the policy-based route associated with the specified ID on the specified virtual router.**'
operationId: getVrfPBRPolicyModel
parameters:
- description: Unique identifier of a policy-based route.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/VrfPBRPolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**Modify the policy-based route associated with the specified ID on the specified virtual router. _Check
the response section for applicable examples (if any)._**'
operationId: updateVrfPBRPolicyModel
parameters:
- description: Unique identifier of a policy-based route.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/VrfPBRPolicyModel'
type: object
description: The input policy-based route model.
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/VrfPBRPolicyModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/staticroutes
: get:
deprecated: false
description: '**Get the list of all Static routes (ipv4 and ipv6) associated with the specified device on the specified
virtual router.**'
operationId: getAllVrfStaticRouteModel
parameters:
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/VrfStaticRouteModelListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/routing/virtualrouters/{virtualrouterUUID}/staticroutes/{objectId}
: get:
deprecated: false
description: '**Get the static route associated with the specified ID on the specified virtual router.**'
operationId: getVrfStaticRouteModel
parameters:
- description: Unique identifier of a Static Route.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the virtual router.
in: path
name: virtualrouterUUID
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/staticroutes
( Example payload for GET on static routes )'
: value:
items:
- id: static_route_uuid
links:
parent: /api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/routing/virtualrouters/virtualRouterUUID/staticroutes
self: /api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/routing/virtualrouters/virtualRouterUUID/ipv4staticroutes/static_route_uuid
type: IPv4StaticRoute
links:
self: /api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/routing/virtualrouters/virtualRouterUUID/staticroutes?offset=0&limit=1
paging:
count: 1
limit: 1
offset: 0
pages: 1
? 'Example 2 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicerecords/DeviceUUID/routing/virtualrouters/VrfUUID/staticroutes?expanded=true
( Example payload for GET on static routes with ?expanded=true )'
: value:
items:
- gateway:
literal:
type: Host
value: 1.2.3.5
id: static_route_uuid
interfaceName: OUTSIDE_INTF3
isTunneled: false
links:
parent: /api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/routing/virtualrouters/virtualRouterUUID/staticroutes
self: /api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/routing/virtualrouters/virtualRouterUUID/ipv4staticroutes/static_route_uuid
metadata:
domain:
id: domainUUID
name: Global
type: Domain
timestamp: 1531749882006.0
metricValue: 12
selectedNetworks:
- id: 86caab8a-9bdd-420d-858b-5690fde8ce58
name: IPv4-Benchmark-Tests
overridable: false
type: Network
type: IPv4StaticRoute
links:
self: /api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/routing/virtualrouters/virtualRouterUUID/staticroutes?offset=0&limit=1&expanded=true
paging:
count: 1
limit: 1
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/VrfStaticRouteModel'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/subinterfaces:
get:
deprecated: false
description: '**Get the list of all sub-interfaces associated with the specified NGFW device ID. More
details on netmod events(out of sync interfaces): GET /interfaceevents
.**'
operationId: getAllFTDSubInterface
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/subinterfaces ( GET
ALL without any query strings )'
: value:
items:
- id: SubIntf1
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/subinterfaces/SubIntf1
name: GigabitEthernet1/4
- id: SubIntf2
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/subinterfaces/SubIntf2
name: GigabitEthernet1/5
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/subinterfaces?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/subinterfaces?expanded=true
( GET ALL with expanded=true )'
: value:
items:
- MTU: 1500
applicationMonitoring:
enable: true
description: TestSubIntf
enableAntiSpoofing: false
enableSGTPropagate: true
enabled: true
id: SubIntfId2
ifname: SubIntf1
ipv4:
static:
address: 10.20.40.40
netmask: '24'
ipv6:
dadAttempts: 1
enableAutoConfig: false
enableDHCPAddrConfig: false
enableDHCPNonAddrConfig: false
enableIPV6: false
enableIPV6DadLoopbackDetect: true
enableRA: true
enforceEUI64: false
nsInterval: 1000
raInterval: 200
raLifeTime: 1800
reachableTime: 0
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/domainUUID/subinterfaces/SubIntfId1
managementOnly: false
metadata:
domain:
id: GlobalDomainUUID
name: Global
timestamp: 1467055685450.0
name: GigabitEthernet1/4
overrideDefaultFragmentSetting: {}
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
priority: 10
securityZone:
id: 6dd95c28-3c9c-11e6-b776-a85c95c244a3
type: SecurityZone
subIntfId: 25769804816.0
type: SubInterface
vlanId: 1
- MTU: 1500
applicationMonitoring:
enable: true
enableAntiSpoofing: false
enableSGTPropagate: true
enabled: true
id: SubIntfId2
ifname: SubIntf2
ipv4:
static: {}
ipv6:
addresses:
- address: '2002::'
enforceEUI64: false
prefix: '128'
dadAttempts: 1
enableAutoConfig: false
enableDHCPAddrConfig: false
enableDHCPNonAddrConfig: false
enableIPV6: false
enableIPV6DadLoopbackDetect: true
enableRA: true
enforceEUI64: false
linkLocalAddress: FE80::19
nsInterval: 1000
prefixes:
- address: 2003::/128
advertisement:
autoConfig: true
offlink: false
preferLifeTime:
duration:
preferLifeTime: 604800
validLifeTime: 2592000.0
default: false
raInterval: 200
raLifeTime: 1800
reachableTime: 0
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/domainUUID/subinterfaces/SubIntfId2
managementOnly: false
metadata:
domain:
id: GlobalDomainUUID
name: Global
timestamp: 1467055685450.0
name: GigabitEthernet1/5
overrideDefaultFragmentSetting:
chain: 24
size: 200
timeout: 5
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
priority: 10
subIntfId: 25769804817.0
type: SubInterface
vlanId: 2
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/domainUUID/subinterfaces?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/FTDSubInterfaceListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**Create a subinterface on the specified NGFW device. _Check the response section for applicable examples
(if any)._**'
operationId: createMultipleFTDSubInterface
parameters:
- description: Boolean value indicating whether this is performed as a bulk operation.
in: query
name: bulk
required: false
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/subinterfaces ( Success:
Test POST method for FTD logical (sub) interface )'
: value:
MTU: 1500
applicationMonitoring:
enable: true
arpConfig:
- enableAlias: false
ipAddress: 101.101.101.101/25
macAddress: 03DC.1234.2323
enableAntiSpoofing: true
enableSGTPropagate: true
enabled: true
ifname: Intf_name
ipv4:
dhcp:
dhcpRouteMetric: 1
enableDefaultRouteDHCP: 'true'
pppoe:
enableRouteSettings: true
ipAddress: 1.2.3.4/25
pppAuth: < PAP | CHAP | MSCHAP>
pppoePassword: User_password
pppoeRouteMetric: 1
pppoeUser: User_name
storeCredsInFlash: false
vpdnGroupName: VPDN_group_name
static:
address: 1.2.3.4
netmask: '25'
ipv6:
addresses:
- address: '2001::'
enforceEUI64: false
prefix: '124'
- address: '8080::'
enforceEUI64: true
prefix: '12'
dadAttempts: 1
enableAutoConfig: true
enableDHCPAddrConfig: true
enableDHCPNonAddrConfig: false
enableIPV6: true
enableIPV6DadLoopbackDetect: true
enableRA: false
enforceEUI64: false
linkLocalAddress: 'FE80::'
nsInterval: 10000
prefixes:
- address: 2001::/124
advertisement:
autoConfig: false
offlink: false
preferLifeTime:
duration:
preferLifeTime: 604800
validLifeTime: 2592300.0
expirationLifeTime:
preferDateTime: '2016-11-05T08:15:30-05:00'
validDateTime: '2016-12-05T08:15:30-05:00'
default: false
raInterval: 200
raLifeTime: 1800
reachableTime: 0
managementOnly: true
name: GigabitEthernet0/1
overrideDefaultFragmentSetting:
chain: 24
size: 200
timeout: 5
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
priority: 10
securityZone:
id: sec_zone_id
type: SecurityZone
subIntfId: 12345
type: SubInterface
vlanId: 30
? 'Example 2 : POST /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/subinterfaces?bulk=true
( Bulk POST operation on FTD logical (sub) interface )'
: value:
- MTU: 1500
applicationMonitoring:
enable: true
arpConfig:
- enableAlias: false
ipAddress: 101.101.101.101/25
macAddress: 03DC.1234.2323
enableAntiSpoofing: true
enableSGTPropagate: true
enabled: true
ifname: Intf_name
ipv4:
dhcp:
dhcpRouteMetric: 1
enableDefaultRouteDHCP: 'true'
pppoe:
enableRouteSettings: true
ipAddress: 1.2.3.4/25
pppAuth: < PAP | CHAP | MSCHAP>
pppoePassword: User_password
pppoeRouteMetric: 1
pppoeUser: User_name
storeCredsInFlash: false
vpdnGroupName: VPDN_group_name
static:
address: 1.2.3.4
netmask: '25'
ipv6:
addresses:
- address: '2001::'
enforceEUI64: false
prefix: '124'
- address: '8080::'
enforceEUI64: true
prefix: '12'
dadAttempts: 1
enableAutoConfig: true
enableDHCPAddrConfig: true
enableDHCPNonAddrConfig: false
enableIPV6: true
enableIPV6DadLoopbackDetect: true
enableRA: false
enforceEUI64: false
linkLocalAddress: 'FE80::'
nsInterval: 10000
prefixes:
- address: 2001::/124
advertisement:
autoConfig: false
offlink: false
preferLifeTime:
duration:
preferLifeTime: 604800
validLifeTime: 2592300.0
expirationLifeTime:
preferDateTime: '2016-11-05T08:15:30-05:00'
validDateTime: '2016-12-05T08:15:30-05:00'
default: false
raInterval: 200
raLifeTime: 1800
reachableTime: 0
managementOnly: true
name: GigabitEthernet0/1
overrideDefaultFragmentSetting:
chain: 24
size: 200
timeout: 5
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
priority: 10
securityZone:
id: sec_zone_id
type: SecurityZone
subIntfId: 12345
type: SubInterface
vlanId: 30
- MTU: 1500
applicationMonitoring:
enable: true
arpConfig:
- enableAlias: false
ipAddress: 101.101.101.101/25
macAddress: 03DC.1234.2323
enableAntiSpoofing: true
enableSGTPropagate: true
enabled: true
ifname: Intf_name_2
ipv4:
dhcp:
dhcpRouteMetric: 1
enableDefaultRouteDHCP: 'true'
pppoe:
enableRouteSettings: true
ipAddress: 1.2.3.4/25
pppAuth: < PAP | CHAP | MSCHAP>
pppoePassword: User_password
pppoeRouteMetric: 1
pppoeUser: User_name
storeCredsInFlash: false
vpdnGroupName: VPDN_group_name
static:
address: 1.2.3.4
netmask: '25'
ipv6:
addresses:
- address: '2001::'
enforceEUI64: false
prefix: '124'
- address: '8080::'
enforceEUI64: true
prefix: '12'
dadAttempts: 1
enableAutoConfig: true
enableDHCPAddrConfig: true
enableDHCPNonAddrConfig: false
enableIPV6: true
enableIPV6DadLoopbackDetect: true
enableRA: false
enforceEUI64: false
linkLocalAddress: 'FE80::'
nsInterval: 10000
prefixes:
- address: 2001::/124
advertisement:
autoConfig: false
offlink: false
preferLifeTime:
duration:
preferLifeTime: 604800
validLifeTime: 2592300.0
expirationLifeTime:
preferDateTime: '2016-11-05T08:15:30-05:00'
validDateTime: '2016-12-05T08:15:30-05:00'
default: false
raInterval: 200
raLifeTime: 1800
reachableTime: 0
managementOnly: true
name: GigabitEthernet0/2
overrideDefaultFragmentSetting:
chain: 24
size: 200
timeout: 5
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
priority: 10
securityZone:
id: sec_zone_id
type: SecurityZone
subIntfId: 123
type: SubInterface
vlanId: 35
schema:
$ref: '#/components/schemas/FTDSubInterface'
type: object
description: The input sub-interface model.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/subinterfaces ( Success:
Test POST method for FTD logical (sub) interface )'
: value:
MTU: 1500
applicationMonitoring:
enable: true
arpConfig:
- enableAlias: false
ipAddress: 101.101.101.101/25
macAddress: 03DC.1234.2323
enableAntiSpoofing: true
enableSGTPropagate: true
enabled: true
id: subInterfaceUUID
ifname: Intf_name
ipv4:
dhcp:
dhcpRouteMetric: 1
enableDefaultRouteDHCP: 'true'
pppoe:
enableRouteSettings: true
ipAddress: 1.2.3.4/25
pppAuth: < PAP | CHAP | MSCHAP>
pppoePassword: User_password
pppoeRouteMetric: 1
pppoeUser: User_name
storeCredsInFlash: false
vpdnGroupName: VPDN_group_name
static:
address: 1.2.3.4
netmask: '25'
ipv6:
addresses:
- address: '2001::'
enforceEUI64: false
prefix: '124'
- address: '8080::'
enforceEUI64: true
prefix: '12'
dadAttempts: 1
enableAutoConfig: true
enableDHCPAddrConfig: true
enableDHCPNonAddrConfig: false
enableIPV6: true
enableIPV6DadLoopbackDetect: true
enableRA: false
enforceEUI64: false
linkLocalAddress: 'FE80::'
nsInterval: 10000
prefixes:
- address: 2001::/124
advertisement:
autoConfig: false
offlink: false
preferLifeTime:
duration:
preferLifeTime: 604800
validLifeTime: 2592300.0
expirationLifeTime:
preferDateTime: '2016-11-05T08:15:30-05:00'
validDateTime: '2016-12-05T08:15:30-05:00'
default: false
raInterval: 200
raLifeTime: 1800
reachableTime: 0
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/subinterfaces/subinterfaceUUID
managementOnly: true
metadata:
activity: 0
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
link: 0
readOnly:
state: false
speed: -1
timestamp: 1458597038.0
name: GigabitEthernet0/1
overrideDefaultFragmentSetting:
chain: 24
size: 200
timeout: 5
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
priority: 10
securityZone:
id: sec_zone_id
type: SecurityZone
subIntfId: 12345
type: SubInterface
vlanId: 30
? 'Example 2 : POST /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/subinterfaces?bulk=true
( Bulk POST operation on FTD logical (sub) interface )'
: value:
items:
- MTU: 1500
applicationMonitoring:
enable: true
arpConfig:
- enableAlias: false
ipAddress: 101.101.101.101/25
macAddress: 03DC.1234.2323
enableAntiSpoofing: true
enableSGTPropagate: true
enabled: true
id: subInterfaceUUID
ifname: Intf_name
ipv4:
dhcp:
dhcpRouteMetric: 1
enableDefaultRouteDHCP: 'true'
pppoe:
enableRouteSettings: true
ipAddress: 1.2.3.4/25
pppAuth: < PAP | CHAP | MSCHAP>
pppoePassword: User_password
pppoeRouteMetric: 1
pppoeUser: User_name
storeCredsInFlash: false
vpdnGroupName: VPDN_group_name
static:
address: 1.2.3.4
netmask: '25'
ipv6:
addresses:
- address: '2001::'
enforceEUI64: false
prefix: '124'
- address: '8080::'
enforceEUI64: true
prefix: '12'
dadAttempts: 1
enableAutoConfig: true
enableDHCPAddrConfig: true
enableDHCPNonAddrConfig: false
enableIPV6: true
enableIPV6DadLoopbackDetect: true
enableRA: false
enforceEUI64: false
linkLocalAddress: 'FE80::'
nsInterval: 10000
prefixes:
- address: 2001::/124
advertisement:
autoConfig: false
offlink: false
preferLifeTime:
duration:
preferLifeTime: 604800
validLifeTime: 2592300.0
expirationLifeTime:
preferDateTime: '2016-11-05T08:15:30-05:00'
validDateTime: '2016-12-05T08:15:30-05:00'
default: false
raInterval: 200
raLifeTime: 1800
reachableTime: 0
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/subinterfaces/subinterfaceUUID
managementOnly: true
metadata:
activity: 0
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
link: 0
readOnly:
state: false
speed: -1
timestamp: 1458597038.0
name: GigabitEthernet0/1
overrideDefaultFragmentSetting:
chain: 24
size: 200
timeout: 5
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
priority: 10
securityZone:
id: sec_zone_id
type: SecurityZone
subIntfId: 12345
type: SubInterface
vlanId: 30
- MTU: 1500
applicationMonitoring:
enable: true
arpConfig:
- enableAlias: false
ipAddress: 101.101.101.101/25
macAddress: 03DC.1234.2323
enableAntiSpoofing: true
enableSGTPropagate: true
enabled: true
id: subInterfaceUUID
ifname: Intf_name_2
ipv4:
dhcp:
dhcpRouteMetric: 1
enableDefaultRouteDHCP: 'true'
pppoe:
enableRouteSettings: true
ipAddress: 1.2.3.4/25
pppAuth: < PAP | CHAP | MSCHAP>
pppoePassword: User_password
pppoeRouteMetric: 1
pppoeUser: User_name
storeCredsInFlash: false
vpdnGroupName: VPDN_group_name
static:
address: 1.2.3.4
netmask: '25'
ipv6:
addresses:
- address: '2001::'
enforceEUI64: false
prefix: '124'
- address: '8080::'
enforceEUI64: true
prefix: '12'
dadAttempts: 1
enableAutoConfig: true
enableDHCPAddrConfig: true
enableDHCPNonAddrConfig: false
enableIPV6: true
enableIPV6DadLoopbackDetect: true
enableRA: false
enforceEUI64: false
linkLocalAddress: 'FE80::'
nsInterval: 10000
prefixes:
- address: 2001::/124
advertisement:
autoConfig: false
offlink: false
preferLifeTime:
duration:
preferLifeTime: 604800
validLifeTime: 2592300.0
expirationLifeTime:
preferDateTime: '2016-11-05T08:15:30-05:00'
validDateTime: '2016-12-05T08:15:30-05:00'
default: false
raInterval: 200
raLifeTime: 1800
reachableTime: 0
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/subinterfaces/subinterfaceUUID
managementOnly: true
metadata:
activity: 0
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
link: 0
readOnly:
state: false
speed: -1
timestamp: 1458597038.0
name: GigabitEthernet0/2
overrideDefaultFragmentSetting:
chain: 24
size: 200
timeout: 5
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
priority: 10
securityZone:
id: sec_zone_id
type: SecurityZone
subIntfId: 123
type: SubInterface
vlanId: 35
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/subinterfaces?bulk=true
schema:
$ref: '#/components/schemas/FTDSubInterface'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/subinterfaces/{objectId}:
delete:
deprecated: false
description: '**Delete the sub-interface associated with the specified NGFW device ID and interface ID. _Check the response
section for applicable examples (if any)._**'
operationId: deleteFTDSubInterface
parameters:
- description: Unique identifier of a sub-interface.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/subinterfaces/subinterfaceUUID
( Success: Test DELETE method for FTD logical interface )'
: value:
MTU: 1500
applicationMonitoring:
enable: true
enableAntiSpoofing: false
enableSGTPropagate: true
enabled: true
id: subinterfaceUUID
ifname: SubIntf2
ipv4:
static: {}
ipv6:
addresses:
- address: '2002::'
enforceEUI64: false
prefix: '128'
dadAttempts: 1
enableAutoConfig: false
enableDHCPAddrConfig: false
enableDHCPNonAddrConfig: false
enableIPV6: false
enableIPV6DadLoopbackDetect: true
enableRA: true
enforceEUI64: false
linkLocalAddress: FE80::19
nsInterval: 1000
prefixes:
- address: 2003::/128
advertisement:
autoConfig: true
offlink: false
preferLifeTime:
duration:
preferLifeTime: 604800
validLifeTime: 2592000.0
default: false
raInterval: 200
raLifeTime: 1800
reachableTime: 0
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/subinterfaces/subinterfaceUUID
managementOnly: false
metadata:
domain:
id: GlobalDomainUUID
name: Global
timestamp: 1467055685450.0
name: GigabitEthernet0/1
overrideDefaultFragmentSetting:
chain: 24
size: 200
timeout: 5
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
priority: 10
subIntfId: 25769804817.0
type: SubInterface
vlanId: 2
schema:
$ref: '#/components/schemas/FTDSubInterface'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
get:
deprecated: false
description: '**Get the sub-interface associated with the specified NGFW device ID and interface ID.**'
operationId: getFTDSubInterface
parameters:
- description: Unique identifier of a sub-interface.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/subinterfaces/subinterfaceUUID
( Success: Test GET method for FTD logical interface )'
: value:
MTU: 1500
applicationMonitoring:
enable: true
monitoredApplications:
- id: '2325'
name: 050plus
type: Application
- id: '1553'
name: 1&1 Internet
type: Application
enableAntiSpoofing: false
enableSGTPropagate: true
enabled: true
id: subinterfaceUUID
ifname: SubIntf2
ipv4:
static: {}
ipv6:
addresses:
- address: '2002::'
enforceEUI64: false
prefix: '128'
dadAttempts: 1
enableAutoConfig: false
enableDHCPAddrConfig: false
enableDHCPNonAddrConfig: false
enableIPV6: false
enableIPV6DadLoopbackDetect: true
enableRA: true
enforceEUI64: false
linkLocalAddress: FE80::19
nsInterval: 1000
prefixes:
- address: 2003::/128
advertisement:
autoConfig: true
offlink: false
preferLifeTime:
duration:
preferLifeTime: 604800
validLifeTime: 2592000.0
default: false
raInterval: 200
raLifeTime: 1800
reachableTime: 0
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/subinterfaces/subinterfaceUUID
managementOnly: false
metadata:
domain:
id: GlobalDomainUUID
name: Global
timestamp: 1467055685450.0
name: GigabitEthernet1/4
overrideDefaultFragmentSetting:
chain: 24
size: 200
timeout: 5
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
priority: 10
subIntfId: 25769804817.0
type: SubInterface
vlanId: 2
schema:
$ref: '#/components/schemas/FTDSubInterface'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**Modify the sub-interface associated with the specified NGFW device ID and interface ID. _Check the response
section for applicable examples (if any)._**'
operationId: updateFTDSubInterface
parameters:
- description: Unique identifier of a sub-interface.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/subinterfaces/subinterfaceUUID
( Success: Test PUT method for FTD logical (sub) interface )'
: value:
MTU: 1500
arpConfig:
- enableAlias: false
ipAddress: 101.101.101.101/25
macAddress: 03DC.1234.2323
enableAntiSpoofing: true
enabled: true
id: subinterfaceUUID
ifname: Intf_name
ipv4:
dhcp:
dhcpRouteMetric: 1
enableDefaultRouteDHCP: 'true'
pppoe:
enableRouteSettings: true
ipAddress: 1.2.3.4/25
pppAuth: < PAP | CHAP | MSCHAP>
pppoePassword: User_password
pppoeRouteMetric: 1
pppoeUser: User_name
storeCredsInFlash: false
vpdnGroupName: VPDN_group_name
static:
address: 1.2.3.4
netmask: '25'
ipv6:
addresses:
- address: '2001::'
enforceEUI64: false
prefix: '124'
- address: '8080::'
enforceEUI64: true
prefix: '12'
dadAttempts: 1
enableAutoConfig: true
enableDHCPAddrConfig: true
enableDHCPNonAddrConfig: false
enableIPV6: true
enableIPV6DadLoopbackDetect: true
enableRA: false
enforceEUI64: false
linkLocalAddress: 'FE80::'
nsInterval: 10000
prefixes:
- address: 2001::/124
advertisement:
autoConfig: false
offlink: false
preferLifeTime:
duration:
preferLifeTime: 604800
validLifeTime: 2592300.0
expirationLifeTime:
preferDateTime: '2016-11-05T08:15:30.000Z'
validDateTime: '2016-12-05T08:15:30.000Z'
default: false
raInterval: 200
raLifeTime: 1800
reachableTime: 0
managementOnly: true
name: GigabitEthernet0/1
overrideDefaultFragmentSetting:
chain: 24
size: 200
timeout: 5
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
priority: 10
securityZone:
id: sec_zone_id
type: SecurityZone
subIntfId: 12345
type: SubInterface
vlanId: 30
schema:
$ref: '#/components/schemas/FTDSubInterface'
type: object
description: The input sub-interface model.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/subinterfaces/subinterfaceUUID
( Success: Test PUT method for FTD logical (sub) interface )'
: value:
MTU: 1500
arpConfig:
- enableAlias: false
ipAddress: 101.101.101.101/25
macAddress: 03DC.1234.2323
enableAntiSpoofing: true
enableSGTPropagate: true
enabled: true
id: subinterfaceUUID
ifname: Intf_name
ipv4:
dhcp:
dhcpRouteMetric: 1
enableDefaultRouteDHCP: 'true'
pppoe:
enableRouteSettings: true
ipAddress: 1.2.3.4/25
pppAuth: < PAP | CHAP | MSCHAP>
pppoePassword: User_password
pppoeRouteMetric: 1
pppoeUser: User_name
storeCredsInFlash: false
vpdnGroupName: VPDN_group_name
static:
address: 1.2.3.4
netmask: '25'
ipv6:
addresses:
- address: '2001::'
enforceEUI64: false
prefix: '124'
- address: '8080::'
enforceEUI64: true
prefix: '12'
dadAttempts: 1
enableAutoConfig: true
enableDHCPAddrConfig: true
enableDHCPNonAddrConfig: false
enableIPV6: true
enableIPV6DadLoopbackDetect: true
enableRA: false
enforceEUI64: false
linkLocalAddress: 'FE80::'
nsInterval: 10000
prefixes:
- address: 2001::/124
advertisement:
autoConfig: false
offlink: false
preferLifeTime:
duration:
preferLifeTime: 604800
validLifeTime: 2592300.0
expirationLifeTime:
preferDateTime: '2016-11-05T08:15:30.000Z'
validDateTime: '2016-12-05T08:15:30.000Z'
default: false
raInterval: 200
raLifeTime: 1800
reachableTime: 0
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/subinterfaces/subinterfaceUUID
managementOnly: true
metadata:
activity: 0
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
link: 0
readOnly:
state: false
speed: -1
timestamp: 1458597038.0
name: GigabitEthernet0/1
overrideDefaultFragmentSetting:
chain: 24
size: 200
timeout: 5
pathMonitoring:
enable: true
monitoredIp: string
type: PEER_IPV4 | PEER_IPV6 | AUTO | AUTO4 | AUTO6
priority: 10
securityZone:
id: sec_zone_id
type: SecurityZone
subIntfId: 12345
type: SubInterface
vlanId: 30
schema:
$ref: '#/components/schemas/FTDSubInterface'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/universalzerotrustsettings:
get:
deprecated: false
description: '**Retrieves the Hybrid Zero Trust configuration for device.**'
operationId: getAllHybridZeroTrustSetting
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/HybridZeroTrustSettingListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
? /v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/universalzerotrustsettings/{objectId}
: get:
deprecated: false
description: '**Retrieves the Hybrid Zero Trust configuration for device.**'
operationId: getHybridZeroTrustSetting
parameters:
- description: Unique identifier of a Hybrid Zero Trust Setting.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/HybridZeroTrustSetting'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**Retrieves the Hybrid Zero Trust configuration for device. _Check the response section for applicable
examples (if any)._**'
operationId: updateHybridZeroTrustSetting
parameters:
- description: Unique identifier of a Hybrid Zero Trust Setting.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/HybridZeroTrustSetting'
type: object
description: The input Hybrid Zero Trust Setting model.
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/HybridZeroTrustSetting'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/virtualswitches:
get:
deprecated: false
description: '**Get the list of all virtual switches associated with the specified NGIPS device ID.**'
operationId: getAllVirtualSwitch
parameters:
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/virtualswitches (
Success: Test GET ALL success )'
: value:
items:
- id: virtualswitchUUID1
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/virtualswitches/virtualswitchUUID1
name: virtual_switch_1
type: VirtualSwitch
- id: virtualswitchUUID2
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/virtualswitches/virtualswitchUUID2
name: virtual_switch_2
type: VirtualSwitch
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/virtualswitches?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/virtualswitches?expanded=true
( Success: Test GET ALL success with expanded=true )'
: value:
items:
- domainId: 2
dropBPDU: false
enableSpanningTreeProtocol: false
hybridInterface:
id: hybridInterfaceUUID
name: hybrid_1
type: FPLogicalInterface
id: virtualswitchUUID1
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/virtualswitches/virtualswitchUUID1
metadata:
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
readOnly:
state: false
timestamp: 1458595542.0
name: virtual_switch_1
strictTCPEnforcement: false
switchedInterfaces:
- id: switchedInterfaceUUID1
name: s1p3.1
type: FPLogicalInterface
- id: switchedInterfaceUUID2
name: s1p4.1
type: FPLogicalInterface
type: VirtualSwitch
- domainId: 3
dropBPDU: false
enableSpanningTreeProtocol: true
id: virtualswitchUUID2
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/virtualswitches/virtualswitchUUID2
metadata:
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
readOnly:
state: false
timestamp: 1458595542.0
name: virtual_switch_2
strictTCPEnforcement: false
type: VirtualSwitch
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/virtualswitches?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/VirtualSwitchListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**Create a virtual switch on the specified NGIPS device. _Check the response section for applicable examples
(if any)._**'
operationId: createVirtualSwitch
parameters:
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/virtualswitches ( Test
POST of Virtual Switch to add a record )'
: value:
domainId: 4
dropBPDU: false
enableSpanningTreeProtocol: true
hybridInterface:
id: hybridInterfaceUUID
name: hybrid_1
type: FPLogicalInterface
name: virtual_switch_3
strictTCPEnforcement: false
switchedInterfaces:
- id: switchedInterfaceUUID1
name: s1p3.1
type: FPLogicalInterface
- id: switchedInterfaceUUID2
name: s1p4.1
type: FPLogicalInterface
type: VirtualSwitch
schema:
$ref: '#/components/schemas/VirtualSwitch'
type: object
description: The input virtual switch model.
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/VirtualSwitch'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/virtualswitches/{objectId}:
delete:
deprecated: false
description: '**Delete the virtual switch associated with the specified NGIPS device ID and virtual switch ID. _Check
the response section for applicable examples (if any)._**'
operationId: deleteVirtualSwitch
parameters:
- description: Unique identifier of a virtual switch.
in: path
name: objectId
required: true
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/virtualswitches/virtualswitchUUID1
( Test DELETE of Virtual Switch )'
: value:
domainId: 2
dropBPDU: false
enableSpanningTreeProtocol: false
hybridInterface:
id: hybridInterfaceUUID
name: hybrid_1
type: FPLogicalInterface
id: virtualswitchUUID1
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/virtualswitches/virtualswitchUUID
metadata:
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
readOnly:
state: false
timestamp: 1458595542.0
name: virtual_switch_1
strictTCPEnforcement: false
switchedInterfaces:
- id: switchedInterfaceUUID1
name: s1p3.1
type: FPLogicalInterface
- id: switchedInterfaceUUID2
name: s1p4.1
type: FPLogicalInterface
type: VirtualSwitch
schema:
$ref: '#/components/schemas/VirtualSwitch'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
get:
deprecated: false
description: '**Get the virtual switch associated with the specified NGIPS device ID and virtual switch ID.**'
operationId: getVirtualSwitch
parameters:
- description: Unique identifier of a virtual switch.
in: path
name: objectId
required: true
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/virtualswitches/virtualswitchUUID
( Success: Test GET method for virtual switch )'
: value:
domainId: 2
dropBPDU: false
enableSpanningTreeProtocol: false
hybridInterface:
id: hybridInterfaceUUID
name: hybrid_1
type: FPLogicalInterface
id: virtualswitchUUID1
links:
self: /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/virtualswitches/virtualswitchUUID
metadata:
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
readOnly:
state: false
timestamp: 1458595542.0
name: virtual_switch_1
strictTCPEnforcement: false
switchedInterfaces:
- id: switchedInterfaceUUID1
name: s1p3.1
type: FPLogicalInterface
- id: switchedInterfaceUUID2
name: s1p4.1
type: FPLogicalInterface
type: VirtualSwitch
schema:
$ref: '#/components/schemas/VirtualSwitch'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**Modify the virtual switch associated with the specified NGIPS device ID and virtual switch ID. _Check
the response section for applicable examples (if any)._**'
operationId: updateVirtualSwitch
parameters:
- description: Unique identifier of a virtual switch.
in: path
name: objectId
required: true
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/devices/devicerecords/containerUUID/virtualswitches/virtualswitchUUID2
( Test PUT of Virtual Switch to update record )'
: value:
domainId: 3
dropBPDU: true
enableSpanningTreeProtocol: false
hybridInterface:
id: hybridInterfaceUUID
name: hybrid_1
type: FPLogicalInterface
id: virtualswitchUUID2
name: virtual_switch_2
strictTCPEnforcement: false
switchedInterfaces:
- id: switchedInterfaceUUID1
name: s1p3.1
type: FPLogicalInterface
- id: switchedInterfaceUUID2
name: s1p4.1
type: FPLogicalInterface
type: VirtualSwitch
schema:
$ref: '#/components/schemas/VirtualSwitch'
type: object
description: The input virtual switch model.
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/VirtualSwitch'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/virtualtunnelinterfaces:
get:
deprecated: false
description: '**Get the list of virtual tunnel interfaces associated with the specified NGFW device.**'
operationId: getAllFTDVTIInterface
parameters:
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
- $ref: '#/components/parameters/offset'
name: offset
- $ref: '#/components/parameters/limit'
name: limit
- $ref: '#/components/parameters/expanded'
name: expanded
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/virtualtunnelinterfaces
( Success: Test GET ALL success )'
: value:
items:
- id: virtualtunnelinterfaceUUID1
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/virtualtunnelinterfaces/virtualtunnelinterfaceUUID1
name: tunnel-1
type: VTIInterface
- id: virtualtunnelinterfaceUUID2
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/virtualtunnelinterfaces/virtualtunnelinterfaceUUID2
name: tunnel-2
type: VTIInterface
- id: virtualtunnelinterfaceUUID3
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/virtualtunnelinterfaces/virtualtunnelinterfaceUUID3
name: tunnel-3
type: VTIInterface
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/virtualtunnelinterfaces?offset=0&limit=3
paging:
count: 3
limit: 3
offset: 0
pages: 1
? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/virtualtunnelinterfaces/virtualtunnelinterfaceUUID?expanded=true
( Success: Test GET ALL success with expanded=true )'
: value:
items:
- borrowIPfrom:
id: 00505686-854B-0ed3-0000-008589934808
name: Loopback5
type: LoopbackInterface
enabled: true
id: 00000000-0000-0ed3-0000-206158430258
ifname: tunnel-4
ipsecMode: ipv4
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/virtualtunnelinterfaces/virtualtunnelinterfaceUUID1
metadata:
destinationIpAddress: 10.10.10.10
domain:
id: domainUUID
name: Global
timestamp: 1462814174120.0
vpnTopologyName: s2s-4
name: Tunnel4
securityZone:
id:
links:
self: http://.....
type: SecurityZone
tunnelId: 4
tunnelSource:
id: interface UUID
name: GigabitEthernet0/0
type: PhysicalInterface
tunnelType: STATIC
type: VTIInterface
- enabled: true
id: 00000000-0000-0ed3-0000-206158430258
ifname: tunnel-5
ipsecMode: ipv4
ipv4:
static:
address: 2.2.2.2
netmask: 255.255.255.0
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/virtualtunnelinterfaces/virtualtunnelinterfaceUUID2
metadata:
destinationIpAddress: 10.10.10.10
domain:
id: domainUUID
name: Global
timestamp: 1462814174120.0
vpnTopologyName: s2s-4
name: Tunnel5
securityZone:
id:
links:
self: http://.....
type: SecurityZone
tunnelId: 5
tunnelSource:
id: interface UUID
name: GigabitEthernet0/0
type: PhysicalInterface
tunnelType: STATIC
type: VTIInterface
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/virtualtunnelinterfaces/virtualtunnelinterfaceUUID?offset=0&limit=2
paging:
count: 2
limit: 2
offset: 0
pages: 1
schema:
$ref: '#/components/schemas/FTDVTIInterfaceListContainer'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
post:
deprecated: false
description: '**Create a virtual tunnel interface on the specified NGFW device. _Check the response section for applicable
examples (if any)._**'
operationId: createMultipleFTDVTIInterface
parameters:
- description: Boolean value indicating whether this is performed as a bulk operation.
in: query
name: bulk
required: false
schema:
type: boolean
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : POST /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/virtualtunnelinterfaces
( Success: Test POST method for FTD virtual tunnel interface )'
: value:
enabled: true
id: 00000000-0000-0ed3-0000-206158430258
ifname: tunnel-5
ipsecMode: ipv4
ipv4:
static:
address: 169.254.100.1
netmask: 255.255.255.252
securityZone:
id:
links:
self: http://.....
type: SecurityZone
tunnelId: 5
tunnelSource:
id: interface UUID
name: GigabitEthernet0/0
type: PhysicalInterface
tunnelType: STATIC
type: VTIInterface
? 'Example 2 : POST /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/virtualtunnelinterfaces?bulk=true
( Bulk POST operation on FTD virtual tunnel interface )'
: value:
- borrowIPfrom:
id: loopback interface UUID
name: Loopback5
type: LoopbackInterface
enabled: true
id: 00000000-0000-0ed3-0000-206158430259
ifname: tunnel-6
ipsecMode: ipv4
securityZone:
id:
links:
self: http://.....
type: SecurityZone
tunnelId: 6
tunnelSource:
id: interface UUID
name: GigabitEthernet0/1
type: PhysicalInterface
tunnelType: STATIC
type: VTIInterface
- enabled: true
id: 00000000-0000-0ed3-0000-206158430250
ifname: tunnel-7
ipsecMode: ipv4
ipv4:
static:
address: 169.254.100.5
netmask: 255.255.255.252
securityZone:
id:
links:
self: http://.....
type: SecurityZone
tunnelId: 7
tunnelSource:
id: interface UUID
name: GigabitEthernet0/2
type: PhysicalInterface
tunnelType: STATIC
type: VTIInterface
schema:
$ref: '#/components/schemas/FTDVTIInterface'
type: object
description: The input virtual tunnel interface model.
required: true
responses:
'201':
content:
application/json:
examples:
? 'Example 1 : POST /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/virtualtunnelinterfaces
( Success: Test POST method for FTD virtual tunnel interface )'
: value:
enabled: true
id: 00000000-0000-0ed3-0000-206158430258
ifname: tunnel-5
ipsecMode: ipv4
ipv4:
static:
address: 169.254.100.1
netmask: 255.255.255.252
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/virtualtunnelinterfaces/virtualtunnelinterfaceUUID
metadata:
destinationIpAddress: 10.10.10.10
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
readOnly:
state: false
timestamp: 1458597038.0
vpnTopologyName: s2s-4
name: Tunnel5
securityZone:
id:
links:
self: http://.....
type: SecurityZone
tunnelId: 5
tunnelSource:
id: interface UUID
name: GigabitEthernet0/0
type: PhysicalInterface
tunnelType: STATIC
type: VTIInterface
? 'Example 2 : POST /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/virtualtunnelinterfaces?bulk=true
( Bulk POST operation on FTD virtual tunnel interface )'
: value:
items:
- enabled: true
id: 00000000-0000-0ed3-0000-206158430259
ifname: tunnel-6
ipsecMode: ipv4
ipv4:
static:
address: 169.254.100.1
netmask: 255.255.255.252
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/virtualtunnelinterfaces/virtualtunnelinterfaceUUID
metadata:
destinationIpAddress: 10.10.10.10
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
readOnly:
state: false
timestamp: 1458597038.0
vpnTopologyName: s2s-4
name: Tunnel6
securityZone:
id:
links:
self: http://.....
type: SecurityZone
tunnelId: 6
tunnelSource:
id: interface UUID
name: GigabitEthernet0/1
type: PhysicalInterface
tunnelType: STATIC
type: VTIInterface
- borrowIPfrom:
id: 00505686-854B-0ed3-0000-008589934808
name: Loopback5
type: LoopbackInterface
enabled: true
id: 00000000-0000-0ed3-0000-206158430250
ifname: tunnel-7
ipsecMode: ipv4
links:
self: /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/virtualtunnelinterfaces/virtualtunnelinterfaceUUID
metadata:
destinationIpAddress: 10.10.10.10
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
readOnly:
state: false
timestamp: 1458597038.0
vpnTopologyName: s2s-4
name: Tunnel7
securityZone:
id:
links:
self: http://.....
type: SecurityZone
tunnelId: 7
tunnelSource:
id: interface UUID
name: GigabitEthernet0/2
type: PhysicalInterface
tunnelType: STATIC
type: VTIInterface
links:
self: https://example.cisco.com/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/virtualtunnelinterfaces?bulk=true
schema:
$ref: '#/components/schemas/FTDVTIInterface'
type: object
description: Created
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/virtualtunnelinterfaces/{objectId}:
delete:
deprecated: false
description: '**Delete the virtual tunnel interface associated with the specified NGFW device and interface ID. _Check
the response section for applicable examples (if any)._**'
operationId: deleteFTDVTIInterface
parameters:
- description: Unique identifier of a virtual tunnel interface.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : DELETE /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/virtualtunnelinterfaces/virtualtunnelinterfaceUUID
( Success: Test DELETE method for virtual tunnel interface )'
: value:
enabled: true
id: 00000000-0000-0ed3-0000-206158430258
ifname: tunnel-5
ipsecMode: ipv4
ipv4:
static:
address: 2.2.2.2
netmask: 255.255.255.0
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/virtualtunnelinterfaces/virtualtunnelinterfaceUUID
metadata:
destinationIpAddress: 10.10.10.10
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
readOnly:
state: false
timestamp: 1458597038.0
vpnTopologyName: s2s-4
name: Tunnel5
securityZone:
id:
links:
self: http://.....
type: SecurityZone
tunnelId: 5
tunnelSource:
id: interface UUID
name: GigabitEthernet0/0
type: PhysicalInterface
tunnelType: STATIC
type: VTIInterface
schema:
$ref: '#/components/schemas/FTDVTIInterface'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
get:
deprecated: false
description: '**Get the virtual tunnel interface associated with the specified NGFW device and interface ID.**'
operationId: getFTDVTIInterface
parameters:
- description: Unique identifier of a virtual tunnel interface.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : GET /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/virtualtunnelinterfaces/virtualtunnelinterfaceUUID
( Success: Test GET method for virtual tunnel interface )'
: value:
enabled: true
id: 00000000-0000-0ed3-0000-206158430258
ifname: tunnel-4
ipsecMode: ipv6
ipv4:
static:
address: 2.2.2.2
netmask: 255.255.255.0
ipv6:
addresses:
- address: ee::11
prefix: '64'
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/virtualtunnelinterfaces/virtualtunnelinterfaceUUID
metadata:
destinationIpAddress: 10.10.10.10
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
readOnly:
state: false
timestamp: 1458597038.0
vpnTopologyName: s2s-4
name: Tunnel4
securityZone:
id:
links:
self: http://.....
type: SecurityZone
tunnelId: 4
tunnelSource:
id: interface UUID
name: GigabitEthernet0/0
type: PhysicalInterface
tunnelType: STATIC
type: VTIInterface
schema:
$ref: '#/components/schemas/FTDVTIInterface'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
put:
deprecated: false
description: '**Modify the virtual tunnel interface associated with the specified NGFW device and interface ID. _Check
the response section for applicable examples (if any)._**'
operationId: updateFTDVTIInterface
parameters:
- description: Unique identifier of a virtual tunnel interface.
in: path
name: objectId
required: true
schema:
type: string
- description: UUID of the ticket for tracking the configuration changes.
in: header
name: ticket-id
required: false
schema:
type: string
- description: The container id under which this specific resource is contained.
in: path
name: containerUUID
required: true
schema:
type: string
- $ref: '#/components/parameters/domainUUID'
name: domainUUID
requestBody:
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/virtualtunnelinterfaces/virtualtunnelinterfaceUUID
( Success: Test PUT method for virtual tunnel interface )'
: value:
- borrowIPfrom:
id: loopback interface UUID
name: Loopback5
type: LoopbackInterface
enabled: true
id: 00000000-0000-0ed3-0000-206158430258
ifname: tunnel-5
ipsecMode: ipv4
name: Tunnel5
securityZone:
id:
links:
self: http://.....
type: SecurityZone
tunnelId: 5
tunnelSource:
id: interface UUID
name: GigabitEthernet0/0
type: PhysicalInterface
tunnelType: STATIC
type: VTIInterface
- enabled: true
id: 00000000-0000-0ed3-0000-206158430258
ifname: tunnel-5
ipsecMode: ipv4
ipv4:
static:
address: 2.2.2.2
netmask: 255.255.255.0
name: Tunnel5
securityZone:
id:
links:
self: http://.....
type: SecurityZone
tunnelId: 5
tunnelSource:
id: interface UUID
name: GigabitEthernet0/0
type: PhysicalInterface
tunnelType: STATIC
type: VTIInterface
schema:
$ref: '#/components/schemas/FTDVTIInterface'
type: object
description: The input virtual tunnel interface model.
required: true
responses:
'200':
content:
application/json:
examples:
? 'Example 1 : PUT /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/virtualtunnelinterfaces/virtualtunnelinterfaceUUID
( Success: Test PUT method for virtual tunnel interface )'
: value:
- borrowIPfrom:
id: 00505686-854B-0ed3-0000-008589934808
name: Loopback5
type: LoopbackInterface
enabled: true
id: 00000000-0000-0ed3-0000-206158430258
ifname: tunnel-5
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/virtualtunnelinterfaces/virtualtunnelinterfaceUUID
metadata:
destinationIpAddress: 10.10.10.10
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
readOnly:
state: false
timestamp: 1458597038.0
vpnTopologyName: s2s-4
name: Tunnel5
securityZone:
id:
links:
self: http://.....
type: SecurityZone
tunnelId: 5
tunnelSource:
id: interface UUID
name: GigabitEthernet0/0
type: PhysicalInterface
tunnelType: STATIC
type: VTIInterface
- enabled: true
id: 00000000-0000-0ed3-0000-206158430258
ifname: tunnel-5
ipv4:
static:
address: 2.2.2.2
netmask: 255.255.255.0
links:
self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/virtualtunnelinterfaces/virtualtunnelinterfaceUUID
metadata:
destinationIpAddress: 10.10.10.10
domain:
id: DomainUUID
name: Global
type: domain
lastUser:
id: UserUUID
name: admin
type: user
readOnly:
state: false
timestamp: 1458597038.0
vpnTopologyName: s2s-4
name: Tunnel5
securityZone:
id:
links:
self: http://.....
type: SecurityZone
tunnelId: 5
tunnelSource:
id: interface UUID
name: GigabitEthernet0/0
type: PhysicalInterface
tunnelType: STATIC
type: VTIInterface
schema:
$ref: '#/components/schemas/FTDVTIInterface'
type: object
description: OK
default:
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
type: object
description: Error
tags:
- Devices
servers:
- url: https://api.us.security.cisco.com/firewall
description: US
- url: https://api.eu.security.cisco.com/firewall
description: EU
- url: https://api.apj.security.cisco.com/firewall
description: APJ
- url: https://api.au.security.cisco.com/firewall
description: AUS
- url: https://api.in.security.cisco.com/firewall
description: IN
- url: https://api.int.security.cisco.com/firewall
description: Staging
- url: https://scale.manage.security.cisco.com/api/rest
description: Scale
- url: https://ci.manage.security.cisco.com/api/rest
description: CI
- url: https://manage.stg.secure.cisco/api/rest
description: Stgf9
/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/devices/devicerecords/{containerUUID}/vlaninterfaces:
get:
deprecated: false
description: '**Get the list of VLAN interfaces associated with the specified NGFW device. More
details on netmod events(out of sync interfaces):