VpnBackupInterfaceEntry - Security Cloud Control Firewall Manager API Documentation - Cisco DevNet

{"type":"model","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/ee9bdf946673e45c4f256a22e0a754e29a9b2098/54f4ba30-7fe2-3433-bbd5-a4d458aee37e","info":{"title":"Cisco Cloud-delivered Firewall Management Center (cdFMC) API","version":"1.15.0","description":"Use the documentation to explore the endpoints the cdFMC has to offer","contact":{"name":"Cisco Firepower TAC","email":"ngfw-support@cisco.com"}},"tags":[{"name":"Analysis"},{"name":"Audit"},{"name":"Backup"},{"name":"Change Management"},{"name":"Chassis"},{"name":"Deployment"},{"name":"Device Clusters"},{"name":"Device Groups"},{"name":"Device HA Pairs"},{"name":"Devices"},{"name":"Health"},{"name":"Integration"},{"name":"Intelligence"},{"name":"License"},{"name":"Network Map"},{"name":"Object"},{"name":"Policy"},{"name":"Policy Assignments"},{"name":"Search"},{"name":"Status"},{"name":"System Configuration"},{"name":"System Information"},{"name":"Templates"},{"name":"Troubleshoot"},{"name":"Updates"},{"name":"Users"}],"openapi":"3.0.1","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"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"properties":{"attributes":{"type":"object","$$ref":"#/components/schemas/Attributes"},"description":{"type":"string"},"domainReadOnly":{"type":"boolean"},"group":{"type":"boolean"},"id":{"format":"int32","type":"integer"},"interface":{"type":"object","properties":{"activeMacAddress":{"type":"string"},"attributes":{"type":"object","$$ref":"#/components/schemas/Attributes"},"clusterIPv4AddrPool":{"format":"int32","type":"integer"},"description":{"type":"string"},"deviceId":{"format":"int32","type":"integer"},"enableParentInterfaces":{"type":"boolean"},"enableSGTPropagate":{"type":"boolean"},"enabled":{"type":"boolean"},"id":{"format":"int32","type":"integer"},"interfaceDescription":{"type":"string"},"interfaceEnabled":{"type":"boolean"},"interfaceGroupUuidList":{"items":{"type":"string"},"type":"array"},"interfaceIfName":{"type":"string"},"interfaceIpv4":{"type":"object","properties":{"interfaceIpAddr":{"type":"string"},"interfaceIpAddrVariable":{"type":"object","properties":{"attributes":{"type":"object","$$ref":"#/components/schemas/Attributes"},"description":{"type":"string"},"domainReadOnly":{"type":"boolean"},"group":{"type":"boolean"},"id":{"format":"int32","type":"integer"},"literal":{"type":"boolean"},"name":{"type":"string"},"readOnly":{"type":"boolean"},"references":{"type":"object","properties":{"type":{"type":"string"},"valueList":{"items":{"type":"object","properties":{"literal":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/NamedEntry"},"type":"array"}},"$$ref":"#/components/schemas/ObjectRefs"},"subType":{"type":"string"},"systemObject":{"type":"boolean"},"toolTip":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"},"valueList":{"items":{"type":"object","properties":{"literal":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/NamedEntry"},"type":"array"}},"$$ref":"#/components/schemas/VariableObjectEntry"},"interfaceIpSelection":{"enum":["STATIC","DHCP","PPPOE"],"type":"string"},"interfaceNetmask":{"type":"string"},"interfacePppoeRouteMetric":{"format":"int32","type":"integer"},"interfaceSetRoute":{"type":"boolean"},"interfaceVpdnGroup":{"type":"string"},"ipv4PoolName":{"type":"string"},"ipv4PoolSelfLink":{"type":"string"},"ipv4PoolUuid":{"type":"string"}},"$$ref":"#/components/schemas/InterfaceIpv4"},"interfaceIpv6":{"type":"object","properties":{"interfaceIPv6AddressTableList":{"items":{"type":"object","properties":{"clusterIPv6AddrPool":{"format":"int32","type":"integer"},"interfaceIPv6AddrVariable":{"type":"object","properties":{"attributes":{"type":"object","$$ref":"#/components/schemas/Attributes"},"description":{"type":"string"},"domainReadOnly":{"type":"boolean"},"group":{"type":"boolean"},"id":{"format":"int32","type":"integer"},"literal":{"type":"boolean"},"name":{"type":"string"},"readOnly":{"type":"boolean"},"references":{"type":"object","properties":{"type":{"type":"string"},"valueList":{"items":{"type":"object","properties":{"literal":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/NamedEntry"},"type":"array"}},"$$ref":"#/components/schemas/ObjectRefs"},"subType":{"type":"string"},"systemObject":{"type":"boolean"},"toolTip":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"},"valueList":{"items":{"type":"object","properties":{"literal":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/NamedEntry"},"type":"array"}},"$$ref":"#/components/schemas/VariableObjectEntry"},"interfaceIPv6Address":{"type":"string"},"interfaceIPv6Eui64":{"type":"boolean"}},"$$ref":"#/components/schemas/InterfaceIpv6Address"},"type":"array"},"interfaceIPv6ClientPdHintPrefix":{"type":"string"},"interfaceIPv6ClientPdPrefixName":{"type":"string"},"interfaceIPv6DHCPPrefixesTableList":{"items":{"type":"object","properties":{"interfaceIPv6DHCPPrefixesLength":{"type":"string"},"interfaceIPv6DHCPPrefixesName":{"type":"string"}},"$$ref":"#/components/schemas/Ipv6Prefixes"},"type":"array"},"interfaceIPv6DHCPServerPool":{"type":"string"},"interfaceIPv6DadAttempts":{"format":"int32","type":"integer"},"interfaceIPv6EnableAutoConfig":{"type":"boolean"},"interfaceIPv6EnableDHCPClient":{"type":"boolean"},"interfaceIPv6EnableDefaultRoute":{"type":"boolean"},"interfaceIPv6EnableIPv6":{"type":"boolean"},"interfaceIPv6EnableRa":{"type":"boolean"},"interfaceIPv6EnforceEui64":{"type":"boolean"},"interfaceIPv6LinkLocal":{"type":"string"},"interfaceIPv6NdManagedConfig":{"type":"boolean"},"interfaceIPv6NdOtherConfig":{"type":"boolean"},"interfaceIPv6NsInterval":{"format":"int32","type":"integer"},"interfaceIPv6ObtainDefaultAutoConfig":{"enum":["DHCP","IGNORE"],"type":"string"},"interfaceIPv6PrefixTableList":{"items":{"type":"object","properties":{"interfaceIPv6PrefixAddressVariable":{"type":"object","properties":{"attributes":{"type":"object","$$ref":"#/components/schemas/Attributes"},"description":{"type":"string"},"domainReadOnly":{"type":"boolean"},"group":{"type":"boolean"},"id":{"format":"int32","type":"integer"},"literal":{"type":"boolean"},"name":{"type":"string"},"readOnly":{"type":"boolean"},"references":{"type":"object","properties":{"type":{"type":"string"},"valueList":{"items":{"type":"object","properties":{"literal":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/NamedEntry"},"type":"array"}},"$$ref":"#/components/schemas/ObjectRefs"},"subType":{"type":"string"},"systemObject":{"type":"boolean"},"toolTip":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"},"valueList":{"items":{"type":"object","properties":{"literal":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/NamedEntry"},"type":"array"}},"$$ref":"#/components/schemas/VariableObjectEntry"},"interfaceIPv6PrefixDefault":{"type":"boolean"},"interfaceIPv6PrefixLifeTime":{"type":"string"},"interfaceIPv6PrefixNoAdvertisement":{"type":"boolean"},"interfaceIPv6PrefixNoAutoConfig":{"type":"boolean"},"interfaceIPv6PrefixOffLink":{"type":"boolean"},"interfaceIPv6PrefixPreferredLifeTime":{"type":"string"},"interfaceIPv6PrefixPreferredTill":{"type":"string"},"interfaceIPv6PrefixValidLifeTime":{"type":"string"},"interfaceIPv6PrefixValidTill":{"type":"string"}},"$$ref":"#/components/schemas/InterfaceIpv6Prefix"},"type":"array"},"interfaceIPv6RaInterval":{"format":"int32","type":"integer"},"interfaceIPv6RaLifetime":{"format":"int32","type":"integer"},"interfaceIPv6RaMilliSec":{"type":"boolean"},"interfaceIPv6ReachacbleTime":{"format":"int32","type":"integer"},"ipv6DadLoopbackDetect":{"type":"boolean"},"ipv6PoolName":{"type":"string"},"ipv6PoolSelfLink":{"type":"string"},"ipv6PoolUuid":{"type":"string"}},"$$ref":"#/components/schemas/InterfaceIpv6"},"interfaceManagementOnly":{"type":"boolean"},"interfaceManagementType":{"type":"string"},"interfaceMediaType":{"type":"string"},"interfaceMode":{"enum":["INLINE","PASSIVE","TAP","NONE","ERSPAN","SWITCHED","ROUTED","SWITCHPORT","EVENTING"],"type":"string"},"interfaceName":{"type":"string"},"interfaceSecurityLevel":{"format":"int32","type":"integer"},"interfaceSecurityZoneId":{"type":"string"},"interfaceSettings":{"type":"object","properties":{"pixArpTableList":{"items":{"type":"object","properties":{"pixArpTableEnableAlias":{"type":"boolean"},"pixArpTableIpAddress":{"type":"string"},"pixArpTableMacAddress":{"type":"string"}},"$$ref":"#/components/schemas/InterfaceSettingARP"},"type":"array"},"pixDnsDomainLookupInterface":{"type":"boolean"},"pixFragmentChain":{"format":"int32","type":"integer"},"pixFragmentFullReassembly":{"type":"boolean"},"pixFragmentOverwriteEnabled":{"type":"boolean"},"pixFragmentSize":{"format":"int32","type":"integer"},"pixFragmentTimeout":{"format":"int32","type":"integer"},"pixIpVerifyEnabled":{"type":"boolean"},"pixMacLearningTableInterface":{"type":"boolean"},"pixMacTableList":{"items":{"type":"object","properties":{"pixMacAddressTableMacAddress":{"type":"string"}},"$$ref":"#/components/schemas/InterfaceSettingMAC"},"type":"array"}},"$$ref":"#/components/schemas/InterfaceSettings"},"interfaceSnortFailOpenBusy":{"type":"boolean"},"interfaceSnortFailOpenDown":{"type":"boolean"},"interfaceVxLanNveOnly":{"type":"boolean"},"l2SwitchingEnabled":{"type":"boolean"},"literal":{"type":"boolean"},"macAddressPoolEntry":{"type":"object","properties":{"id":{"format":"int32","type":"integer"},"literal":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/ObjectEntry"},"managementAccessAllowedNetworkList":{"items":{"type":"object","properties":{"id":{"format":"int32","type":"integer"},"literal":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/ObjectEntry"},"type":"array"},"managementAccessInterface":{"type":"boolean"},"mandatory":{"type":"boolean"},"mtu":{"format":"int32","type":"integer"},"name":{"type":"string"},"pathMonitoringEntry":{"type":"object","properties":{"enable":{"type":"boolean"},"enableNSGMonitoring":{"type":"boolean"},"monitoredIp":{"type":"string"},"type":{"enum":["AUTO","PEER_IPV4","PEER_IPV6","AUTO4","AUTO6"],"type":"string"}},"$$ref":"#/components/schemas/PathMonitoringEntry"},"position":{"format":"int32","type":"integer"},"priority":{"format":"int32","type":"integer"},"readOnly":{"type":"boolean"},"standbyMacAddress":{"type":"string"},"state":{"type":"string"},"subType":{"type":"string"},"tooltip":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"},"vrfInfo":{"type":"object","properties":{"id":{"format":"int32","type":"integer"},"literal":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/ObjectEntry"}},"$$ref":"#/components/schemas/InterfaceBasePolicyEntry"},"literal":{"type":"boolean"},"localIdentityType":{"enum":["ADDRESS","AUTO","EMAILID","HOSTNAME","KEYID"],"type":"string"},"name":{"type":"string"},"nattedInterfaceAddress":{"type":"string"},"readOnly":{"type":"boolean"},"references":{"type":"object","properties":{"type":{"type":"string"},"valueList":{"items":{"type":"object","properties":{"literal":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/NamedEntry"},"type":"array"}},"$$ref":"#/components/schemas/ObjectRefs"},"sendLocalIdentity":{"type":"boolean"},"subType":{"type":"string"},"systemObject":{"type":"boolean"},"toolTip":{"type":"string"},"type":{"type":"string"},"uniqueTunnelId":{"type":"string"},"uuid":{"type":"string"},"value":{"type":"string"},"valueList":{"items":{"type":"object","properties":{"literal":{"type":"boolean"},"name":{"type":"string"},"type":{"type":"string"},"value":{"type":"string"}},"$$ref":"#/components/schemas/NamedEntry"},"type":"array"}},"type":"object","title":"VpnBackupInterfaceEntry"}}