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 , show failover, show failover , show dhcpd state, show ip, show ip , show aaa-server, show aaa-server , show logging, show logging , show snmp-server , show ssl, show ssl , show firewall, show logging, show logging , show route, show route , show vpn-sessiondb, show vpn-sessiondb , show crypto , show rule , show access-list , 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): GET /interfaceevents
.**' operationId: getAllFTDVlanInterface 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/vlaninterfaces ( GET ALL without any query strings )' : value: items: - id: vlanIntf1 links: self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vlaninterfaces/vlanIntf1 name: Vlan1 - id: vlanIntf2 links: self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vlaninterfaces/vlanIntf2 name: Vlan2 links: self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vlaninterfaces?offset=0&limit=2 paging: count: 2 limit: 2 offset: 0 pages: 1 ? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/vlaninterfaces?expanded=true ( GET ALL with expanded=true )' : value: items: - MTU: 1500 description: vlanIntf2 disablePortForwardOnVlan: id: interface UUID name: Vlan1 type: VlanInterface enableAntiSpoofing: false enabled: true id: VlanIntfId2 ifname: vlanIntf1 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/vlaninterfaces/VlanIntfId1 metadata: domain: id: GlobalDomainUUID name: Global hwPortAssociations: - id: Switch Port Interface UUID name: Ethernet1/2 switchPortMode: trunk type: PhysicalInterface - id: Switch Port Interface UUID name: Ethernet1/4 switchPortMode: access type: PhysicalInterface timestamp: 1467055685450.0 mode: NONE name: Vlan1 overrideDefaultFragmentSetting: {} priority: 10 securityZone: id: 6dd95c28-3c9c-11e6-b776-a85c95c244a3 type: SecurityZone type: VlanInterface vlanId: 1 - MTU: 1500 disablePortForwardOnVlan: id: interface UUID name: Vlan1 type: VlanInterface enableAntiSpoofing: false enabled: true id: VlanIntfId2 ifname: vlanIntf2 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/vlaninterfaces/VlanIntfId2 metadata: domain: id: GlobalDomainUUID name: Global hwPortAssociations: - id: Switch Port Interface UUID name: Ethernet1/2 switchPortMode: trunk type: PhysicalInterface - id: Switch Port Interface UUID name: Ethernet1/4 switchPortMode: access type: PhysicalInterface timestamp: 1467055685450.0 mode: NONE name: Vlan2 overrideDefaultFragmentSetting: chain: 24 size: 200 timeout: 5 priority: 10 type: VlanInterface vlanId: 2 links: self: /fmc_config/v1/domain/default/devices/devicerecords/domainUUID/vlaninterfaces?offset=0&limit=2 paging: count: 2 limit: 2 offset: 0 pages: 1 schema: $ref: '#/components/schemas/FTDVlanInterfaceListContainer' 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 VLAN interface on the specified NGFW device. _Check the response section for applicable examples (if any)._**' operationId: createFTDVlanInterface 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/vlaninterfaces ( Success: Test POST method for FTD logical (vlan) interface )' : value: MTU: 1500 arpConfig: - enableAlias: false ipAddress: 101.101.101.101/25 macAddress: 03DC.1234.2323 disablePortForwardOnVlan: id: interface UUID name: Vlan1 type: VlanInterface enableAntiSpoofing: 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 mode: NONE name: Vlan30 overrideDefaultFragmentSetting: chain: 24 size: 200 timeout: 5 priority: 10 securityZone: id: sec_zone_id type: SecurityZone type: VlanInterface vlanId: 30 schema: $ref: '#/components/schemas/FTDVlanInterface' type: object description: The input VLAN interface model."Request payload for the API operation." required: true responses: '201': content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/vlaninterfaces ( Success: Test POST method for FTD logical (vlan) interface )' : value: MTU: 1500 arpConfig: - enableAlias: false ipAddress: 101.101.101.101/25 macAddress: 03DC.1234.2323 disablePortForwardOnVlan: id: interface UUID name: Vlan1 type: VlanInterface enableAntiSpoofing: true enabled: true id: vlaninterfaceUUID 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/vlaninterfaces/vlaninterfaceUUID metadata: activity: 0 domain: id: DomainUUID name: Global type: domain hwPortAssociations: - id: Switch Port Interface UUID name: Ethernet1/2 switchPortMode: trunk type: PhysicalInterface - id: Switch Port Interface UUID name: Ethernet1/4 switchPortMode: access type: PhysicalInterface lastUser: id: UserUUID name: admin type: user link: 0 readOnly: state: false timestamp: 1458597038.0 mode: NONE name: Vlan30 overrideDefaultFragmentSetting: chain: 24 size: 200 timeout: 5 securityZone: id: sec_zone_id type: SecurityZone type: VlanInterface vlanId: 30 schema: $ref: '#/components/schemas/FTDVlanInterface' 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}/vlaninterfaces/{objectId}: delete: deprecated: false description: '**Delete the VLAN interface associated with the specified NGFW device and interface ID. _Check the response section for applicable examples (if any)._**' operationId: deleteFTDVlanInterface parameters: - description: Unique identifier of a VLAN 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/vlaninterfaces/vlaninterfaceUUID ( Success: Test DELETE method for FTD logical(vlan) interface )' : value: MTU: 1500 disablePortForwardOnVlan: id: interface UUID name: Vlan1 type: VlanInterface enableAntiSpoofing: false enabled: true id: vlaninterfaceUUID ifname: vlanIntf2 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/vlaninterfaces/vlaninterfaceUUID metadata: domain: id: GlobalDomainUUID name: Global hwPortAssociations: - id: Switch Port Interface UUID name: Ethernet1/2 switchPortMode: trunk type: PhysicalInterface - id: Switch Port Interface UUID name: Ethernet1/4 switchPortMode: access type: PhysicalInterface timestamp: 1467055685450.0 mode: NONE name: Vlan2 overrideDefaultFragmentSetting: chain: 24 size: 200 timeout: 5 priority: 10 type: VlanInterface vlanId: 2 schema: $ref: '#/components/schemas/FTDVlanInterface' 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 VLAN interface associated with the specified NGFW device and interface ID.**' operationId: getFTDVlanInterface parameters: - description: Unique identifier of a VLAN 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/vlaninterfaces/vlaninterfaceUUID ( Success: Test GET method for FTD logical(vlan) interface )' : value: MTU: 1500 disablePortForwardOnVlan: id: interface UUID name: Vlan1 type: VlanInterface enableAntiSpoofing: false enabled: true id: vlaninterfaceUUID ifname: vlanintf 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/vlaninterfaces/vlaninterfaceUUID metadata: domain: id: GlobalDomainUUID name: Global hwPortAssociations: - id: Switch Port Interface UUID name: Ethernet1/2 switchPortMode: trunk type: PhysicalInterface - id: Switch Port Interface UUID name: Ethernet1/4 switchPortMode: access type: PhysicalInterface timestamp: 1467055685450.0 mode: NONE name: Vlan2 overrideDefaultFragmentSetting: chain: 24 size: 200 timeout: 5 priority: 10 type: VlanInterface vlanId: 2 schema: $ref: '#/components/schemas/FTDVlanInterface' 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 VLAN interface associated with the specified NGFW device and interface ID. _Check the response section for applicable examples (if any)._**' operationId: updateFTDVlanInterface parameters: - description: Unique identifier of a VLAN 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/vlaninterfaces/vlaninterfaceUUID ( Success: Test PUT method for FTD logical (vlan) interface )' : value: MTU: 1500 arpConfig: - enableAlias: false ipAddress: 101.101.101.101/25 macAddress: 03DC.1234.2323 disablePortForwardOnVlan: id: interface UUID name: Vlan1 type: VlanInterface enableAntiSpoofing: true enabled: true id: vlaninterfaceUUID 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 mode: NONE name: Vlan30 overrideDefaultFragmentSetting: chain: 24 size: 200 timeout: 5 priority: 10 securityZone: id: sec_zone_id type: SecurityZone type: VlanInterface vlanId: 30 schema: $ref: '#/components/schemas/FTDVlanInterface' type: object description: The input VLAN interface model. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/vlaninterfaces/vlaninterfaceUUID ( Success: Test PUT method for FTD logical (vlan) interface )' : value: MTU: 1500 arpConfig: - enableAlias: false ipAddress: 101.101.101.101/25 macAddress: 03DC.1234.2323 disablePortForwardOnVlan: id: interface UUID name: Vlan1 type: VlanInterface enableAntiSpoofing: true enabled: true id: vlaninterfaceUUID 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/vlaninterfaces/vlaninterfaceUUID metadata: activity: 0 domain: id: DomainUUID name: Global type: domain hwPortAssociations: - id: Switch Port Interface UUID name: Ethernet1/2 switchPortMode: trunk type: PhysicalInterface - id: Switch Port Interface UUID name: Ethernet1/4 switchPortMode: access type: PhysicalInterface lastUser: id: UserUUID name: admin type: user link: 0 readOnly: state: false timestamp: 1458597038.0 mode: NONE name: Vlan30 overrideDefaultFragmentSetting: chain: 24 size: 200 timeout: 5 priority: 10 securityZone: id: sec_zone_id type: SecurityZone type: VlanInterface vlanId: 30 schema: $ref: '#/components/schemas/FTDVlanInterface' 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}/vniinterfaces: get: deprecated: false description: '**Get the list of VNII interfaces associated with the specified NGFW device.**' operationId: getAllFTDVNIInterface 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/vniinterfaces ( GET ALL without any query strings )' : value: items: - id: vniIntf1 links: self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vniinterfaces/vniIntf1 name: vni1 - id: vniIntf2 links: self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vniinterfaces/vniIntf2 name: vni2 links: self: /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vniinterfaces?offset=0&limit=2 paging: count: 2 limit: 2 offset: 0 pages: 1 ? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/vniinterfaces?expanded=true ( GET ALL with expanded=true )' : value: items: - description: vniIntf2 enableAntiSpoofing: false enableProxy: false enabled: true id: VniIntfId2 ifname: vniIntf1 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/vniinterfaces/VniIntfId1 metadata: domain: id: GlobalDomainUUID name: Global timestamp: 1467055685450.0 multicastGroupAddress: 224.0.0.2 name: vni2 overrideDefaultFragmentSetting: {} segmentId: 301 type: VNIInterface vniId: 2 vtepID: 1 - enableAntiSpoofing: false enableProxy: false enabled: true id: VniIntfId2 ifname: vniIntf2 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/vniinterfaces/VniIntfId2 metadata: domain: id: GlobalDomainUUID name: Global timestamp: 1467055685450.0 multicastGroupAddress: 224.0.0.4 name: Vni2 overrideDefaultFragmentSetting: chain: 24 size: 200 timeout: 5 segmentId: 501 type: VNIInterface vniId: 3 vtepID: 1 links: self: /fmc_config/v1/domain/default/devices/devicerecords/domainUUID/vniinterfaces?offset=0&limit=2 paging: count: 2 limit: 2 offset: 0 pages: 1 schema: $ref: '#/components/schemas/FTDVNIInterfaceListContainer' 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 VNII interface on the specified NGFW device. _Check the response section for applicable examples (if any)._**' operationId: createFTDVNIInterface 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/vniinterfaces ( Success: Test POST method for FTD VNI interface )' : value: arpConfig: - enableAlias: false ipAddress: 101.101.101.101/25 macAddress: 03DC.1234.2323 enableAntiSpoofing: true enableProxy: false enabled: true externalPort: 8083 externalSegmentId: 8081 ifname: vni1 internalPort: 8082 internalSegmentId: 8080 ipv4: 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 multicastGroupAddress: 224.0.0.24 name: VNI30 overrideDefaultFragmentSetting: chain: 24 size: 200 timeout: 5 securityZone: id: sec_zone_id type: SecurityZone segmentId: 501 type: VNIInterface vniId: 5 vtepID: 1 schema: $ref: '#/components/schemas/FTDVNIInterface' type: object description: The input VNII interface model. required: true responses: '201': content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain/domainUUID/devices/devicerecords/containerUUID/vniinterfaces ( Success: Test POST method for FTD VNI interface )' : value: arpConfig: - enableAlias: false ipAddress: 101.101.101.101/25 macAddress: 03DC.1234.2323 enableAntiSpoofing: true enableProxy: false enabled: true externalPort: 8083 externalSegmentId: 8081 id: vniinterfaceUUID ifname: vni1 internalPort: 8082 internalSegmentId: 8080 ipv4: 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/vniinterfaces/vniinterfaceUUID metadata: domain: id: DomainUUID name: Global type: domain lastUser: id: UserUUID name: admin type: user readOnly: state: false timestamp: 1458597038.0 multicastGroupAddress: 224.0.0.24 name: VNI30 overrideDefaultFragmentSetting: chain: 24 size: 200 timeout: 5 securityZone: id: sec_zone_id type: SecurityZone segmentId: 501 type: VNIInterface vniId: 5 vtepID: 1 schema: $ref: '#/components/schemas/FTDVNIInterface' 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}/vniinterfaces/{objectId}: delete: deprecated: false description: '**Delete the VNII interface associated with the specified NGFW device and interface ID. _Check the response section for applicable examples (if any)._**' operationId: deleteFTDVNIInterface parameters: - description: Unique identifier of a VNII 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/vniinterfaces/vniinterfaceUUID ( Success: Test DELETE method for FTD VNI interface )' : value: enableAntiSpoofing: false enableProxy: false enabled: true id: vniinterfaceUUID ifname: vniIntf2 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/vniinterfaces/vniinterfaceUUID metadata: domain: id: GlobalDomainUUID name: Global timestamp: 1467055685450.0 multicastGroupAddress: 224.0.0.24 name: Vni2 overrideDefaultFragmentSetting: chain: 24 size: 200 timeout: 5 segmentId: 501 type: VNIInterface vniId: 5 vtepID: 1 schema: $ref: '#/components/schemas/FTDVNIInterface' 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 VNII interface associated with the specified NGFW device and interface ID.**' operationId: getFTDVNIInterface parameters: - description: Unique identifier of a VNII 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/vniinterfaces/vniinterfaceUUID ( Success: Test GET method for FTD VNI interface )' : value: enableAntiSpoofing: false enableProxy: false enabled: true id: vniinterfaceUUID 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/vniinterfaces/vniinterfaceUUID metadata: domain: id: GlobalDomainUUID name: Global timestamp: 1467055685450.0 multicastGroupAddress: 224.0.0.2 name: Vni2 overrideDefaultFragmentSetting: chain: 24 size: 200 timeout: 5 segmentId: 301 type: VNIInterface vniId: 2 vtepID: 1 schema: $ref: '#/components/schemas/FTDVNIInterface' 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 VNII interface associated with the specified NGFW device and interface ID. _Check the response section for applicable examples (if any)._**' operationId: updateFTDVNIInterface parameters: - description: Unique identifier of a VNII 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/vniinterfaces/vniinterfaceUUID ( Success: Test PUT method for FTD VNI interface )' : value: arpConfig: - enableAlias: false ipAddress: 101.101.101.101/25 macAddress: 03DC.1234.2323 enableAntiSpoofing: true enableProxy: false enabled: true externalPort: 8083 externalSegmentId: 8081 id: vniinterfaceUUID ifname: Intf_name internalPort: 8082 internalSegmentId: 8080 ipv4: 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 multicastGroupAddress: 224.0.0.24 name: Vni30 overrideDefaultFragmentSetting: chain: 24 size: 200 timeout: 5 securityZone: id: sec_zone_id type: SecurityZone segmentId: 501 type: VNIInterface vniId: 5 vtepID: 1 schema: $ref: '#/components/schemas/FTDVNIInterface' type: object description: The input VNII interface model. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/default/devices/devicerecords/containerUUID/vniinterfaces/vniinterfaceUUID ( Success: Test PUT method for FTD VNI interface )' : value: arpConfig: - enableAlias: false ipAddress: 101.101.101.101/25 macAddress: 03DC.1234.2323 enableAntiSpoofing: true enableProxy: false enabled: true externalPort: 8083 externalSegmentId: 8081 id: vniinterfaceUUID ifname: Intf_name internalPort: 8082 internalSegmentId: 8080 ipv4: 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/vniinterfaces/vniinterfaceUUID metadata: domain: id: DomainUUID name: Global type: domain lastUser: id: UserUUID name: admin type: user readOnly: state: false timestamp: 1458597038.0 multicastGroupAddress: 224.0.0.24 name: Vni30 overrideDefaultFragmentSetting: chain: 24 size: 200 timeout: 5 securityZone: id: sec_zone_id type: SecurityZone segmentId: 501 type: VNIInterface vniId: 5 vtepID: 1 schema: $ref: '#/components/schemas/FTDVNIInterface' 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}/vteppolicies: get: deprecated: false description: '**Get the list of VTEP policies on the specified NGFW device.**' operationId: getAllVTEPPolicy 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/deviceUUID/vteppolicies ( GET ALL VTEPPolicy )': value: items: - id: vtepPolicyUUID links: self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies/vtepPolicyUUID nveEnable: true type: VTEPPolicy vtepEntries: - nveDestinationPort: 6081 nveEncapsulationType: GENEVE nveVtepId: 1 sourceInterface: id: interfaceUUID name: GigabitEthernet0/0 type: PhysicalInterface links: self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies?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/deviceUUID/vteppolicies ( GET ALL VTEPPolicy with VXLAN encapsulation and neighbor discovery type as NONE )' : value: items: - id: vtepPolicyUUID links: self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies/vtepPolicyUUID nveEnable: true type: VTEPPolicy vtepEntries: - nveDestinationPort: 4789 nveEncapsulationType: VXLAN nveVtepId: 1 sourceInterface: id: interfaceUUID name: GigabitEthernet0/0 type: PhysicalInterface links: self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies?offset=0&limit=25&expanded=true paging: count: 1 limit: 25 offset: 0 pages: 1 ? 'Example 3 : GET /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies ( GET ALL VTEPPolicy with VXLAN encapsulation and neighbor discovery type as STATIC_PEER_IP )' : value: items: - id: vtepPolicyUUID links: self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies/vtepPolicyUUID nveEnable: true type: VTEPPolicy vtepEntries: - nveDestinationPort: 4789 nveEncapsulationType: VXLAN nveNeighborAddress: literal: type: Host value: 192.168.0.1 nveNeighborDiscoveryType: STATIC_PEER_IP nveVtepId: 1 sourceInterface: id: interfaceUUID name: GigabitEthernet0/0 type: PhysicalInterface links: self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies?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/deviceUUID/vteppolicies ( GET ALL VTEPPolicy with VXLAN encapsulation and neighbor discovery type as STATIC_PEER_GROUP )' : value: items: - id: vtepPolicyUUID links: self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies/vtepPolicyUUID nveEnable: true type: VTEPPolicy vtepEntries: - nveDestinationPort: 4789 nveEncapsulationType: VXLAN nveNeighborAddress: object: id: networkGroupObjectUUID name: networkGroupObjectName overridable: false type: NetworkGroup nveNeighborDiscoveryType: STATIC_PEER_GROUP nveVtepId: 1 sourceInterface: id: interfaceUUID name: GigabitEthernet0/0 type: PhysicalInterface links: self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies?offset=0&limit=25&expanded=true paging: count: 1 limit: 25 offset: 0 pages: 1 ? 'Example 5 : GET /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies ( GET ALL VTEPPolicy with VXLAN encapsulation and neighbor discovery type as DEFAULT_MULTICAST_GROUP )' : value: items: - id: vtepPolicyUUID links: self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies/vtepPolicyUUID nveEnable: true type: VTEPPolicy vtepEntries: - nveDestinationPort: 4789 nveEncapsulationType: VXLAN nveNeighborAddress: literal: type: Host value: 224.1.1.1 nveNeighborDiscoveryType: DEFAULT_MULTICAST_GROUP nveVtepId: 1 sourceInterface: id: interfaceUUID name: GigabitEthernet0/0 type: PhysicalInterface links: self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies?offset=0&limit=25&expanded=true paging: count: 1 limit: 25 offset: 0 pages: 1 schema: $ref: '#/components/schemas/VTEPPolicyListContainer' 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 VTEP policy on the specified NGFW device. _Check the response section for applicable examples (if any)._**' operationId: createVTEPPolicy 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/deviceUUID/vteppolicies ( POST request to create VTEP Policy )' : value: nveEnable: true type: VTEPPolicy vtepEntries: - nveDestinationPort: 6081 nveEncapsulationType: GENEVE nveVtepId: 1 sourceInterface: id: interfaceUUID name: GigabitEthernet0/0 type: PhysicalInterface ? 'Example 2 : POST /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies ( POST request to create VTEP Policy with VXLAN encapsulation and neighbor discovery type as NONE )' : value: nveEnable: true type: VTEPPolicy vtepEntries: - nveDestinationPort: 4789 nveEncapsulationType: VXLAN nveNeighborDiscoveryType: NONE nveVtepId: 1 sourceInterface: id: interfaceUUID name: GigabitEthernet0/0 type: PhysicalInterface ? 'Example 3 : POST /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies ( POST request to create VTEP Policy with VXLAN encapsulation and neighbor discovery type as STATIC_PEER_IP )' : value: nveEnable: true type: VTEPPolicy vtepEntries: - nveDestinationPort: 4789 nveEncapsulationType: VXLAN nveNeighborAddress: literal: type: Host value: 192.168.0.1 nveNeighborDiscoveryType: STATIC_PEER_IP nveVtepId: 1 sourceInterface: id: interfaceUUID name: GigabitEthernet0/0 type: PhysicalInterface ? 'Example 4 : POST /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies ( POST request to create VTEP Policy with VXLAN encapsulation and neighbor discovery type as STATIC_PEER_GROUP )' : value: nveEnable: true type: VTEPPolicy vtepEntries: - nveDestinationPort: 4789 nveEncapsulationType: VXLAN nveNeighborAddress: object: id: networkGroupObjectUUID name: networkGroupObjectName overridable: false type: NetworkGroup nveNeighborDiscoveryType: STATIC_PEER_GROUP nveVtepId: 1 sourceInterface: id: interfaceUUID name: GigabitEthernet0/0 type: PhysicalInterface ? 'Example 5 : POST /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies ( POST request to create VTEP Policy with VXLAN encapsulation and neighbor discovery type as DEFAULT_MULTICAST_GROUP )' : value: nveEnable: true type: VTEPPolicy vtepEntries: - nveDestinationPort: 4789 nveEncapsulationType: VXLAN nveNeighborAddress: literal: type: Host value: 224.1.1.1 nveNeighborDiscoveryType: DEFAULT_MULTICAST_GROUP nveVtepId: 1 sourceInterface: id: interfaceUUID name: GigabitEthernet0/0 type: PhysicalInterface schema: $ref: '#/components/schemas/VTEPPolicy' type: object description: The input VTEP policy model. required: true responses: '201': content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies ( POST request to create VTEP Policy )' : value: id: vtepPolicyUUID nveEnable: true type: VTEPPolicy vtepEntries: - nveDestinationPort: 6081 nveEncapsulationType: GENEVE nveVtepId: 1 sourceInterface: id: interfaceUUID name: GigabitEthernet0/0 type: PhysicalInterface ? 'Example 2 : POST /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies ( POST request to create VTEP Policy with VXLAN encapsulation and neighbor discovery type as NONE )' : value: id: vtepPolicyUUID nveEnable: true type: VTEPPolicy vtepEntries: - nveDestinationPort: 4789 nveEncapsulationType: VXLAN nveNeighborDiscoveryType: NONE nveVtepId: 1 sourceInterface: id: interfaceUUID name: GigabitEthernet0/0 type: PhysicalInterface ? 'Example 3 : POST /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies ( POST request to create VTEP Policy with VXLAN encapsulation and neighbor discovery type as STATIC_PEER_IP )' : value: id: vtepPolicyUUID nveEnable: true type: VTEPPolicy vtepEntries: - nveDestinationPort: 4789 nveEncapsulationType: VXLAN nveNeighborAddress: literal: type: Host value: 192.168.0.1 nveNeighborDiscoveryType: STATIC_PEER_IP nveVtepId: 1 sourceInterface: id: interfaceUUID name: GigabitEthernet0/0 type: PhysicalInterface ? 'Example 4 : POST /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies ( POST request to create VTEP Policy with VXLAN encapsulation and neighbor discovery type as STATIC_PEER_GROUP )' : value: id: vtepPolicyUUID nveEnable: true type: VTEPPolicy vtepEntries: - nveDestinationPort: 4789 nveEncapsulationType: VXLAN nveNeighborAddress: object: id: networkGroupObjectUUID name: networkGroupObjectName overridable: false type: NetworkGroup nveNeighborDiscoveryType: STATIC_PEER_GROUP nveVtepId: 1 sourceInterface: id: interfaceUUID name: GigabitEthernet0/0 type: PhysicalInterface ? 'Example 5 : POST /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies ( POST request to create VTEP Policy with VXLAN encapsulation and neighbor discovery type as DEFAULT_MULTICAST_GROUP )' : value: id: vtepPolicyUUID nveEnable: true type: VTEPPolicy vtepEntries: - nveDestinationPort: 4789 nveEncapsulationType: VXLAN nveNeighborAddress: literal: type: Host value: 224.1.1.1 nveNeighborDiscoveryType: DEFAULT_MULTICAST_GROUP nveVtepId: 1 sourceInterface: id: interfaceUUID name: GigabitEthernet0/0 type: PhysicalInterface schema: $ref: '#/components/schemas/VTEPPolicy' 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}/vteppolicies/{objectId}: delete: deprecated: false description: '**Delete the specified VTEP policy. _Check the response section for applicable examples (if any)._**' operationId: deleteVTEPPolicy parameters: - description: Unique identifier of a VTEP 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: schema: $ref: '#/components/schemas/VTEPPolicy' 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 VTEP policy.**' operationId: getVTEPPolicy parameters: - description: Unique identifier of a VTEP 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 /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies/vtepPolicyUUID ( GET VTEPPolicy By Id )' : value: id: vtepPolicyUUID links: self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies/vtepPolicyUUID nveEnable: true type: VTEPPolicy vtepEntries: - nveDestinationPort: 6081 nveEncapsulationType: GENEVE nveVtepId: 1 sourceInterface: id: interfaceUUID name: GigabitEthernet0/0 type: PhysicalInterface ? 'Example 2 : GET /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies/vtepPolicyUUID ( GET VTEPPolicy By Id with VXLAN encapsulation and neighbor discovery type as NONE )' : value: id: vtepPolicyUUID links: self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies/vtepPolicyUUID nveEnable: true type: VTEPPolicy vtepEntries: - nveDestinationPort: 4789 nveEncapsulationType: VXLAN nveVtepId: 1 sourceInterface: id: interfaceUUID name: GigabitEthernet0/0 type: PhysicalInterface ? 'Example 3 : GET /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies/vtepPolicyUUID ( GET VTEPPolicy By Id with VXLAN encapsulation and neighbor discovery type as STATIC_PEER_IP )' : value: id: vtepPolicyUUID links: self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies/vtepPolicyUUID nveEnable: true type: VTEPPolicy vtepEntries: - nveDestinationPort: 4789 nveEncapsulationType: VXLAN nveNeighborAddress: literal: type: Host value: 192.168.0.1 nveNeighborDiscoveryType: STATIC_PEER_IP nveVtepId: 1 sourceInterface: id: interfaceUUID name: GigabitEthernet0/0 type: PhysicalInterface ? 'Example 4 : GET /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies/vtepPolicyUUID ( GET VTEPPolicy By Id with VXLAN encapsulation and neighbor discovery type as STATIC_PEER_GROUP )' : value: id: vtepPolicyUUID links: self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies/vtepPolicyUUID nveEnable: true type: VTEPPolicy vtepEntries: - nveDestinationPort: 4789 nveEncapsulationType: VXLAN nveNeighborAddress: object: id: networkGroupObjectUUID name: networkGroupObjectName overridable: false type: NetworkGroup nveNeighborDiscoveryType: STATIC_PEER_GROUP nveVtepId: 1 sourceInterface: id: interfaceUUID name: GigabitEthernet0/0 type: PhysicalInterface ? 'Example 5 : GET /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies/vtepPolicyUUID ( GET VTEPPolicy By Id with VXLAN encapsulation and neighbor discovery type as DEFAULT_MULTICAST_GROUP )' : value: id: vtepPolicyUUID links: self: https://fmc-host:port/api/fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies/vtepPolicyUUID nveEnable: true type: VTEPPolicy vtepEntries: - nveDestinationPort: 4789 nveEncapsulationType: VXLAN nveNeighborAddress: literal: type: Host value: 224.1.1.1 nveNeighborDiscoveryType: DEFAULT_MULTICAST_GROUP nveVtepId: 1 sourceInterface: id: interfaceUUID name: GigabitEthernet0/0 type: PhysicalInterface schema: $ref: '#/components/schemas/VTEPPolicy' 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 VTEP policy. _Check the response section for applicable examples (if any)._**' operationId: updateVTEPPolicy parameters: - description: Unique identifier of a VTEP 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 /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies/vtepPolicyUUID ( PUT request to update an VTEP Policy )' : value: id: vtepPolicyUUID nveEnable: true type: VTEPPolicy vtepEntries: - nveDestinationPort: 6081 nveEncapsulationType: GENEVE nveVtepId: 1 sourceInterface: id: interfaceUUID name: GigabitEthernet0/0 type: PhysicalInterface ? 'Example 2 : PUT /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies/vtepPolicyUUID ( PUT request to update an VTEP Policy with VXLAN encapsulation and neighbor discovery type as NONE )' : value: id: vtepPolicyUUID nveEnable: true type: VTEPPolicy vtepEntries: - nveDestinationPort: 4789 nveEncapsulationType: VXLAN nveNeighborDiscoveryType: NONE nveVtepId: 1 sourceInterface: id: interfaceUUID name: GigabitEthernet0/0 type: PhysicalInterface ? 'Example 3 : PUT /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies/vtepPolicyUUID ( PUT request to update an VTEP Policy with VXLAN encapsulation and neighbor discovery type as STATIC_PEER_IP )' : value: id: vtepPolicyUUID nveEnable: true type: VTEPPolicy vtepEntries: - nveDestinationPort: 4789 nveEncapsulationType: VXLAN nveNeighborAddress: literal: type: Host value: 192.168.0.1 nveNeighborDiscoveryType: STATIC_PEER_IP nveVtepId: 1 sourceInterface: id: interfaceUUID name: GigabitEthernet0/0 type: PhysicalInterface ? 'Example 4 : PUT /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies/vtepPolicyUUID ( PUT request to update an VTEP Policy with VXLAN encapsulation and neighbor discovery type as STATIC_PEER_GROUP )' : value: id: vtepPolicyUUID nveEnable: true type: VTEPPolicy vtepEntries: - nveDestinationPort: 4789 nveEncapsulationType: VXLAN nveNeighborAddress: object: id: networkGroupObjectUUID name: networkGroupObjectName overridable: false type: NetworkGroup nveNeighborDiscoveryType: STATIC_PEER_GROUP nveVtepId: 1 sourceInterface: id: interfaceUUID name: GigabitEthernet0/0 type: PhysicalInterface ? 'Example 5 : PUT /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies/vtepPolicyUUID ( PUT request to update an VTEP Policy with VXLAN encapsulation and neighbor discovery type as DEFAULT_MULTICAST_GROUP )' : value: id: vtepPolicyUUID nveEnable: true type: VTEPPolicy vtepEntries: - nveDestinationPort: 4789 nveEncapsulationType: VXLAN nveNeighborAddress: literal: type: Host value: 224.1.1.1 nveNeighborDiscoveryType: DEFAULT_MULTICAST_GROUP nveVtepId: 1 sourceInterface: id: interfaceUUID name: GigabitEthernet0/0 type: PhysicalInterface schema: $ref: '#/components/schemas/VTEPPolicy' type: object description: The input VTEP policy model. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies/vtepPolicyUUID ( PUT request to update an VTEP Policy )' : value: id: vtepPolicyUUID nveEnable: true type: VTEPPolicy vtepEntries: - nveDestinationPort: 6081 nveEncapsulationType: GENEVE nveVtepId: 1 sourceInterface: id: interfaceUUID name: GigabitEthernet0/0 type: PhysicalInterface ? 'Example 2 : PUT /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies/vtepPolicyUUID ( PUT request to update an VTEP Policy with VXLAN encapsulation and neighbor discovery type as NONE )' : value: id: vtepPolicyUUID nveEnable: true type: VTEPPolicy vtepEntries: - nveDestinationPort: 4789 nveEncapsulationType: VXLAN nveNeighborDiscoveryType: NONE nveVtepId: 1 sourceInterface: id: interfaceUUID name: GigabitEthernet0/0 type: PhysicalInterface ? 'Example 3 : PUT /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies/vtepPolicyUUID ( PUT request to update an VTEP Policy with VXLAN encapsulation and neighbor discovery type as STATIC_PEER_IP )' : value: id: vtepPolicyUUID nveEnable: true type: VTEPPolicy vtepEntries: - nveDestinationPort: 4789 nveEncapsulationType: VXLAN nveNeighborAddress: literal: type: Host value: 192.168.0.1 nveNeighborDiscoveryType: STATIC_PEER_IP nveVtepId: 1 sourceInterface: id: interfaceUUID name: GigabitEthernet0/0 type: PhysicalInterface ? 'Example 4 : PUT /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies/vtepPolicyUUID ( PUT request to update an VTEP Policy with VXLAN encapsulation and neighbor discovery type as STATIC_PEER_GROUP )' : value: id: vtepPolicyUUID nveEnable: true type: VTEPPolicy vtepEntries: - nveDestinationPort: 4789 nveEncapsulationType: VXLAN nveNeighborAddress: object: id: networkGroupObjectUUID name: networkGroupObjectName overridable: false type: NetworkGroup nveNeighborDiscoveryType: STATIC_PEER_GROUP nveVtepId: 1 sourceInterface: id: interfaceUUID name: GigabitEthernet0/0 type: PhysicalInterface ? 'Example 5 : PUT /fmc_config/v1/domain/domainUUID/devices/devicerecords/deviceUUID/vteppolicies/vtepPolicyUUID ( PUT request to update an VTEP Policy with VXLAN encapsulation and neighbor discovery type as DEFAULT_MULTICAST_GROUP )' : value: id: vtepPolicyUUID nveEnable: true type: VTEPPolicy vtepEntries: - nveDestinationPort: 4789 nveEncapsulationType: VXLAN nveNeighborAddress: literal: type: Host value: 224.1.1.1 nveNeighborDiscoveryType: DEFAULT_MULTICAST_GROUP nveVtepId: 1 sourceInterface: id: interfaceUUID name: GigabitEthernet0/0 type: PhysicalInterface schema: $ref: '#/components/schemas/VTEPPolicy' 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/{objectId}: get: deprecated: false description: '**Get the device record associated with the specified ID.**' operationId: getDevice parameters: - description: Identifier for device. in: path name: objectId 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/device_uuid ( Test GET of device for a uuid )': value: hostName: id: device_uuid license_caps: - PROTECT - MALWARE metadata: containerDetails: id: container_uuid name: cotainer_name type: DeviceHAPair | DeviceStack | DeviceCluster deviceSerialNumber: string domain: object isPartOfContainer: true readOnly: object snortEngine: SNORT2 | SNORT3 snortVersion: string sruVersion: string task: object vdbVersion: string name: nachos performanceTier: FTDv50 type: Device schema: $ref: '#/components/schemas/Device' 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 device record associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: updateDevice parameters: - description: Identifier for device. 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 - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /fmc_config/v1/domain/DomainUUID/devices/devicerecords/device_uuid ( Test PUT of network object to update record )' : value: hostName: 10.20.30.40 id: device_uuid license_caps: - PROTECT - MALWARE name: nachos_updated performanceTier: FTDv30 prohibitPacketTransfer: true type: Device 'Example 2 : PUT /fmc_config/v1/domain/DomainUUID/devices/devicerecords ( Test PUT of network object to create record )': value: hostName: 10.1.1.10 license_caps: - PROTECT - MALWARE name: newDevice regKey: test snortEngine: SNORT2 | SNORT3 type: Device schema: $ref: '#/components/schemas/Device' type: object description: Input representation of device. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/Device' 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/devicesettings: get: deprecated: false description: '**Get the device settings.**' operationId: getAllDeviceSettings parameters: - $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/deviceSettings?expanded=true ( Get all Device Settings with AutoRollback data )' : value: items: - deploymentSettings: enableAutoRollback: true rollbackConnectivityMonitorInterval: 80 id: deviceUUID type: DeviceSettings - deploymentSettings: enableAutoRollback: false rollbackConnectivityMonitorInterval: 20 id: deviceUUID2 type: DeviceSettings links: self: api/fmc_config/v1/domain/DomainUUID/devices/devicesettings?expanded=true&offset=0&limit=3 paging: count: '2' limit: '25' offset: '0' pages: '1' schema: $ref: '#/components/schemas/DeviceSettingsListContainer' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Devices put: deprecated: false description: '**Create a specific device setting. _Check the response section for applicable examples (if any)._**' operationId: updateMultipleDeviceSettings parameters: - description: Boolean value indicating whether this is performed as a bulk operation. in: query name: bulk required: true schema: type: boolean - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/deviceSettings/deviceUUID?expanded=true ( Update Device Settings with AutoRollback data for a given device )' : value: deploymentSettings: enableAutoRollback: true rollbackConnectivityMonitorInterval: 80 id: deviceUUID type: DeviceSettings ? 'Example 2 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/deviceSettings?expanded=true ( Update Device Settings with AutoRollback data for more than one device )' : value: - deploymentSettings: enableAutoRollback: true rollbackConnectivityMonitorInterval: 80 id: deviceUUID type: DeviceSettings - deploymentSettings: enableAutoRollback: false rollbackConnectivityMonitorInterval: 20 id: deviceUUID2 type: DeviceSettings schema: $ref: '#/components/schemas/DeviceSettings' type: object description: Input representation of device settings. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/deviceSettings/deviceUUID?expanded=true ( Update Device Settings with AutoRollback data for a given device )' : value: items: - deploymentSettings: enableAutoRollback: true rollbackConnectivityMonitorInterval: 80 id: deviceUUID type: DeviceSettings links: self: api/fmc_config/v1/domain/DomainUUID/devices/devicesettings/deviceUUID?expanded=true&offset=0&limit=3 ? 'Example 2 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/deviceSettings?expanded=true ( Update Device Settings with AutoRollback data for more than one device )' : value: items: - deploymentSettings: enableAutoRollback: true rollbackConnectivityMonitorInterval: 80 id: deviceUUID type: DeviceSettings - deploymentSettings: enableAutoRollback: false rollbackConnectivityMonitorInterval: 20 id: deviceUUID2 type: DeviceSettings links: self: api/fmc_config/v1/domain/DomainUUID/devices/devicesettings?expanded=true&offset=0&limit=3 paging: count: '2' limit: '25' offset: '0' pages: '1' schema: $ref: '#/components/schemas/DeviceSettings' 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/devicesettings/{containerUUID}: get: deprecated: false description: '**Get the specific device setting.**' operationId: getDeviceSettings 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 responses: '200': content: application/json: examples: 'Example 1 : GET /api/fmc_config/v1/domain/DomainUUID/devices/devicesettings/deviceUUID ( Test GET of Device Settings )': value: deploymentSettings: enableAutoRollback: true rollbackConnectivityMonitorInterval: 80 id: deviceUUID links: self: /api/fmc_config/v1/domain/DomainUUID/devices/devicesettings/deviceUUID type: DeviceSettings schema: $ref: '#/components/schemas/DeviceSettings' type: object description: OK default: content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' type: object description: Error tags: - Devices put: deprecated: false description: '**Create device settings. _Check the response section for applicable examples (if any)._**' operationId: updateDeviceSettings 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 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/deviceSettings/deviceUUID?expanded=true ( Update Device Settings with AutoRollback data for a given device )' : value: deploymentSettings: enableAutoRollback: true rollbackConnectivityMonitorInterval: 80 id: deviceUUID type: DeviceSettings ? 'Example 2 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/deviceSettings?expanded=true ( Update Device Settings with AutoRollback data for more than one device )' : value: - deploymentSettings: enableAutoRollback: true rollbackConnectivityMonitorInterval: 80 id: deviceUUID type: DeviceSettings - deploymentSettings: enableAutoRollback: false rollbackConnectivityMonitorInterval: 20 id: deviceUUID2 type: DeviceSettings schema: $ref: '#/components/schemas/DeviceSettings' type: object description: Input representation of device settings. required: true responses: '200': content: application/json: examples: ? 'Example 1 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/deviceSettings/deviceUUID?expanded=true ( Update Device Settings with AutoRollback data for a given device )' : value: items: - deploymentSettings: enableAutoRollback: true rollbackConnectivityMonitorInterval: 80 id: deviceUUID type: DeviceSettings links: self: api/fmc_config/v1/domain/DomainUUID/devices/devicesettings/deviceUUID?expanded=true&offset=0&limit=3 ? 'Example 2 : PUT /api/fmc_config/v1/domain/DomainUUID/devices/deviceSettings?expanded=true ( Update Device Settings with AutoRollback data for more than one device )' : value: items: - deploymentSettings: enableAutoRollback: true rollbackConnectivityMonitorInterval: 80 id: deviceUUID type: DeviceSettings - deploymentSettings: enableAutoRollback: false rollbackConnectivityMonitorInterval: 20 id: deviceUUID2 type: DeviceSettings links: self: api/fmc_config/v1/domain/DomainUUID/devices/devicesettings?expanded=true&offset=0&limit=3 paging: count: '2' limit: '25' offset: '0' pages: '1' schema: $ref: '#/components/schemas/DeviceSettings' 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/ltpdevicerecords: get: deprecated: false description: '**Get the list of all devices onboarded through Zero Touch Provisioning(ZTP). This API endpoint can be used to track the onboarding status of ZTP devices until the ZTP onboarding transitions into device registration in the FMC.**' operationId: getAllLTPDeviceRecord parameters: - description: 'Filter to retrieve ZTP devices based on serialNumber or status. For example: serialNumber:JAD20001ADD,status:CLAIM_PENDING.' 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 : GETALL /fmc_config/v1/domain/DomainUUID/devices/ltpdevicerecords?expanded=false ( GETALL of LTP devices with expanded false )' : value: items: - id: device_uuid links: self: /fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devices/ltpdevicerecords/uuid name: nachos type: LTPDeviceRecord - id: device_uuid links: self: /fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devices/ltpdevicerecords/uuid name: name type: LTPDeviceRecord links: self: /fmc_config/v1/domain/DomainUUID/devices/ltpdevicerecords?offset=0&limit=25 paging: count: 2 limit: 2 offset: 0 pages: 1 ? 'Example 2 : GETALL /fmc_config/v1/domain/DomainUUID/devices/ltpdevicerecords?expanded=true ( GETALL of LTP devices with expanded true )' : value: items: - defaultPasswordAlreadyChanged: boolean id: device_uuid license_caps: - PROTECT - MALWARE links: self: /fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devices/ltpdevicerecords/uuid metadata: status: CLAIM_PENDING serialNumber: string type: LTPDeviceRecord - defaultPasswordAlreadyChanged: boolean id: device_uuid license_caps: - PROTECT - MALWARE links: self: /fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devices/ltpdevicerecords/uuid metadata: status: CLAIM_PENDING name: name serialNumber: string type: LTPDeviceRecord links: self: /fmc_config/v1/domain/DomainUUID/devices/ltpdevicerecords?offset=0&limit=25 paging: count: 2 limit: 2 offset: 0 pages: 1 ? 'Example 3 : GETALL /fmc_config/v1/domain/DomainUUID/devices/ltpdevicerecords?offset=0&limit=25&filter=serialNumber:JAD221406DE&expanded=true ( GETALL of LTP devices with expanded true )' : value: items: - defaultPasswordAlreadyChanged: boolean id: device_uuid license_caps: - PROTECT - MALWARE links: self: /fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devices/ltpdevicerecords/uuid metadata: status: CLAIM_PENDING serialNumber: JAD221406DE type: LTPDeviceRecord links: self: /fmc_config/v1/domain/DomainUUID/devices/ltpdevicerecords paging: count: 2 limit: 2 offset: 0 pages: 1 ? 'Example 4 : GETALL /fmc_config/v1/domain/DomainUUID/devices/ltpdevicerecords?offset=0&limit=25&filter=status:CLAIM_PENDING&expanded=true ( GETALL of LTP devices with expanded true )' : value: items: - defaultPasswordAlreadyChanged: boolean id: device_uuid license_caps: - PROTECT - MALWARE links: self: /fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devices/ltpdevicerecords/uuid metadata: status: CLAIM_PENDING statusDescription: Claim pending serialNumber: JAD221406DE type: LTPDeviceRecord links: self: /fmc_config/v1/domain/DomainUUID/devices/ltpdevicerecords paging: count: 2 limit: 2 offset: 0 pages: 1 ? 'Example 5 : GETALL /fmc_config/v1/domain/DomainUUID/devices/ltpdevicerecords?expanded=false ( GETALL of LTP devices with expanded false )' : value: items: - id: device_uuid links: self: /fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devices/ltpdevicerecords/uuid name: nachos type: LTPDeviceRecord - id: device_uuid links: self: /fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devices/ltpdevicerecords/uuid name: name type: LTPDeviceRecord links: self: /fmc_config/v1/domain/DomainUUID/devices/ltpdevicerecords?offset=0&limit=25 paging: count: 2 limit: 2 offset: 0 pages: 1 ? 'Example 6 : GETALL /fmc_config/v1/domain/DomainUUID/devices/ltpdevicerecords?expanded=true ( GETALL of LTP devices with expanded true )' : value: items: - defaultPasswordAlreadyChanged: boolean id: device_uuid license_caps: - PROTECT - MALWARE links: self: /fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devices/ltpdevicerecords/uuid metadata: status: CLAIM_PENDING serialNumber: string type: LTPDeviceRecord - defaultPasswordAlreadyChanged: boolean id: device_uuid license_caps: - PROTECT - MALWARE links: self: /fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devices/ltpdevicerecords/uuid metadata: status: CLAIM_PENDING name: name serialNumber: string type: LTPDeviceRecord links: self: /fmc_config/v1/domain/DomainUUID/devices/ltpdevicerecords?offset=0&limit=25 paging: count: 2 limit: 2 offset: 0 pages: 1 ? 'Example 7 : GETALL /fmc_config/v1/domain/DomainUUID/devices/ltpdevicerecords?offset=0&limit=25&filter=serialNumber:JAD221406DE&expanded=true ( GETALL of LTP devices with expanded true )' : value: items: - defaultPasswordAlreadyChanged: boolean id: device_uuid license_caps: - PROTECT - MALWARE links: self: /fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devices/ltpdevicerecords/uuid metadata: status: CLAIM_PENDING serialNumber: JAD221406DE type: LTPDeviceRecord links: self: /fmc_config/v1/domain/DomainUUID/devices/ltpdevicerecords paging: count: 2 limit: 2 offset: 0 pages: 1 ? 'Example 8 : GETALL /fmc_config/v1/domain/DomainUUID/devices/ltpdevicerecords?offset=0&limit=25&filter=status:CLAIM_PENDING&expanded=true ( GETALL of LTP devices with expanded true )' : value: items: - defaultPasswordAlreadyChanged: boolean id: device_uuid license_caps: - PROTECT - MALWARE links: self: /fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devices/ltpdevicerecords/uuid metadata: status: CLAIM_PENDING statusDescription: Claim pending serialNumber: JAD221406DE type: LTPDeviceRecord links: self: /fmc_config/v1/domain/DomainUUID/devices/ltpdevicerecords paging: count: 2 limit: 2 offset: 0 pages: 1 schema: $ref: '#/components/schemas/LTPDeviceRecordListContainer' 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/ltpdevicerecords/{objectId}: delete: deprecated: false description: '**Delete the Zero Touch Provisioned(ZTP) device associated with the specified ID. _Check the response section for applicable examples (if any)._**' operationId: deleteLTPDeviceRecord parameters: - description: Unique identifier of the ZTP device. in: path name: objectId 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/ltpdevicerecords/device_uuid ( Test DELETE of LTP device for a uuid )' : value: defaultPasswordAlreadyChanged: boolean id: device_uuid license_caps: - PROTECT - MALWARE metadata: status: CLAIM_PENDING name: nachos serialNumber: string type: LTPDeviceRecord schema: $ref: '#/components/schemas/LTPDeviceRecord' 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 Zero Touch Provisioned(ZTP) device associated with the specified ID. This API endpoint can be used to track the onboarding status of ZTP device until the ZTP onboarding transitions into device registration in the FMC.**' operationId: getLTPDeviceRecord parameters: - description: Unique identifier of the ZTP device. in: path name: objectId required: true schema: type: string - $ref: '#/components/parameters/domainUUID' name: domainUUID responses: '200': content: application/json: examples: ? 'Example 1 : GETALL /fmc_config/v1/domain/DomainUUID/devices/ltpdevicerecords?expanded=false ( GETALL of LTP devices with expanded false )' : value: items: - id: device_uuid links: self: /fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devices/ltpdevicerecords/uuid name: nachos type: LTPDeviceRecord - id: device_uuid links: self: /fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devices/ltpdevicerecords/uuid name: name type: LTPDeviceRecord links: self: /fmc_config/v1/domain/DomainUUID/devices/ltpdevicerecords?offset=0&limit=25 paging: count: 2 limit: 2 offset: 0 pages: 1 ? 'Example 2 : GETALL /fmc_config/v1/domain/DomainUUID/devices/ltpdevicerecords?expanded=true ( GETALL of LTP devices with expanded true )' : value: items: - defaultPasswordAlreadyChanged: boolean id: device_uuid license_caps: - PROTECT - MALWARE links: self: /fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devices/ltpdevicerecords/uuid metadata: status: CLAIM_PENDING serialNumber: string type: LTPDeviceRecord - defaultPasswordAlreadyChanged: boolean id: device_uuid license_caps: - PROTECT - MALWARE links: self: /fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devices/ltpdevicerecords/uuid metadata: status: CLAIM_PENDING name: name serialNumber: string type: LTPDeviceRecord links: self: /fmc_config/v1/domain/DomainUUID/devices/ltpdevicerecords?offset=0&limit=25 paging: count: 2 limit: 2 offset: 0 pages: 1 ? 'Example 3 : GETALL /fmc_config/v1/domain/DomainUUID/devices/ltpdevicerecords?offset=0&limit=25&filter=serialNumber:JAD221406DE&expanded=true ( GETALL of LTP devices with expanded true )' : value: items: - defaultPasswordAlreadyChanged: boolean id: device_uuid license_caps: - PROTECT - MALWARE links: self: /fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devices/ltpdevicerecords/uuid metadata: status: CLAIM_PENDING serialNumber: JAD221406DE type: LTPDeviceRecord links: self: /fmc_config/v1/domain/DomainUUID/devices/ltpdevicerecords paging: count: 2 limit: 2 offset: 0 pages: 1 ? 'Example 4 : GETALL /fmc_config/v1/domain/DomainUUID/devices/ltpdevicerecords?offset=0&limit=25&filter=status:CLAIM_PENDING&expanded=true ( GETALL of LTP devices with expanded true )' : value: items: - defaultPasswordAlreadyChanged: boolean id: device_uuid license_caps: - PROTECT - MALWARE links: self: /fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devices/ltpdevicerecords/uuid metadata: status: CLAIM_PENDING statusDescription: Claim pending serialNumber: JAD221406DE type: LTPDeviceRecord links: self: /fmc_config/v1/domain/DomainUUID/devices/ltpdevicerecords paging: count: 2 limit: 2 offset: 0 pages: 1 ? 'Example 5 : GET /fmc_config/v1/domain/DomainUUID/devices/ltpdevicerecords/device_uuid ( Test GET of LTP device for a uuid )' : value: defaultPasswordAlreadyChanged: boolean id: device_uuid license_caps: - PROTECT - MALWARE metadata: status: CLAIM_PENDING name: nachos serialNumber: string type: LTPDeviceRecord schema: $ref: '#/components/schemas/LTPDeviceRecord' 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/operational/bulkregistrations: post: deprecated: false description: '**Enable bulk registration of devices using File upload. _Check the response section for applicable examples (if any)._**' operationId: createBulkRegistration parameters: - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: multipart/form-data: examples: ? 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/bulkregistrations ( Bulk LTP onboarding without template by uploading a csv file )' : value: excludeDevicesWithError: false onboardingMethod: SERIAL_NUMBER payloadFile: .csv format device configuration file performValidationOnly: false schema: properties: excludeDevicesWithError: description: Boolean identifier for ignoring devices with validation errors for registration. This is applicable only when onboardingMethod is REGISTRATION_KEY. false is the default value. type: boolean onboardingMethod: description: Enums used to specify the device onboarding method. SERIAL_NUMBER and REGISTRATION_KEY are supported enums. type: string payloadFile: description: File containing the device details. .csv and .txt are supported file formats.*required format: binary type: string performValidationOnly: description: Boolean identifier to specify whether device details should be validated or validated and registered. false is the default value. type: boolean templateUuid: description: UUID of the device template which can be applied on the devices being registered. type: string type: object responses: '201': content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/bulkregistrations ( Bulk LTP onboarding without template by uploading a csv file )' : value: excludeDevicesWithError: false metadata: task: description: LTP onboarding has started. Use the Task Status API to get the status id: '8589934651' links: 'self ': /fmc_config/v1/domain/DomainUUID/job/taskstatuses/8589934651 status: '200' taskType: LTP_ONBOARDING onboardingMethod: SERIAL_NUMBER performValidationOnly: false schema: $ref: '#/components/schemas/BulkRegistration' 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/operational/bulkregistrations/downloadsamplecsv: get: deprecated: false description: '**Get sample csv for download. Sample csv contains the required header details that have to be used for the registration of devices using template.**' operationId: getDownloadSampleCsv parameters: - description: Specifies the onboarding method. Possible values are SERIAL_NUMBER and REGISTRATION_KEY. in: query name: onboardingMethod required: true schema: type: string - description: UUID of the device template. in: query name: templateUuid 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/DownloadSampleCsvListContainer' 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/operational/changemanagers: post: deprecated: false description: '**Migrate configuration management of FTD from FMC to SCC. _Check the response section for applicable examples (if any)._**' operationId: createChangeConfigManagerFTDRequest parameters: - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/changemanagers ( POST a Change Manager request for list of devices. )' : value: action: CONFIGURE_DEVICE_VALIDATE configManagerHost: fmc.cdo.com deviceList: - id: 1087edc2-064c-4fa7-90b9-72ae7ed4c474 - id: 3a6bda97-5f7c-4874-934c-01ca2095b780 type: ChangeManager ? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/changemanagers ( POST a Change Manager request for list of devices. )' : value: action: CONFIGURE_DEVICE configManagerHost: fmc.cdo.com deviceList: - action: CONFIGURE_MANAGER_ADD id: 1087edc2-064c-4fa7-90b9-72ae7ed4c474 natID: 895fe546-d3db-4563-9936-6b0f10c6a993 regKey: 7c6dc3ca-7b73-4565-99e4-a86dc3740ac7 - action: CONFIGURE_MANAGER_DELETE id: 3a6bda97-5f7c-4874-934c-01ca2095b780 type: ChangeManager ? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/changemanagers ( POST a Change Manager request for list of devices. )' : value: action: CONFIGURE_MANAGER deviceList: - action: INITIATE_MIGRATION id: 1087edc2-064c-4fa7-90b9-72ae7ed4c474 - action: INITIATE_MIGRATION id: 3a6bda97-5f7c-4874-934c-01ca2095b780 type: ChangeManager ? 'Example 4 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/changemanagers ( POST a Change Manager request for list of devices. )' : value: action: CONFIGURE_MANAGER configManagerHost: fmc.cdo.com deviceList: - action: SWITCH_TO_ANALYTICS id: 1087edc2-064c-4fa7-90b9-72ae7ed4c474 - action: DELETE_DEVICE id: 2611ce84-1ee3-4c9c-9598-89b12e3bc42d - action: DISCARD_MIGRATION id: 3a6bda97-5f7c-4874-934c-01ca2095b780 license_caps: - MALWARE - URLFilter - PROTECT - CONTROL - VPN performanceTier: FTDv5 | FTDv10 | FTDv20| FTDv30 | FTDv50 | Legacy type: ChangeManager ? 'Example 5 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/changemanagers ( POST a Change Manager request for specified task id. )' : value: action: GENERATE_REPORTS reportOptions: form: AWSAccessKeyId: AKIAPQDIUIQN94C766L bucket: sample headers: X-Amz-Algorithm: AWS4-HMAC-SHA256 X-Amz-Date: 20210519T191457Z X-Amz-Expires: '604800' X-Amz-Signature: 08e13665182fa198912dda24a18318958287c38d9d589898982f186cffe2e83fd66f X-Amz-SignedHeaders: host importTaskId: '133143986189' jobSummary: deviceList: - host: OnPremFTD id: 3a6bda97-5f7c-4874-934c-01ca2095b780 lastUpdateTime: Tue Dec 21 13:05:00 IST 2021 license_caps: - MALWARE - URLFilter - PROTECT - CONTROL - VPN name: OnPremFTD performanceTier: FTDv5 | FTDv10 | FTDv20| FTDv30 | FTDv50 | Legacy status: Success terminalAction: Retain on FMC for Analytics failedCount: 0 jobExpiryTime: Mon Dec 20 08:08:00 IST 2021 numberOfDevices: 1 sourceManagerHost: fmc.on-prem.internal.com successCount: 1 url: https://sampleBucket.s3amazonaws.com/prefix/object type: ChangeManager schema: $ref: '#/components/schemas/ChangeConfigManagerFTDRequest' type: object description: Input representation for migration data required: true responses: '202': content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/changemanagers ( POST a Change Manager request for list of devices. )' : value: action: CONFIGURE_DEVICE_VALIDATE configManagerHost: fmc.cdo.com deviceList: - id: 1087edc2-064c-4fa7-90b9-72ae7ed4c474 - id: 3a6bda97-5f7c-4874-934c-01ca2095b780 metadata: task: id: '133143986189' links: self: /api/fmc_config/v1/domain/DomainUUID/job/taskstatuses/133143986189 type: ChangeManager ? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/changemanagers ( POST a Change Manager request for list of devices. )' : value: action: CONFIGURE_DEVICE configManagerHost: fmc.cdo.com deviceList: - action: CONFIGURE_MANAGER_ADD id: 1087edc2-064c-4fa7-90b9-72ae7ed4c474 natID: 895fe546-d3db-4563-9936-6b0f10c6a993 regKey: 7c6dc3ca-7b73-4565-99e4-a86dc3740ac7 - action: CONFIGURE_MANAGER_DELETE id: 3a6bda97-5f7c-4874-934c-01ca2095b780 metadata: task: id: '133143986189' links: self: /api/fmc_config/v1/domain/DomainUUID/job/taskstatuses/133143986189 type: ChangeManager ? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/changemanagers ( POST a Change Manager request for list of devices. )' : value: action: CONFIGURE_MANAGER configManagerHost: fmc.cdo.com deviceList: - action: INITIATE_MIGRATION id: 1087edc2-064c-4fa7-90b9-72ae7ed4c474 - action: INITIATE_MIGRATION id: 3a6bda97-5f7c-4874-934c-01ca2095b780 metadata: task: id: '133143986189' links: self: /api/fmc_config/v1/domain/DomainUUID/job/taskstatuses/133143986189 type: ChangeManager ? 'Example 4 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/changemanagers ( POST a Change Manager request for list of devices. )' : value: action: CONFIGURE_MANAGER configManagerHost: fmc.cdo.com deviceList: - action: SWITCH_TO_ANALYTICS id: 1087edc2-064c-4fa7-90b9-72ae7ed4c474 - action: DELETE_DEVICE id: 2611ce84-1ee3-4c9c-9598-89b12e3bc42d - action: DISCARD_MIGRATION id: 3a6bda97-5f7c-4874-934c-01ca2095b780 license_caps: - MALWARE - URLFilter - PROTECT - CONTROL - VPN performanceTier: FTDv5 | FTDv10 | FTDv20| FTDv30 | FTDv50 | Legacy metadata: task: id: '133143986189' links: self: /api/fmc_config/v1/domain/DomainUUID/job/taskstatuses/133143986189 type: ChangeManager ? 'Example 5 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/changemanagers ( POST a Change Manager request for specified task id. )' : value: action: GENERATE_REPORTS metadata: task: id: '155143986189' links: self: /api/fmc_config/v1/domain/DomainUUID/job/taskstatuses/133143986189 reportOptions: form: AWSAccessKeyId: AKIAPQDIUIQN94C766L bucket: sample headers: X-Amz-Algorithm: AWS4-HMAC-SHA256 X-Amz-Date: 20210519T191457Z X-Amz-Expires: '604800' X-Amz-Signature: 08e13665182fa198912dda24a18318958287c38d9d589898982f186cffe2e83fd66f X-Amz-SignedHeaders: host importTaskId: '133143986189' jobSummary: deviceList: - host: OnPremFTD id: 3a6bda97-5f7c-4874-934c-01ca2095b780 lastUpdateTime: Tue Dec 21 13:05:00 IST 2021 license_caps: - MALWARE - URLFilter - PROTECT - CONTROL - VPN name: OnPremFTD performanceTier: FTDv5 | FTDv10 | FTDv20| FTDv30 | FTDv50 | Legacy status: Success terminalAction: Retain on FMC for Analytics failedCount: 0 jobExpiryTime: Mon Dec 20 08:08:00 IST 2021 numberOfDevices: 1 sourceManagerHost: fmc.on-prem.internal.com successCount: 1 url: https://sampleBucket.s3amazonaws.com/prefix/object type: ChangeManager schema: $ref: '#/components/schemas/ChangeConfigManagerFTDRequest' 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/operational/exports: post: deprecated: false description: '**Migrate configuration management of FTD from FMC to CDO. _Check the response section for applicable examples (if any)._**' operationId: createDeviceExport parameters: - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/exports ( Export device configuration )': value: deviceList: - 00e5091a-ca4e-11eb-872b-edfdb3a31887 - 7de01414-02b7-4693-acf1-8f30a92f2c1f - ec48d989-fed8-4004-99a0-7e6d2a2319d5 - 02531776-670d-46e7-8e0f-045070a27d59 ? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/exports ( Export device configuration to AWS S3 bucket )' : value: deviceList: - 00e5091a-ca4e-11eb-872b-edfdb3a31887 - 7de01414-02b7-4693-acf1-8f30a92f2c1f - ec48d989-fed8-4004-99a0-7e6d2a2319d5 - 02531776-670d-46e7-8e0f-045070a27d59 exportOptions: options: form: AWSAccessKeyId: AKIAPQDIUIQN94C766L bucket: sample headers: X-Amz-Algorithm: AWS4-HMAC-SHA256 X-Amz-Date: 20210519T191457Z X-Amz-Expires: '604800' X-Amz-Signature: 08e13665182fa198912dda24a18318958287c38d9d589898982f186cffe2e83fd66f X-Amz-SignedHeaders: host url: https://sampleBucket.s3amazonaws.com/prefix/object ? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/exports ( Export device configuration to azure storage )' : value: deviceList: - 00e5091a-ca4e-11eb-872b-edfdb3a31887 - 7de01414-02b7-4693-acf1-8f30a92f2c1f - ec48d989-fed8-4004-99a0-7e6d2a2319d5 - 02531776-670d-46e7-8e0f-045070a27d59 exportOptions: url: https://myaccount.blob.core.windows.net/sfo/DeviceExport.sfo?sv=2021-02-12&st=2021-02-09&se=2021-02-10&sr=c&sp=r&si=YWJjZGVmZw%3d%3d&sig=dD80ihBh5jfNpymO5Hg1IdiJIEvHcJpCMiCMnN%2fRnbI%3d schema: $ref: '#/components/schemas/DeviceExport' type: object description: Specify list of devices and optional export options required: true responses: '201': content: application/json: examples: 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/exports ( Export device configuration )': value: deviceList: - 00e5091a-ca4e-11eb-872b-edfdb3a31887 - 7de01414-02b7-4693-acf1-8f30a92f2c1f - ec48d989-fed8-4004-99a0-7e6d2a2319d5 - 02531776-670d-46e7-8e0f-045070a27d59 metadata: task: description: Device configuration export task queued id: 93b2c18a-cb69-11eb-a8f1-27e3d065c679 links: 'self ': /fmc_config/v1/domain/DomainUUID/job/taskstatuses/93b2c18a-cb69-11eb-a8f1-27e3d065c679 status: '200' taskType: DEVICE_EXPORT ? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/exports ( Export device configuration to AWS S3 bucket )' : value: deviceList: - 00e5091a-ca4e-11eb-872b-edfdb3a31887 - 7de01414-02b7-4693-acf1-8f30a92f2c1f - ec48d989-fed8-4004-99a0-7e6d2a2319d5 - 02531776-670d-46e7-8e0f-045070a27d59 exportOptions: options: form: AWSAccessKeyId: AKIAPQDIUIQN94C766L bucket: sample headers: X-Amz-Algorithm: AWS4-HMAC-SHA256 X-Amz-Date: 20210519T191457Z X-Amz-Expires: '604800' X-Amz-Signature: 08e13665182fa198912dda24a18318958287c38d9d589898982f186cffe2e83fd66f X-Amz-SignedHeaders: host url: https://sampleBucket.s3.amazonaws.com/prefix/object metadata: task: description: Device configuration export task queued id: 93b2c18a-cb69-11eb-a8f1-27e3d065c679 links: 'self ': /fmc_config/v1/domain/DomainUUID/job/taskstatuses/93b2c18a-cb69-11eb-a8f1-27e3d065c679 status: '200' taskType: DEVICE_EXPORT ? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/exports ( Export device configuration to azure storage )' : value: deviceList: - 00e5091a-ca4e-11eb-872b-edfdb3a31887 - 7de01414-02b7-4693-acf1-8f30a92f2c1f - ec48d989-fed8-4004-99a0-7e6d2a2319d5 - 02531776-670d-46e7-8e0f-045070a27d59 exportOptions: url: https://myaccount.blob.core.windows.net/sfo/DeviceExport.sfo?sv=2021-02-12&st=2021-02-09&se=2021-02-10&sr=c&sp=r&si=YWJjZGVmZw%3d%3d&sig=dD80ihBh5jfNpymO5Hg1IdiJIEvHcJpCMiCMnN%2fRnbI%3d metadata: task: description: Device configuration export task queued id: 93b2c18a-cb69-11eb-a8f1-27e3d065c679 links: 'self ': /fmc_config/v1/domain/DomainUUID/job/taskstatuses/93b2c18a-cb69-11eb-a8f1-27e3d065c679 status: '200' taskType: DEVICE_EXPORT schema: $ref: '#/components/schemas/DeviceExport' 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/operational/imports: post: deprecated: false description: '**Package and export device configuration of specified Firewall Threat Defenses. _Check the response section for applicable examples (if any)._**' operationId: createDeviceImport parameters: - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: multipart/form-data: examples: ? 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/imports ( Import device configuration by uploading sfo file )' : value: deviceList: - 00e5091a-ca4e-11eb-872b-edfdb3a31887 - 7de01414-02b7-4693-acf1-8f30a92f2c1f - ec48d989-fed8-4004-99a0-7e6d2a2319d5 - 02531776-670d-46e7-8e0f-045070a27d59 payloadFile: .sfo format device configuration file ? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/imports ( Import device configuration from remote storage using AWS pre-signed url )' : value: deviceList: - 00e5091a-ca4e-11eb-872b-edfdb3a31887 - 7de01414-02b7-4693-acf1-8f30a92f2c1f - ec48d989-fed8-4004-99a0-7e6d2a2319d5 - 02531776-670d-46e7-8e0f-045070a27d59 importOptions: options: checksum: 0c1b9614e4172e2135d6a06851c0fc5d64689564fc9f5c0543049eb2505c1528 form: AWSAccessKeyId: AKIASSHKUIQN35C746L bucket: sample headers: X-Amz-Algorithm: AWS4-HMAC-SHA256 X-Amz-Date: 20210519T191457Z X-Amz-Expires: '604800' X-Amz-Signature: 08e13665182fa198912dda24a18318958287c38d9d589898982f186cffe2e83fd66f X-Amz-SignedHeaders: host url: https://sampleBucket.s3.amazonaws.com/prefix/object payloadFile: .sfo format device configuration file ? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/imports ( Import device configuration from azure storage )' : value: deviceList: - 00e5091a-ca4e-11eb-872b-edfdb3a31887 - 7de01414-02b7-4693-acf1-8f30a92f2c1f - ec48d989-fed8-4004-99a0-7e6d2a2319d5 - 02531776-670d-46e7-8e0f-045070a27d59 importOptions: options: checksum: 0c1b9614e4172e2135d6a06851c0fc5d64689564fc9f5c0543049eb2505c1528 url: https://myaccount.blob.core.windows.net/sfo/DeviceExport.sfo?sv=2021-02-12&st=2021-02-09&se=2021-02-10&sr=c&sp=r&si=YWJjZGVmZw%3d%3d&sig=dD80ihBh5jfNpymO5Hg1IdiJIEvHcJpCMiCMnN%2fRnbI%3d ? 'Example 4 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/imports ( Import S2S Only configuration by uploading sfo file )' : value: deviceList: - 00e5091a-ca4e-11eb-872b-edfdb3a31887 - 7de01414-02b7-4693-acf1-8f30a92f2c1f - ec48d989-fed8-4004-99a0-7e6d2a2319d5 - 02531776-670d-46e7-8e0f-045070a27d59 payloadFile: .sfo format device configuration file schema: properties: deviceList: description: Specify list of devices to be imported. type: string deviceMappingOptions: description: '' type: string importOptions: description: Optional device configuration import options. type: string payloadFile: description: File containing the device configurations in .sfo format. format: binary type: string type: object responses: '201': content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/imports ( Import device configuration by uploading sfo file )' : value: deviceList: - 00e5091a-ca4e-11eb-872b-edfdb3a31887 - 7de01414-02b7-4693-acf1-8f30a92f2c1f - ec48d989-fed8-4004-99a0-7e6d2a2319d5 - 02531776-670d-46e7-8e0f-045070a27d59 importOptions: options: checksum: ed8c8ea4c7733107753c000d58ab790903a96ea5756aa08b608429b029301377 metadata: task: description: Device configuration import task queued id: 93b2c18a-cb69-11eb-a8f1-27e3d065c679 links: 'self ': /fmc_config/v1/domain/DomainUUID/job/taskstatuses/93b2c18a-cb69-11eb-a8f1-27e3d065c679 status: '200' taskType: DEVICE_IMPORT ? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/imports ( Import device configuration from remote storage using AWS pre-signed url )' : value: deviceList: - 00e5091a-ca4e-11eb-872b-edfdb3a31887 - 7de01414-02b7-4693-acf1-8f30a92f2c1f - ec48d989-fed8-4004-99a0-7e6d2a2319d5 - 02531776-670d-46e7-8e0f-045070a27d59 importOptions: options: checksum: 0c1b9614e4172e2135d6a06851c0fc5d64689564fc9f5c0543049eb2505c1528 form: AWSAccessKeyId: AKIASSHKUIQN35C746L bucket: sample headers: X-Amz-Algorithm: AWS4-HMAC-SHA256 X-Amz-Date: 20210519T191457Z X-Amz-Expires: '604800' X-Amz-Signature: 08e13665182fa198912dda24a18318958287c38d9d589898982f186cffe2e83fd66f X-Amz-SignedHeaders: host url: https://sampleBucket.s3.amazonaws.com/prefix/object metadata: task: description: Device configuration import task queued id: 93b2c18a-cb69-11eb-a8f1-27e3d065c679 links: 'self ': /fmc_config/v1/domain/DomainUUID/job/taskstatuses/93b2c18a-cb69-11eb-a8f1-27e3d065c679 status: '200' taskType: DEVICE_IMPORT ? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/imports ( Import device configuration from azure storage )' : value: deviceList: - 00e5091a-ca4e-11eb-872b-edfdb3a31887 - 7de01414-02b7-4693-acf1-8f30a92f2c1f - ec48d989-fed8-4004-99a0-7e6d2a2319d5 - 02531776-670d-46e7-8e0f-045070a27d59 importOptions: options: checksum: 0c1b9614e4172e2135d6a06851c0fc5d64689564fc9f5c0543049eb2505c1528 url: https://myaccount.blob.core.windows.net/sfo/DeviceExport.sfo?sv=2021-02-12&st=2021-02-09&se=2021-02-10&sr=c&sp=r&si=YWJjZGVmZw%3d%3d&sig=dD80ihBh5jfNpymO5Hg1IdiJIEvHcJpCMiCMnN%2fRnbI%3d metadata: task: description: Device configuration import task queued id: 93b2c18a-cb69-11eb-a8f1-27e3d065c679 links: 'self ': /fmc_config/v1/domain/DomainUUID/job/taskstatuses/93b2c18a-cb69-11eb-a8f1-27e3d065c679 status: '200' taskType: DEVICE_IMPORT ? 'Example 4 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/imports ( Import S2S Only configuration by uploading sfo file )' : value: deviceList: - 00e5091a-ca4e-11eb-872b-edfdb3a31887 - 7de01414-02b7-4693-acf1-8f30a92f2c1f - ec48d989-fed8-4004-99a0-7e6d2a2319d5 - 02531776-670d-46e7-8e0f-045070a27d59 importOptions: includeDeviceCertificates: 'false' includeS2sVpnPoliciesOnly: 'true' includeSharedPolicies: 'false' includeVpnPolicies: 'false' metadata: task: description: Device configuration import task queued id: 93b2c18a-cb69-11eb-a8f1-27e3d065c679 links: 'self ': /fmc_config/v1/domain/DomainUUID/job/taskstatuses/93b2c18a-cb69-11eb-a8f1-27e3d065c679 status: '200' taskType: DEVICE_IMPORT schema: $ref: '#/components/schemas/DeviceImport' 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/operational/managecertificates: post: deprecated: false description: '**Perform a certificate enrollment operation on devices. Possible action values are ENROLL, RE_ENROLL, REFRESH, DELETE, and EXPORT. All actions require a deviceCertificates section containing a deviceID and certificates subsection. EXPORT also requires a exportOptions subsection containing isPemFormat which can be either true or false and a passPhrase. There can be multiple deviceCertificates sections, but each section may only have one deviceId and one certificate per deviceID. You cannot use multiple actions in the same POST operation.

ENROLL pushes a certificate file onto a device.

RE_ENROLL perform an ENROLL but cleans up any failed previous enrollment.

REFRESH gets the devices current certificate enrollment status.

DELETE deletes a specific certificate enrollment and the certificate information from the device.

EXPORT requests a copy of an existing certificate from the device. _Check the response section for applicable examples (if any)._**' operationId: createManageDeviceCertificatesRequestModel parameters: - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/managecertificate ( Enroll a certificate on a device )' : value: action: ENROLL deviceCertificates: - certificates: - certificate: id: 7de01414-02b7-4693-acf1-8f30a92f2c1f name: certificate-1 type: CertEnrollment deviceId: 00e5091a-ca4e-11eb-872b-edfdb3a31887 ? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/managecertificate ( Re-enroll a certificate on a device )' : value: action: RE_ENROLL deviceCertificates: - certificates: - certificate: id: 7de01414-02b7-4693-acf1-8f30a92f2c1f name: certificate-1 type: CertEnrollment deviceId: 00e5091a-ca4e-11eb-872b-edfdb3a31887 ? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/managecertificate ( Refresh a certificate on a device )' : value: action: REFRESH deviceCertificates: - certificates: - certificate: id: 7de01414-02b7-4693-acf1-8f30a92f2c1f name: certificate-1 type: CertEnrollment deviceId: 00e5091a-ca4e-11eb-872b-edfdb3a31887 ? 'Example 4 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/managecertificate ( Delete a certificate on a device )' : value: action: DELETE deviceCertificates: - certificates: - certificate: id: 7de01414-02b7-4693-acf1-8f30a92f2c1f name: certificate-1 type: CertEnrollment deviceId: 00e5091a-ca4e-11eb-872b-edfdb3a31887 ? 'Example 5 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/managecertificate ( Export a certificate from a device )' : value: action: EXPORT deviceCertificates: - certificates: - certificate: id: 7de01414-02b7-4693-acf1-8f30a92f2c1f name: certificate-1 type: CertEnrollment exportOptions: isPemFormat: false passPhrase: test deviceId: 00e5091a-ca4e-11eb-872b-edfdb3a31887 schema: $ref: '#/components/schemas/ManageDeviceCertificatesRequestModel' type: object description: Specify the action type, the list of devices and the list of certificates to perform the action. Only one certificate can be provided per device. required: true responses: '202': content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/managecertificate ( Enroll a certificate on a device )' : value: action: ENROLL deviceCertificates: - certificates: - certificate: id: 7de01414-02b7-4693-acf1-8f30a92f2c1f name: certificate-1 type: CertEnrollment deviceId: 00e5091a-ca4e-11eb-872b-edfdb3a31887 metadata: task: description: Device certificate management task queued id: '8589936887' links: 'self ': /fmc_config/v1/domain/DomainUUID/job/taskstatuses/8589936887 status: '200' taskType: MANAGE_CERTIFICATE ? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/managecertificate ( Re-enroll a certificate on a device )' : value: action: RE_ENROLL deviceCertificates: - certificates: - certificate: id: 7de01414-02b7-4693-acf1-8f30a92f2c1f name: certificate-1 type: CertEnrollment deviceId: 00e5091a-ca4e-11eb-872b-edfdb3a31887 metadata: task: description: Device certificate management task queued id: '8589936887' links: 'self ': /fmc_config/v1/domain/DomainUUID/job/taskstatuses/8589936887 status: '200' taskType: MANAGE_CERTIFICATE ? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/managecertificate ( Refresh a certificate on a device )' : value: action: REFRESH deviceCertificates: - certificates: - certificate: id: 7de01414-02b7-4693-acf1-8f30a92f2c1f name: certificate-1 type: CertEnrollment deviceId: 00e5091a-ca4e-11eb-872b-edfdb3a31887 metadata: task: description: Device certificate management task queued id: 93b2c18a-cb69-11eb-a8f1-27e3d065c679 links: 'self ': /fmc_config/v1/domain/DomainUUID/job/taskstatuses/8589936887 status: '200' taskType: MANAGE_CERTIFICATE ? 'Example 4 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/managecertificate ( Delete a certificate on a device )' : value: action: DELETE deviceCertificates: - certificates: - certificate: id: 7de01414-02b7-4693-acf1-8f30a92f2c1f name: certificate-1 type: CertEnrollment deviceId: 00e5091a-ca4e-11eb-872b-edfdb3a31887 metadata: task: description: Device certificate management task queued id: 93b2c18a-cb69-11eb-a8f1-27e3d065c679 links: 'self ': /fmc_config/v1/domain/DomainUUID/job/taskstatuses/8589936887 status: '200' taskType: MANAGE_CERTIFICATE ? 'Example 5 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/managecertificate ( Export a certificate from a device )' : value: action: EXPORT deviceCertificates: - certificates: - certificate: id: 7de01414-02b7-4693-acf1-8f30a92f2c1f name: certificate-1 type: CertEnrollment exportOptions: isPemFormat: false passPhrase: test deviceId: 00e5091a-ca4e-11eb-872b-edfdb3a31887 metadata: task: description: Device certificate management task queued id: 93b2c18a-cb69-11eb-a8f1-27e3d065c679 links: 'self ': /fmc_config/v1/domain/DomainUUID/job/taskstatuses/8589936887 status: '200' taskType: MANAGE_CERTIFICATE schema: $ref: '#/components/schemas/ManageDeviceCertificatesRequestModel' 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/operational/modelmigrations: post: deprecated: false description: '**Creates a request to migrate configurations from Firepower Threat Defense 1100, 2100, 4100, or 9300 Series to Secure Firewall 3100 or 4200 Series. _Check the response section for applicable examples (if any)._**' operationId: createModelMigration parameters: - description: Validates the migration request before migrating the configurations. If the value is true and the request is invalid then validation errors are displayed. If the value is false and the request is valid, the migration task will start. If the request is invalid, validation errors are displayed. in: query name: validateOnly required: false schema: type: boolean - description: Ignore the warning messages for the model migration operation. If the value is true, the warning messages are ignored. If the value is false, the warning messages are displayed. in: query name: ignoreWarning required: false schema: type: boolean - $ref: '#/components/parameters/domainUUID' name: domainUUID requestBody: content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/modelmigrations ( FTD Model Migration with overrideableInterfaceAttributesMode as RETAIN_TARGET_VALUES )' : value: interfaceMapping: - sourceInterface: name: Ethernet1/6 type: PhysicalInterface targetInterface: name: Ethernet1/7 type: PhysicalInterface - sourceInterface: name: Ethernet1/7 type: PhysicalInterface targetInterface: name: Ethernet1/6 type: PhysicalInterface overrideableInterfaceAttributesMode: RETAIN_TARGET_VALUES sourceDevice: id: 610a2dd6-d26d-11ef-be90-d6339b8b17e7 type: Device targetDevice: id: 221f0306-d0b2-11ef-9235-d5639b8b17e7 type: Device type: FtdModelMigration ? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/modelmigrations ( FTD Model Migration with overrideableInterfaceAttributesMode as OVERRIDE_TARGET_VALUES )' : value: interfaceMapping: - sourceInterface: name: Ethernet1/6 type: PhysicalInterface targetInterface: name: Ethernet1/7 overrideableInterfaceAttributes: autoNeg: 'true' duplex: FULL speed: ONE_GBPS type: PhysicalInterface - sourceInterface: name: Ethernet1/7 type: PhysicalInterface targetInterface: name: Ethernet1/6 overrideableInterfaceAttributes: autoNeg: 'true' duplex: FULL speed: ONE_GBPS type: PhysicalInterface overrideableInterfaceAttributesMode: OVERRIDE_TARGET_VALUES sourceDevice: id: 610a2dd6-d26d-11ef-be90-d6339b8b17e7 type: Device targetDevice: id: 221f0306-d0b2-11ef-9235-d5639b8b17e7 type: Device type: FtdModelMigration ? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/modelmigrations ( FTD Model Migration with EtherChannelInterface and overrideableInterfaceAttributesMode as RETAIN_TARGET_VALUES )' : value: interfaceMapping: - sourceInterface: name: Ethernet1/7 type: PhysicalInterface targetInterface: name: Ethernet1/6 type: PhysicalInterface - sourceInterface: name: Ethernet1/6 type: PhysicalInterface targetInterface: name: Ethernet1/7 type: PhysicalInterface - sourceInterface: name: Port-channel3 type: EtherChannelInterface targetInterface: name: Port-channel3 selectedInterfaces: - id: 0050568C-A09C-0ed3-0000-060129542463 name: Ethernet1/3 type: PhysicalInterface - id: 0050568C-A09C-0ed3-0000-090194315552 name: Ethernet1/4 type: PhysicalInterface type: EtherChannelInterface - sourceInterface: name: Port-channel4 type: EtherChannelInterface targetInterface: name: Port-channel4 selectedInterfaces: - id: 0050568C-A09C-0ed3-0000-060129542463 name: Ethernet1/7 type: PhysicalInterface - id: 0050568C-A09C-0ed3-0000-090194315552 name: Ethernet1/5 type: PhysicalInterface type: EtherChannelInterface overrideableInterfaceAttributesMode: RETAIN_TARGET_VALUES sourceDevice: id: 47102344-ce63-11ef-a281-05b476d299fe type: Device targetDevice: id: 91a5476a-cdb2-11ef-a404-133e76d299fe type: Device type: FtdModelMigration ? 'Example 4 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/modelmigrations ( FTD Model Migration with EtherChannelInterface and overrideableInterfaceAttributesMode as OVERRIDE_TARGET_VALUES )' : value: interfaceMapping: - sourceInterface: name: Ethernet1/7 type: PhysicalInterface targetInterface: name: Ethernet1/6 overrideableInterfaceAttributes: autoNeg: 'true' duplex: FULL speed: ONE_GBPS type: PhysicalInterface - sourceInterface: name: Ethernet1/6 type: PhysicalInterface targetInterface: name: Ethernet1/7 overrideableInterfaceAttributes: autoNeg: 'true' duplex: FULL speed: ONE_GBPS type: PhysicalInterface - sourceInterface: name: Port-channel3 type: EtherChannelInterface targetInterface: name: Port-channel3 overrideableInterfaceAttributes: autoNeg: 'true' duplex: FULL speed: ONE_GBPS selectedInterfaces: - id: 0050568C-A09C-0ed3-0000-060129542463 name: Ethernet1/3 type: PhysicalInterface - id: 0050568C-A09C-0ed3-0000-090194315552 name: Ethernet1/4 type: PhysicalInterface type: EtherChannelInterface - sourceInterface: name: Port-channel4 type: EtherChannelInterface targetInterface: name: Port-channel4 overrideableInterfaceAttributes: autoNeg: 'false' duplex: FULL speed: TWENTY_FIVE_GBPS selectedInterfaces: - id: 0050568C-A09C-0ed3-0000-060129542463 name: Ethernet2/6 overrideableInterfaceAttributes: fecMode: CL108RS type: PhysicalInterface - id: 0050568C-A09C-0ed3-0000-090194315552 name: Ethernet2/5 overrideableInterfaceAttributes: fecMode: CL108RS type: PhysicalInterface type: EtherChannelInterface overrideableInterfaceAttributesMode: OVERRIDE_TARGET_VALUES sourceDevice: id: a1d8ecf2-d0b1-11ef-98a1-f5599b8b17e7 type: Device targetDevice: id: 221f0306-d0b2-11ef-9235-d5639b8b17e7 type: Device type: FtdModelMigration schema: $ref: '#/components/schemas/ModelMigration' type: object description: Model migration payload required: true responses: '201': content: application/json: examples: ? 'Example 1 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/modelmigrations ( FTD Model Migration with overrideableInterfaceAttributesMode as RETAIN_TARGET_VALUES )' : value: assignSharedPolicies: true metadata: task: id: '38654706097' links: self: https://u32c01p12-vrouter.cisco.com:17323/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/job/taskstatuses/38654706097 type: TaskStatus sourceDevice: id: 610a2dd6-d26d-11ef-be90-d6339b8b17e7 type: Device targetDevice: id: 221f0306-d0b2-11ef-9235-d5639b8b17e7 type: Device ? 'Example 2 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/modelmigrations ( FTD Model Migration with overrideableInterfaceAttributesMode as OVERRIDE_TARGET_VALUES )' : value: assignSharedPolicies: true metadata: task: id: '38654706695' links: self: https://u32c01p12-vrouter.cisco.com:17323/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/job/taskstatuses/38654706695 type: TaskStatus sourceDevice: id: 610a2dd6-d26d-11ef-be90-d6339b8b17e7 type: Device targetDevice: id: 221f0306-d0b2-11ef-9235-d5639b8b17e7 type: Device ? 'Example 3 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/modelmigrations ( FTD Model Migration with EtherChannelInterface and overrideableInterfaceAttributesMode as RETAIN_TARGET_VALUES )' : value: assignSharedPolicies: true metadata: task: id: '38654706695' links: self: https://u32c01p12-vrouter.cisco.com:17323/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/job/taskstatuses/38654706695 type: TaskStatus sourceDevice: id: 610a2dd6-d26d-11ef-be90-d6339b8b17e7 type: Device targetDevice: id: 221f0306-d0b2-11ef-9235-d5639b8b17e7 type: Device ? 'Example 4 : POST /fmc_config/v1/domain/DomainUUID/devices/operational/modelmigrations ( FTD Model Migration with EtherChannelInterface and overrideableInterfaceAttributesMode as OVERRIDE_TARGET_VALUES )' : value: assignSharedPolicies: true metadata: task: id: '38654707307' links: self: https://u32c01p12-vrouter.cisco.com:17323/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/job/taskstatuses/38654707307 type: TaskStatus sourceDevice: id: a1d8ecf2-d0b1-11ef-98a1-f5599b8b17e7 type: Device targetDevice: id: 221f0306-d0b2-11ef-9235-d5639b8b17e7 type: Device schema: $ref: '#/components/schemas/ModelMigration' 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 components: schemas: IAccessPolicyModel: properties: decryptionPolicySetting: $ref: '#/components/schemas/IAccessPolicyDecryptionPolicySetting' type: object defaultAction: $ref: '#/components/schemas/IAccessPolicyDefaultAction' type: object description: type: string id: type: string identityPolicySetting: $ref: '#/components/schemas/IACPolicyIdentityPolicySettings' type: object links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string prefilterPolicySetting: $ref: '#/components/schemas/IAccessPolicyPrefilterPolicySettingModel' type: object rules: items: $ref: '#/components/schemas/IReference' type: object type: array securityIntelligence: $ref: '#/components/schemas/IReference' type: object type: type: string version: type: string required: - defaultAction type: object ITargetInterface: properties: id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string overrideableInterfaceAttributes: $ref: '#/components/schemas/IOverrideableInterfaceAttributes' type: object selectedInterfaces: items: $ref: '#/components/schemas/SelectedInterface' type: object type: array type: type: string type: object LLFilesMap: additionalProperties: type: string type: object IOspfv3InterfaceAuthenticationBase: properties: type: type: string required: - type type: object IOspfv3NeighborCost: properties: cost: format: int32 type: integer filterOutgoingLSA: type: boolean type: object IIpvPrefixListFilter: properties: filterUpdateAction: enum: - IN - OUT type: string id: type: string ipv4PrefixList: $ref: '#/components/schemas/IReference' type: object ipv6PrefixList: $ref: '#/components/schemas/IReference' type: object links: $ref: '#/components/schemas/ILinks' type: object name: type: string type: type: string type: object IChangeConfigManagerFTDInfo: properties: action: enum: - CONFIGURE_MANAGER_ADD - CONFIGURE_MANAGER_DELETE - INITIATE_MIGRATION - DISCARD_MIGRATION - SWITCH_TO_ANALYTICS - DELETE_DEVICE type: string id: type: string license_caps: items: type: string type: array links: $ref: '#/components/schemas/ILinks' type: object name: type: string natID: type: string performanceTier: type: string regKey: type: string type: type: string type: object HealthMonitorModelListContainer: properties: items: $ref: '#/components/schemas/HealthMonitorModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IPoeConfig: properties: consumptionWattage: format: int32 type: integer state: type: boolean type: object IChangeConfigManagerFTDReportJobSummary: properties: deviceList: items: $ref: '#/components/schemas/IChangeConfigManagerFTDReportDeviceInfo' type: object type: array failedCount: format: int32 type: integer jobExpiryTime: type: string jobStatusMessage: type: string numberOfDevices: format: int32 type: integer sourceManagerHost: type: string successCount: format: int32 type: integer type: object LTPDeviceRecord: properties: accessPolicy: $ref: '#/components/schemas/IPolicyModel' description: access policy to be used for LTP Device type: object defaultPasswordAlreadyChanged: description: flag to represent whether device default password is changed or not type: boolean description: type: string deviceGroup: $ref: '#/components/schemas/IDeviceGroup' description: device group to which LTP device should be grouped type: object id: description: Unique identifier (UUID) representing the LTP device record type: string license_caps: description: 'Array of strings representing the license capabilities on the managed device. For registering FTD, the allowed values are: ESSENTIALS (mandatory), IPS, URL, MALWARE_DEFENSE, CARRIER, SECURE_CLIENT_PREMIER, SECURE_CLIENT_PREMIER_ADVANTAGE, SECURE_CLIENT_VPNOnly. For Firepower ASA or NGIPSv devices, allowed values are: BASE, THREAT, PROTECT, CONTROL, URLFilter, MALWARE, VPN, SSL. ' items: type: string type: array links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/IMetadata' description: Defines read only details about the LTP Device record status with description, last user who modified the object etc. type: object name: description: User-specified name of the LTP Device record type: string password: description: password to be used to login to LTP Device or to update the device password. password should meet following criteria like it should contain one small letter , one capital case , one special character, one number& minimum of 8 characters length & maximum up to 128 characters type: string serialNumber: description: Serial number of LTP Device record type: string type: description: Type of the LTP Device record; this value is always LTPDeviceRecord. type: string required: - license_caps type: object ILsaThrottleTimer: properties: initialDelay: format: int32 type: integer maximumDelay: format: int32 type: integer minimumDelay: format: int32 type: integer type: object IHybridZeroTrustFQDNConfig: properties: FQDN: type: string certificate: $ref: '#/components/schemas/IReference' type: object interfaces: items: $ref: '#/components/schemas/IReference' type: object type: array type: object DeviceCertificateModel: properties: description: type: string enrolledCertificates: items: $ref: '#/components/schemas/IEnrolledCertificate' type: object type: array id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string type: type: string version: type: string weakCryptoEnabled: type: boolean type: object HybridZeroTrustSettingListContainer: properties: items: $ref: '#/components/schemas/HybridZeroTrustSetting' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object VirtualSwitch: properties: description: type: string domainId: format: int32 type: integer dropBPDU: type: boolean enableSpanningTreeProtocol: type: boolean hybridInterface: $ref: '#/components/schemas/IInterface' type: object id: type: string links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string sensorPolicy: $ref: '#/components/schemas/IAccessPolicyModel' type: object staticMacEntries: items: $ref: '#/components/schemas/IStaticMacEntry' type: object type: array strictTCPEnforcement: type: boolean switchedInterfaces: items: $ref: '#/components/schemas/IInterface' type: object type: array type: type: string version: type: string type: object PreferLifeTime: properties: duration: $ref: '#/components/schemas/Duration' type: object expirationLifeTime: $ref: '#/components/schemas/ExpirationLifeTime' type: object type: object IEigrpAdvancedConfigModel: description: Contains EIGRP advanced configurations. properties: administrativeDistance: $ref: '#/components/schemas/IEigrpAdministrativeDistance' description: Used for configuring the administrative distance for a route. type: object clusterPool: $ref: '#/components/schemas/ReferenceObject' description: Configure IPv4 Cluster Pool Address for the EIGRP. type: object defaultRouteDistributionIn: $ref: '#/components/schemas/ReferenceObject' description: Configure EIGRP to accept exterior default routing information through Access List. type: object defaultRouteDistributionOut: $ref: '#/components/schemas/ReferenceObject' description: Configure EIGRPto advertise exterior default routing information through Access List. type: object enableLogNeighborWarnings: description: Enable the logging of EIGRP neighbor warning messages.Can be TRUE or FALSE. type: boolean logNeighborChanges: description: Enable the logging of EIGRP neighbor adjacency changes.Can be TRUE or FALSE. type: boolean logNeighborWarningInterval: description: Specifiy the interval at which warnings to be logged.Can be TRUE or FALSE. format: int32 type: integer routeMetric: $ref: '#/components/schemas/IEigrpRouteMetric' description: It contains the bandwidth, load, delay, reliability and MTU values which are used by routing algorithm for selecting or rejecting a routing path for transferring data/traffic. type: object routerId: description: Configure to specify an unique global address for the EIGRP.It will be an IPv4 address. type: string stub: $ref: '#/components/schemas/IEigrpStub' description: Enable the device as an EIGRP stub routing process. type: object type: object IAggregateAddresses: properties: advertiseMap: $ref: '#/components/schemas/IRouteMap' type: object asSet: type: boolean attributeMap: $ref: '#/components/schemas/IRouteMap' type: object id: type: string ipv4AggregateNetwork: $ref: '#/components/schemas/INetworkAddress' type: object ipv6AggregateNetwork: $ref: '#/components/schemas/INetworkAddress' type: object links: $ref: '#/components/schemas/ILinks' type: object name: type: string summaryOnly: type: boolean suppressMap: $ref: '#/components/schemas/IRouteMap' type: object type: type: string type: object DeviceDDNSSettingModel: properties: ddnsInterfaceSettings: items: $ref: '#/components/schemas/IDDNSInterfaceSettingModel' type: object type: array ddnsUpdateMethods: items: $ref: '#/components/schemas/IDDNSUpdateMethodModel' type: object type: array description: type: string dhcpClientIdInterfaces: items: $ref: '#/components/schemas/ReferenceObject' type: object type: array dhcpClientRequestType: enum: - NOT_SELECTED - NO_UPDATE - ONLY_PTR - BOTH_A_AND_PTR_RECORD type: string dynamicDDNSUpdateType: enum: - NOT_SELECTED - ONLY_PTR - BOTH_A_AND_PTR_RECORD type: string enableDHCPClientBroadcast: type: boolean id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string overrideDHCPClientRequest: type: boolean type: type: string version: type: string type: object IDHCPIPv6Pool: properties: description: type: string dnsServer: $ref: '#/components/schemas/IDHCPIPv6DNSServer' type: object domainName: $ref: '#/components/schemas/IDHCPIPv6DomainName' type: object id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string otherServerOptions: items: $ref: '#/components/schemas/IDHCPIPv6OtherServerOptions' type: object type: array type: type: string version: type: string type: object IAccessPolicyDecryptionPolicySetting: properties: decryptionPolicy: $ref: '#/components/schemas/IReference' type: object description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string type: type: string version: type: string type: object IBGPGSTimers: properties: holdTime: format: int32 type: integer id: type: string keepAlive: format: int32 type: integer links: $ref: '#/components/schemas/ILinks' type: object minHoldTime: format: int32 type: integer name: type: string type: type: string type: object FPLogicalInterfaceListContainer: properties: items: $ref: '#/components/schemas/FPLogicalInterface' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object INeighborGeneral: properties: asOverride: type: boolean description: type: string enableAddress: type: boolean fallOverBFD: enum: - SINGLE_HOP - MULTI_HOP - AUTO_DETECT_HOP - NONE type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string shutdown: type: boolean type: type: string updateSource: $ref: '#/components/schemas/IFTDInterface' type: object type: object IFileWrapper: properties: attrib: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string path: type: string type: type: string type: object IAccessPolicyPrefilterPolicySettingModel: description: Object representing the association of prefilter policy to specified access policy. When access policy is created, the attribute will refer to Default Prefilter Policy. This attribute can be updated only using the PUT operation. If the attribute is missing from PUT call, the attribute will not be changed. properties: description: type: string id: description: Unique identifier representing prefilter policy. type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: description: Name of the associated prefilter policy. type: string type: description: Type must be PrefilterPolicy. type: string version: type: string type: object IEnrolledCertificate: properties: caCertExpiryDate: type: string caCertificateStatus: enum: - PENDING - AVAILABLE - NOT_AVAILABLE - IN_PROGRESS - NOT_APPLICABLE type: string certificate: $ref: '#/components/schemas/IReference' type: object deploymentStatus: enum: - SUCCESS - FAILED - ABORTED - IN_PROGRESS - ADDED type: string enrollmentType: enum: - SCEP - EST - MANUAL - MANUAL_ONLY_CA - MANUAL_ONLY_ID - SELF_SIGNED_CERTFICATE - PKCS12 type: string errorMessage: type: string identityCertExpiryDate: type: string identityCertificateStatus: enum: - PENDING - AVAILABLE - NOT_AVAILABLE - IN_PROGRESS - NOT_APPLICABLE - AVAILABLE_PENDING type: string isOutdated: type: boolean status: type: boolean type: object BulkRegistration: description: An object that represents the details for bulk registration of devices. properties: description: type: string excludeDevicesWithError: description: Indicates that devices with validation errors will be ignored for registration. When value is false, validation exception is thrown even one invalid device details is found. When value is true, registration of valid devices will continue and invalid devices will be ignored. This is applicable only when onboarding method is REGISTRATION_KEY. Default value is false. type: boolean files: items: $ref: '#/components/schemas/IFileWrapper' type: object type: array filesMap: $ref: '#/components/schemas/LLFilesMap' type: object id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string onboardingMethod: description: Indicates the onboarding method of device registration. Allowed values are SERIAL_NUMBER and REGISTRATION_KEY. enum: - SERIAL_NUMBER - REGISTRATION_KEY type: string performValidationOnly: description: Specifies whether device details should be validated or validated and registered. Default value is false. type: boolean templateUuid: description: UUID of the device template which can be applied on the devices being registered. type: string type: type: string version: type: string type: object ErrorResponse: properties: category: description: Describes the category of the error thrown. enum: - FRAMEWORK - OTHER - VALIDATION type: string messages: description: List of error messages which the response has. items: $ref: '#/components/schemas/ErrorMessagesContainer' type: object type: array severity: description: Specifies the Highest level severity among all the error messages. enum: - ERROR - WARN type: string type: object INeighborFilterList: properties: asPathList: $ref: '#/components/schemas/IReference' type: object filterUpdateAction: enum: - IN - OUT type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string type: type: string type: object IOverrideDefaultFragmentSetting: properties: chain: format: int32 type: integer size: format: int32 type: integer timeout: format: int32 type: integer type: object INetworkObjectContainer: properties: literal: $ref: '#/components/schemas/INetworkAddressLiteral' type: object object: $ref: '#/components/schemas/INetworkBase' type: object type: object IDHCPIPv6DNSServer: properties: importFromInternalServer: type: boolean ipAddresses: items: type: string type: array type: object IRuleRecommendation: properties: acceptDisabledRules: type: boolean lastUpdatedTime: format: int32 type: integer networks: items: $ref: '#/components/schemas/Snort3IPSReferenceObject' type: object type: array recommendationInUse: type: boolean securityLevel: enum: - LEVEL_1 - LEVEL_2 - LEVEL_3 - LEVEL_4 type: string type: object EigrpPolicyModel: properties: advancedConfiguration: $ref: '#/components/schemas/IEigrpAdvancedConfigModel' type: object asNumber: type: string basicConfiguration: $ref: '#/components/schemas/IEigrpBasicConfigModel' type: object distributionList: items: $ref: '#/components/schemas/EigrpDistributionListModel' type: object type: array eigrpInterfaces: items: $ref: '#/components/schemas/EigrpInterfaceModel' type: object type: array id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string neighbors: items: $ref: '#/components/schemas/EigrpNeighborModel' type: object type: array redistributeProtocols: items: $ref: '#/components/schemas/EigrpRedistributionModel' type: object type: array summaryAddressList: items: $ref: '#/components/schemas/EigrpSummaryAddressModel' type: object type: array type: type: string type: object INeighborFiltering: properties: id: type: string ipv4PrefixListFilter: items: $ref: '#/components/schemas/IIpvPrefixListFilter' type: object type: array ipv6PrefixListFilter: items: $ref: '#/components/schemas/IIpvPrefixListFilter' type: object type: array links: $ref: '#/components/schemas/ILinks' type: object name: type: string neighborDefaultOriginate: $ref: '#/components/schemas/INeighborDefaultOriginate' type: object neighborDistributeLists: items: $ref: '#/components/schemas/INeighborDistributeLists' type: object type: array neighborFilterList: items: $ref: '#/components/schemas/INeighborFilterList' type: object type: array neighborMaximumPrefix: $ref: '#/components/schemas/INeighborMaximumPrefix' type: object neighborRouteMap: items: $ref: '#/components/schemas/INeighborRouteMap' type: object type: array type: type: string type: object VrfIPv4StaticRouteModelListContainer: properties: items: $ref: '#/components/schemas/VrfIPv4StaticRouteModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IOspfv3NsfGracefulRestart: properties: gracefulRestart: $ref: '#/components/schemas/IOspfv3GracefulRestart' type: object gracefulRestartHelper: $ref: '#/components/schemas/IOspfv3GracefulRestartHelper' type: object type: object IRouteMapEntry: description: List of route maps entries already configured for this route map object. properties: action: description: 'Indicate the redistribution access: PERMIT or DENY' enum: - PERMIT - DENY type: string addToExistingCommunity: type: boolean asPathLists: description: Enable matching the BGP autonomous system path access list with the specified path access list. items: $ref: '#/components/schemas/IReference' type: object type: array asPathPrependASPath: description: Prepend an arbitrary autonomous system path string to BGP routes. items: format: int32 type: integer type: array asPathPrependLastASToASPath: description: Prepend the AS path with the last AS number. format: int32 type: integer automaticTagSetting: description: Automatically compute the tag value. type: boolean communityListSetting: description: Enable matching the BGP community with the specified community. format: int32 type: integer communityListSettingInternet: description: 'Internet: one of the well-known communities' type: boolean communityListSettingNoAdvertise: description: 'No Advertise: one of the well-known communities' type: boolean communityListSettingNoExport: description: 'No-Export: One of the well-known communities' type: boolean communityLists: description: Enable matching the BGP community with the specified community. items: $ref: '#/components/schemas/IReference' type: object type: array convertRouteTagIntoASPath: type: boolean extendedCommunityAdditive: type: boolean extendedCommunityLists: items: $ref: '#/components/schemas/IReference' type: object type: array extendedCommunityRouteTarget: type: string interfaceNames: description: Match traffic based on the (ingress/egress) interfaces. Logical names. items: type: string type: array interfaces: description: Match traffic based on the (ingress/egress) interfaces. Input security Zones. items: $ref: '#/components/schemas/IReference' type: object type: array ipv4AccessListAddresses: description: Match IPv4 (routes/traffic) based on the route address. items: $ref: '#/components/schemas/IReference' type: object type: array ipv4AccessListNextHops: description: Match IPv4 (routes/traffic) based on the next-hop address. items: $ref: '#/components/schemas/IReference' type: object type: array ipv4AccessListRouteSources: description: 'Match IPv4 (routes/traffic) based on the advertising source address of the route. ' items: $ref: '#/components/schemas/IReference' type: object type: array ipv4PrefixListAddresses: description: Match IPv4 (routes/traffic) based on the route address. items: $ref: '#/components/schemas/IReference' type: object type: array ipv4PrefixListNexthops: description: Match IPv4 (routes/traffic) based on the next-hop address. items: $ref: '#/components/schemas/IReference' type: object type: array ipv4PrefixListRouteSources: description: 'Match IPv4 (routes/traffic) based on the advertising source address of the route. ' items: $ref: '#/components/schemas/IReference' type: object type: array ipv6AccessListAddresses: description: Match IPv6 (routes/traffic) based on the route address. items: $ref: '#/components/schemas/IReference' type: object type: array ipv6AccessListNextHops: description: Match IPv6 (routes/traffic) based on the next-hop address. items: $ref: '#/components/schemas/IReference' type: object type: array ipv6AccessListRouteSources: description: Match IPv6 (routes/traffic) based on the advertising source address of route. items: $ref: '#/components/schemas/IReference' type: object type: array ipv6PrefixListAddresses: description: Match IPv6 (routes/traffic) based on the route address. items: $ref: '#/components/schemas/IReference' type: object type: array ipv6PrefixListNexthops: description: Match IPv6 (routes/traffic) based on the next-hop address. items: $ref: '#/components/schemas/IReference' type: object type: array ipv6PrefixListRouteSources: description: Match IPv6 (routes/traffic) based on the advertising source address of route. items: $ref: '#/components/schemas/IReference' type: object type: array localPreferenceSetting: description: Preference value for the autonomous system path format: int32 type: integer metricBandwidth: description: Metric value or bandwidth in Kbits per second format: int32 type: integer metricRouteValues: description: Enable matching the metric of a route items: format: int32 type: integer type: array metricType: description: 'Valid values are : internal, type-1, or type-2.' enum: - INTERNAL - TYPE_1 - TYPE_2 type: string nextHopIPV4Setting: description: Specify a next hop IPv4 address of the next hop to which packets are output. enum: - USE_PEER_ADDRESS - SPECIFIC_IP type: string nextHopIPV6Setting: description: Specify a next hop IPv6 address of the next hop to which packets are output. enum: - USE_PEER_ADDRESS - SPECIFIC_IP type: string originSetting: description: BGP origin code. Valid values are Local IGP Local IGP and Incomplete. enum: - LOCAL_IGP - INCOMPLETE type: string policyLists: description: Configure a route map to evaluate and process a BGP policy. items: $ref: '#/components/schemas/IReference' type: object type: array prefixListIPV4Setting: $ref: '#/components/schemas/IReference' description: Match IPv4 (routes/traffic) based on the route address. type: object prefixListIPV6Setting: $ref: '#/components/schemas/IReference' description: Match IPv6 (routes/traffic) based on the route address. type: object routeTypeExternal1: description: Enable External1 route type type: boolean routeTypeExternal2: description: Enable External2 route type type: boolean routeTypeInternal: type: boolean routeTypeLocal: description: Enable Local route type type: boolean routeTypeNSSAExternal1: description: Enable NSSA-External1 route type type: boolean routeTypeNSSAExternal2: description: Enable NSSA-External2 route type type: boolean sequence: description: Indicates the position a new route map entry will have in the list of route maps entries already configured for this route map object format: int32 type: integer specificCommunityNone: type: boolean specificIPsIPV4Setting: items: type: string type: array specificIPsIPV6Setting: items: type: string type: array tagValues: description: This setting allows you to match any routes that have a specified security group tag. items: format: int32 type: integer type: array weightSetting: description: BGP weight for the routing table format: int32 type: integer required: - action - sequence type: object DeviceImportExportOptions: properties: changeDeviceBeforeImport: type: boolean conflictOption: enum: - NEW - LATEST - RENAME_IMPORTED - REPLACE_EXISTING - KEEP_EXISTING - REUSE_EXISTING type: string includeDeviceCertificates: type: boolean includeS2sVpnPoliciesOnly: type: boolean includeSharedPolicies: type: boolean includeVpnPolicies: type: boolean options: $ref: '#/components/schemas/IDeviceImportExportRequestOptions' type: object url: type: string type: object IDeviceChassisData: properties: chassisSerialNo: type: string chassisUrl: type: string securityModuleNo: format: int32 type: integer securityModuleSN: type: string type: object FTDVTIInterface: properties: MTU: format: int32 type: integer activeMACAddress: type: string applicationMonitoring: $ref: '#/components/schemas/IApplicationMonitoring' type: object arpConfig: items: $ref: '#/components/schemas/IARPConfigContainer' type: object type: array borrowIPfrom: $ref: '#/components/schemas/IInterface' type: object description: type: string enableAntiSpoofing: type: boolean enableDNSLookup: type: boolean enableSGTPropagate: type: boolean enabled: type: boolean fmcAccessConfig: $ref: '#/components/schemas/IFMCAccessConfig' type: object fragmentReassembly: type: boolean id: type: string ifname: type: string ipAddressAssignmentType: enum: - MANUAL_IP - BORROW_IP_FROM_INTERFACE type: string ipsecMode: type: string ipv4: $ref: '#/components/schemas/IIPv4Container' type: object ipv6: $ref: '#/components/schemas/IIPv6Container' type: object links: $ref: '#/components/schemas/ILinks' type: object macAddressPool: $ref: '#/components/schemas/IReference' type: object macLearn: type: boolean macTable: items: type: string type: array managementOnly: type: boolean metadata: $ref: '#/components/schemas/IMetadata' type: object mode: enum: - INLINE - PASSIVE - TAP - ERSPAN - NONE - SWITCHPORT type: string name: type: string overrideDefaultFragmentSetting: $ref: '#/components/schemas/IOverrideDefaultFragmentSetting' type: object pathMonitoring: $ref: '#/components/schemas/IPathMonitoring' type: object priority: format: int32 type: integer securityZone: $ref: '#/components/schemas/ISecurityZoneObjectModel' type: object standbyMACAddress: type: string tunnelIPAddressVariable: $ref: '#/components/schemas/IReference' type: object tunnelId: format: int32 type: integer tunnelSource: $ref: '#/components/schemas/IInterface' type: object tunnelSrcIPv6IntfAddr: type: string tunnelType: type: string type: type: string version: type: string type: object IIPv6PrefixContainer: properties: length: type: string name: type: string type: object VirtualAccessInterface: properties: MTU: format: int32 type: integer activeMACAddress: type: string applicationMonitoring: $ref: '#/components/schemas/IApplicationMonitoring' type: object arpConfig: items: $ref: '#/components/schemas/IARPConfigContainer' type: object type: array borrowIPfrom: $ref: '#/components/schemas/IInterface' type: object description: type: string destinationIpAddress: type: string dvtiId: type: string dvtiLogicalName: type: string dvtiName: type: string enableAntiSpoofing: type: boolean enableDNSLookup: type: boolean enableSGTPropagate: type: boolean enabled: type: boolean fmcAccessConfig: $ref: '#/components/schemas/IFMCAccessConfig' type: object fragmentReassembly: type: boolean id: type: string ifname: type: string innerFlowCount: format: int32 type: integer ipAddress: type: string ipAddressAssignmentType: enum: - MANUAL_IP - BORROW_IP_FROM_INTERFACE type: string ipsecMode: type: string ipsecProfile: type: string ipv4: $ref: '#/components/schemas/IIPv4Container' type: object ipv6: $ref: '#/components/schemas/IIPv6Container' type: object links: $ref: '#/components/schemas/ILinks' type: object macAddressPool: $ref: '#/components/schemas/IReference' type: object macLearn: type: boolean macTable: items: type: string type: array managementOnly: type: boolean metadata: $ref: '#/components/schemas/IMetadata' type: object mode: enum: - INLINE - PASSIVE - TAP - ERSPAN - NONE - SWITCHPORT type: string name: type: string overrideDefaultFragmentSetting: $ref: '#/components/schemas/IOverrideDefaultFragmentSetting' type: object pathMonitoring: $ref: '#/components/schemas/IPathMonitoring' type: object priority: format: int32 type: integer securityZone: $ref: '#/components/schemas/ISecurityZoneObjectModel' type: object sourceIp: type: string standbyMACAddress: type: string status: type: string timeUpSince: type: string tunnelIPAddressVariable: $ref: '#/components/schemas/IReference' type: object tunnelId: format: int32 type: integer tunnelSource: $ref: '#/components/schemas/IInterface' type: object tunnelSrcIPv6IntfAddr: type: string tunnelType: type: string type: type: string version: type: string type: object OutOfBandChangesListContainer: properties: items: $ref: '#/components/schemas/OutOfBandChanges' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object BGPGeneralSettingModelListContainer: properties: items: $ref: '#/components/schemas/BGPGeneralSettingModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IAccessPolicyDefaultAction: properties: action: description: 'Specifies the action to take when the conditions defined by the rule are met. One of: BLOCK | TRUST | NETWORK_DISCOVERY | PERMIT | INHERIT_FROM_PARENT.' enum: - BLOCK - TRUST - PERMIT - NETWORK_DISCOVERY - INHERIT_FROM_PARENT type: string description: description: User provided description. type: string enableSyslog: type: boolean id: description: Unique identifier representing resource. type: string intrusionPolicy: $ref: '#/components/schemas/IIntrusionPolicyModel' type: object links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object logBegin: description: Boolean indicating whether the device will log events at the beginning of the connection. Default is false. type: boolean logEnd: description: Boolean indicating whether the device will log events at the end of the connection. Default is false. type: boolean metadata: $ref: '#/components/schemas/IMetadata' description: Object representing metadata properties of response object. type: object name: description: User chosen resource name. type: string sendEventsToFMC: description: Boolean indicating whether the device will send events to the Firepower Management Center event viewer. Default is false. type: boolean snmpConfig: $ref: '#/components/schemas/IReference' description: Object representing the SNMP alert associated with the access rule. type: object syslogConfig: $ref: '#/components/schemas/IReference' description: Object representing the syslog alert associated with the access rule. type: object syslogSeverity: enum: - ALERT - CRIT - DEBUG - EMERG - ERR - INFO - NOTICE - WARNING type: string type: description: Response object associated with resource. type: string variableSet: $ref: '#/components/schemas/IReference' description: Object representing the variable set associated with the access rule. type: object version: description: Version number of the response object. type: string required: - action type: object FTDAllInterfacesModelListContainer: properties: items: $ref: '#/components/schemas/FTDAllInterfacesModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IEigrpInterfaceAuthentication: description: Contains EIGRP Interface Authenticatin information properties: keyId: description: The shared key id that matches the key format: int32 type: integer md5auth: description: If true, the neighbor area has a MD5 authentication type: boolean password: description: User password string type: string pwdEncryption: description: 'Password encryption. Possible values: UNENCRYPTED | ENCRYPTED | AUTHKEY' enum: - UNENCRYPTED - ENCRYPTED - AUTHKEY type: string type: object PBRPolicyModelListContainer: properties: items: $ref: '#/components/schemas/PBRPolicyModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IDeviceCertificate: properties: certificates: items: $ref: '#/components/schemas/ICertificateDetails' type: object type: array deviceId: type: string type: object IDeviceMappingOptions: properties: interfaceMapping: items: $ref: '#/components/schemas/IDeviceConfigInterfaceMapping' type: object type: array sourceDevice: type: string targetDevice: type: string type: object IOspfv3VirtualLinks: properties: deadInterval: format: int32 type: integer helloInterval: format: int32 type: integer retransmitInterval: format: int32 type: integer routerId: type: string transmitDelay: format: int32 type: integer ttlSecurity: format: int32 type: integer type: object INeighborAdvanced: properties: id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string neighborHops: $ref: '#/components/schemas/INeighborHops' type: object neighborSecret: type: string neighborSecretVariable: $ref: '#/components/schemas/IReference' type: object neighborTransportConnectionMode: $ref: '#/components/schemas/INeighborTransportConnectionMode' type: object neighborTransportPathMTUDiscovery: $ref: '#/components/schemas/INeighborTransportPathMTUDiscovery' type: object neighborVersion: format: int32 type: integer neighborWeight: format: int32 type: integer nextHopSelf: type: boolean sendCommunity: type: boolean type: type: string type: object IApplicationCategory: description: Represents an ApplicationCategory. properties: description: description: Application category resource description. type: string id: description: Unique identifier for the application category. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/IMetadata' description: Object representing metadata attributes for the application category. type: object name: description: Name of the application category. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on a device or domain. type: object type: description: Type of the response object. This value is always ApplicationCategory. type: string version: description: Version number of the response object. type: string type: object LLDPContainer: properties: receive: type: boolean transmit: type: boolean type: object IIPv4AddressPool: properties: addressType: enum: - RANGE - SUPERNET type: string description: type: string id: type: string ipAddressRange: type: string links: $ref: '#/components/schemas/ILinks' type: object mask: type: string metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string numberOfAddresses: format: int32 type: integer overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object rangeStart: format: int32 type: integer subnetPrefix: format: int32 type: integer supernetAddress: type: string supernetPrefix: format: int32 type: integer type: type: string version: type: string required: - ipAddressRange type: object IRedistributeProtocolBase: properties: routeMap: $ref: '#/components/schemas/IRouteMap' type: object routeMetric: $ref: '#/components/schemas/IOspfRouteMetric' type: object subnets: type: boolean tagNumber: format: int32 type: integer type: type: string type: object DownloadSampleCsvListContainer: properties: items: $ref: '#/components/schemas/DownloadSampleCsv' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object INeighborHaMode: properties: disable: type: boolean id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string type: type: string type: object DeviceMetadata: properties: chassisData: $ref: '#/components/schemas/DeviceChassisData' description: This field holds information related to chassis. type: object chassisDetails: $ref: '#/components/schemas/IDeviceChassisData' type: object clusterBootstrapSupported: type: boolean containerDetails: $ref: '#/components/schemas/IBaseDevice' description: If 'isPartOfContainer' field is true then this field will hold the information of container. type: object deviceSerialNumber: type: string domain: $ref: '#/components/schemas/Domain' description: Lists the domains to which this instance belongs if applicable. type: object dummyDevice: type: boolean inventoryData: $ref: '#/components/schemas/DeviceInventoryData' description: Inventory details of the device. type: object inventoryDetails: $ref: '#/components/schemas/IDeviceInventoryData' type: object isDummyDevice: type: boolean isLocked: type: boolean isMultiInstance: description: Indicated if the device is in multiinstance or native mode. type: boolean isPartOfContainer: description: This field indicates whether it is part of any cluster. This will be true for a device which is part of NGFWHA, NGFW cluster and firepower devices which is part of Stack. type: boolean isSnort3: type: boolean lastUser: $ref: '#/components/schemas/MetadataUser' description: The last user who modified this instance. type: object lspVersion: type: string matches: items: type: string type: array otherAssociatedPolicies: description: assigned policies to device other than Access Policy items: $ref: '#/components/schemas/IReference' type: object type: array readOnly: $ref: '#/components/schemas/ReadOnly' description: Details regarding the read only status of this instance. type: object snortVersion: description: Snort version of a particular device. type: string sruVersion: description: SRU version of a particular device. type: string task: $ref: '#/components/schemas/ITaskStatus' type: object timestamp: description: The last updated timestamp. format: int32 type: integer universalZeroTrustSetting: $ref: '#/components/schemas/LLUniversalZeroTrustSetting' type: object universalZeroTrustSupported: type: boolean vdbVersion: description: VDB version of a particular device. type: string required: - otherAssociatedPolicies type: object DeviceCopyConfigRequest: description: Copy configuration operation on device properties: copySharedPolicies: description: Boolean value. Copies shared policies from source standalone device or HA to target standalone device based on True or False input type: boolean sourceDevice: $ref: '#/components/schemas/ITarget' description: Source device is either a standalone device UUID or HA container UUID type: object targetDeviceList: description: Target device list is a standalone device UUID items: $ref: '#/components/schemas/ITarget' type: object type: array type: object IOspfAdministrativeDistance: properties: external: format: int32 type: integer interArea: format: int32 type: integer intraArea: format: int32 type: integer type: object IDistance: properties: externalDistance: format: int32 type: integer id: type: string internalDistance: format: int32 type: integer links: $ref: '#/components/schemas/ILinks' type: object localDistance: format: int32 type: integer name: type: string type: type: string type: object IIPv6ClientPdContainer: properties: hintPrefixes: items: type: string type: array prefixName: type: string type: object VrfPBRPolicyModelListContainer: properties: items: $ref: '#/components/schemas/VrfPBRPolicyModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object VRFPolicyEntry: properties: attributes: $ref: '#/components/schemas/Attributes' type: object description: type: string enabled: type: boolean id: format: int32 type: integer interfaceEntryList: items: $ref: '#/components/schemas/VRFInterfaceEntry' type: object type: array l2SwitchingEnabled: type: boolean literal: type: boolean mandatory: type: boolean name: type: string position: format: int32 type: integer readOnly: type: boolean subType: type: string tooltip: type: string type: type: string uuid: type: string value: type: string type: object Ospfv3AreaRouteSummaryEntry: properties: attributes: $ref: '#/components/schemas/Attributes' type: object description: type: string enabled: type: boolean id: format: int32 type: integer l2SwitchingEnabled: type: boolean literal: type: boolean mandatory: type: boolean name: type: string opType: type: string ospfv3AreaRangeAdvertise: type: boolean ospfv3AreaRangeCost: format: int32 type: integer ospfv3AreaRangeNetwork: $ref: '#/components/schemas/ObjectEntry' type: object position: format: int32 type: integer readOnly: type: boolean subType: type: string tooltip: type: string type: type: string userAction: type: string uuid: type: string value: type: string type: object FTDAllInterfacesModel: properties: MTU: format: int32 type: integer activeMACAddress: type: string applicationMonitoring: $ref: '#/components/schemas/IApplicationMonitoring' type: object arpConfig: items: $ref: '#/components/schemas/IARPConfigContainer' type: object type: array description: type: string enableAntiSpoofing: type: boolean enableDNSLookup: type: boolean enableSGTPropagate: type: boolean enabled: type: boolean fmcAccessConfig: $ref: '#/components/schemas/IFMCAccessConfig' type: object fragmentReassembly: type: boolean id: type: string ifname: type: string ipv4: $ref: '#/components/schemas/IIPv4Container' type: object ipv6: $ref: '#/components/schemas/IIPv6Container' type: object links: $ref: '#/components/schemas/ILinks' type: object macAddressPool: $ref: '#/components/schemas/IReference' type: object macLearn: type: boolean macTable: items: type: string type: array managementOnly: type: boolean metadata: $ref: '#/components/schemas/IMetadata' type: object mode: enum: - INLINE - PASSIVE - TAP - ERSPAN - NONE - SWITCHPORT type: string name: type: string overrideDefaultFragmentSetting: $ref: '#/components/schemas/IOverrideDefaultFragmentSetting' type: object pathMonitoring: $ref: '#/components/schemas/IPathMonitoring' type: object priority: format: int32 type: integer securityZone: $ref: '#/components/schemas/ISecurityZoneObjectModel' type: object standbyMACAddress: type: string type: type: string version: type: string type: object VrfOspfPolicyModelListContainer: properties: items: $ref: '#/components/schemas/VrfOspfPolicyModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object LLUniversalZeroTrustSetting: additionalProperties: $ref: '#/components/schemas/IHybridZeroTrustDeviceSetting' type: object type: object IOspfv3NeighborProperties: properties: neighborCost: $ref: '#/components/schemas/IOspfv3NeighborCost' type: object neighborPriority: $ref: '#/components/schemas/IOspfv3NeighborPriority' type: object type: object IACPolicyIdentityPolicySettings: properties: description: type: string id: type: string identityPolicy: $ref: '#/components/schemas/IReference' type: object links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string type: type: string version: type: string type: object INeighborTransportConnectionMode: properties: establishTCPSession: type: boolean id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string type: type: string type: object ManageDeviceCertificatesRequestModel: properties: action: enum: - ENROLL - RE_ENROLL - REFRESH - DELETE - EXPORT type: string description: type: string deviceCertificates: items: $ref: '#/components/schemas/IDeviceCertificate' type: object type: array id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/TaskMetadata' type: object name: type: string type: type: string version: type: string type: object IApplicationMonitoring: properties: enable: type: boolean monitoredApplications: items: $ref: '#/components/schemas/IApplicationModel' type: object type: array type: object ManagementInterfaceConvergenceListContainer: properties: items: $ref: '#/components/schemas/ManagementInterfaceConvergence' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object VTEPPolicy: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string nveEnable: type: boolean type: type: string version: type: string vtepEntries: items: $ref: '#/components/schemas/IVTEPEntry' type: object type: array type: object IAuthTypeAndString: properties: cryptoEncryptionType: enum: - PLAINTEXT type: string cryptoKeyString: type: string type: object BFDPolicyModelMetaData: properties: domain: $ref: '#/components/schemas/Domain' type: object ipType: enum: - V_4 - V_6 type: string iptype: enum: - V_4 - V_6 type: string isLocked: type: boolean lastUser: $ref: '#/components/schemas/MetadataUser' type: object matches: items: type: string type: array readOnly: $ref: '#/components/schemas/ReadOnly' type: object timestamp: format: int32 type: integer type: object IEigrpAdvertise: description: Contains information about advertised routes. properties: connected: description: Indicates whether to advertise the connected routes or not. Can be TRUE or FALSE. type: boolean redistributed: description: Indicates whether to advertise the redistributed routes or not. Can be TRUE or FALSE. type: boolean static: description: Indicates whether to advertise the static routes or not. Can be TRUE or FALSE. type: boolean summary: description: Indicates whether to advertise the summary routes or not. Can be TRUE or FALSE. type: boolean type: object FTDVTIInterfaceListContainer: properties: items: $ref: '#/components/schemas/FTDVTIInterface' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IOspfHelloMultiplierMechanism: properties: helloMultiplier: format: int32 type: integer neighborDetectionType: type: string type: object IOverride: description: Defines the override details for this object. properties: parent: $ref: '#/components/schemas/IReference' description: Link to the parent/global resource which is overriden. type: object target: $ref: '#/components/schemas/IReference' description: The device or the domain target on which this override is enabled. type: object type: object INetworkAddress: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string type: object IIPv6Container: properties: DHCP: $ref: '#/components/schemas/IIPv6DHCPContainer' type: object addresses: items: $ref: '#/components/schemas/IAddressContainer' type: object type: array dadAttempts: format: int32 type: integer enableAutoConfig: type: boolean enableDADLoopback: type: boolean enableDHCPAddrConfig: type: boolean enableDHCPNonAddrConfig: type: boolean enableIPV6: type: boolean enableRA: type: boolean enforceEUI64: type: boolean linkLocalAddress: type: string nsInterval: format: int32 type: integer pool: $ref: '#/components/schemas/IReference' type: object prefixes: items: $ref: '#/components/schemas/IPrefixContainer' type: object type: array raInterval: format: int32 type: integer raLifeTime: format: int32 type: integer reachableTime: format: int32 type: integer type: object IOspfv3GracefulRestartHelper: properties: enableLSA: type: boolean type: object VrfBGPIPvAddressFamilyModel: description: 'BGP is an inter and intra autonomous system routing protocol. ' properties: addressFamilyIPv4: $ref: '#/components/schemas/IBGPAddressFamilyModel' description: Family Address configuration mode for IPv4 type: object addressFamilyIPv6: $ref: '#/components/schemas/IBGPAddressFamilyModel' description: Family Address configuration mode for IPv6 type: object asNumber: description: Specifies the BGP Autonomous number type: string asNumberVariable: $ref: '#/components/schemas/IReference' type: object clusterPool: $ref: '#/components/schemas/IIPv4AddressPool' type: object description: description: User provided resource description. type: string id: description: Unique identifier (UUID) for the VrfBGPIPvAdressFamily. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata attributes for the VrfBGPIPvAdressFamily type: object name: description: Name of the VrfBGPIPvAdressFamily object type: string routerId: description: Possible values can be null or valid ipv4 address. type: string routerIdVariable: $ref: '#/components/schemas/IReference' type: object type: description: Type of BGP Object type: string version: description: Version number of the response object. type: string required: - routerId - routerIdVariable type: object FPPhysicalInterface: properties: description: type: string enabled: format: int32 type: integer id: type: string interfaceType: enum: - NONE - MANAGEMENT - PASSIVE - INLINE - SWITCHED - ROUTED - HA_LINK - ASA type: string ipAddresses: items: type: string type: array links: $ref: '#/components/schemas/Links' type: object mdi: type: string metadata: $ref: '#/components/schemas/IMetadata' type: object mode: type: string mtu: format: int32 type: integer name: type: string staticArpEntries: items: $ref: '#/components/schemas/IStaticArpEntry' type: object type: array type: type: string version: type: string type: object IOspfDeadIntervalMechanism: properties: deadInterval: format: int32 type: integer helloInterval: format: int32 type: integer neighborDetectionType: type: string type: object IPv4StaticRouteModel: properties: description: type: string gateway: $ref: '#/components/schemas/IHostObjectContainer' type: object id: type: string interfaceName: type: string isTunneled: type: boolean links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object metricValue: format: int32 type: integer name: type: string routeTracking: $ref: '#/components/schemas/ISLAMonitorModel' type: object selectedNetworks: items: $ref: '#/components/schemas/INetworkAddress' type: object type: array type: type: string version: type: string required: - gateway - interfaceName - metricValue - selectedNetworks type: object IStaticMacEntry: properties: interface: $ref: '#/components/schemas/IInterface' type: object mac: type: string type: object VRFInterfaceEntry: properties: id: format: int32 type: integer literal: type: boolean logicalName: type: string name: type: string type: type: string uuid: type: string value: type: string type: object FTDSubInterfaceListContainer: properties: items: $ref: '#/components/schemas/FTDSubInterface' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object DeviceDHCPServerSettingsListContainer: properties: items: $ref: '#/components/schemas/DeviceDHCPServerSettings' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object ISecurityZoneObjectModel: properties: description: type: string devices: items: $ref: '#/components/schemas/IInterfaceDeviceModel' type: object type: array id: type: string interfaceMode: enum: - PASSIVE - INLINE - SWITCHED - ROUTED - ASA type: string interfaces: items: $ref: '#/components/schemas/IFTDInterface' type: object type: array links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object subType: type: string type: type: string version: type: string type: object FTDBridgeGroupInterface: properties: MTU: format: int32 type: integer activeMACAddress: type: string applicationMonitoring: $ref: '#/components/schemas/IApplicationMonitoring' type: object arpConfig: items: $ref: '#/components/schemas/IARPConfigContainer' type: object type: array bridgeGroupId: format: int32 type: integer description: type: string enableAntiSpoofing: type: boolean enableDNSLookup: type: boolean enableSGTPropagate: type: boolean enabled: type: boolean fmcAccessConfig: $ref: '#/components/schemas/IFMCAccessConfig' type: object fragmentReassembly: type: boolean id: type: string ifname: type: string ipAddress: type: string ipv4: $ref: '#/components/schemas/IIPv4Container' type: object ipv6: $ref: '#/components/schemas/IIPv6Container' type: object links: $ref: '#/components/schemas/ILinks' type: object macAddressPool: $ref: '#/components/schemas/IReference' type: object macLearn: type: boolean macTable: items: type: string type: array managementOnly: type: boolean metadata: $ref: '#/components/schemas/IMetadata' type: object mode: enum: - INLINE - PASSIVE - TAP - ERSPAN - NONE - SWITCHPORT type: string name: type: string overrideDefaultFragmentSetting: $ref: '#/components/schemas/IOverrideDefaultFragmentSetting' type: object pathMonitoring: $ref: '#/components/schemas/IPathMonitoring' type: object priority: format: int32 type: integer securityZone: $ref: '#/components/schemas/ISecurityZoneObjectModel' type: object selectedInterfaces: items: $ref: '#/components/schemas/IInterface' type: object type: array standbyMACAddress: type: string type: type: string version: type: string type: object ModelMigrationRequestMetadata: properties: domain: $ref: '#/components/schemas/Domain' type: object isLocked: type: boolean lastUser: $ref: '#/components/schemas/MetadataUser' type: object matches: items: type: string type: array readOnly: $ref: '#/components/schemas/ReadOnly' type: object task: $ref: '#/components/schemas/TaskStatus' type: object timestamp: format: int32 type: integer type: object StaticRouteModelListContainer: properties: items: $ref: '#/components/schemas/StaticRouteModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object VrfOspfInterfacePolicyModelListContainer: properties: items: $ref: '#/components/schemas/VrfOspfInterfacePolicyModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IBGPAddressFamilyModel: properties: aftableMap: $ref: '#/components/schemas/IRouteMap' type: object aggregateAddressesIPv4s: items: $ref: '#/components/schemas/IAggregateAddresses' type: object type: array aggregateAddressesIPv6s: items: $ref: '#/components/schemas/IAggregateAddresses' type: object type: array autoSummary: type: boolean bgpRedistributeInternal: type: boolean bgpSupressInactive: type: boolean defaultInformationOrginate: type: boolean description: type: string distance: $ref: '#/components/schemas/IDistance' type: object distributeLists: items: $ref: '#/components/schemas/IDistributeLists' type: object type: array ebgp: format: int32 type: integer ibgp: format: int32 type: integer id: type: string injectMaps: items: $ref: '#/components/schemas/IRouteInjection' type: object type: array links: $ref: '#/components/schemas/ILinks' type: object maximumPaths: items: $ref: '#/components/schemas/IMaximumPaths' type: object type: array metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string neighbors: items: $ref: '#/components/schemas/INeighbors' type: object type: array networks: items: $ref: '#/components/schemas/IBgpNetworks' type: object type: array redistributeProtocols: items: $ref: '#/components/schemas/IRedistributeProtocolBase' type: object type: array routeImportExport: $ref: '#/components/schemas/IRouteImportExport' type: object synchronization: type: boolean type: type: string version: type: string type: object IIPv4VerifyAvailabilityModel: properties: ip: type: string sequence: format: int32 type: integer track: format: int32 type: integer type: object IRouteMap: properties: description: type: string entries: items: $ref: '#/components/schemas/IRouteMapEntry' type: object type: array id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string required: - entries - name type: object IDeviceInventoryData: properties: cpuCores: type: string cpuType: type: string memoryInMB: type: string storageInGB: type: string type: object DeviceSettingsInterface: properties: id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string type: type: string type: object ChangeConfigManagerFTDRequest: properties: action: enum: - CONFIGURE_DEVICE_VALIDATE - CONFIGURE_DEVICE - CONFIGURE_MANAGER - GENERATE_REPORTS type: string configManagerHost: type: string description: type: string deviceList: items: $ref: '#/components/schemas/IChangeConfigManagerFTDInfo' type: object type: array id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/ChangeConfigManagerFTDMetadata' type: object name: type: string reportOptions: $ref: '#/components/schemas/IChangeConfigManagerFTDReportOptions' type: object type: type: string version: type: string type: object DeviceInventoryData: properties: cpuCores: type: string cpuType: type: string memoryInMB: type: string storageInGB: type: string type: object VirtualSwitchListContainer: properties: items: $ref: '#/components/schemas/VirtualSwitch' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object DeviceSettingsListContainer: properties: items: $ref: '#/components/schemas/DeviceSettings' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object DeviceDHCPServerSettings: properties: autoConfigInterface: $ref: '#/components/schemas/ReferenceObject' type: object description: type: string dhcpOptions: items: $ref: '#/components/schemas/IDHCPOptions' type: object type: array dhcpServers: items: $ref: '#/components/schemas/IDHCPServers' type: object type: array id: type: string leaseLengthInSec: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string pingTimeoutInMs: type: string primaryDNSServer: $ref: '#/components/schemas/ReferenceObject' type: object primaryWINSServer: $ref: '#/components/schemas/ReferenceObject' type: object searchDomain: type: string secondaryDNSServer: $ref: '#/components/schemas/ReferenceObject' type: object secondaryWINSServer: $ref: '#/components/schemas/ReferenceObject' type: object type: type: string version: type: string type: object Domain: description: The details about the domain. properties: id: description: Unique UUID of this domain type: string links: $ref: '#/components/schemas/ILinks' description: Links to the domain resource URLs. type: object name: description: Name of the domain. type: string type: description: Domain type definition (fixed). type: string uuid: type: string type: object IOspfAreaRanges: properties: addressNetwork: $ref: '#/components/schemas/INetworkAddress' type: object advertise: type: boolean type: object IOspfNeighbors: properties: ipAddress: $ref: '#/components/schemas/INetworkAddress' type: object neighborInterface: $ref: '#/components/schemas/IFTDInterface' type: object type: object MetadataUser: description: This object defines details about the user. properties: id: description: The unique UUID of the user type: string links: $ref: '#/components/schemas/ILinks' description: Contains the self referencing links to this resource type: object name: description: Name of the user. type: string type: description: The user type (fixed). type: string type: object TaskMetadata: properties: domain: $ref: '#/components/schemas/Domain' type: object isLocked: type: boolean lastUser: $ref: '#/components/schemas/MetadataUser' type: object matches: items: type: string type: array readOnly: $ref: '#/components/schemas/ReadOnly' type: object task: $ref: '#/components/schemas/TaskStatus' type: object timestamp: format: int32 type: integer type: object FTDBridgeGroupInterfaceListContainer: properties: items: $ref: '#/components/schemas/FTDBridgeGroupInterface' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object DDNSUpdateIntervalModel: properties: day: format: int32 type: integer hourOfTheDay: format: int32 type: integer minute: format: int32 type: integer second: format: int32 type: integer type: object BFDPolicyModelListContainer: properties: items: $ref: '#/components/schemas/BFDPolicyModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IOspfProtocolConfiguration: properties: enableBFD: type: boolean filterOutgoingLSA: type: boolean ignoreMtuMismatch: type: boolean ospfAuthentication: $ref: '#/components/schemas/IOspfAuthentication' type: object ospfInterval: $ref: '#/components/schemas/IOspfInterval' type: object packetCost: format: int32 type: integer priority: format: int32 type: integer ptpNonBroadcast: type: boolean retransmitInterval: format: int32 type: integer transmitDelay: format: int32 type: integer type: object IMetadata: properties: domain: $ref: '#/components/schemas/IDomain' type: object isLocked: type: boolean lastUser: $ref: '#/components/schemas/IMetadataUser' type: object matches: items: type: string type: array readOnly: $ref: '#/components/schemas/IReadonly' type: object timestamp: format: int32 type: integer type: object IApplicationRisk: description: Represents an ApplicationRisk. properties: description: description: Application risk resource description. type: string id: description: Unique identifier for the application risk. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/IMetadata' description: Object representing metadata attributes for the application risk. type: object name: description: Name of the application risk. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on a device or domain. type: object type: description: Type of the response object. This value is always ApplicationRisk. type: string version: description: Version number of the response object. type: string type: object IPv6StaticRouteModel: properties: description: type: string gateway: $ref: '#/components/schemas/IHostObjectContainer' type: object id: type: string interfaceName: type: string isTunneled: type: boolean links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object metricValue: format: int32 type: integer name: type: string selectedNetworks: items: $ref: '#/components/schemas/INetworkAddress' type: object type: array type: type: string version: type: string required: - gateway - interfaceName - metricValue - selectedNetworks type: object Ospfv3PolicyModelListContainer: properties: items: $ref: '#/components/schemas/Ospfv3PolicyModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object FTDEtherChannelInterface: properties: LLDP: $ref: '#/components/schemas/LLDPContainer' type: object MTU: format: int32 type: integer activeMACAddress: type: string applicationMonitoring: $ref: '#/components/schemas/IApplicationMonitoring' type: object arpConfig: items: $ref: '#/components/schemas/IARPConfigContainer' type: object type: array description: type: string enableAntiSpoofing: type: boolean enableDNSLookup: type: boolean enableSGTPropagate: type: boolean enabled: type: boolean erspanFlowId: format: int32 type: integer erspanSourceIP: type: string etherChannelId: format: int32 type: integer fmcAccessConfig: $ref: '#/components/schemas/IFMCAccessConfig' type: object fragmentReassembly: type: boolean hardware: $ref: '#/components/schemas/IHardwareContainer' type: object id: type: string ifname: type: string ipv4: $ref: '#/components/schemas/IIPv4Container' type: object ipv6: $ref: '#/components/schemas/IIPv6Container' type: object lacpMode: enum: - ACTIVE - PASSIVE - 'ON' type: string lacpRate: enum: - DEFAULT - NORMAL - FAST type: string links: $ref: '#/components/schemas/ILinks' type: object loadBalancing: enum: - DST_IP - DST_IP_PORT - DST_PORT - DST_MAC - SRC_IP - SRC_IP_PORT - SRC_PORT - SRC_MAC - SRC_DST_IP - SRC_DST_IP_PORT - SRC_DST_PORT - SRC_DST_MAC - VLAN_DST_IP - VLAN_DST_IP_PORT - VLAN_SRC_IP - VLAN_SRC_IP_PORT - VLAN_SRC_DST_IP - VLAN_SRC_DST_IP_PORT - VLAN_ONLY type: string macAddressPool: $ref: '#/components/schemas/IReference' type: object macLearn: type: boolean macTable: items: type: string type: array managementOnly: type: boolean maxActivePhysicalInterface: format: int32 type: integer metadata: $ref: '#/components/schemas/IMetadata' type: object minActivePhysicalInterface: format: int32 type: integer mode: enum: - INLINE - PASSIVE - TAP - ERSPAN - NONE - SWITCHPORT type: string name: type: string nveOnly: type: boolean overrideDefaultFragmentSetting: $ref: '#/components/schemas/IOverrideDefaultFragmentSetting' type: object pathMonitoring: $ref: '#/components/schemas/IPathMonitoring' type: object priority: format: int32 type: integer securityZone: $ref: '#/components/schemas/ISecurityZoneObjectModel' type: object selectedInterfaces: items: $ref: '#/components/schemas/IInterface' type: object type: array standbyMACAddress: type: string type: type: string version: type: string type: object IEigrpAdministrativeDistance: description: Used for configuring the administrative distance for a route. properties: external: description: Administrative distance for external routing.Can be a number ranging from 1-255. format: int32 type: integer internal: description: Administrative distance for internal routing.Can be a number ranging from 1-255. format: int32 type: integer type: object IDHCPRelayServerConfig: properties: clientsideInterfaces: items: $ref: '#/components/schemas/DeviceSettingsInterface' type: object type: array description: type: string id: type: string interface: $ref: '#/components/schemas/ReferenceObject' type: object links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string server: $ref: '#/components/schemas/ReferenceObject' type: object type: type: string version: type: string type: object HealthAlertConfig: properties: enabled: type: boolean name: type: string thresholds: items: $ref: '#/components/schemas/HealthThreshold' type: object type: array type: object ChangeConfigManagerFTDMetadata: properties: domain: $ref: '#/components/schemas/Domain' type: object isLocked: type: boolean lastUser: $ref: '#/components/schemas/MetadataUser' type: object matches: items: type: string type: array readOnly: $ref: '#/components/schemas/ReadOnly' type: object task: $ref: '#/components/schemas/TaskStatus' type: object timestamp: format: int32 type: integer type: object Snort3IPSReferenceObject: properties: id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string type: type: string value: type: string type: object Commands: properties: commandInput: type: string commandOutput: type: string description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string type: type: string version: type: string type: object IAdvanced: properties: enableOGS: type: boolean type: object Ospfv3RedistributionEntry: properties: attributes: $ref: '#/components/schemas/Attributes' type: object description: type: string enabled: type: boolean id: format: int32 type: integer l2SwitchingEnabled: type: boolean literal: type: boolean mandatory: type: boolean name: type: string opType: type: string ospfv3BGPPID: type: string ospfv3IncludeConnected: type: boolean ospfv3MetricType: enum: - NONE - _1 - _2 type: string ospfv3MetricValue: format: int32 type: integer ospfv3RePID: format: int32 type: integer ospfv3RouteMap: $ref: '#/components/schemas/ObjectEntry' type: object ospfv3RouteMatchExternal1: type: boolean ospfv3RouteMatchExternal2: type: boolean ospfv3RouteMatchInternal: type: boolean ospfv3RouteMatchNssa1: type: boolean ospfv3RouteMatchNssa2: type: boolean ospfv3RouteType: enum: - CONNECTED - OSPF - STATIC - BGP type: string ospfv3TagValue: format: int32 type: integer position: format: int32 type: integer readOnly: type: boolean subType: type: string tooltip: type: string type: type: string userAction: type: string uuid: type: string value: type: string type: object IApplicationType: description: Represents an ApplicationType. properties: description: description: Application type resource description. type: string id: description: Unique identifier for the application type. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/IMetadata' description: Object representing metadata attributes for the application type. type: object name: description: Name of the application type. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on a device or domain. type: object type: description: Type of the response object. This value is always ApplicationType. type: string version: description: Version number of the response object. type: string type: object Ospfv3AreaEntry: properties: attributes: $ref: '#/components/schemas/Attributes' type: object description: type: string enabled: type: boolean id: format: int32 type: integer l2SwitchingEnabled: type: boolean literal: type: boolean mandatory: type: boolean name: type: string opType: type: string ospfv3AreaDefaultCost: format: int32 type: integer ospfv3AreaDefaultInformation: type: boolean ospfv3AreaId: type: string ospfv3AreaMetricType: enum: - _1 - _2 type: string ospfv3AreaMetricValue: format: int32 type: integer ospfv3AreaNoRedistribution: type: boolean ospfv3AreaType: enum: - NORMAL - NSSA - STUB type: string ospfv3AreaTypeSummary: type: boolean position: format: int32 type: integer readOnly: type: boolean routeSummaryList: items: $ref: '#/components/schemas/Ospfv3AreaRouteSummaryEntry' type: object type: array subType: type: string tooltip: type: string type: type: string userAction: type: string uuid: type: string value: type: string virtualLinkList: items: $ref: '#/components/schemas/Ospfv3AreaVirtualLinkEntry' type: object type: array type: object Ospfv3PassiveInterfaceEntry: properties: attributes: $ref: '#/components/schemas/Attributes' type: object description: type: string enabled: type: boolean id: format: int32 type: integer l2SwitchingEnabled: type: boolean literal: type: boolean mandatory: type: boolean name: type: string opType: type: string ospfv3PassiveInterface: $ref: '#/components/schemas/ObjectEntry' type: object ospfv3pIntfProcessId: format: int32 type: integer position: format: int32 type: integer readOnly: type: boolean subType: type: string tooltip: type: string type: type: string userAction: type: string uuid: type: string value: type: string type: object VirtualAccessInterfaceListContainer: properties: items: $ref: '#/components/schemas/VirtualAccessInterface' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IActionInfo: type: object IOspfv3Timers: properties: floodPacing: format: int32 type: integer lsaArrival: format: int32 type: integer lsaGroup: format: int32 type: integer lsaThrottleTimer: $ref: '#/components/schemas/ILsaThrottleTimer' type: object retransmission: format: int32 type: integer spfThrottleTimer: $ref: '#/components/schemas/ISpfThrottleTimer' type: object type: object IIPv6DHCPContainer: properties: clientPd: $ref: '#/components/schemas/IIPv6ClientPdContainer' type: object enableDHCPClient: type: boolean ipv6DHCPPool: $ref: '#/components/schemas/IDHCPIPv6Pool' type: object ipv6Prefixes: items: $ref: '#/components/schemas/IIPv6PrefixContainer' type: object type: array obtainIPV6DefaultRouteDHCP: type: boolean type: object VrfBFDPolicyModelListContainer: properties: items: $ref: '#/components/schemas/VrfBFDPolicyModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IDeviceImportExportOptions: properties: changeDeviceBeforeImport: type: boolean conflictOption: enum: - NEW - LATEST - RENAME_IMPORTED - REPLACE_EXISTING - KEEP_EXISTING - REUSE_EXISTING type: string includeDeviceCertificates: type: boolean includeS2sVpnPoliciesOnly: type: boolean includeSharedPolicies: type: boolean includeVpnPolicies: type: boolean options: $ref: '#/components/schemas/IDeviceImportExportRequestOptions' type: object url: type: string type: object EigrpDistributionListModel: description: Contains criteria for filtering EIGRP updates. properties: accessList: $ref: '#/components/schemas/ReferenceObject' description: The list defines which networks are to be received and which are to be suppressed in routing updates. type: object deviceInterface: $ref: '#/components/schemas/IFTDInterface' description: Specify the interface to which the filtering rule applies. type: object filterDirection: description: 'The rule filters default route information from incoming or outgoing EIGRP routing updates. Can be any one of the following: (INBOUND or OUTBOUND).' enum: - INBOUND - OUTBOUND type: string policyId: type: string processId: description: This represents the AS number in case protocol is selected as BGP and Process ID in case the protocol selected as OSPF. type: string protocol: description: 'Protocol to which the filter should be applied. Can be any one of the following: (STATIC | CONNECTED | RIP | OSPF | BGP).' enum: - CONNECTED - BGP - OSPF - RIP - STATIC type: string type: object FTDEtherChannelInterfaceListContainer: properties: items: $ref: '#/components/schemas/FTDEtherChannelInterface' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IAddressContainer: properties: address: type: string addressVariable: $ref: '#/components/schemas/IReference' type: object enforceEUI64: type: boolean prefix: type: string type: object IInterfaceDeviceModel: properties: description: type: string id: type: string interfaces: items: $ref: '#/components/schemas/IFTDInterface' type: object type: array links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string type: type: string version: type: string type: object IOspfv3NeighborPriority: properties: pollInterval: format: int32 type: integer priority: format: int32 type: integer type: object DeviceImportExportMetadata: properties: checksum: type: string domain: $ref: '#/components/schemas/Domain' type: object downloadUrl: type: string isLocked: type: boolean lastUser: $ref: '#/components/schemas/MetadataUser' type: object matches: items: type: string type: array readOnly: $ref: '#/components/schemas/ReadOnly' type: object task: $ref: '#/components/schemas/TaskStatus' type: object timestamp: format: int32 type: integer type: object ModelMigration: properties: assignSharedPolicies: type: boolean description: type: string id: type: string ignoreWarning: type: string interfaceMapping: items: $ref: '#/components/schemas/IDeviceConfigInterfaceMapping' type: object type: array links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/ModelMigrationRequestMetadata' type: object name: type: string overrideableInterfaceAttributesMode: enum: - OVERRIDE_TARGET_VALUES - RETAIN_TARGET_VALUES type: string sourceDevice: $ref: '#/components/schemas/ITarget' type: object targetDevice: $ref: '#/components/schemas/ITarget' type: object type: type: string validateOnly: type: boolean version: type: string type: object VirtualRouterModelListContainer: properties: items: $ref: '#/components/schemas/VirtualRouterModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IOspfAuthentication: properties: areaAuth: $ref: '#/components/schemas/IOspfAreaAuth' type: object keyChain: $ref: '#/components/schemas/IOspfKeyChainAuth' type: object md5AuthList: items: $ref: '#/components/schemas/IOspfMD5Auth' type: object type: array passwdAuth: $ref: '#/components/schemas/IOspfPasswdAuth' type: object type: object IVTEPEntry: properties: nveDestinationPort: format: int32 type: integer nveEncapsulationType: enum: - VXLAN - GENEVE type: string nveNeighborAddress: $ref: '#/components/schemas/INetworkObjectContainer' type: object nveNeighborDiscoveryType: enum: - DEFAULT_MULTICAST_GROUP - STATIC_PEER_GROUP - STATIC_PEER_IP - NONE type: string nveVtepId: format: int32 type: integer sourceInterface: $ref: '#/components/schemas/IFTDInterface' type: object type: object FTDVNIInterface: properties: MTU: format: int32 type: integer activeMACAddress: type: string applicationMonitoring: $ref: '#/components/schemas/IApplicationMonitoring' type: object arpConfig: items: $ref: '#/components/schemas/IARPConfigContainer' type: object type: array description: type: string enableAntiSpoofing: type: boolean enableDNSLookup: type: boolean enableProxy: type: boolean enableSGTPropagate: type: boolean enabled: type: boolean externalPort: format: int32 type: integer externalSegmentId: format: int32 type: integer fmcAccessConfig: $ref: '#/components/schemas/IFMCAccessConfig' type: object fragmentReassembly: type: boolean id: type: string ifname: type: string internalPort: format: int32 type: integer internalSegmentId: format: int32 type: integer ipv4: $ref: '#/components/schemas/IIPv4Container' type: object ipv6: $ref: '#/components/schemas/IIPv6Container' type: object links: $ref: '#/components/schemas/ILinks' type: object macAddressPool: $ref: '#/components/schemas/IReference' type: object macLearn: type: boolean macTable: items: type: string type: array managementOnly: type: boolean metadata: $ref: '#/components/schemas/IMetadata' type: object mode: enum: - INLINE - PASSIVE - TAP - ERSPAN - NONE - SWITCHPORT type: string multicastGroupAddress: type: string name: type: string overrideDefaultFragmentSetting: $ref: '#/components/schemas/IOverrideDefaultFragmentSetting' type: object pathMonitoring: $ref: '#/components/schemas/IPathMonitoring' type: object priority: format: int32 type: integer proxyType: enum: - SINGLE_ARM - DUAL_ARM - PAIRED type: string securityZone: $ref: '#/components/schemas/ISecurityZoneObjectModel' type: object segmentId: format: int32 type: integer standbyMACAddress: type: string type: type: string version: type: string vniId: format: int32 type: integer vtepID: format: int32 type: integer type: object VrfPBRPolicyModel: properties: description: type: string forwardingActions: items: $ref: '#/components/schemas/IPbrForwardingActionModel' type: object type: array id: type: string ingressInterfaces: items: $ref: '#/components/schemas/IFTDInterface' type: object type: array links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string type: type: string version: type: string type: object Ospfv3AreaVirtualLinkEntry: properties: attributes: $ref: '#/components/schemas/Attributes' type: object description: type: string enabled: type: boolean id: format: int32 type: integer l2SwitchingEnabled: type: boolean literal: type: boolean mandatory: type: boolean name: type: string opType: type: string ospfv3VLDeadInterval: format: int32 type: integer ospfv3VLHelloInterval: format: int32 type: integer ospfv3VLRetransmitInterval: format: int32 type: integer ospfv3VLRouterId: $ref: '#/components/schemas/ObjectEntry' type: object ospfv3VLTTLSecurity: format: int32 type: integer ospfv3VLTransmitDelay: format: int32 type: integer position: format: int32 type: integer readOnly: type: boolean subType: type: string tooltip: type: string type: type: string userAction: type: string uuid: type: string value: type: string type: object IOspfArea: properties: areaId: type: string areaNetworks: items: $ref: '#/components/schemas/INetworkAddress' type: object type: array areaRanges: items: $ref: '#/components/schemas/IOspfAreaRanges' type: object type: array areaType: $ref: '#/components/schemas/IOspfAreaType' type: object authentication: enum: - PASSWORD - MESSAGE_DIGEST type: string defaultCost: format: int32 type: integer filterList: items: $ref: '#/components/schemas/IOspfFilterList' type: object type: array virtualLinks: items: $ref: '#/components/schemas/IOspfVirtualLinks' type: object type: array type: object InlineSet: properties: bypass: type: boolean description: type: string failOpenSnortBusy: type: boolean failOpenSnortDown: type: boolean failSafe: type: boolean failopen: type: boolean id: type: string inlinepairs: items: $ref: '#/components/schemas/IInlinePair' type: object type: array links: $ref: '#/components/schemas/Links' type: object loadBalancingMode: type: string loadBalancingModeVlan: type: string macFiltering: type: boolean metadata: $ref: '#/components/schemas/IMetadata' type: object mtu: format: int32 type: integer name: type: string propogateLinkState: type: boolean standBy: type: boolean strictTCPEnforcement: type: boolean tapMode: type: boolean type: type: string version: type: string type: object INetworkObjectsContainer: properties: literals: items: $ref: '#/components/schemas/INetworkAddressLiteral' type: object type: array objects: items: $ref: '#/components/schemas/INetworkBase' type: object type: array type: object IFMCAccessConfig: properties: allowedNetworks: items: $ref: '#/components/schemas/INetworkAddress' type: object type: array enableAccess: type: boolean type: object IReadonly: properties: reason: enum: - RBAC - SYSTEM - DOMAIN type: string state: type: boolean type: object INeighborRouteMap: properties: filterUpdateAction: enum: - IN - OUT type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string routeMap: $ref: '#/components/schemas/IRouteMap' type: object type: type: string type: object IHybridZeroTrustDeviceSetting: properties: autoDeployEnabled: type: boolean domainSettings: items: $ref: '#/components/schemas/IHybridZeroTrustFQDNConfig' type: object type: array universalZeroTrustEnabled: type: boolean type: object ISpfThrottleTimer: properties: initialDelay: format: int32 type: integer maximumWaitTime: format: int32 type: integer minimumHoldTime: format: int32 type: integer type: object IMaximumPaths: properties: ibgp: type: boolean id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string type: type: string value: format: int32 type: integer type: object SseProxyData: properties: id: type: string name: type: string type: object ILinks: description: This defines the self referencing links for the given resource. properties: parent: description: Full resource URL path to reference the parent (if any) for this resource. type: string self: description: Full resource URL path to reference this particular resource. type: string type: object IEigrpInterfaceTimer: description: Contains EIGRP Interface timer information properties: delay: description: Throughput delay (tens of microseconds) format: int32 type: integer helloInterval: description: Interval- in seconds between hello transmissions format: int32 type: integer holdTime: description: Hold time - in seconds before neighbor is considered down format: int32 type: integer type: object HealthThreshold: properties: type: type: string value: format: int32 type: integer type: object IApplicationModel: description: Represents an ApplicationModel containing Application Types, Tags, Productivity, Risk, and Categories. properties: appId: description: Application Identifier stored in internal database (VDB). format: int32 type: integer applicationTypes: description: List of objects representing application types. items: $ref: '#/components/schemas/IApplicationType' type: object type: array categories: description: List of objects representing application categories. items: $ref: '#/components/schemas/IApplicationCategory' type: object type: array deprecated: description: Boolean representing if the application has been deprecated. type: boolean description: description: Application resource description. type: string id: description: Unique identifier (UUID) for the application. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/IMetadata' description: Object representing metadata attributes for the application model. type: object name: description: Name of the application. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on a device or domain. type: object productivity: $ref: '#/components/schemas/IApplicationProductivity' description: The application productivity associated with this application. type: object risk: $ref: '#/components/schemas/IApplicationRisk' description: The application risk associated with this application. type: object tags: description: List of objects representing application tags. items: $ref: '#/components/schemas/IApplicationTag' type: object type: array type: description: Type of the response object. This value is always Application. type: string version: description: Version number of the response object. type: string type: object FTDVNIInterfaceListContainer: properties: items: $ref: '#/components/schemas/FTDVNIInterface' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IOspfv3Neighbor: properties: configurations: items: $ref: '#/components/schemas/IOspfv3NeighborConfiguration' type: object type: array deviceInterface: $ref: '#/components/schemas/IFTDInterface' type: object required: - configurations - deviceInterface type: object OspfPolicyModelListContainer: properties: items: $ref: '#/components/schemas/OspfPolicyModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object ICertificateDetails: properties: certificate: $ref: '#/components/schemas/IReference' type: object exportOptions: $ref: '#/components/schemas/IDeviceCertificateExportOptions' type: object type: object IStandardACLEntry: description: Standard Access List entry properties: action: description: 'Indicate the redistribution access: PERMIT or DENY' enum: - PERMIT - DENY type: string networks: $ref: '#/components/schemas/INetworkObjectsContainer' description: The network objects/groups assoicated with this object type: object required: - action - networks type: object InterfaceEventListContainer: properties: items: $ref: '#/components/schemas/InterfaceEvent' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object LLForm: additionalProperties: type: string type: object IHostObjectContainer: properties: literal: $ref: '#/components/schemas/INetworkAddressLiteral' type: object object: $ref: '#/components/schemas/IHost' type: object type: object IBaseDevice: properties: accessPolicy: $ref: '#/components/schemas/IPolicyModel' type: object advanced: $ref: '#/components/schemas/IAdvanced' type: object description: type: string healthMessage: type: string healthPolicy: $ref: '#/components/schemas/IHealthPolicy' type: object healthStatus: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object model: type: string modelId: type: string modelNumber: type: string modelType: type: string name: type: string role: type: string status: type: string sw_version: type: string type: type: string version: type: string type: object LTPDeviceRecordListContainer: properties: items: $ref: '#/components/schemas/LTPDeviceRecord' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object DeviceListContainer: properties: items: $ref: '#/components/schemas/Device' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IOspfVirtualLinks: properties: authentication: $ref: '#/components/schemas/IOspfAuthentication' type: object deadInterval: format: int32 type: integer helloInterval: format: int32 type: integer id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string retransmitInterval: format: int32 type: integer routerId: type: string transmitDelay: format: int32 type: integer type: type: string type: object IHardwareContainer: properties: autoNegState: type: boolean duplex: enum: - AUTO - FULL - HALF type: string fecMode: enum: - AUTO - CL108RS - CL74FC - CL91RS - DISABLE type: string flowControlSend: enum: - 'ON' - 'OFF' type: string speed: enum: - AUTO - TEN - HUNDRED - THOUSAND - TWO_THOUSAND_FIVE_HUNDRED - TEN_THOUSAND - TWENTY_FIVE_THOUSAND - FORTY_THOUSAND - HUNDRED_THOUSAND - TWO_HUNDRED_THOUSAND - FOUR_HUNDRED_THOUSAND - DETECT_SFP type: string type: object IDDNSInterfaceSettingModel: properties: description: type: string dhcpClientRequestType: enum: - NOT_SELECTED - NO_UPDATE - ONLY_PTR - BOTH_A_AND_PTR_RECORD type: string dynamicDDNSUpdateType: enum: - NOT_SELECTED - ONLY_PTR - BOTH_A_AND_PTR_RECORD type: string hostname: type: string hostnameVariable: $ref: '#/components/schemas/IReference' type: object id: type: string interface: $ref: '#/components/schemas/ReferenceObject' type: object links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string overrideDHCPClientRequest: type: boolean type: type: string updateMethodName: type: string version: type: string type: object IOspfAreaType: properties: id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string noRedistribution: type: boolean noSummary: type: boolean routeMetric: $ref: '#/components/schemas/IOspfRouteMetric' type: object type: type: string type: object IAdvertisement: properties: autoConfig: type: boolean offlink: type: boolean preferLifeTime: $ref: '#/components/schemas/PreferLifeTime' type: object type: object IRouteInjection: properties: copyAttributes: type: boolean existMap: $ref: '#/components/schemas/IRouteMap' type: object id: type: string injectMap: $ref: '#/components/schemas/IRouteMap' type: object links: $ref: '#/components/schemas/ILinks' type: object name: type: string type: type: string type: object IEigrpPassiveInterfaceModel: description: Contains attributes related to Passive interfaces. properties: allInterfaces: description: Enable all the routable interfaces not to take part in EIGRP routing process.Can be TRUE or FALSE. type: boolean selectedInterfaces: description: Provide the list of interfaces which are not to take part in EIGRP routing process. items: $ref: '#/components/schemas/IFTDInterface' type: object type: array type: object ReferenceObject: properties: id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string type: type: string type: object FTDPhysicalInterface: properties: LLDP: $ref: '#/components/schemas/LLDPContainer' type: object MTU: format: int32 type: integer activeMACAddress: type: string applicationMonitoring: $ref: '#/components/schemas/IApplicationMonitoring' type: object arpConfig: items: $ref: '#/components/schemas/IARPConfigContainer' type: object type: array channelGroupId: format: int32 type: integer description: type: string enableAntiSpoofing: type: boolean enableDNSLookup: type: boolean enableSGTPropagate: type: boolean enabled: type: boolean erspanFlowId: format: int32 type: integer erspanSourceIP: type: string fmcAccessConfig: $ref: '#/components/schemas/IFMCAccessConfig' type: object fragmentReassembly: type: boolean hardware: $ref: '#/components/schemas/IHardwareContainer' type: object id: type: string ifname: type: string ipv4: $ref: '#/components/schemas/IIPv4Container' type: object ipv6: $ref: '#/components/schemas/IIPv6Container' type: object isRedundantMember: type: boolean lacpMode: enum: - ACTIVE - PASSIVE - 'ON' type: string links: $ref: '#/components/schemas/ILinks' type: object macAddressPool: $ref: '#/components/schemas/IReference' type: object macLearn: type: boolean macTable: items: type: string type: array managementOnly: type: boolean metadata: $ref: '#/components/schemas/IMetadata' type: object mode: enum: - INLINE - PASSIVE - TAP - ERSPAN - NONE - SWITCHPORT type: string name: type: string nveOnly: type: boolean overrideDefaultFragmentSetting: $ref: '#/components/schemas/IOverrideDefaultFragmentSetting' type: object pathMonitoring: $ref: '#/components/schemas/IPathMonitoring' type: object powerOverEthernet: $ref: '#/components/schemas/IPoeConfig' type: object priority: format: int32 type: integer securityZone: $ref: '#/components/schemas/ISecurityZoneObjectModel' type: object standbyMACAddress: type: string switchPortConfig: $ref: '#/components/schemas/ISwitchPortConfig' type: object type: type: string version: type: string type: object INeighborHops: properties: disableConnectedCheck: type: boolean id: type: string links: $ref: '#/components/schemas/ILinks' type: object maxHopCount: format: int32 type: integer name: type: string neighborTtlSecurityHops: format: int32 type: integer type: type: string type: object IInterfaceObjectModel: properties: description: type: string devices: items: $ref: '#/components/schemas/IInterfaceDeviceModel' type: object type: array id: type: string interfaces: items: $ref: '#/components/schemas/IFTDInterface' type: object type: array links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string type: object IPv6StaticRouteModelListContainer: properties: items: $ref: '#/components/schemas/IPv6StaticRouteModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IOspfv3GracefulRestart: properties: gracefulRestartInterval: format: int32 type: integer type: object VrfIPv6StaticRouteModelListContainer: properties: items: $ref: '#/components/schemas/VrfIPv6StaticRouteModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object VrfStaticRouteModelListContainer: properties: items: $ref: '#/components/schemas/VrfStaticRouteModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object ErrorMessagesContainer: properties: bulkPayloadIndex: description: More details about the error. type: string code: description: More details about the error. type: string description: description: More details about the error. type: string details: description: More details about the error. type: string errorCode: description: More details about the error. type: string location: description: More details about the error. type: string severity: description: Specifies the Highest level severity among all the error messages. enum: - ERROR - WARN type: string type: object Ospfv3PolicyModel: properties: areas: items: $ref: '#/components/schemas/IOspfv3Area' type: object type: array description: type: string enableOspfv3: type: boolean id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string ospfv3ProcessEntry: $ref: '#/components/schemas/Ospfv3ProcessEntry' type: object ospfv3Role: type: string processConfiguration: $ref: '#/components/schemas/IOspfv3ProcessModel' type: object processId: format: int32 type: integer redistributeProtocols: items: $ref: '#/components/schemas/IRedistributeProtocolBase' type: object type: array summaryPrefix: items: $ref: '#/components/schemas/IOspfv3SummaryPrefix' type: object type: array type: type: string version: type: string required: - enableOspfv3 type: object Duration: properties: preferLifeTime: format: int32 type: integer validLifeTime: format: int32 type: integer type: object Ospfv3InterfaceNeighborEntry: properties: attributes: $ref: '#/components/schemas/Attributes' type: object description: type: string enabled: type: boolean id: format: int32 type: integer l2SwitchingEnabled: type: boolean literal: type: boolean mandatory: type: boolean name: type: string opType: type: string ospfv3NeighborCost: format: int32 type: integer ospfv3NeighborDatabaseFilter: type: boolean ospfv3NeighborIP: type: string ospfv3NeighborIntfName: $ref: '#/components/schemas/ObjectEntry' type: object ospfv3NeighborPollInterval: format: int32 type: integer ospfv3NeighborPriority: format: int32 type: integer ospfv3NeighborType: type: string position: format: int32 type: integer readOnly: type: boolean subType: type: string tooltip: type: string type: type: string userAction: type: string uuid: type: string value: type: string type: object LLHeaders: additionalProperties: type: string type: object VTEPPolicyListContainer: properties: items: $ref: '#/components/schemas/VTEPPolicy' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IDeviceGroup: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object members: items: $ref: '#/components/schemas/IBaseDevice' type: object type: array metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string type: type: string version: type: string type: object ExpirationLifeTime: properties: preferDateTime: type: string validDateTime: type: string type: object IBGPGSBestPath: properties: alwaysCompareMed: type: boolean bestPathCompareRouterId: type: boolean bestPathMedMissingAsWorst: type: boolean defaultLocalPreferenceValue: format: int32 type: integer deterministicMed: type: boolean id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string type: type: string type: object FTDLoopbackInterfaceListContainer: properties: items: $ref: '#/components/schemas/FTDLoopbackInterface' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object VrfOspfInterfacePolicyModel: properties: description: type: string deviceInterface: $ref: '#/components/schemas/IFTDInterface' type: object id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string ospfProtocolConfiguration: $ref: '#/components/schemas/IOspfProtocolConfiguration' type: object type: type: string version: type: string type: object FTDVlanInterfaceListContainer: properties: items: $ref: '#/components/schemas/FTDVlanInterface' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IPrefixContainer: properties: address: type: string addressVariable: $ref: '#/components/schemas/IReference' type: object advertisement: $ref: '#/components/schemas/IAdvertisement' type: object default: type: boolean type: object BGPGeneralSettingModel: description: BGP is an inter and intra autonomous system routing protocol. properties: aggregateTimer: description: Integer stating Interval at which BGP routes will be aggregated or to disable timer-based router aggregation. format: int32 type: integer asNumber: description: Integer specifying the BGP Autonomous number type: string asNumberVariable: $ref: '#/components/schemas/IReference' type: object asnotationDot: description: Boolean stating default display and regular expression match format of BGP 4-byte autonomous system numbers from asplain (decimal values) to dot notation. type: boolean bestPath: $ref: '#/components/schemas/IBGPGSBestPath' description: Object specifying the AS about which path has preference to exist the AS in other to reach a certain network type: object bgpGracefulRestart: $ref: '#/components/schemas/IBGPGSGracefulRestart' description: Object representing the graceful Restart capability type: object bgpNextHopTriggerDelay: description: Integer to set the delay to tigger nexthop tracking format: int32 type: integer bgpNextHopTriggerEnable: description: Boolean stating whetther to enable BGP next-hop address tracking immediately type: boolean bgptimers: $ref: '#/components/schemas/IBGPGSTimers' description: Object to adjust BGP network timers type: object clusterPool: $ref: '#/components/schemas/IIPv4AddressPool' type: object description: description: User provided resource description. type: string enforceFirstAs: description: Boolean stating whether to discard updates received from an external BGP (eBGP) peers that do not list their autonomous system (AS) number. type: boolean fastExternalFallOver: type: boolean id: description: Unique identifier (UUID) for the BGP. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object logNeighborChanges: description: Boolean stating whether to enable logging when the status of BGP neighbor changes. type: boolean maxasLimit: description: Integer stating the range to discard routes that have as-path segments that exceed a specified value. format: int32 type: integer metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata attributes for the BGP. type: object name: description: Name of the BGP object type: string routerId: description: String value for the routerID.Possible values can be "AUTOMATIC" or valid ipv4 address type: string routerIdVariable: $ref: '#/components/schemas/IReference' type: object scanTime: description: Integer stating Scanning interval of BGP routers for next hop validation. format: int32 type: integer transportPathMtuDiscovery: description: Boolean indicating whether BGP to automatically discover the best TCP path MTU for each BGP session. type: boolean type: description: Type of BGP Object type: string version: description: Version number of the response object. type: string required: - routerId - routerIdVariable type: object IDeviceImportExportRequestOptions: properties: checksum: type: string form: $ref: '#/components/schemas/LLForm' type: object headers: $ref: '#/components/schemas/LLHeaders' type: object type: object CommandsListContainer: properties: items: $ref: '#/components/schemas/Commands' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object FTDRedundantInterface: properties: MTU: format: int32 type: integer activeMACAddress: type: string applicationMonitoring: $ref: '#/components/schemas/IApplicationMonitoring' type: object arpConfig: items: $ref: '#/components/schemas/IARPConfigContainer' type: object type: array description: type: string enableAntiSpoofing: type: boolean enableDNSLookup: type: boolean enableSGTPropagate: type: boolean enabled: type: boolean fmcAccessConfig: $ref: '#/components/schemas/IFMCAccessConfig' type: object fragmentReassembly: type: boolean id: type: string ifname: type: string ipv4: $ref: '#/components/schemas/IIPv4Container' type: object ipv6: $ref: '#/components/schemas/IIPv6Container' type: object links: $ref: '#/components/schemas/ILinks' type: object macAddressPool: $ref: '#/components/schemas/IReference' type: object macLearn: type: boolean macTable: items: type: string type: array managementOnly: type: boolean metadata: $ref: '#/components/schemas/IMetadata' type: object mode: enum: - INLINE - PASSIVE - TAP - ERSPAN - NONE - SWITCHPORT type: string name: type: string nveOnly: type: boolean overrideDefaultFragmentSetting: $ref: '#/components/schemas/IOverrideDefaultFragmentSetting' type: object pathMonitoring: $ref: '#/components/schemas/IPathMonitoring' type: object primaryInterface: $ref: '#/components/schemas/IInterface' type: object priority: format: int32 type: integer redundantId: format: int32 type: integer secondaryInterface: $ref: '#/components/schemas/IInterface' type: object securityZone: $ref: '#/components/schemas/ISecurityZoneObjectModel' type: object standbyMACAddress: type: string type: type: string version: type: string type: object IStandardACL: properties: description: type: string entries: items: $ref: '#/components/schemas/IStandardACLEntry' type: object type: array id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string required: - entries - name type: object IBGPGSGracefulRestart: properties: gracefulRestart: type: boolean gracefulRestartRestartTime: format: int32 type: integer gracefulRestartStalePathTime: format: int32 type: integer id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string type: type: string type: object IBgpNetworks: properties: id: type: string ipv4Address: $ref: '#/components/schemas/INetworkAddress' type: object ipv6Address: $ref: '#/components/schemas/INetworkAddress' type: object links: $ref: '#/components/schemas/ILinks' type: object name: type: string routeMap: $ref: '#/components/schemas/IRouteMap' type: object type: type: string type: object INeighborDefaultOriginate: properties: id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string routeMap: $ref: '#/components/schemas/IRouteMap' type: object type: type: string type: object IDHCPContainer: properties: dhcpRouteMetric: format: int32 type: integer enableDefaultRouteDHCP: type: boolean type: object IOspfLogAdjChanges: properties: logType: enum: - DEFAULT - DETAILED type: string type: object IHealthPolicy: description: Description of Health Policy. properties: basePolicyID: type: string defaultPolicy: type: boolean description: description: Description of Health Policy. type: string healthModules: items: $ref: '#/components/schemas/HealthModule' type: object type: array id: description: Unique identifier (UUID) representing the Health policy. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/IMetadata' description: Object representing metadata attributes for the Health policy. type: object name: description: User-specified name of the Health policy. type: string policyType: type: string setting: $ref: '#/components/schemas/HealthSetting' type: object type: description: Type of the Health policy; this value is always HealthPolicy. type: string version: description: Version number of the response object. type: string type: object EigrpNeighborModel: description: Contains EIGRP neighbor attributes. properties: id: type: string neighborAddress: $ref: '#/components/schemas/ReferenceObject' description: Network object that has the neighbor IP address. type: object neighborInterface: $ref: '#/components/schemas/IFTDInterface' description: The interface through which the neighbor is available. Specify interface name, id and type. type: object type: object OspfInterfacePolicyModelListContainer: properties: items: $ref: '#/components/schemas/OspfInterfacePolicyModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object HybridZeroTrustSetting: properties: autoDeployEnabled: type: boolean description: type: string domainSettings: items: $ref: '#/components/schemas/IHybridZeroTrustFQDNConfig' type: object type: array id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/UZTNADeviceSettingsMetadata' type: object name: type: string sourceNATv4: $ref: '#/components/schemas/IReference' type: object sourceNATv6: $ref: '#/components/schemas/IReference' type: object type: type: string universalZeroTrustEnabled: type: boolean version: type: string type: object HealthSetting: properties: alertEvaluationInterval: format: int32 type: integer certFileContent: type: string certFileName: type: string certFileType: type: string certPassphrase: type: string configType: type: string dataCollectionInterval: format: int32 type: integer dialInHosts: items: $ref: '#/components/schemas/DialHost' type: object type: array dialOutHosts: items: $ref: '#/components/schemas/DialHost' type: object type: array enabledOpenConfig: type: boolean grpcPassword: type: string grpcUsername: type: string readOnly: type: boolean type: object IHealthMonitorMetric: properties: id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string type: type: string unit: type: string value: format: int32 type: integer type: object IDHCPOptions: properties: ascii: type: string description: type: string firstIpAddress: $ref: '#/components/schemas/ReferenceObject' type: object hex: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string optionCode: type: string optionType: enum: - IP - ASCII - HEX type: string secondIpAddress: $ref: '#/components/schemas/IReference' type: object type: type: string version: type: string type: object IReference: description: Contains reference information. properties: id: description: Unique identifier representing resource. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object name: description: User chosen resource name. type: string type: description: Response object associated with resource. type: string type: object ITarget: description: This is the target device. properties: description: type: string id: description: Unique ID of the device. type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: description: Name of the device. type: string type: description: Device type: string version: type: string type: object FTDPhysicalInterfaceListContainer: properties: items: $ref: '#/components/schemas/FTDPhysicalInterface' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object OutOfBandChanges: properties: configCLIDiffLines: type: string configDiffInfo: enum: - OOB_CHANGES_REQUEST_COMPLETED_DEPLOYED_CONFIG_MISSING - OOB_CHANGES_REQUEST_COMPLETED_NO_DIFF_EXISTS - OOB_CHANGES_REQUEST_COMPLETED_DIFF_REPORTED type: string description: type: string id: type: string isOOBAcknowledged: type: boolean links: $ref: '#/components/schemas/ILinks' type: object message: type: string metadata: $ref: '#/components/schemas/OutOfBoundChangesRequestMetadata' type: object name: type: string oobId: type: string oobTaskStatus: type: string oobType: enum: - RBD_CLI - CONFIG_MODE type: string oobaction: enum: - DETECT_OUT_OF_BAND_CHANGES - ACKNOWLEDGE_OUT_OF_BAND_CHANGES type: string type: type: string version: type: string type: object IARPConfigContainer: properties: enableAlias: type: boolean ipAddress: type: string macAddress: type: string type: object INeighborRoutes: properties: advertisementInterval: format: int32 type: integer id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string neighborAdvertiseMaps: items: $ref: '#/components/schemas/INeighborAdvertiseMaps' type: object type: array removePrivateAs: type: boolean type: type: string type: object Ospfv3ProcessEntry: properties: areaList: items: $ref: '#/components/schemas/Ospfv3AreaEntry' type: object type: array attributes: $ref: '#/components/schemas/Attributes' type: object description: type: string enabled: type: boolean id: format: int32 type: integer l2SwitchingEnabled: type: boolean literal: type: boolean mandatory: type: boolean name: type: string opType: type: string ospfv3ClusterPool: $ref: '#/components/schemas/ObjectEntry' type: object ospfv3DefaultRoute: type: boolean ospfv3DefaultRouteMap: $ref: '#/components/schemas/ObjectEntry' type: object ospfv3DefaultRouteMetricType: enum: - _1 - _2 type: string ospfv3DefaultRouteMetricValue: format: int32 type: integer ospfv3DefaultRouteOriginate: type: boolean ospfv3EnableProcess: type: boolean ospfv3ExternalDistance: format: int32 type: integer ospfv3FirstTimerSpfThrottle: format: int32 type: integer ospfv3GracefulLSA: type: boolean ospfv3GracefulRestart: type: boolean ospfv3GracefulRestartHelper: type: boolean ospfv3GracefulRestartInterval: format: int32 type: integer ospfv3IgnoreLsaMospf: type: boolean ospfv3InterAreaDistance: format: int32 type: integer ospfv3InterfaceList: items: $ref: '#/components/schemas/Ospfv3InterfaceCommonEntry' type: object type: array ospfv3IntraAreaDistance: format: int32 type: integer ospfv3LogAdjacencyChangeDetails: type: boolean ospfv3LogAdjacencyChanges: type: boolean ospfv3MaxTimerLsaThrottle: format: int32 type: integer ospfv3MaxTimerSpfThrottle: format: int32 type: integer ospfv3MinTimerLsaThrottle: format: int32 type: integer ospfv3PassiveInterfaceList: items: $ref: '#/components/schemas/Ospfv3PassiveInterfaceEntry' type: object type: array ospfv3ProcessDesc: type: string ospfv3ProcessID: format: int32 type: integer ospfv3ProcessRole: enum: - INTERNAL - ABR - ASBR - ABRANDASBR type: string ospfv3RouterId: type: string ospfv3RouterIdCombo: enum: - AUTOMATIC - IPADDRESS - CLUSTERPOOL type: string ospfv3TimerLSAArrival: format: int32 type: integer ospfv3TimerLSAFloodPacing: format: int32 type: integer ospfv3TimerLSAGroupPacing: format: int32 type: integer ospfv3TimerLSARetransPacing: format: int32 type: integer ospfv3TimerLsaThrottle: format: int32 type: integer ospfv3TimerSpfThrottle: format: int32 type: integer position: format: int32 type: integer readOnly: type: boolean redistributeList: items: $ref: '#/components/schemas/Ospfv3RedistributionEntry' type: object type: array subType: type: string summaryPrefixList: items: $ref: '#/components/schemas/Ospfv3SummaryPrefixEntry' type: object type: array tooltip: type: string type: type: string userAction: type: string uuid: type: string value: type: string type: object IEigrpRouteMetric: description: It contains the bandwidth, load, delay, reliability and MTU values which are used by routing algorithm for selecting or rejecting a routing path for transferring data/traffic. properties: bandwidth: description: Specify the Bandwidth value. Can be a number ranging from 1-4294967295. format: int32 type: integer delay: description: Specify the delay value. Can be a number ranging from 0-4294967295. format: int32 type: integer effectiveBandwidth: description: Specify the Effective Bandwidth value.Can be a number ranging from 1-255. format: int32 type: integer pathMTU: description: Specify the Path MTU value.Can be a number ranging from 1-65535. format: int32 type: integer reliability: description: Specify the Reliability value.Can be a number ranging from 0-255 format: int32 type: integer type: object IFPPhysicalInterface: properties: description: type: string enabled: format: int32 type: integer id: type: string interfaceType: enum: - NONE - MANAGEMENT - PASSIVE - INLINE - SWITCHED - ROUTED - HA_LINK - ASA type: string ipAddresses: items: type: string type: array links: $ref: '#/components/schemas/ILinks' type: object mdi: type: string metadata: $ref: '#/components/schemas/IMetadata' type: object mode: type: string mtu: format: int32 type: integer name: type: string staticArpEntries: items: $ref: '#/components/schemas/IStaticArpEntry' type: object type: array type: type: string version: type: string type: object IInterface: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string type: type: string version: type: string type: object IIPv4Container: properties: dhcp: $ref: '#/components/schemas/IDHCPContainer' type: object pppoe: $ref: '#/components/schemas/IPPPoEContianer' type: object static: $ref: '#/components/schemas/IStaticIPContainer' type: object type: object IOspfFilterRule: properties: accessList: $ref: '#/components/schemas/IStandardACL' type: object inInterface: $ref: '#/components/schemas/IFTDInterface' type: object processId: type: string protocol: enum: - CONNECTED - STATIC - RIP - OSPF - EIGRP - NONE - BGP type: string type: type: string required: - type type: object IDHCPIPv6OtherServerOptions: properties: address: $ref: '#/components/schemas/IDHCPIPv6DNSServer' type: object domainName: $ref: '#/components/schemas/IDHCPIPv6DomainName' type: object option: enum: - NIS - NISP - SIP - SNTP type: string type: object OutOfBoundChangesRequestMetadata: properties: domain: $ref: '#/components/schemas/Domain' type: object downloadUrl: type: string isLocked: type: boolean lastUser: $ref: '#/components/schemas/MetadataUser' type: object matches: items: type: string type: array oobstatus: enum: - DCC_ERROR_CODE001 - DCC_ERROR_CODE002 - DCC_ERROR_CODE003 - DCC_ERROR_CODE004 - DCC_ERROR_CODE005 - DCC_ERROR_CODE006 - DCC_ERROR_CODE007 - DCC_WARN_CODE001 - DCC_WARN_CODE002 - DCC_MSG_CODE001 - DCC_MSG_CODE002 - DCC_MSG_CODE003 - TS_MSG_CODE001 - TS_MSG_CODE002 - TS_MSG_CODE003 - BU_MSG_CODE001 - BU_MSG_CODE002 - BU_MSG_CODE003 - DB_MSG_CODE001 - DB_MSG_CODE002 - DB_MSG_CODE003 - DM_MSG_CODE001 - DM_MSG_CODE002 - DM_MSG_CODE003 - DM_MSG_CODE004 - DM_MSG_CODE005 - DM_MSG_CODE006 - DM_MSG_CODE007 - DM_MSG_CODE008 - DM_MSG_CODE009 - DM_MSG_CODE010 - DM_MSG_CODE011 - HITOCUNT_MSG_CODE001 - HITOCUNT_MSG_CODE002 - HITOCUNT_MSG_CODE003 - HITOCUNT_MSG_CODE004 - POLICYCLONE_MSG_CODE001 - POLICYCLONE_MSG_CODE002 - POLICYCLONE_MSG_CODE003 - POLICYCLONE_MSG_CODE004 - FTD_HA_ENABLE_FAILOVER_IN_PROGRESS - FTD_HA_ENABLE_FAILOVER_SUCCESS - FTD_HA_ENABLE_FAILOVER_FAILURE - FTD_HA_ENABLE_FAILOVER_WARNING - FTD_HA_SWITCH_ACTIVE_IN_PROGRESS - FTD_HA_SWITCH_ACTIVE_SUCCESS - FTD_HA_SWITCH_ACTIVE_FAILURE - FTD_HA_SWITCH_ACTIVE_WARNING - FTD_HA_NO_FAILOVER_IN_PROGRESS - FTD_HA_NO_FAILOVER_SUCCESS - FTD_HA_NO_FAILOVER_FAILURE - FTD_HA_NO_FAILOVER_WARNING - FTD_HA_DUMMY_COMPLETED_ERROR - TARGET_UPGRADE_IN_PROGRESS - TARGET_UPGRADE_SUCCESS - TARGET_UPGRADE_FAILURE - TARGET_UPGRADE_WARNING - TARGET_CANCEL_UPGRADE_IN_PROGRESS - TARGET_CANCEL_UPGRADE_SUCCESS - TARGET_CANCEL_UPGRADE_FAILURE - TARGET_CANCEL_UPGRADE_WARNING - FTD_CLUSTER_NODE_ADDITION_IN_PROGRESS - FTD_CLUSTER_ADDITION_NODE_TO_CLUSTER_IN_PROGRESS - FTD_CLUSTER_NODE_SUCCESSFULLY_ADDED_TO_CLUSTER - FTD_CLUSTER_DATA_NODE_BOOTSTRAP_IN_PROGRESS_FOR_ADDNODE - FTD_CLUSTER_ALL_DEVICES_ADDED_SUCCESSFULLY - FTD_CLUSTER_SOME_DEVICES_ADDED_SUCCESSFULLY - FTD_CLUSTER_ALL_DEVICES_ADDED_FAILED - FTD_CLUSTER_NODE_SUCCESSFULLY_JOINED_TO_CLUSTER - FTD_CLUSTER_NODE_FAILED_TO_JOIN_CLUSTER - FTD_CLUSTER_MASTER_BOOTSTRAP_IN_PROGRESS - FTD_CLUSTER_MASTER_BOOTSTRAP_SUCCESS_SLAVE_BOOTSTRAP_IN_PROGRESS - FTD_CLUSTER_CONTROL_BOOTSTRAP_SUCCESS_WAITING_FOR_NODEJOIN - FTD_CLUSTER_MASTER_BOOTSTRAP_FAILED_AND_SLAVE_BOOTSTRAP_ABORTED - FTD_CLUSTER_MASTER_BOOTSTRAP_TIMEOUT_AND_SLAVE_BOOTSTRAP_ABORTED - FTD_CLUSTER_ALL_DEVICES_BOOTSTRAP_SUCCESS - FTD_CLUSTER_SOME_DEVICES_BOOTSTRAP_SUCCESS - FTD_CLUSTER_MASTER_BOOTSTRAP_SUCCESS - FTD_CLUSTER_MASTER_BOOTSTRAP_ABORTED - FTD_CLUSTER_CONTROL_BOOTSTRAP_INTERRUPTED_BY_SYSYEM_RESTART - FTD_CLUSTER_MASTER_NODEJOIN_FAILED - FTD_CLUSTER_MASTER_NODEJOIN_FAILED_ALL_SLAVES_ABORTED - FTD_CLUSTER_WAITING_FOR_MASTER_BOOTSTRAP_COMPLETION - FTD_CLUSTER_SLAVE_BOOTSTRAP_IN_PROGRESS - FTD_CLUSTER_SLAVE_BOOTSTRAP_SUCCESS - FTD_CLUSTER_SLAVE_BOOTSTRAP_FAILED - FTD_CLUSTER_SLAVE_BOOTSTRAP_TIMEOUT - FTD_CLUSTER_SLAVE_BOOTSTRAP_ABORTED - FTD_CLUSTER_DATA_BOOTSTRAP_INTERRUPTED_BY_SYSTEM_RESTART - FTD_CLUSTER_DATA_BOOTSTRAP_ABORTED_CONTROL_NODEJOIN_FAILURE - FTD_CLUSTER_MASTER_BOOTSTRAP_SUCCESS_ALL_SLAVES_FAILED - FTD_CLUSTER_BREAK_INITIATED_CONTROL - FTD_CLUSTER_BREAK_INITIATED_DATA - FTD_CLUSTER_BREAK_DATA_IN_PROGRESS - FTD_CLUSTER_POST_DATA_BREAK_OPERATION_FAILED - FTD_CLUSTER_DATA_PRE_BREAK_DEPLOY_FAILED - FTD_CLUSTER_DATA_POST_BOOTSTRAP_OPERATION_FAILED - FTD_CLUSTER_DATA_BREAK_SUCCESS - FTD_CLUSTER_DATA_BREAK_DEPLOY_SUCCESS - FTD_CLUSTER_DATA_BREAK_DEPLOY_FAILED - FTD_CLUSTER_CONTROL_BREAK_ABORTED_FEW_DATA_FAILED - FTD_CLUSTER_CONTROL_BREAK_POST_DEPLOY_FAILED_DATA_BREAK_SUCCESS - FTD_CLUSTER_CONTROL_PRE_BREAK_DEPLOY_FAILED_DATA_BREAK_SUCCESS - FTD_CLUSTER_CONTROL_BREAK_DEPLOY_SUCCESS_DATA_BREAK_SUCCESS - FTD_CLUSTER_CONTROL_BREAK_SUCCESS_DATA_BREAK_SUCCESS - FTD_CLUSTER_CONTROL_BREAK_DEPLOY_FAILED_DATA_BREAK_SUCCESS - FTD_CLUSTER_CONTROL_POST_BOOTSTRAP_FAILURE_DATA_ABORTED - FTD_CLUSTER_CONTROL_POST_BOOTSTRAP_FAILURE - FTD_CLUSTER_CONTROL_FAILURE_DATA_FAILURE_CONTAINER_CREATION - FTD_CLUSTER_DATA_FAILURE_CONTAINER_CREATION - FTD_CLUSTER_CONTROL_FAILURE_CONTAINER_CREATION - FTD_CLUSTER_SOME_DEVICES_REMOVED_SUCCESSFULLY - FTD_CLUSTER_ALL_DEVICES_REMOVE_FAILED - FTD_CLUSTER_ALL_DEVICES_REMOVED_SUCCESSFULLY - FTD_CLUSTER_DATA_NODE_REMOVE_INITIATED - FTD_CLUSTER_DATA_NODES_REMOVE_INPROGRESS - FTD_CLUSTER_EDIT_INPROGRESS - FTD_CLUSTER_EDIT_SUCCESS - FTD_CLUSTER_EDIT_DEPLOYMENT_FAILURE - FTD_CLUSTER_EDIT_POST_DEPLOYMENT_FAILURE - FTD_CLUSTER_EDIT_CONTROL_COMPLETE_SOME_DATA_NODE_INPROGRESS - FTD_CLUSTER_EDIT_COMPLETE_ALL_SUCCESS - FTD_CLUSTER_EDIT_COMPLETE_ALL_FAILURE - FTD_CLUSTER_EDIT_COMPLETE_CONTROL_SUCCESS_SOME_DATA_FAILED - FTD_CLUSTER_EDIT_COMPLETE_CONTROL_DEPLOY_AND_SOME_DATA_FAILED - FTD_CLUSTER_EDIT_COMPLETE_CONTROL_POST_DEPLOY_AND_SOME_DATA_FAIL - FTD_CLUSTER_DISABLE_CLUSTER_FAILED_ON_NODE - FTD_CLUSTER_DISABLE_FAILED_ON_ALL_DEVICES - FTD_CLUSTER_CONTROL_BREAK_INTERRUPTED_BY_SYSYEM_RESTART - FTD_CLUSTER_DATA_BREAK_INTERRUPTED_BY_SYSYEM_RESTART - FTD_CLUSTER_DATA_NODE_ADD_INTERRUPTED_BY_SYSTEM_RESTART - FTD_CLUSTER_DATA_NODE_REMOVAL_INTERRUPTED_BY_SYSTEM_RESTART - FTD_CLUSTER_NODE_EDIT_INTERRUPTED_BY_SYSTEM_RESTART - FTD_CLUSTER_CLUSTER_COMMAND_EXEC_INTERRUPTED_BY_SYSTEM_RESTART - FTD_CLUSTER_RECONCILE_STARTED - FTD_CLUSTER_RECONCILE_SUCCEEDED - FTD_CLUSTER_RECONCILE_FAILED - FTD_CLUSTER_COMMAND_STARTED - FTD_CLUSTER_COMMAND_SUCCESS - FTD_CLUSTER_COMMAND_FAILED - SSP_EPM_OIR_FAILED - SSP_EPM_OIR_SUCCESS - DR_REGISTRATION_PENDING - DR_REGISTRATION_IN_PROGRESS - DR_REGISTRATION_FAILED - DR_DISCOVERY_FAILED - DR_DISCOVERY_IN_PROGRESS - DR_DISCOVERY_SUCCESS_DEPLOYMENT_IN_PROGRESS - DR_DEPLOYMENT_FAILED - DR_DEVICE_SUCCESSFULLY_REGISTERED - DR_SFTUNNEL_CONNECTION_SUCCESS - DR_SFTUNNEL_CONNECTION_FAILED - DR_SFTUNNEL_CONNECTION_RETRY - DR_BULK_REGISTRATION_STARTED - DR_CONFIG_IMPORT_PENDING - DR_CONFIG_IMPORT_IN_PROGRESS - DR_CONFIG_IMPORT_FAILED - DR_CONFIG_IMPORT_SUCCESS - DR_DISCOVERY_SUCCESS_AUTO_REG_IN_PROGRESS - DR_AUTO_REG_SUCCESS_DEPLOYMENT_IN_PROGRESS - DR_AUTO_REG_FAILURE - DUR_UNREGISTRATION_IN_PROGRESS - DUR_UNREGISTRATION_SUCCESS - DUR_UNREGISTRATION_FAILED - DUR_BULK_UNREGISTRATION_STARTED - DEVICE_TEMPLATE_SUCCESSFULLY_CREATED - DEVICE_TEMPLATE_CREATION_IN_PROGRESS - DEVICE_TEMPLATE_CONFIG_PROVISION_FAILED - DEVICE_TEMPLATE_CONFIG_PROVISION_IN_PROGRESS - CHANGE_MANAGER_SUCCESS - CHANGE_MANAGER_FAILED - CHANGE_MANAGER_IN_PROGRESS - CHANGE_MANAGER_PENDING - CLUSTER_SWITCH_PRIMARY_IN_PROGRESS - CLUSTER_SWITCH_PRIMARY_SUCCESS - CLUSTER_SWITCH_PRIMARY_FAILURE - CLUSTER_SWITCH_PRIMARY_ABORTED - PENDING_CHANGES_REQUEST_STARTED - PENDING_CHANGES_REQUEST_IN_PROGRESS - PENDING_CHANGES_REQUEST_COMPLETE_ALL_SUCCESS - PENDING_CHANGES_REQUEST_COMPLETE_ALL_FAILED - PENDING_CHANGES_REQUEST_COMPLETE_WITH_PARTIAL_SUCCESS - PENDING_CHANGES_REQUEST_FAILURE - PENDING_CHANGES_REQUEST_COMPLETE_ALL_SKIP - PENDING_CHANGES_REQUEST_FOR_DEVICE_STARTED - PENDING_CHANGES_REQUEST_FOR_DEVICE_IN_PROGRESS - PENDING_CHANGES_REQUEST_FOR_DEVICE_SUCCESS - PENDING_CHANGES_REQUEST_FOR_DEVICE_FAILED - PENDING_CHANGES_REQUEST_CLI_DIFF_IN_PROGRESS - PENDING_CHANGES_REQUEST_POLICY_DIFF_IN_PROGRESS - PENDING_CHANGES_REQUEST_FOR_DEVICE_NO_DIFF_REPORT - OOB_CHANGES_REQUEST_STARTED - OOB_CHANGES_REQUEST_IN_PROGRESS - OOB_DETECTION_COMPLETED_REPORTING_IN_PROGRESS - OOB_CHANGES_REQUEST_COMPLETED_NO_DIFF_TOBE_REPORTED - OOB_CHANGES_REQUEST_REPORTING_COMPLETED - OOB_CHANGES_REQUEST_ACKNOWLEDGED - OOB_CHANGES_REQUEST_FAILED - OOB_CHANGES_REQUEST_COMPLETED_UNABLE_TO_ACCESS_DEPLOYED_CONFIG - DEV_MODEL_MIGRATION_SUCCESS - DEV_MODEL_MIGRATION_PENDING - DEV_MODEL_MIGRATION_FAILURE - NGFW_TEMPLATE_APPLY_SUCCESS - NGFW_TEMPLATE_APPLY_PENDING - NGFW_TEMPLATE_APPLY_FAILURE - DR_DISCOVERY_SUCCESS_NGFW_TEMPLATE_APPLY_INPROGRESS - DR_NGFW_TEMPLATE_APPLY_SUCCESS_DEPLOYMENT_IN_PROGRESS - DR_DISCOVERY_SUCCESS_NGFW_TEMPLATE_APPLY_FAILURE - CHASSIS_TS_TRIGGERED - CHASSIS_TS_GEN_IN_PROGRESS - CHASSIS_TS_GEN_FAILED_INTERNAL_ERROR - CHASSIS_TS_COPY_TO_FMC_STARTED - CHASSIS_TS_COMPLETED - CHASSIS_TS_S3_UPLOAD_FAILED - CHASSIS_TS_COPY_TO_FMC_FAILED - CHASSIS_CONVERSION_STARTED - CHASSIS_CONVERSION_TRIGGERED_ON_DEVICE - CHASSIS_CONVERSION_SUCCESSFUL - CHASSIS_CONVERSION_FAILED - CHASSIS_CONVERSION_BULK_TASK_STARTED - CHASSIS_CONVERSION_BULK_TASK_SUCCESS - CHASSIS_CONVERSION_BULK_TASK_FAILED - CHASSIS_CONVERSION_FAILED_SYSTEM_RESTART - CHASSIS_BULK_CONVERSION_FAILED_SYSTEM_RESTART - SNORT_PROFILER_TRIGGERED - SNORT_PROFILER_IN_PROGRESS - SNORT_PROFILER_COMPLETED - SNORT_PROFILER_INTERNAL_ERROR - CPU_PROFILER_TRIGGERED - CPU_PROFILER_IN_PROGRESS - CPU_PROFILER_COMPLETED - CPU_PROFILER_INTERNAL_ERROR - FLEXCONFIG_MIGRATION_STARTED - FLEXCONFIG_MIGRATION_IN_PROGRESS - FLEXCONFIG_MIGRATION_COMPLETE_ALL_SUCCESS - FLEXCONFIG_MIGRATION_COMPLETE_WITH_ERRORS - FLEXCONFIG_MIGRATION_FAILURE - FLEXCONFIG_MIGRATION_FOR_DEVICE_STARTED - FLEXCONFIG_MIGRATION_FOR_DEVICE_IN_PROGRESS - FLEXCONFIG_MIGRATION_FOR_DEVICE_SUCCESS - FLEXCONFIG_MIGRATION_FOR_DEVICE_FAILED - FTDCLUSTER_DATA_THREAD_INTERRUPTED - FTDCLUSTER_DATA_THREAD_EXECUTION_EXCEPTION - FTDCLUSTER_DATA_THREAD_TIMED_OUT - REPORT_GENERATION_FAILURE - REPORT_GENERATION_PENDING - REPORT_GENERATION_SUCCESS - LTP_ONBOARDING_STARTED - LTP_ONBOARDING_IN_PROGRESS - LTP_ONBOARDING_SUCCESS - LTP_ONBOARDING_FAILED - DEVICE_TEMPLATE_CONVERSION_SUCCESS - DEVICE_TEMPLATE_CONVERSION_PENDING - DEVICE_TEMPLATE_CONVERSION_FAILURE - DEVICE_CERTIFICATE_MANAGEMENT_PENDING - DEVICE_CERTIFICATE_ENROLLMENT_RUNNING - DEVICE_CERTIFICATE_ENROLLMENT_SUCCESS - DEVICE_CERTIFICATE_ENROLLMENT_FAILURE - DEVICE_CERTIFICATE_REFRESH_RUNNING - DEVICE_CERTIFICATE_REFRESH_SUCCESS - DEVICE_CERTIFICATE_REFRESH_FAILURE - DEVICE_CERTIFICATE_DELETE_RUNNING - DEVICE_CERTIFICATE_DELETE_SUCCESS - DEVICE_CERTIFICATE_DELETE_FAILURE - DEVICE_CERTIFICATE_EXPORT_SUCCESS - DEVICE_CERTIFICATE_EXPORT_RUNNING - DEVICE_CERTIFICATE_EXPORT_FAILURE - DEFAULT_DEVICE_TEMPLATE_SUCCESS - DEFAULT_DEVICE_TEMPLATE_CREATION_PENDING - DEFAULT_DEVICE_TEMPLATE_FAILURE type: string readOnly: $ref: '#/components/schemas/ReadOnly' type: object task: $ref: '#/components/schemas/ITaskStatus' type: object taskId: format: int32 type: integer timestamp: format: int32 type: integer type: object InterfaceEvent: properties: action: enum: - SYNC_WITH_DEVICE - ACCEPT_CHANGES type: string change: type: string description: type: string hasPendingChanges: type: boolean id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string state: enum: - DISASSOCIATED - ASSOCIATED - MODIFIED type: string type: type: string version: type: string type: object ISLAMonitorModel: properties: dataSize: format: int32 type: integer description: type: string frequency: format: int32 type: integer id: type: string interfaceNames: items: type: string type: array interfaceObjects: items: $ref: '#/components/schemas/IInterfaceObjectModel' type: object type: array links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object monitorAddress: type: string name: type: string noOfPackets: format: int32 type: integer slaId: format: int32 type: integer threshold: format: int32 type: integer timeout: format: int32 type: integer tos: format: int32 type: integer type: type: string version: type: string required: - interfaceObjects - monitorAddress - slaId type: object IHost: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string value: type: string version: type: string type: object FTDRedundantInterfaceListContainer: properties: items: $ref: '#/components/schemas/FTDRedundantInterface' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object StaticRouteModel: properties: description: type: string gateway: $ref: '#/components/schemas/IHostObjectContainer' type: object id: type: string interfaceName: type: string isTunneled: type: boolean links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object metricValue: format: int32 type: integer name: type: string selectedNetworks: items: $ref: '#/components/schemas/INetworkAddress' type: object type: array type: type: string version: type: string required: - gateway - interfaceName - metricValue - selectedNetworks type: object IDHCPServers: properties: addressPool: type: string addressPoolVariable: $ref: '#/components/schemas/IReference' type: object description: type: string enableDHCP: type: boolean id: type: string interface: $ref: '#/components/schemas/ReferenceObject' type: object links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string type: type: string version: type: string type: object IOspfv3SummaryPrefix: properties: advertise: type: boolean ipv6Prefix: $ref: '#/components/schemas/INetworkAddress' type: object tag: type: string type: object BFDPolicyModel: properties: description: type: string destinationAddress: $ref: '#/components/schemas/ReferenceObject' type: object hopType: enum: - SINGLE_HOP - MULTI_HOP type: string id: type: string interface: $ref: '#/components/schemas/IFTDInterface' type: object links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/BFDPolicyModelMetaData' type: object name: type: string slowTimer: format: int32 type: integer sourceAddress: $ref: '#/components/schemas/ReferenceObject' type: object template: $ref: '#/components/schemas/ReferenceObject' type: object type: type: string version: type: string type: object DeviceDDNSSettingModelListContainer: properties: items: $ref: '#/components/schemas/DeviceDDNSSettingModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IDeviceConfigInterfaceMapping: properties: sourceInterface: $ref: '#/components/schemas/IReference' type: object targetInterface: $ref: '#/components/schemas/ITargetInterface' type: object type: object VrfECMPZoneModel: description: Equal-Cost Multi-Path (ECMP) properties: description: description: Description of Equal-Cost Multi-Path (ECMP) Zone type: string id: description: Unique identifier (UUID) representing the ECMP Zone type: string interfaces: description: List of interfaces to be associated with ECMP Zone items: $ref: '#/components/schemas/IFTDInterface' type: object type: array links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata attributes for the ECMP Zone type: object name: description: ECMP Zone Name type: string type: description: Type of the ECMP Zone. This value is always ecmpzones type: string version: description: Version number of the response object type: string type: object OspfInterfacePolicyModel: properties: description: type: string deviceInterface: $ref: '#/components/schemas/IFTDInterface' type: object id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string ospfProtocolConfiguration: $ref: '#/components/schemas/IOspfProtocolConfiguration' type: object type: type: string version: type: string type: object IIntrusionPolicyModel: properties: basePolicy: $ref: '#/components/schemas/IReference' description: Representing policy details which is used as base for current policy. This field is not present for preprovisioned intrusioned policies. type: object id: description: Intrusion Policy UUID type: string inlineDrop: description: Indicates the inspection mode <0 or 1> format: int32 type: integer inspectionMode: description: Only applicable for SNORT3. Possible values could be DETECTION or PREVENTION enum: - PREVENTION - DETECTION type: string isSystemDefined: type: boolean links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object name: description: Name of the intrusion policy type: string ruleRecommendation: $ref: '#/components/schemas/IRuleRecommendation' type: object snortEngine: description: Possible values could be SNORT2 or SNORT3 enum: - SNORT2 - SNORT3 type: string sseProxyData: $ref: '#/components/schemas/SseProxyData' type: object type: description: Type must be intrusionpolicy type: string type: object VrfBFDPolicyModel: properties: description: type: string destinationAddress: $ref: '#/components/schemas/ReferenceObject' type: object hopType: enum: - SINGLE_HOP - MULTI_HOP type: string id: type: string interface: $ref: '#/components/schemas/IFTDInterface' type: object links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/BFDPolicyModelMetaData' type: object name: type: string slowTimer: format: int32 type: integer sourceAddress: $ref: '#/components/schemas/ReferenceObject' type: object template: $ref: '#/components/schemas/ReferenceObject' type: object type: type: string version: type: string type: object DeviceExport: description: An object that represents the details for device configuration export. properties: description: type: string deviceList: description: UUIDs of devices to be exported. items: type: string type: array exportOptions: $ref: '#/components/schemas/DeviceImportExportOptions' description: Export options. type: object id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/DeviceImportExportMetadata' type: object name: type: string type: type: string version: type: string type: object IOspfPasswdAuth: properties: authKey: type: string authType: type: string type: object IChangeConfigManagerFTDReportDeviceInfo: properties: host: type: string id: type: string lastUpdateTime: type: string license_caps: items: type: string type: array links: $ref: '#/components/schemas/ILinks' type: object name: type: string performanceTier: type: string status: type: string statusMessage: type: string terminalAction: type: string type: type: string type: object PagingContainer: properties: count: format: int32 type: integer limit: format: int32 type: integer offset: format: int32 type: integer pages: format: int32 type: integer type: object EigrpSummaryAddressModel: properties: adminDistance: format: int32 type: integer deviceInterface: $ref: '#/components/schemas/IFTDInterface' type: object policyId: format: int32 type: integer summaryAddress: $ref: '#/components/schemas/ReferenceObject' type: object type: object SelectedInterface: properties: id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string overrideableInterfaceAttributes: $ref: '#/components/schemas/IOverrideableInterfaceAttributes' type: object type: type: string type: object IOspfv3RouteSummary: properties: advertise: type: boolean cost: format: int32 type: integer ipv6Prefix: $ref: '#/components/schemas/INetworkAddress' type: object type: object FTDSubInterface: properties: MTU: format: int32 type: integer activeMACAddress: type: string applicationMonitoring: $ref: '#/components/schemas/IApplicationMonitoring' type: object arpConfig: items: $ref: '#/components/schemas/IARPConfigContainer' type: object type: array description: type: string enableAntiSpoofing: type: boolean enableDNSLookup: type: boolean enableSGTPropagate: type: boolean enabled: type: boolean fmcAccessConfig: $ref: '#/components/schemas/IFMCAccessConfig' type: object fragmentReassembly: type: boolean id: type: string ifname: type: string ipv4: $ref: '#/components/schemas/IIPv4Container' type: object ipv6: $ref: '#/components/schemas/IIPv6Container' type: object links: $ref: '#/components/schemas/ILinks' type: object macAddressPool: $ref: '#/components/schemas/IReference' type: object macLearn: type: boolean macTable: items: type: string type: array managementOnly: type: boolean metadata: $ref: '#/components/schemas/IMetadata' type: object mode: enum: - INLINE - PASSIVE - TAP - ERSPAN - NONE - SWITCHPORT type: string name: type: string overrideDefaultFragmentSetting: $ref: '#/components/schemas/IOverrideDefaultFragmentSetting' type: object pathMonitoring: $ref: '#/components/schemas/IPathMonitoring' type: object priority: format: int32 type: integer securityZone: $ref: '#/components/schemas/ISecurityZoneObjectModel' type: object standbyMACAddress: type: string subIntfId: format: int32 type: integer type: type: string version: type: string vlanId: format: int32 type: integer type: object IDomain: properties: id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string type: type: string type: object IOspfProcessModel: properties: administrativeDistance: $ref: '#/components/schemas/IOspfAdministrativeDistance' type: object clusterPool: $ref: '#/components/schemas/IIPv4AddressPool' type: object defaultInformationOriginate: $ref: '#/components/schemas/IOspfDefaultInfoOriginate' type: object description: type: string id: type: string ignoreLsaMospf: type: boolean links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string nsfGracefulRestart: $ref: '#/components/schemas/IOspfNsfGracefulRestart' type: object rfc1583Compatible: type: boolean routerId: type: string timers: $ref: '#/components/schemas/IOspfTimers' type: object type: type: string version: type: string type: object Device: description: A model representing a Device. properties: accessPolicy: $ref: '#/components/schemas/IPolicyModel' description: Object representing the currently assigned access control policy. You need to specify an existing access control policy when registering a device. type: object actions: items: $ref: '#/components/schemas/IPreDeployAction' type: object type: array advanced: $ref: '#/components/schemas/IAdvanced' description: Object representing Device Advanced Configuration. type: object analyticsOnly: description: Boolean representing whether to register the device only for analytics/events. type: boolean changeManager: type: boolean cloudDeviceId: type: string deploymentStatus: description: Device deployment status type: string description: description: User-specified description of the registered device. type: string deviceGroup: $ref: '#/components/schemas/IDeviceGroup' description: Object representing the device group. type: object ftdMode: description: 'FTD mode (Example: ROUTED or TRANSPARENT)' enum: - ROUTED - TRANSPARENT type: string healthMessage: description: Current health description of the device type: string healthPolicy: $ref: '#/components/schemas/IHealthPolicy' description: Object representing the system health policy applied to the registered device. type: object healthStatus: description: Current health status of the device. type: string hostName: description: Hostname or IP address of the device. If the device is behind NAT, you can leave the host name as blank, and enter the NAT_ID string in the 'Unique NAT ID' text box. Use the same NAT_ID string that you used while configuring FMC on the device. type: string id: description: Unique identifier (UUID) representing the registered device. type: string isAWSDevice: type: boolean isAzureDevice: type: boolean isConnected: description: Device connection status type: boolean isMCDManaged: description: Boolean indicating whether the device is managed by MCD Controller. Only applicable for cdFMC. type: boolean keepLocalEvents: description: Boolean indicating whether local events are recorded and kept on the device. type: boolean license_caps: description: 'Array of strings representing the license capabilities on the managed device. For registering FTD, the allowed values are: ESSENTIALS (mandatory), IPS, URL, MALWARE_DEFENSE, CARRIER, SECURE_CLIENT_PREMIER, SECURE_CLIENT_PREMIER_ADVANTAGE, SECURE_CLIENT_VPNOnly. For Firepower ASA or NGIPSv devices, allowed values are: BASE, THREAT, PROTECT, CONTROL, URLFilter, MALWARE, VPN, SSL. ' items: type: string type: array licenseType: description: License types for devices controlled externally (MCD). enum: - BYOL - SAAS - PAYG type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object managementState: description: Device management status. enum: - MANAGED - UNMANAGED type: string metadata: $ref: '#/components/schemas/DeviceMetadata' description: Object representing metadata attributes of the Device. type: object model: description: Model name of the registered device. type: string modelId: description: Model ID of the registered device. type: string modelNumber: description: Model number of the registered device. type: string modelType: description: Model type of the registered device. type: string name: description: 'User-specified name of the registered device. (Example: Device 01 - 192.168.0.152.)' type: string natID: description: Unique ID for a Network address translation (NAT) device (optional; used for device registration). If the device to be registered and the Firepower Management Center are separated by a NAT device, enter a unique NAT ID. type: string performanceTier: description: Performance tier for the managed device ( applicable only for vFTD's from 6.8.0 with possible values FTDv5 | FTDv10 | FTDv20 | FTDv30 | FTDv50 | Legacy ). type: string prohibitPacketTransfer: description: Boolean indicating whether to prohibit the registered device from sending packet data with events to the Firepower Management Center (true) or to allow transfer (false). If this field is set to false (the default), the device transfers packets when a certain event is triggered. Not all traffic data is sent; connection events do not include a payload, only connection metadata. type: boolean regKey: description: Registration Key that you entered while configuring FMC on the device. type: string role: description: 'device role in case of container(HA, Cluster). (Example: Primary/Control ' type: string secondaryHostname: description: Secondary hostname or IP address of the device (Applicable only from 7.3.0 onwards). type: string serialNumber: type: string skipDeployment: description: Boolean representing whether to skip initial deployment during registration of a device. type: boolean snortEngine: enum: - SNORT2 - SNORT3 type: string status: description: 'device status in case of container(HA, Cluster). (Example: Active/Standby) ' type: string sw_version: description: Device version type: string type: description: Type of the device; this value is always Device. type: string version: description: Version number of the response object. type: string required: - hostName - license_caps - regKey type: object VrfIPv4StaticRouteModel: properties: description: type: string gateway: $ref: '#/components/schemas/IHostObjectContainer' type: object id: type: string interfaceName: type: string isTunneled: type: boolean links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object metricValue: format: int32 type: integer name: type: string routeTracking: $ref: '#/components/schemas/ISLAMonitorModel' type: object selectedNetworks: items: $ref: '#/components/schemas/INetworkAddress' type: object type: array type: type: string version: type: string required: - gateway - interfaceName - metricValue - selectedNetworks type: object ECMPZoneModelListContainer: properties: items: $ref: '#/components/schemas/ECMPZoneModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IOspfv3Area: properties: areaId: type: string areaType: $ref: '#/components/schemas/IOspfAreaType' type: object defaultCost: format: int32 type: integer routeSummary: items: $ref: '#/components/schemas/IOspfv3RouteSummary' type: object type: array virtualLinks: items: $ref: '#/components/schemas/IOspfv3VirtualLinks' type: object type: array type: object DeviceCertificateModelListContainer: properties: items: $ref: '#/components/schemas/DeviceCertificateModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object Ospfv3InterfacePolicyModel: properties: areaId: type: string authentication: $ref: '#/components/schemas/IOspfv3InterfaceAuthenticationBase' type: object description: type: string deviceInterface: $ref: '#/components/schemas/IFTDInterface' type: object id: type: string instance: format: int32 type: integer links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string neighbor: $ref: '#/components/schemas/IOspfv3Neighbor' type: object processId: format: int32 type: integer properties: $ref: '#/components/schemas/IOspfv3InterfaceConfiguration' type: object type: type: string version: type: string required: - deviceInterface type: object IEigrpStub: description: Contains attributes required to designate the router as Stub router. properties: advertise: $ref: '#/components/schemas/IEigrpAdvertise' description: Enable the router to only advertise the packets.Can be TRUE or FALSE. type: object receiveOnly: description: Enable the router to only recieve the packets.Can be TRUE or FALSE. type: boolean type: object IFilterProtocol: properties: id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string processId: type: string protocol: enum: - CONNECTED - BGP - OSPF - RIP - STATIC type: string type: type: string type: object IDeviceCertificateExportOptions: properties: isPemFormat: type: boolean passPhrase: type: string type: object BGPIPvAddressFamilyModelListContainer: properties: items: $ref: '#/components/schemas/BGPIPvAddressFamilyModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object INetworkBase: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string overridable: type: boolean overrides: $ref: '#/components/schemas/IOverride' type: object type: type: string version: type: string type: object VrfIPv6StaticRouteModel: properties: description: type: string gateway: $ref: '#/components/schemas/IHostObjectContainer' type: object id: type: string interfaceName: type: string isTunneled: type: boolean links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object metricValue: format: int32 type: integer name: type: string selectedNetworks: items: $ref: '#/components/schemas/INetworkAddress' type: object type: array type: type: string version: type: string required: - gateway - interfaceName - metricValue - selectedNetworks type: object INeighborMaximumPrefix: properties: id: type: string links: $ref: '#/components/schemas/ILinks' type: object maxPrefixLimit: format: int32 type: integer name: type: string restartInterval: format: int32 type: integer thresholdValue: format: int32 type: integer type: type: string warningOnly: type: boolean type: object VrfEigrpPolicyModel: properties: advancedConfiguration: $ref: '#/components/schemas/IEigrpAdvancedConfigModel' type: object asNumber: type: string basicConfiguration: $ref: '#/components/schemas/IEigrpBasicConfigModel' type: object distributionList: items: $ref: '#/components/schemas/EigrpDistributionListModel' type: object type: array eigrpInterfaces: items: $ref: '#/components/schemas/EigrpInterfaceModel' type: object type: array id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string neighbors: items: $ref: '#/components/schemas/EigrpNeighborModel' type: object type: array redistributeProtocols: items: $ref: '#/components/schemas/EigrpRedistributionModel' type: object type: array summaryAddressList: items: $ref: '#/components/schemas/EigrpSummaryAddressModel' type: object type: array type: type: string type: object IMetadataUser: properties: id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string type: type: string type: object IPbrForwardingActionModel: properties: defaultInterface: type: boolean egressInterfaces: items: $ref: '#/components/schemas/IFTDInterface' type: object type: array forwardingActionType: type: string fragmentForIpv4: type: string ipv4VerifyAvailability: items: $ref: '#/components/schemas/IIPv4VerifyAvailabilityModel' type: object type: array matchCriteria: $ref: '#/components/schemas/IReference' type: object nextHopIPv4Addresses: items: type: string type: array nextHopIPv4Default: items: type: string type: array nextHopIPv4PeerAddress: type: boolean nextHopIPv4Recursive: type: string nextHopIPv6Addresses: items: type: string type: array nextHopIPv6Default: items: type: string type: array nextHopIPv6PeerAddress: type: boolean nextHopIPv6Recursive: type: string type: object HealthMonitorModel: properties: dateTime: type: string description: type: string healthMonitorMetric: $ref: '#/components/schemas/IHealthMonitorMetric' type: object id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object metric: type: string name: type: string type: type: string version: type: string type: object IOspfRouteMetric: properties: metricType: enum: - TYPE_1 - TYPE_2 type: string metricValue: format: int32 type: integer type: object IOspfv3InterfaceConfiguration: properties: deadInterval: format: int32 type: integer enableBFD: type: boolean enableOspfv3ForIntf: type: boolean filterOutgoingLSA: type: boolean floodReduction: type: boolean helloInterval: format: int32 type: integer ignoreMtuMismatch: type: boolean packetCost: format: int32 type: integer priority: format: int32 type: integer ptpNonBroadcast: type: boolean retransmitInterval: format: int32 type: integer transmitDelay: format: int32 type: integer type: object IChangeConfigManagerFTDReportOptions: properties: form: $ref: '#/components/schemas/LLForm' type: object headers: $ref: '#/components/schemas/LLHeaders' type: object importTaskId: type: string jobSummary: $ref: '#/components/schemas/IChangeConfigManagerFTDReportJobSummary' type: object s2sVpnImportTaskId: type: string url: type: string type: object DeviceDHCPRelaySettingsListContainer: properties: items: $ref: '#/components/schemas/DeviceDHCPRelaySettings' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IOspfSummaryAddresses: properties: advertise: type: boolean summaryNetwork: items: $ref: '#/components/schemas/INetworkAddress' type: object type: array tagNumber: format: int32 type: integer type: object HealthModule: properties: alertConfig: items: $ref: '#/components/schemas/HealthAlertConfig' type: object type: array alertEnabled: type: boolean criticalThreshold: format: int32 type: integer customThresholds: items: $ref: '#/components/schemas/HealthThreshold' type: object type: array enabled: type: boolean moduleId: type: string severity: type: string type: type: string warningThreshold: format: int32 type: integer type: object FPPhysicalInterfaceListContainer: properties: items: $ref: '#/components/schemas/FPPhysicalInterface' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IOspfTimers: properties: floodPacing: format: int32 type: integer lsaArrival: format: int32 type: integer lsaGroup: format: int32 type: integer lsaThrottleTimer: $ref: '#/components/schemas/ILsaThrottleTimer' type: object retransmission: format: int32 type: integer spfThrottleTimer: $ref: '#/components/schemas/ISpfThrottleTimer' type: object type: object ObjectEntry: properties: id: format: int32 type: integer literal: type: boolean name: type: string type: type: string uuid: type: string value: type: string type: object IRouteImportExport: properties: exportRouteTargets: items: type: string type: array globalVrfExportRouteMap: $ref: '#/components/schemas/IRouteMap' type: object globalVrfImportRouteMap: $ref: '#/components/schemas/IRouteMap' type: object importRouteTargets: items: type: string type: array userVrfExportRouteMap: $ref: '#/components/schemas/IRouteMap' type: object userVrfImportRouteMap: $ref: '#/components/schemas/IRouteMap' type: object type: object IApplicationTag: description: Represents an ApplicationTag. properties: description: description: Application tag resource description. type: string id: description: Unique identifier for the application tag. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/IMetadata' description: Object representing metadata attributes for the application tag. type: object name: description: Name of the application tag. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on a device or domain. type: object type: description: Type of the response object. This value is always ApplicationTag. type: string version: description: Version number of the response object. type: string type: object VrfECMPZoneModelListContainer: properties: items: $ref: '#/components/schemas/VrfECMPZoneModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IStaticArpEntry: properties: ip: type: string mac: type: string type: object IOverrideableInterfaceAttributes: properties: autoNeg: type: boolean duplex: enum: - AUTO - FULL - HALF type: string fecMode: enum: - AUTO - CL108RS - CL74FC - CL91RS - DISABLE type: string speed: enum: - AUTO - TEN_MBPS - HUNDRED_MBPS - ONE_GBPS - TEN_GBPS - TWENTY_FIVE_GBPS - FORTY_GBPS - HUNDRED_GBPS - TWO_HUNDRED_GBPS - FOUR_HUNDRED_GBPS - DETECT_SFP type: string type: object DeviceChassisData: properties: chassisSerialNo: type: string chassisUrl: type: string securityModuleNo: format: int32 type: integer securityModuleSN: type: string type: object ReadOnly: description: Defines the read only conditions if the referenced resource is read only. properties: reason: description: Reason the resource is read only - SYSTEM (if it is system defined), RBAC (if user RBAC permissions make it read only) or DOMAIN (if resource is read only in current domain). enum: - RBAC - SYSTEM - DOMAIN type: string state: description: True if this resource us read only and false otherwise. type: boolean type: object IVirtualSwitch: properties: description: type: string domainId: format: int32 type: integer dropBPDU: type: boolean enableSpanningTreeProtocol: type: boolean hybridInterface: $ref: '#/components/schemas/IInterface' type: object id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string sensorPolicy: $ref: '#/components/schemas/IAccessPolicyModel' type: object staticMacEntries: items: $ref: '#/components/schemas/IStaticMacEntry' type: object type: array strictTCPEnforcement: type: boolean switchedInterfaces: items: $ref: '#/components/schemas/IInterface' type: object type: array type: type: string version: type: string type: object FPLogicalInterface: properties: description: type: string enabled: format: int32 type: integer icmpEnabled: format: int32 type: integer id: type: string interfaceType: enum: - SWITCHED - ROUTED - VLAN type: string ipAddresses: items: type: string type: array links: $ref: '#/components/schemas/Links' type: object mdi: type: string metadata: $ref: '#/components/schemas/IMetadata' type: object mode: type: string mtu: format: int32 type: integer name: type: string physicalInterface: $ref: '#/components/schemas/IFPPhysicalInterface' type: object securityZone: $ref: '#/components/schemas/ISecurityZoneObjectModel' type: object staticArpEntries: items: $ref: '#/components/schemas/IStaticArpEntry' type: object type: array type: type: string version: type: string virtualSwitch: $ref: '#/components/schemas/IVirtualSwitch' type: object vlanTag: format: int32 type: integer type: object ISwitchPortConfig: properties: accessModeVlanId: format: int32 type: integer portMode: enum: - ACCESS - TRUNK type: string protectedEnabled: type: boolean trunkModeAllowedVlanIds: type: string trunkModeNativeVlanId: format: int32 type: integer type: object Metadata: description: Defines read only details about the object - whether it is system defined, last user who modified the object etc. properties: domain: $ref: '#/components/schemas/Domain' description: Defines the domains this instance belongs to (if applicable). type: object isLocked: type: boolean lastUser: $ref: '#/components/schemas/MetadataUser' description: The last user who modified this instance. type: object matches: items: type: string type: array readOnly: $ref: '#/components/schemas/ReadOnly' description: Details regarding the read only status of this instance type: object timestamp: description: The last updated timestamp. format: int32 type: integer type: object DeviceImport: description: An object that represents the details for device configuration import. properties: description: type: string deviceList: description: UUIDs of devices to be verified with metadata before import. items: type: string type: array deviceMappingOptions: $ref: '#/components/schemas/IDeviceMappingOptions' type: object files: description: Specifies device configuration file in `.sfo` format. items: $ref: '#/components/schemas/IFileWrapper' type: object type: array filesMap: $ref: '#/components/schemas/LLFilesMap' type: object id: type: string importOptions: $ref: '#/components/schemas/IDeviceImportExportOptions' description: Import options. type: object links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string type: type: string version: type: string type: object Ospfv3InterfaceCommonEntry: properties: attributes: $ref: '#/components/schemas/Attributes' type: object description: type: string enabled: type: boolean id: format: int32 type: integer l2SwitchingEnabled: type: boolean literal: type: boolean mandatory: type: boolean name: type: string neighborList: items: $ref: '#/components/schemas/Ospfv3InterfaceNeighborEntry' type: object type: array opType: type: string ospfv3EnableOspfv3ForInterface: type: boolean ospfv3IntfAreaId: type: string ospfv3IntfAuthKeyEncrypt: type: boolean ospfv3IntfAuthentication: enum: - MD5 - SHA1 type: string ospfv3IntfAuthenticationKey: type: string ospfv3IntfBroadcast: type: boolean ospfv3IntfCost: format: int32 type: integer ospfv3IntfDatabaseFilter: type: boolean ospfv3IntfDeadInterval: format: int32 type: integer ospfv3IntfEnableBFD: type: boolean ospfv3IntfEnableEncryption: type: boolean ospfv3IntfEncBitKey: enum: - _128 - _192 - _256 type: string ospfv3IntfEncKeyEncrypt: type: boolean ospfv3IntfEncType: enum: - AREA - INTERFACE - NONE type: string ospfv3IntfEncryption: enum: - _3DES - AESCBC - DES type: string ospfv3IntfEncryptionKey: type: string ospfv3IntfFlood: type: boolean ospfv3IntfHelloInterval: format: int32 type: integer ospfv3IntfInstance: format: int32 type: integer ospfv3IntfMtuIgnore: type: boolean ospfv3IntfName: $ref: '#/components/schemas/ObjectEntry' type: object ospfv3IntfPriority: format: int32 type: integer ospfv3IntfProcessId: format: int32 type: integer ospfv3IntfPtp: type: boolean ospfv3IntfRetransmitInterval: format: int32 type: integer ospfv3IntfSpi: format: int32 type: integer ospfv3IntfTransmitDelay: format: int32 type: integer position: format: int32 type: integer readOnly: type: boolean subType: type: string tooltip: type: string type: type: string userAction: type: string uuid: type: string value: type: string type: object IDeploymentSettings: properties: enableAutoRollback: type: boolean rollbackConnectivityMonitorInterval: format: int32 type: integer type: object Links: properties: parent: type: string self: type: string type: object PBRPolicyModel: properties: description: type: string forwardingActions: items: $ref: '#/components/schemas/IPbrForwardingActionModel' type: object type: array id: type: string ingressInterfaces: items: $ref: '#/components/schemas/IFTDInterface' type: object type: array links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string type: type: string version: type: string type: object INeighborTimers: properties: holdTime: format: int32 type: integer id: type: string keepAliveInterval: format: int32 type: integer links: $ref: '#/components/schemas/ILinks' type: object minimumHoldTime: format: int32 type: integer name: type: string type: type: string type: object DeviceDHCPRelaySettings: properties: description: type: string dhcpRelayAgent: items: $ref: '#/components/schemas/IDHCPRelayAgent' type: object type: array dhcpRelayServers: items: $ref: '#/components/schemas/IDHCPRelayServerConfig' type: object type: array id: type: string ipv4TimeoutInSec: type: string ipv6TimeoutInSec: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string trustAllInformation: type: boolean type: type: string version: type: string type: object IPPPoEContianer: properties: enableRouteSettings: type: boolean ipAddress: type: string pppAuth: enum: - PAP - CHAP - MSCHAP type: string pppoePassword: type: string pppoeRouteMetric: format: int32 type: integer pppoeUser: type: string storeCredsInFlash: type: boolean vpdnGroupName: type: string type: object IOspfv3NeighborConfiguration: properties: linkLocalAddress: type: string properties: $ref: '#/components/schemas/IOspfv3NeighborProperties' type: object required: - linkLocalAddress - properties type: object UZTNADeviceSettingsMetadata: properties: coreProfile: type: string domain: $ref: '#/components/schemas/Domain' type: object isLocked: type: boolean lastUser: $ref: '#/components/schemas/MetadataUser' type: object matches: items: type: string type: array readOnly: $ref: '#/components/schemas/ReadOnly' type: object timestamp: format: int32 type: integer type: object ManagementInterfaceConvergence: properties: checkConvergenceReadiness: type: string description: type: string id: type: string ignoreWarning: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object mode: type: string name: type: string type: type: string version: type: string type: object IStaticIPContainer: properties: address: type: string addressVariable: $ref: '#/components/schemas/IReference' type: object netmask: type: string pool: $ref: '#/components/schemas/IReference' type: object type: object DownloadSampleCsv: properties: {} type: object IPathMonitoring: properties: enable: type: boolean monitoredIp: type: string type: enum: - AUTO - PEER_IPV4 - PEER_IPV6 - AUTO4 - AUTO6 type: string type: object TaskStatus: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object message: type: string metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string showDetailedDeviceStatus: type: string status: type: string subTasks: items: $ref: '#/components/schemas/ISubTask' type: object type: array taskType: enum: - DEVICE_REGISTRATION - SMART_LICENSE - DEVICE_DEPLOYMENT - DEVICE_ROLLBACK - NGFWHA_OPERATIONS - COPY_CONFIG_REQUEST - HIT_COUNT_REFRESH - FTD_CLUSTER_BOOTSTRAP - FTD_CLUSTER_CREATE - FTD_CLUSTER_BREAK - FTD_CLUSTER_ADD_NODES - FTD_CLUSTER_REMOVE_NODES - DEVICE_BACKUP - FTD_CLUSTER_UPDATE_BOOTSTRAP - FTD_CLUSTER_COMMAND - SSP_EPM_OIR - SSP_EPM_BREAKOUT_DEPLOY - DEVICE_EXPORT - DEVICE_IMPORT - POLICY_EXPORT - CHASSIS_REGISTRATION - CHANGE_MANAGER - CONFIGURE_DEVICE_VALIDATE - CONFIGURE_DEVICE - CONFIGURE_MANAGER - CONFIGURE_MANAGER_ADD - CONFIGURE_MANAGER_DELETE - INITIATE_MIGRATION - DISCARD_MIGRATION - SWITCH_TO_ANALYTICS - DELETE_DEVICE - GENERATE_REPORTS - FLEXCONFIG_MIGRATION - DEVICE_UNREGISTRATION - PENDING_CHANGES_REQUEST - DEVICE_TROUBLESHOOT - DEVICE_MODEL_MIGRATION - DEVICE_TEMPLATE_CREATION - CHASSIS_CONVERSION_REQUEST - SNORT_PROFILER - CPU_PROFILER - POLICY_REPORT_GENERATION - DEVICE_TEMPLATE_APPLY - LTP_ONBOARDING - POLICY_CLONE_OPERATION - DEVICE_CERTIFICATE_MANAGEMENT - OOB_CHANGES_REQUEST - UPLOAD_TROUBLESHOOT type: string type: type: string type: object Attributes: type: object IOspfv3LogAdjacencyChanges: properties: includeDetails: type: boolean type: object IPolicyModel: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string type: type: string version: type: string type: object FTDVlanInterface: properties: MTU: format: int32 type: integer activeMACAddress: type: string applicationMonitoring: $ref: '#/components/schemas/IApplicationMonitoring' type: object arpConfig: items: $ref: '#/components/schemas/IARPConfigContainer' type: object type: array description: type: string disablePortForwardOnVlan: $ref: '#/components/schemas/IInterface' type: object enableAntiSpoofing: type: boolean enableDNSLookup: type: boolean enableSGTPropagate: type: boolean enabled: type: boolean fmcAccessConfig: $ref: '#/components/schemas/IFMCAccessConfig' type: object fragmentReassembly: type: boolean id: type: string ifname: type: string ipv4: $ref: '#/components/schemas/IIPv4Container' type: object ipv6: $ref: '#/components/schemas/IIPv6Container' type: object links: $ref: '#/components/schemas/ILinks' type: object macAddressPool: $ref: '#/components/schemas/IReference' type: object macLearn: type: boolean macTable: items: type: string type: array managementOnly: type: boolean metadata: $ref: '#/components/schemas/IMetadata' type: object mode: enum: - INLINE - PASSIVE - TAP - ERSPAN - NONE - SWITCHPORT type: string name: type: string overrideDefaultFragmentSetting: $ref: '#/components/schemas/IOverrideDefaultFragmentSetting' type: object pathMonitoring: $ref: '#/components/schemas/IPathMonitoring' type: object priority: format: int32 type: integer securityZone: $ref: '#/components/schemas/ISecurityZoneObjectModel' type: object standbyMACAddress: type: string type: type: string version: type: string vlanId: format: int32 type: integer type: object FTDLoopbackInterface: description: A model representing loopback Interface type definition under device records. properties: MTU: format: int32 type: integer activeMACAddress: type: string applicationMonitoring: $ref: '#/components/schemas/IApplicationMonitoring' type: object arpConfig: items: $ref: '#/components/schemas/IARPConfigContainer' type: object type: array description: type: string enableAntiSpoofing: type: boolean enableDNSLookup: type: boolean enableSGTPropagate: type: boolean enabled: description: Specifies whether the interface is shutdown. type: boolean fmcAccessConfig: $ref: '#/components/schemas/IFMCAccessConfig' type: object fragmentReassembly: type: boolean id: description: Unique identifier (UUID) for the loopback interface. type: string ifname: description: Represents nameif of loopback interface. type: string ipv4: $ref: '#/components/schemas/IIPv4Container' description: Represents the static(only) ipv4 address of the loopback interface. type: object ipv6: $ref: '#/components/schemas/IIPv6Container' description: Represents the list of ipv6 address of the loopback interface. type: object links: $ref: '#/components/schemas/ILinks' type: object loopbackId: description: Represents the logical id of loopback interface. format: int32 type: integer macAddressPool: $ref: '#/components/schemas/IReference' type: object macLearn: type: boolean macTable: items: type: string type: array managementOnly: type: boolean metadata: $ref: '#/components/schemas/IMetadata' description: Object representing metadata properties. type: object mode: enum: - INLINE - PASSIVE - TAP - ERSPAN - NONE - SWITCHPORT type: string name: description: Represents name of loopback interface. type: string overrideDefaultFragmentSetting: $ref: '#/components/schemas/IOverrideDefaultFragmentSetting' type: object pathMonitoring: $ref: '#/components/schemas/IPathMonitoring' type: object priority: format: int32 type: integer securityZone: $ref: '#/components/schemas/ISecurityZoneObjectModel' type: object standbyMACAddress: type: string type: description: Type will be LoopbackInterface always. type: string version: type: string type: object FPInterfaceStatisticsListContainer: properties: items: $ref: '#/components/schemas/FPInterfaceStatistics' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IKeyChainObject: properties: description: type: string id: type: string keys: items: $ref: '#/components/schemas/IKeyObject' type: object type: array links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string type: type: string version: type: string type: object ECMPZoneModel: description: Equal-Cost Multi-Path (ECMP) properties: description: description: Description of Equal-Cost Multi-Path (ECMP) Zone type: string id: description: Unique identifier (UUID) representing the ECMP Zone type: string interfaces: description: List of interfaces to be associated with ECMP Zone items: $ref: '#/components/schemas/IFTDInterface' type: object type: array links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metadata attributes for the ECMP Zone type: object name: description: ECMP Zone Name type: string type: description: Type of the ECMP Zone. This value is always ecmpzones type: string version: description: Version number of the response object type: string type: object ITaskStatus: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object message: type: string metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string status: type: string subTasks: items: $ref: '#/components/schemas/ISubTask' type: object type: array taskType: enum: - DEVICE_REGISTRATION - SMART_LICENSE - DEVICE_DEPLOYMENT - DEVICE_ROLLBACK - NGFWHA_OPERATIONS - COPY_CONFIG_REQUEST - HIT_COUNT_REFRESH - FTD_CLUSTER_BOOTSTRAP - FTD_CLUSTER_CREATE - FTD_CLUSTER_BREAK - FTD_CLUSTER_ADD_NODES - FTD_CLUSTER_REMOVE_NODES - DEVICE_BACKUP - FTD_CLUSTER_UPDATE_BOOTSTRAP - FTD_CLUSTER_COMMAND - SSP_EPM_OIR - SSP_EPM_BREAKOUT_DEPLOY - DEVICE_EXPORT - DEVICE_IMPORT - POLICY_EXPORT - CHASSIS_REGISTRATION - CHANGE_MANAGER - CONFIGURE_DEVICE_VALIDATE - CONFIGURE_DEVICE - CONFIGURE_MANAGER - CONFIGURE_MANAGER_ADD - CONFIGURE_MANAGER_DELETE - INITIATE_MIGRATION - DISCARD_MIGRATION - SWITCH_TO_ANALYTICS - DELETE_DEVICE - GENERATE_REPORTS - FLEXCONFIG_MIGRATION - DEVICE_UNREGISTRATION - PENDING_CHANGES_REQUEST - DEVICE_TROUBLESHOOT - DEVICE_MODEL_MIGRATION - DEVICE_TEMPLATE_CREATION - CHASSIS_CONVERSION_REQUEST - SNORT_PROFILER - CPU_PROFILER - POLICY_REPORT_GENERATION - DEVICE_TEMPLATE_APPLY - LTP_ONBOARDING - POLICY_CLONE_OPERATION - DEVICE_CERTIFICATE_MANAGEMENT - OOB_CHANGES_REQUEST - UPLOAD_TROUBLESHOOT type: string type: type: string type: object BGPIPvAddressFamilyModel: description: BGP is an inter and intra autonomous system routing protocol. properties: addressFamilyIPv4: $ref: '#/components/schemas/IBGPAddressFamilyModel' description: Family Address configuration mode for IPv4. type: object addressFamilyIPv6: $ref: '#/components/schemas/IBGPAddressFamilyModel' description: Family Address configuration mode for IPv6. type: object asNumber: description: Integer specifying the BGP Autonomous number. type: string asNumberVariable: $ref: '#/components/schemas/IReference' type: object clusterPool: $ref: '#/components/schemas/IIPv4AddressPool' description: IPv4POOL Object value for the clusterPool. Possible values can be null or valid ipv4 pool object. type: object description: description: User provided resource description. type: string id: description: Unique identifier (UUID) for the BGPIPvAddressFamily. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/Metadata' description: Object representing metedata attributes for BGPIPvAddressFamily. type: object name: description: Name of the BGPBGPIPvAddressFamily object. type: string routerId: description: String value for the routerID. Possible values can be null or valid ipv4 address. type: string routerIdVariable: $ref: '#/components/schemas/IReference' type: object type: description: Type of BGP object. type: string version: description: Version number of the response object. type: string required: - routerId - routerIdVariable type: object IOspfInterval: properties: helloInterval: $ref: '#/components/schemas/IOspfDeadIntervalMechanism' type: object helloMultiplier: $ref: '#/components/schemas/IOspfHelloMultiplierMechanism' type: object type: object InlineSetListContainer: properties: items: $ref: '#/components/schemas/InlineSet' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object EigrpInterfaceModel: description: Contains the EIGRP interface attributes. properties: deviceInterface: $ref: '#/components/schemas/IFTDInterface' description: Interface on which the eigrpProtocolConfiguration will be applicable. Specify interface name, id and type. type: object eigrpProtocolConfiguration: $ref: '#/components/schemas/IEigrpProtocolConfigModel' description: Contains the EIGRP protocol configuration. type: object policyId: format: int32 type: integer type: object IInlinePair: properties: first: $ref: '#/components/schemas/IInterface' type: object second: $ref: '#/components/schemas/IInterface' type: object type: object EigrpPolicyModelListContainer: properties: items: $ref: '#/components/schemas/EigrpPolicyModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object INeighbors: properties: id: type: string ipv4Address: type: string ipv4AddressVariable: $ref: '#/components/schemas/IReference' type: object ipv6Address: type: string ipv6AddressVariable: $ref: '#/components/schemas/IReference' type: object linkLocalInterface: $ref: '#/components/schemas/IFTDInterface' type: object links: $ref: '#/components/schemas/ILinks' type: object name: type: string neighborAdvanced: $ref: '#/components/schemas/INeighborAdvanced' type: object neighborFiltering: $ref: '#/components/schemas/INeighborFiltering' type: object neighborGeneral: $ref: '#/components/schemas/INeighborGeneral' type: object neighborHaMode: $ref: '#/components/schemas/INeighborHaMode' type: object neighborLocalAs: $ref: '#/components/schemas/INeighborLocalAs' type: object neighborRoutes: $ref: '#/components/schemas/INeighborRoutes' type: object neighborTimers: $ref: '#/components/schemas/INeighborTimers' type: object remoteAs: type: string remoteAsVariable: $ref: '#/components/schemas/IReference' type: object type: type: string type: object IOspfKeyChainAuth: properties: authKey: $ref: '#/components/schemas/IKeyChainObject' type: object authType: type: string type: object IDDNSUpdateMethodModel: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object methodOption: enum: - DDNS - WEB - FMC_ONLY type: string name: type: string type: type: string updateInterval: $ref: '#/components/schemas/DDNSUpdateIntervalModel' type: object updateRecords: enum: - NOT_DEFINED - A_RECORDS - BOTH_A_AND_PTR_RECORDS type: string version: type: string webURL: type: string webUpdateType: enum: - ALL_ADDRESSES - IPV4_ADDRESS - IPV4_AND_ONE_IPV6_ADDRESS - ONE_IPV6_ADDRESS - ALL_IPV6_ADDRESSES - 'NULL' type: string type: object ISubTask: properties: description: type: string id: type: string message: type: string metadata: $ref: '#/components/schemas/IMetadata' type: object status: type: string target: $ref: '#/components/schemas/ITarget' type: object type: object Ospfv3SummaryPrefixEntry: properties: attributes: $ref: '#/components/schemas/Attributes' type: object description: type: string enabled: type: boolean id: format: int32 type: integer l2SwitchingEnabled: type: boolean literal: type: boolean mandatory: type: boolean name: type: string opType: type: string ospfv3SummaryAdvertise: type: boolean ospfv3SummaryIPv6Network: $ref: '#/components/schemas/ObjectEntry' type: object ospfv3SummaryTag: type: string position: format: int32 type: integer readOnly: type: boolean subType: type: string tooltip: type: string type: type: string userAction: type: string uuid: type: string value: type: string type: object DeviceSettings: properties: deploymentSettings: $ref: '#/components/schemas/IDeploymentSettings' type: object description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string type: type: string version: type: string type: object FPInterfaceStatistics: properties: description: type: string droppedPackets: format: int32 type: integer id: type: string interfaceUuid: type: string links: $ref: '#/components/schemas/Links' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string rxBytes: format: int32 type: integer txBytes: format: int32 type: integer type: type: string version: type: string type: object IOspfDefaultInfoOriginate: properties: alwaysAdvertise: type: boolean routeMap: $ref: '#/components/schemas/IRouteMap' type: object routeMetric: $ref: '#/components/schemas/IOspfRouteMetric' type: object type: object IOspfv3DefaultInfoOriginate: properties: always: type: boolean routeMap: $ref: '#/components/schemas/IRouteMap' type: object routeMetric: $ref: '#/components/schemas/IOspfRouteMetric' type: object type: object IOspfAreaAuth: properties: authType: type: string md5AuthList: items: $ref: '#/components/schemas/IOspfMD5Auth' type: object type: array passwdAuth: $ref: '#/components/schemas/IOspfPasswdAuth' type: object type: object VirtualRouterModel: properties: description: type: string id: type: string interfaces: items: $ref: '#/components/schemas/IFTDInterface' type: object type: array links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string type: type: string version: type: string vrfPolicyEntry: $ref: '#/components/schemas/VRFPolicyEntry' type: object type: object INeighborTransportPathMTUDiscovery: properties: disable: type: boolean id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string type: type: string type: object Ospfv3InterfacePolicyModelListContainer: properties: items: $ref: '#/components/schemas/Ospfv3InterfacePolicyModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IPv4StaticRouteModelListContainer: properties: items: $ref: '#/components/schemas/IPv4StaticRouteModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IOspfNsfGracefulRestart: properties: nsfCapability: type: boolean nsfEnable: type: boolean nsfEnforceGlobal: type: boolean nsfHelper: type: boolean nsfMechanism: enum: - CISCO - IETF - NONE type: string nsfRestartIntraval: format: int32 type: integer type: object INetworkAddressLiteral: properties: type: type: string value: type: string type: object IDHCPIPv6DomainName: properties: importFromInternalServer: type: boolean names: items: type: string type: array type: object IOspfMD5Auth: properties: authType: type: string md5Key: type: string md5KeyId: format: int32 type: integer type: object IOspfv3ProcessModel: properties: administrativeDistance: $ref: '#/components/schemas/IOspfAdministrativeDistance' type: object clusterPool: $ref: '#/components/schemas/IIPv4AddressPool' type: object defaultInformationOriginate: $ref: '#/components/schemas/IOspfv3DefaultInfoOriginate' type: object description: type: string id: type: string ignoreLsaMospf: type: boolean links: $ref: '#/components/schemas/ILinks' type: object logAdjacencyChanges: $ref: '#/components/schemas/IOspfv3LogAdjacencyChanges' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string nsfGracefulRestart: $ref: '#/components/schemas/IOspfv3NsfGracefulRestart' type: object passiveInterfaces: items: $ref: '#/components/schemas/IFTDInterface' type: object type: array routerId: type: string timers: $ref: '#/components/schemas/IOspfv3Timers' type: object type: type: string version: type: string type: object IFTDInterface: properties: description: type: string id: type: string ifname: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string type: type: string version: type: string type: object INeighborAdvertiseMaps: properties: existMap: type: boolean existRouteMap: $ref: '#/components/schemas/IRouteMap' type: object id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string routeMap: $ref: '#/components/schemas/IRouteMap' type: object type: type: string type: object DialHost: properties: host: type: string port: format: int32 type: integer type: object EigrpRedistributionModel: description: Send (redistribute) routes in EIGRP table based on selected criteria properties: matchExternal1: description: Use this to redistribute only the External1 type routes,applicable only for OSPF protocol.Can be TRUE or FALSE. type: boolean matchExternal2: description: Use this to redistribute only the External2 type routes,applicable only for OSPF protocol.Can be TRUE or FALSE. type: boolean matchInternal: description: Use this to redistribute only the internal routes, applicable only for OSPF protocol.Can be TRUE or FALSE. type: boolean matchNssaExternal1: description: Use this to redistribute only the Nssa External1 type routes, applicable only for OSPF protocol.Can be TRUE or FALSE. type: boolean matchNssaExternal2: description: Use this to redistribute only the Nssa External2 type routes, applicable only for OSPF protocol.Can be TRUE or FALSE. type: boolean policyId: format: int32 type: integer processId: description: Process ID used by BGP and OSPF protocols. When used by BGP this is the AS number. type: string protocol: description: 'Protocol to redistribute . Possible values : (STATIC | CONNECTED | RIP | BGP | OSPF)' enum: - CONNECTED - BGP - OSPF - RIP - STATIC type: string routeMap: $ref: '#/components/schemas/ReferenceObject' description: This route map object defines which of the routes from the specified routing protocol are allowed to be redistributed into the target routing process. type: object routeMetric: $ref: '#/components/schemas/IEigrpRouteMetric' description: 'It contains the bandwidth, load, delay, reliability and MTU values which are used by routing algorithm for selecting or rejecting a routing path for transferring data/traffic. ' type: object type: object IKeyObject: properties: acceptLifeTime: $ref: '#/components/schemas/ILifeTime' type: object authAlgorithm: type: string authString: $ref: '#/components/schemas/IAuthTypeAndString' type: object keyId: format: int32 type: integer sendLifeTime: $ref: '#/components/schemas/ILifeTime' type: object type: object ILifeTime: properties: endLifeTimeValue: type: string endLifetimeType: enum: - INFINITE - DURATION - DATETIME type: string startLifeTimeValue: type: string timeZone: type: string type: object VrfBGPIPvAddressFamilyModelListContainer: properties: items: $ref: '#/components/schemas/VrfBGPIPvAddressFamilyModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IApplicationProductivity: description: Represents an ApplicationProductivity. properties: description: description: Application productivity resource description. type: string id: description: Unique identifier for the application productivity. type: string links: $ref: '#/components/schemas/ILinks' description: Object containing links to this resource. type: object metadata: $ref: '#/components/schemas/IMetadata' description: Object representing metadata attributes for the application productivity. type: object name: description: Name of the application productivity. type: string overridable: description: Boolean indicating whether object values can be overridden. type: boolean overrides: $ref: '#/components/schemas/IOverride' description: An object override allows you to define an alternate value for an object on a device or domain. type: object type: description: Type of the response object. This value is always ApplicationProductivity. type: string version: description: Version number of the response object. type: string type: object INeighborLocalAs: properties: asNumber: type: string dualAs: type: boolean id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string noPrepend: type: boolean replaceAs: type: boolean type: type: string type: object IEigrpBasicConfigModel: description: Basic configurations contains the most common configurations for any EIGRP process. properties: autoSummary: description: it will automatically advertise summary routes to other EIGRP routers.Can be TRUE or FALSE. type: boolean networks: description: List of Networks that will participate in the EIGRProuting process. items: $ref: '#/components/schemas/ReferenceObject' type: object type: array passiveInterfaces: $ref: '#/components/schemas/IEigrpPassiveInterfaceModel' description: Interfaces that do not take part in EIGRP routing process. type: object type: object OspfPolicyModel: properties: areas: items: $ref: '#/components/schemas/IOspfArea' type: object type: array description: type: string enableProcess: enum: - PROCESS_1 - PROCESS_2 type: string filterRules: items: $ref: '#/components/schemas/IOspfFilterRule' type: object type: array id: type: string links: $ref: '#/components/schemas/ILinks' type: object logAdjacencyChanges: $ref: '#/components/schemas/IOspfLogAdjChanges' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string neighbors: items: $ref: '#/components/schemas/IOspfNeighbors' type: object type: array processConfiguration: $ref: '#/components/schemas/IOspfProcessModel' type: object processId: type: string redistributeProtocols: items: $ref: '#/components/schemas/IRedistributeProtocolBase' type: object type: array summaryAddresses: items: $ref: '#/components/schemas/IOspfSummaryAddresses' type: object type: array type: type: string version: type: string type: object IEigrpProtocolConfigModel: description: Contains Eigrp Protocol parameters. properties: authentication: $ref: '#/components/schemas/IEigrpInterfaceAuthentication' description: Contains EIGRP authentication configurations. type: object splitHorizon: description: Enables Split Horizon configuration. Can be TRUE or FALSE. type: boolean timers: $ref: '#/components/schemas/IEigrpInterfaceTimer' description: Contains the time intervals for hello interval, hold interval and delay inetrval. type: object type: object VrfOspfPolicyModel: properties: areas: items: $ref: '#/components/schemas/IOspfArea' type: object type: array description: type: string enableProcess: enum: - PROCESS_1 - PROCESS_2 type: string filterRules: items: $ref: '#/components/schemas/IOspfFilterRule' type: object type: array id: type: string links: $ref: '#/components/schemas/ILinks' type: object logAdjacencyChanges: $ref: '#/components/schemas/IOspfLogAdjChanges' type: object metadata: $ref: '#/components/schemas/Metadata' type: object name: type: string neighbors: items: $ref: '#/components/schemas/IOspfNeighbors' type: object type: array processConfiguration: $ref: '#/components/schemas/IOspfProcessModel' type: object processId: type: string redistributeProtocols: items: $ref: '#/components/schemas/IRedistributeProtocolBase' type: object type: array summaryAddresses: items: $ref: '#/components/schemas/IOspfSummaryAddresses' type: object type: array type: type: string version: type: string type: object IOspfFilterList: properties: filterDirection: enum: - IN - OUT type: string prefixList: $ref: '#/components/schemas/IReference' type: object type: object IDHCPRelayAgent: properties: description: type: string enableDHCPIPv4Relay: type: boolean enableDHCPIPv6Relay: type: boolean id: type: string interface: $ref: '#/components/schemas/ReferenceObject' type: object links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string setRoute: type: boolean type: type: string version: type: string type: object INeighborDistributeLists: properties: accessList: $ref: '#/components/schemas/IStandardACL' type: object filterUpdateAction: enum: - IN - OUT type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string type: type: string type: object IPreDeployAction: properties: actionInfo: $ref: '#/components/schemas/IActionInfo' type: object actionType: enum: - APPLY_TEMPLATE type: string type: object VrfStaticRouteModel: properties: description: type: string gateway: $ref: '#/components/schemas/IHostObjectContainer' type: object id: type: string interfaceName: type: string isTunneled: type: boolean links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/Metadata' type: object metricValue: format: int32 type: integer name: type: string selectedNetworks: items: $ref: '#/components/schemas/INetworkAddress' type: object type: array type: type: string version: type: string required: - gateway - interfaceName - metricValue - selectedNetworks type: object DeviceCertificateExportData: properties: description: type: string id: type: string links: $ref: '#/components/schemas/ILinks' type: object metadata: $ref: '#/components/schemas/IMetadata' type: object name: type: string type: type: string version: type: string type: object VrfEigrpPolicyModelListContainer: properties: items: $ref: '#/components/schemas/VrfEigrpPolicyModel' type: array links: $ref: '#/components/schemas/ILinks' type: object paging: $ref: '#/components/schemas/PagingContainer' type: object type: object IDistributeLists: properties: accessList: $ref: '#/components/schemas/IStandardACL' type: object id: type: string links: $ref: '#/components/schemas/ILinks' type: object name: type: string protocol: $ref: '#/components/schemas/IFilterProtocol' type: object type: type: string type: object parameters: limit: description: Number of items to return. in: query name: limit required: false schema: format: int32 type: integer expanded: description: If set to true, the GET response displays a list of objects with additional attributes. in: query name: expanded required: false schema: type: boolean offset: description: Index of first item to return. in: query name: offset required: false schema: format: int32 type: integer domainUUID: description: Domain UUID in: path name: domainUUID required: true schema: type: string securitySchemes: bearerAuth: bearerFormat: JWT scheme: bearer type: http x-refined-from: - cdfmc-openapi.yaml - cisco-secure-firewall-cdfmc-openapi.yml